命令行界面参考


Red Hat OpenStack Platform 16.1

Red Hat OpenStack Platform 的命令行客户端

摘要

对统一 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.1 的主要选项。

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-system-scope <auth-system-scope>]
                 [--os-domain-id <auth-domain-id>]
                 [--os-domain-name <auth-domain-name>]
                 [--os-project-id <auth-project-id>]
                 [--os-project-name <auth-project-name>]
                 [--os-project-domain-id <auth-project-domain-id>]
                 [--os-project-domain-name <auth-project-domain-name>]
                 [--os-trust-id <auth-trust-id>]
                 [--os-default-domain-id <auth-default-domain-id>]
                 [--os-default-domain-name <auth-default-domain-name>]
                 [--os-user-id <auth-user-id>] [--os-username <auth-username>]
                 [--os-user-domain-id <auth-user-domain-id>]
                 [--os-user-domain-name <auth-user-domain-name>]
                 [--os-password <auth-password>]
                 [--os-identity-provider <auth-identity-provider>]
                 [--os-protocol <auth-protocol>]
                 [--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-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-endpoint <auth-endpoint>] [--os-token <auth-token>]
                 [--os-user <auth-user>]
                 [--os-access-token <auth-access-token>]
                 [--os-passcode <auth-passcode>]
                 [--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-roles <auth-roles>]
                 [--os-aodh-endpoint <auth-aodh-endpoint>]
                 [--os-consumer-key <auth-consumer-key>]
                 [--os-consumer-secret <auth-consumer-secret>]
                 [--os-access-key <auth-access-key>]
                 [--os-access-secret <auth-access-secret>]
                 [--os-redirect-uri <auth-redirect-uri>]
                 [--os-code <auth-code>]
                 [--os-auth-methods <auth-auth-methods>]

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

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

--os-service-provider <service_provider>

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

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

使用 Keystoneto-Keystone 联合向服务提供商进行身份验证时的项目名称。

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

如果使用 Keystoneto-Keystone 联合向服务提供商进行身份验证时项目 ID。

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

如果使用 Keystoneto-Keystone 联合向服务提供商进行身份验证时,项目的域名。

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

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

--timing

print 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 版本, default=2 (env: OS_IMAGE_API_VERSION)

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

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

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

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

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

volume api 版本, default=3 (env: OS_VOLUME_API_VERSION)

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

Queue api 版本, default=2 (env: OS_QUEUES_API_VERSION)

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

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

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

--os-data-processing-url OS_DATA_PROCESSING_URL

Data processing 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>

workflow api 版本, default=2 (env: OS_WORKFLOW_API_VERSION)

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

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

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

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

--inspector-api-version INSPECTOR_API_VERSION

inspector api 版本,现在只支持 1 (env: INSPECTOR_VERSION)。

--inspector-url INSPECTOR_URL

inspector 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 version, default=2 (env: os_dns_api_version)

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

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

--os-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 版本, default=2 (env: OS_ALARMING_API_VERSION)

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

选择 Authentication type. available type: password, v3adfspassword, v3oidcclientcredentials, admin_token, none, v3samlpassword, gnocchi-basic, v2password, v3password, v3oidcaccesstoken, noauth, v2token, v3oidcpassword, token, v3tokenlessauth, v3totp, v3applicationcredential, aodh-noauth, v1password, v3oauth1, v3oidcauthcode, gnocchi-noauth, v3token, v3multifactor。默认:根据 --os-username/--os-token (Env: OS_AUTH_TYPE)选定.

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

password: 使用 v3adfspassword 验证 URL: 使用 v3oidcclientcredentials 的身份验证 URL: 带有 v3samlpassword 的身份验证 URL: 使用 v2 密码的身份验证 URL: 使用 v3password 的身份验证 URL: 使用 v3oidcaccesstoken 的身份验证 URL: 使用 v2token 的身份验证 URL: 带有 v3oidcpassword 的身份验证 URL: 使用令牌的身份验证 URL: 使用 v3tokenlessauth 的身份验证 URL: 使用 v3totp 验证 URL: 使用 v3applicationcredential 的身份验证 URL: 使用 v1 密码的身份验证 URL: 使用 v3oauth1 的身份验证 URL: 使用 v3oidcauthcode 的身份验证 URL: 使用 v3token 的身份验证 URL: 使用 v3multifactor 的身份验证 URL: 身份验证 URL (Env): OS_AUTH_URL)

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

使用 password: scope 用于使用 v3adfspassword 的系统操作: 使用 v3oidcclientcredentials 进行系统操作范围: 使用 v3samlpassword 进行系统操作范围: 使用 v3password 进行系统操作范围: 使用 v3oidcaccesstoken 进行系统操作范围: 使用 v3oidcpassword 进行系统操作范围: 使用令牌的系统操作范围: 使用 v3totp 的系统操作范围: 使用 v3applicationcredential 进行系统操作范围: 使用 v3oidcauthcode 进行系统操作范围: 使用 v3token 进行系统操作范围: 使用 v3multifactor 的系统操作范围: 系统操作范围(Env: os_SYSTEM_SCOPE)

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

密码为:使用 v3adfspassword 范围的域 id: 使用 v3oidcclientcredentials 范围的域 ID: 使用 v3samlpassword 范围的域 ID: 使用 v3password 范围的域 ID: 要通过 v3oidcaccesstoken 范围的域 ID: 使用 v3oidcpassword 范围的域 ID: 用于使用令牌的域 ID: 使用 v3tokenlessauth 范围的域 ID: 使用 v3totp 范围的域 ID: 要超出使用 v3applicationcredential 的域 ID: 使用 v3oidcauthcode 范围的域 ID: 使用 v3token 范围的域 ID: 要使用 v3multifactor 范围的域 ID: 要范围的域 ID (Env): os_DOMAIN_ID)

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

密码为:使用 v3adfspassword 范围的域名: 要使用 v3oidcclientcredentials 范围的域名: 使用 v3samlpassword 范围的域名: 要使用 v3 密码的范围的域名: 要通过 v3oidcaccesstoken 范围的域名: 要使用 v3oidcpassword 范围的域名: 要使用令牌的范围的域名: 使用 v3tokenlessauth 范围的域名: 要使用 v3totp 范围的域名: 要超出使用 v3applicationcredential 的域名: 使用 v3oidcauthcode 范围的域名: 要使用 v3token 范围的域名: 要使用 v3multifactor 范围的域名: 要范围为(Env)的域名: OS_DOMAIN_NAME)

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

password: project id to scope to with v3adfspassword: 使用 v3oidcclientcredentials 范围的项目 ID: 使用 v3samlpassword 范围的项目 ID: 使用 v3password 范围的项目 ID: 使用 v3oidcaccesstoken 范围的项目 ID: 要使用 noauth 的范围的项目 ID: 使用 v3oidcpassword 的项目 ID: 要使用令牌的范围的项目 ID: 使用 v3tokenlessauth 范围的项目 ID: 使用 v3totp 范围的项目 ID: 要使用 v3applicationcredential 的范围的项目 ID: 使用 aodh-noauth 范围的项目 ID: 使用 v3oidcauthcode 的项目 ID: 要使用 gnocchi-noauth 范围的项目 ID: 使用 v3token 的项目 ID: 要使用 v3multifactor 范围的项目 ID: 要范围的项目 ID (Env): os_PROJECT_ID)

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

password: 使用 v3adfspassword 范围的项目名称: 要使用 v3oidcclientcredentials 的范围的项目名称: 使用 v3samlpassword 范围的项目名称: 要使用 v3password 范围的项目名称: 要通过 v3oidcaccesstoken 范围的项目名称: 要使用 v3oidcpassword 范围的项目名称: 要用于使用令牌的项目名称: 要使用 v3tokenlessauth 范围的项目名称: 要使用 v3totp 范围的项目名称: 要超出使用 v3applicationcredential 的项目名称: 要使用 v1 密码的范围的项目名称: 要使用 v3oidcauthcode 的 Swift 帐户: 要超出使用 v3token 的项目名称: 要使用 v3multifactor 范围的项目名称: 要范围为(Env)的项目名称: os_PROJECT_NAME)

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

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

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

密码为:包含带有 v3adfspassword 的项目的域名: 包含使用 v3oidcclientcredentials 的项目名称: 包含使用 v3samlpassword 的项目的域名: 包含使用 v3password 的项目的域名: 包含使用 v3oidcaccesstoken 的项目名称: 包含使用 v3oidcpassword 的项目的域名: 包含使用令牌的项目的域名: 包含使用 v3tokenlessauth 的项目的域名: 包含使用 v3totp 的项目的域名: 包含项目 With v3applicationcredential 的域名: 包含使用 v3oidcauthcode 的项目的域名: 包含使用 v3token 的项目的域名: 包含项目 v3multifactor 的域名: 包含项目的域名(Env: os_PROJECT_DOMAIN_NAME)

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

使用 password: trust id with v3adfspassword: trust id with v3oidcclientcredentials: Trust ID with v3samlpassword: Trust ID with v2password: Trust ID with v3oidcaccesstoken: Trust ID with v2token: Trust ID with v3oid: Trust ID with v3oid cpassword: Trust ID with token: Trust ID With v3totp: Trust ID With v3applicationcredential: Trust ID with v3oidcauthcode: Trust ID with v3token: Trust ID with v3multifactor: Trust ID (Env: os_TRUST_ID)

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

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

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

password:用于 v3 api 和 v2 参数的可选域名。它将用于 v3 中的用户和项目域,并在 v2 身份验证中忽略。带有令牌:用于 v3 API 和 v2 参数的可选域名。它将用于 v3 中的用户和项目域,并在 v2 身份验证中忽略。(Env: OS_DEFAULT_DOMAIN_NAME)

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

使用 password: user ID with v2password: user id with v3password: User ID With v3totp: User ID With v3totp: User ID with aodh-noauth: User ID with aodh-noauth: User ID with gnocchi-noauth: User ID (Env: OS_USER_ID)

--os-username <auth-username>

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

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

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

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

使用密码:用户名为 v3password: User 的域名使用 v3totp: User 的域名 With v3applicationcredential: User 的域名(Env: OS_USER_DOMAIN_NAME)

--os-password <auth-password>

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

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

使用 v3adfspassword: 身份提供程序的名称 with v3oidcclientcredentials: Identity Provider's name with v3samlpassword: Identity Provider's name with v3oidcaccesstoken: Identity Provider's name with v3oidcpassword: Identity provider's name with v3oidcauthcode: Identity Provider's name with v3oidcaccesstoken: Identity Provider's name with v3oidcpassword: Identity Provider name with v3oidcclient

--os-protocol <auth-protocol>

使用 v3adfspassword: 使用 v3oidcclientcredentials: Protocol for federated 插件使用 v3samlpassword: Protocol Protocol for federated 插件使用 v3oidcaccesstoken: Protocol for federated 插件使用 v3oidcpassword: Protocol for federated 插件使用 v3oidccauthcode: Protocol for federated 插件(Env: OS_PROTOCOL)

--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:服务提供商的端点(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-client-id <auth-client-id>

v3oidcclientcredentials: oauth 2.0 客户端 id with v3oidcpassword: OAuth 2.0 Client ID with v3oidcauthcode: OAuth 2.0 Client ID (Env: OS_CLIENT_ID)

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

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

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

使用 v3oidcclientcredentials: openid 连接从授权服务器请求的范围。请注意,OpenID Connect 规范必须始终指定 "openid"。使用 v3oidcpassword: OpenID Connect 范围,从授权服务器请求。请注意,OpenID Connect 规范必须始终指定 "openid"。使用从授权服务器请求的 v3oidcauthcode: OpenID Connect 范围。请注意,OpenID Connect 规范必须始终指定 "openid"。(Env: OS_OPENID_SCOPE)

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

使用 v3oidcclientcredentials: openid connect provider Token Endpoint。请注意,如果传递了一个发现文档,此选项将覆盖发现文档中的服务器提供的端点。使用 v3oidcpassword: OpenID Connect Provider Token Endpoint。请注意,如果传递了一个发现文档,此选项将覆盖发现文档中的服务器提供的端点。使用 v3oidcauthcode: OpenID Connect Provider Token Endpoint。请注意,如果传递了一个发现文档,此选项将覆盖发现文档中的服务器提供的端点。(Env: OS_ACCESS_TOKEN_ENDPOINT)

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

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

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

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

--os-endpoint <auth-endpoint>

使用 admin_token: 端点时,始终会用到 gnocchi-basic: Gnocchi 端点,通过 gnocchi-noauth: Gnocchi 端点通过 gnocchi-noauth: Gnocchi 端点(Env: OS_ENDPOINT)来使用。

--os-token <auth-token>

使用 admin_token:始终用于 v2token 的令牌: Token With token: Token 用于通过 v3token: Token 进行身份验证(Env: OS_TOKEN)

--os-user <auth-user>

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

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

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

--os-passcode <auth-passcode>

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

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

v3applicationcredential: application credential auth secret (Env: OS_APPLICATION_CREDENTIAL_SECRET)

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

v3applicationcredential: application credential ID (Env: OS_APPLICATION_CREDENTIAL_ID)

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

v3applicationcredential: application credential name (Env: OS_APPLICATION_CREDENTIAL_NAME)

--os-roles <auth-roles>

使用 aodh-noauth: role with gnocchi-noauth: role (Env: OS_ROLES)

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

使用 aodh-noauth: aodh endpoint (env: OS_AODH_ENDPOINT)

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

With v3oauth1: oauth access key (env: os_access_key)

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

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

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

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

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

consumer 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 Formatter
概述

--noindent

是否禁用缩进 json

表 2.4. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 2.5. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

第 3 章 acl

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

3.1. ACL 删除

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

使用方法:

openstack acl delete [-h] URI

表 3.1. 位置参数
概述

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. 位置参数
概述

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 Formatter
概述

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

当包含引号时,默认为 nonnumeric

表 3.7. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 3.8. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

3.3. ACL 提交

在 secret 或容器上提交 ACL (由 href 标识)。

使用方法:

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. 位置参数
概述

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 的类型

表 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 Formatter
概述

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

当包含引号时,默认为 nonnumeric

表 3.13. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 3.14. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

3.4. ACL 用户添加

按照 href 识别在 secret 或容器中添加 ACL 用户。

使用方法:

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. 位置参数
概述

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 的类型

表 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 Formatter
概述

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

当包含引号时,默认为 nonnumeric

表 3.19. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 3.20. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

3.5. ACL 用户删除

从 secret 或容器中删除 ACL 用户,具体由 href 标识。

使用方法:

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. 位置参数
概述

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 的类型

表 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 Formatter
概述

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

当包含引号时,默认为 nonnumeric

表 3.25. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 3.26. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

第 4 章 action

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

4.1. 操作定义创建

创建新操作。

使用方法:

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. 位置参数
概述

定义

操作定义文件

表 4.2. 可选参数
概述

-h, --help

显示帮助信息并退出

--marker [MARKER]

以上页面的最后执行 uuid 显示在"标记"后执行列表。

--limit [LIMIT]

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

--sort_keys [SORT_KEYS]

按逗号分隔排列结果的排序键列表。默认: created_at。Example: mistral execution-list --sort_keys=id,description

--sort_dirs [SORT_DIRS]

以逗号分隔的排序指令列表。default: asc。Example: mistral execution-list --sort_keys=id,description --sort_dirs=asc,desc

--filter 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 Formatter
概述

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

当包含引号时,默认为 nonnumeric

表 4.5. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 4.6. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

4.2. 操作定义显示

显示操作定义。

使用方法:

openstack action definition definition show [-h] name

表 4.7. 位置参数
概述

name

操作名称

表 4.8. 可选参数
概述

-h, --help

显示帮助信息并退出

4.3. 操作定义删除

删除操作.

使用方法:

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

表 4.9. 位置参数
概述

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 显示在"标记"后执行列表。

--limit [LIMIT]

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

--sort_keys [SORT_KEYS]

按逗号分隔排列结果的排序键列表。默认: created_at。Example: mistral execution-list --sort_keys=id,description

--sort_dirs [SORT_DIRS]

以逗号分隔的排序指令列表。default: asc。Example: mistral execution-list --sort_keys=id,description --sort_dirs=asc,desc

--filter 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 Formatter
概述

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

当包含引号时,默认为 nonnumeric

表 4.14. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 4.15. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--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. 位置参数
概述

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 Formatter
概述

--noindent

是否禁用缩进 json

表 4.20. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 4.21. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--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. 位置参数
概述

定义

操作定义文件

表 4.23. 可选参数
概述

-h, --help

显示帮助信息并退出

--marker [MARKER]

以上页面的最后执行 uuid 显示在"标记"后执行列表。

--limit [LIMIT]

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

--sort_keys [SORT_KEYS]

按逗号分隔排列结果的排序键列表。默认: created_at。Example: mistral execution-list --sort_keys=id,description

--sort_dirs [SORT_DIRS]

以逗号分隔的排序指令列表。default: asc。Example: mistral execution-list --sort_keys=id,description --sort_dirs=asc,desc

--filter 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 Formatter
概述

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

当包含引号时,默认为 nonnumeric

表 4.26. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 4.27. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

4.7. 操作执行删除

删除操作执行。

使用方法:

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

表 4.28. 位置参数
概述

action_execution

操作执行标识符 ID。

表 4.29. 可选参数
概述

-h, --help

显示帮助信息并退出

4.8. 操作执行输入显示

显示操作执行输入数据。

使用方法:

openstack action execution input show [-h] id

表 4.30. 位置参数
概述

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. 位置参数
概述

task_execution_id

任务执行 ID。

表 4.33. 可选参数
概述

-h, --help

显示帮助信息并退出

--marker [MARKER]

以上页面的最后执行 uuid 显示在"标记"后执行列表。

--limit [LIMIT]

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

--sort_keys [SORT_KEYS]

按逗号分隔排列结果的排序键列表。默认: created_at。Example: mistral execution-list --sort_keys=id,description

--sort_dirs [SORT_DIRS]

以逗号分隔的排序指令列表。default: asc。Example: mistral execution-list --sort_keys=id,description --sort_dirs=asc,desc

--filter 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 Formatter
概述

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

当包含引号时,默认为 nonnumeric

表 4.36. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 4.37. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

4.10. 操作执行输出显示

显示 Action 执行输出数据。

使用方法:

openstack action execution output show [-h] id

表 4.38. 位置参数
概述

id

操作执行 ID.

表 4.39. 可选参数
概述

-h, --help

显示帮助信息并退出

4.11. 操作执行运行

创建新操作执行或仅运行特定操作。

使用方法:

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. 位置参数
概述

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 Formatter
概述

--noindent

是否禁用缩进 json

表 4.44. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 4.45. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

4.12. 操作执行显示

显示具体操作执行。

使用方法:

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. 位置参数
概述

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 Formatter
概述

--noindent

是否禁用缩进 json

表 4.50. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 4.51. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

4.13. 操作执行更新

更新特定的操作执行。

使用方法:

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. 位置参数
概述

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 Formatter
概述

--noindent

是否禁用缩进 json

表 4.56. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 4.57. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--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. 位置参数
概述

<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 Formatter
概述

--noindent

是否禁用缩进 json

表 5.5. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 5.6. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

5.2. 地址范围删除

删除地址范围

使用方法:

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

表 5.7. 位置参数
概述

<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 version 网络(4 或 6)的地址范围(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 Formatter
概述

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

当包含引号时,默认为 nonnumeric

表 5.12. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 5.13. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

5.4. 地址范围集

设置地址范围属性

使用方法:

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

表 5.14. 位置参数
概述

<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. 位置参数
概述

<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 Formatter
概述

--noindent

是否禁用缩进 json

表 5.20. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 5.21. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

第 6 章 aggregate

本章论述了 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. 位置参数
概述

<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 Formatter
概述

--noindent

是否禁用缩进 json

表 6.5. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 6.6. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--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. 位置参数
概述

<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 Formatter
概述

--noindent

是否禁用缩进 json

表 6.11. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 6.12. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

6.3. 聚合删除

删除现有聚合

使用方法:

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

表 6.13. 位置参数
概述

<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 Formatter
概述

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

当包含引号时,默认为 nonnumeric

表 6.18. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 6.19. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--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. 位置参数
概述

<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 Formatter
概述

--noindent

是否禁用缩进 json

表 6.24. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 6.25. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

6.6. 聚合集

设置聚合属性

使用方法:

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

表 6.26. 位置参数
概述

<aggregate>

聚合以修改(名称或 ID)

表 6.27. 可选参数
概述

-h, --help

显示帮助信息并退出

--name <name>

设置聚合名称

--zone <availability-zone>

设置可用区域名称

--property <key=value>

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

--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. 位置参数
概述

<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 Formatter
概述

--noindent

是否禁用缩进 json

表 6.32. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 6.33. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

6.8. aggregate unset

取消设置聚合属性

使用方法:

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

表 6.34. 位置参数
概述

<aggregate>

聚合以修改(名称或 ID)

表 6.35. 可选参数
概述

-h, --help

显示帮助信息并退出

--property <key>

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

第 7 章 警报

本章论述了 alarm 命令下的命令。

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、composite、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,alarm,insufficient data]

--severity <SEVERITY>

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

--enabled {True|False}

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

--alarm-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}

真(如果应该重复通知操作,则警报会一直处于目标状态)

表 7.2. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

表 7.3. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 7.4. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 7.5. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

表 7.6. 常见警报规则
概述

--query <QUERY>

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

--comparison-operator <OPERATOR>

与之比较的运算符,其中之一:[ltleeqnegegt]

--evaluation-periods <EVAL_PERIODS>

要评估的时间段数

--threshold <THRESHOLD>

要评估的阈值。

表 7.7. 事件警报
概述

--event-type <EVENT_TYPE>

要评估的事件类型

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

--granularity <GRANULARITY>

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

--aggregation-method <AGGR_METHOD>

与阈值相比的 aggregation_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 格式的复合阈值规则,表单可以是嵌套的 diction,它按 "and", "or" 合并 gnocchi 规则。例如,格式为: {"or":[RULE1, RULE2, {"and": [RULE3, RULE4]}]}。

7.2. 删除警报

删除警报

使用方法:

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

表 7.11. 位置参数
概述

<ALARM ID 或 NAME>

警报的 ID 或名称。

表 7.12. 可选参数
概述

-h, --help

显示帮助信息并退出

--name <NAME>

警报的名称

7.4. alarm-history 显示

显示警报历史记录

使用方法:

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. 位置参数
概述

<alarm-id>

警报 ID

表 7.19. 可选参数
概述

-h, --help

显示帮助信息并退出

--limit <LIMIT>

要返回的资源数量(默认为 server default)

--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 Formatter
概述

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

当包含引号时,默认为 nonnumeric

表 7.22. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 7.23. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

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

Rich query supported by aodh, e.g. project_id!=my-id user_id=foo or user_id=bar

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

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

--limit <LIMIT>

要返回的资源数量(默认为 server default)

--marker <MARKER>

上一列表的最后一个项目。返回此值后的下一个结果,支持的标记是 alarm_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 Formatter
概述

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

当包含引号时,默认为 nonnumeric

表 7.27. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 7.28. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--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. 位置参数
概述

<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 Formatter
概述

--noindent

是否禁用缩进 json

表 7.33. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 7.34. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

7.7. 警报状态获取

获取警报状态

使用方法:

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. 位置参数
概述

<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 Formatter
概述

--noindent

是否禁用缩进 json

表 7.39. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 7.40. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--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. 位置参数
概述

<ALARM ID 或 NAME>

警报的 ID 或名称。

表 7.42. 可选参数
概述

-h, --help

显示帮助信息并退出

--name <NAME>

警报的名称

--state <STATE>

警报的状态之一:[ok,alarm,insufficient data]

表 7.43. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

表 7.44. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 7.45. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 7.46. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--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. 位置参数
概述

<ALARM ID 或 NAME>

警报的 ID 或名称。

表 7.48. 可选参数
概述

-h, --help

显示帮助信息并退出

--name <NAME>

警报的名称

-T <TYPE>, --type <TYPE>

警报类型应当是: event、composite、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,alarm,insufficient data]

--severity <SEVERITY>

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

--enabled {True|False}

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

--alarm-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}

真(如果应该重复通知操作,则警报会一直处于目标状态)

表 7.49. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

表 7.50. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 7.51. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 7.52. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

表 7.53. 常见警报规则
概述

--query <QUERY>

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

--comparison-operator <OPERATOR>

与之比较的运算符,其中之一:[ltleeqnegegt]

--evaluation-periods <EVAL_PERIODS>

要评估的时间段数

--threshold <THRESHOLD>

要评估的阈值。

表 7.54. 事件警报
概述

--event-type <EVENT_TYPE>

要评估的事件类型

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

--granularity <GRANULARITY>

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

--aggregation-method <AGGR_METHOD>

与阈值相比的 aggregation_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 格式的复合阈值规则,表单可以是嵌套的 diction,它按 "and", "or" 合并 gnocchi 规则。例如,格式为: {"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 Formatter
概述

--noindent

是否禁用缩进 json

表 8.4. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 8.5. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

第 9 章 application

本章论述了 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. 位置参数
概述

<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 Formatter
概述

--noindent

是否禁用缩进 json

表 9.5. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 9.6. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

9.2. 应用程序凭证删除

删除应用程序凭证

使用方法:

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

表 9.7. 位置参数
概述

<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 Formatter
概述

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

当包含引号时,默认为 nonnumeric

表 9.12. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 9.13. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--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. 位置参数
概述

<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 Formatter
概述

--noindent

是否禁用缩进 json

表 9.18. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 9.19. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--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 Formatter
概述

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

当包含引号时,默认为 nonnumeric

表 10.4. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 10.5. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--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 Formatter
概述

--noindent

是否禁用缩进 json

表 11.4. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 11.5. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

11.2. 裸机分配删除

取消注册的裸机分配。

使用方法:

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

表 11.6. 位置参数
概述

<allocation>

分配要删除的分配(name 或 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 服务使用的最大值。

--marker <allocation>

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

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

根据指定的分配字段和指示(如 或 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 Formatter
概述

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

当包含引号时,默认为 nonnumeric

表 11.11. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 11.12. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

11.4. 裸机分配集

设置 baremetal 分配属性。

使用方法:

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

表 11.13. 位置参数
概述

<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. 位置参数
概述

<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 Formatter
概述

--noindent

是否禁用缩进 json

表 11.19. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 11.20. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

11.6. baremetal allocation unset

取消设置裸机分配属性。

使用方法:

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

表 11.21. 位置参数
概述

<allocation>

分配的名称或 uuid

表 11.22. 可选参数
概述

-h, --help

显示帮助信息并退出

--name

取消设置分配的名称

--extra <key>

在这个裸机分配中取消设置的额外属性(重复选项以取消设置多个额外属性)。

11.7. baremetal chassis create

创建新的 chassis。

使用方法:

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>

chassis 描述

--extra <key=value>

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

--uuid <uuid>

chassis 的唯一 uuid

表 11.24. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

表 11.25. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 11.26. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 11.27. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

11.8. baremetal chassis delete

删除 chassis。

使用方法:

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

表 11.28. 位置参数
概述

<chassis>

要删除的机箱的 UUID

表 11.29. 可选参数
概述

-h, --help

显示帮助信息并退出

11.9. baremetal chassis 列表

列出 chassis。

使用方法:

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>

每个请求返回的最大 chassis 数量,0 代表没有限制。默认为 Baremetal API 服务使用的最大值。

--long

显示有关 chassis 的详细信息

--marker <chassis>

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

--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 Formatter
概述

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

当包含引号时,默认为 nonnumeric

表 11.33. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 11.34. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

11.10. baremetal chassis 集

设置 chassis 属性。

使用方法:

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

表 11.35. 位置参数
概述

<chassis>

chassis 的 UUID

表 11.36. 可选参数
概述

-h, --help

显示帮助信息并退出

--description <description>

设置 chassis 的描述

--extra <key=value>

在这个机箱上设置的额外步骤(重复选项可设置多个额外的选项)

11.11. baremetal chassis 显示

显示机箱详细信息。

使用方法:

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. 位置参数
概述

<chassis>

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 Formatter
概述

--noindent

是否禁用缩进 json

表 11.41. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 11.42. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

11.12. baremetal chassis unset

取消设置机箱属性。

使用方法:

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

表 11.43. 位置参数
概述

<chassis>

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 服务使用的最大值。

--marker <conductor>

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

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

根据指定的编排器字段和指示(如 或 desc)对输出进行排序(默认值: asc 或 dec)。可以用逗号分隔来指定多个字段和方向。

--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 Formatter
概述

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

当包含引号时,默认为 nonnumeric

表 11.48. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 11.49. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--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. 位置参数
概述

<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 Formatter
概述

--noindent

是否禁用缩进 json

表 11.54. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 11.55. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

11.15. baremetal create

从文件创建资源

使用方法:

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

表 11.56. 位置参数
概述

<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. 位置参数
概述

<name>

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

表 11.59. 可选参数
概述

-h, --help

显示帮助信息并退出

--uuid <uuid>

deploy 模板的 UUID。

--extra <key=value>

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

--steps <steps>

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

表 11.60. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

表 11.61. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 11.62. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 11.63. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

11.17. 裸机部署模板删除

删除部署模板。

使用方法:

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

表 11.64. 位置参数
概述

<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 服务使用的最大值。

--marker <template>

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

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

根据指定的部署模板字段和指示(如 或 desc)对输出进行排序(默认值: asc 或 dec)。可以用逗号分隔来指定多个字段和方向。

--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 Formatter
概述

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

当包含引号时,默认为 nonnumeric

表 11.69. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 11.70. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

11.19. 裸机部署模板集

设置 baremetal 部署模板属性。

使用方法:

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

表 11.71. 位置参数
概述

<template>

部署模板的名称或 uuid

表 11.72. 可选参数
概述

-h, --help

显示帮助信息并退出

--name <name>

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

--steps <steps>

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

--extra <key=value>

在这个 baremetal deploy 模板上设置额外的额外的选项(用于设置多个额外的选项)。

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. 位置参数
概述

<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 Formatter
概述

--noindent

是否禁用缩进 json

表 11.77. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 11.78. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

11.21. baremetal deploy template unset

取消设置裸机部署模板属性。

使用方法:

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

表 11.79. 位置参数
概述

<template>

部署模板的名称或 uuid

表 11.80. 可选参数
概述

-h, --help

显示帮助信息并退出

--extra <key>

此 baremetal deploy 模板上取消设置的额外步骤(重复选项可取消设置多个额外的选项)。

11.22. baremetal 驱动程序列表

列出已启用的驱动程序。

使用方法:

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"或"ynamic")。默认值为所有它们。

--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 Formatter
概述

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

当包含引号时,默认为 nonnumeric

表 11.84. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 11.85. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

11.23. baremetal 驱动程序通过thru 调用

为驱动程序致电供应商传递方法。

使用方法:

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. 位置参数
概述

<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 Formatter
概述

--noindent

是否禁用缩进 json

表 11.90. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 11.91. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

11.24. baremetal 驱动程序通过thru 列表

列举驱动程序可用的厂商令人沮丧的方法。

使用方法:

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. 位置参数
概述

<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 Formatter
概述

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

当包含引号时,默认为 nonnumeric

表 11.96. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 11.97. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

11.25. baremetal 驱动程序属性列表

列出驱动程序属性。

使用方法:

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. 位置参数
概述

<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 Formatter
概述

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

当包含引号时,默认为 nonnumeric

表 11.102. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 11.103. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

11.26. baremetal driver 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. 位置参数
概述

<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 Formatter
概述

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

当包含引号时,默认为 nonnumeric

表 11.108. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 11.109. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

11.27. baremetal 驱动程序显示

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

使用方法:

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. 位置参数
概述

<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 Formatter
概述

--noindent

是否禁用缩进 json

表 11.114. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 11.115. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

11.28. 裸机内省中止

中止运行节点的内省。

使用方法:

openstack baremetal introspection abort [-h] node

表 11.116. 位置参数
概述

node

裸机恢复节点 uuid 或名称

表 11.117. 可选参数
概述

-h, --help

显示帮助信息并退出

11.29. 裸机内省数据保存

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

使用方法:

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

表 11.118. 位置参数
概述

node

裸机恢复节点 uuid 或名称

表 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. 位置参数
概述

node_ident

裸机恢复节点 uuid 或名称

表 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 Formatter
概述

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

当包含引号时,默认为 nonnumeric

表 11.124. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 11.125. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--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. 位置参数
概述

node_ident

裸机恢复节点 uuid 或名称

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 Formatter
概述

--noindent

是否禁用缩进 json

表 11.130. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 11.131. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

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

显示帮助信息并退出

--marker MARKER

上一页面中最后一个项目的 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 Formatter
概述

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

当包含引号时,默认为 nonnumeric

表 11.135. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 11.136. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

11.33. 裸机内省重新处理

重新处理存储内省数据

使用方法:

openstack baremetal introspection reprocess [-h] node

表 11.137. 位置参数
概述

node

裸机恢复节点 uuid 或名称

表 11.138. 可选参数
概述

-h, --help

显示帮助信息并退出

11.34. 裸机内省规则删除

删除内省规则。

使用方法:

openstack baremetal introspection rule delete [-h] uuid

表 11.139. 位置参数
概述

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. 位置参数
概述

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 Formatter
概述

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

当包含引号时,默认为 nonnumeric

表 11.145. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 11.146. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--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 Formatter
概述

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

当包含引号时,默认为 nonnumeric

表 11.150. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 11.151. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--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. 位置参数
概述

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 Formatter
概述

--noindent

是否禁用缩进 json

表 11.157. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 11.158. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--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. 位置参数
概述

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 Formatter
概述

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

当包含引号时,默认为 nonnumeric

表 11.163. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 11.164. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--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. 位置参数
概述

node

裸机恢复节点 uuid 或名称

表 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 Formatter
概述

--noindent

是否禁用缩进 json

表 11.169. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 11.170. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

11.41. 裸机节点中止

将裸机节点的置备状态设置为 abort

使用方法:

openstack baremetal node abort [-h] <node>

表 11.171. 位置参数
概述

<node>

节点的名称或 uuid。

表 11.172. 可选参数
概述

-h, --help

显示帮助信息并退出

11.42. 裸机恢复节点添加特征

将特征添加到节点。

使用方法:

openstack baremetal node add trait [-h] <node> <trait> [<trait> ...]

表 11.173. 位置参数
概述

<node>

节点的名称或 uuid

<trait>

要添加的特征

表 11.174. 可选参数
概述

-h, --help

显示帮助信息并退出

11.43. 裸机恢复节点采用

设置要采用的裸机节点的置备状态

使用方法:

openstack baremetal node adopt [-h] [--wait [<time-out>]] <node>

表 11.175. 位置参数
概述

<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. 位置参数
概述

<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 Formatter
概述

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

当包含引号时,默认为 nonnumeric

表 11.181. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 11.182. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--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. 位置参数
概述

<node>

节点的名称或 uuid

<setting name>

将名称设置为 show

表 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 Formatter
概述

--noindent

是否禁用缩进 json

表 11.187. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 11.188. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

11.46. 裸机节点引导设备集

为节点设置引导设备

使用方法:

openstack baremetal node boot device set [-h] [--persistent]
                                                <node> <device>

表 11.189. 位置参数
概述

<node>

节点的名称或 uuid

<device>

bios、cdrom、disk、pxe、secure、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. 位置参数
概述

<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 Formatter
概述

--noindent

是否禁用缩进 json

表 11.195. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 11.196. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

11.48. 裸机节点清理

将裸机节点的置备状态设置为 clean

使用方法:

openstack baremetal node clean [-h] [--wait [<time-out>]] --clean-steps
                                      <clean-steps>
                                      <node>

表 11.197. 位置参数
概述

<node>

节点的名称或 uuid。

表 11.198. 可选参数
概述

-h, --help

显示帮助信息并退出

--wait [<time-out>]

等待节点到达所需状态可管理。(可选)取超时值(以秒为单位)。默认值为 0,表示它将无限期等待。

--clean-steps <clean-steps>

json 格式的清理步骤。可以是包含清理步骤的文件的路径;或 -,包含从标准输入读取的清洁步骤;或字符串。该值应该是清理步骤字典的列表;每个字典中均应具有键 interfacestep,以及可选的键 arg

11.49. 裸机恢复节点控制台禁用

禁用节点的控制台访问

使用方法:

openstack baremetal node console disable [-h] <node>

表 11.199. 位置参数
概述

<node>

节点的名称或 uuid

表 11.200. 可选参数
概述

-h, --help

显示帮助信息并退出

11.50. 裸机节点控制台启用

为节点启用控制台访问

使用方法:

openstack baremetal node console enable [-h] <node>

表 11.201. 位置参数
概述

<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. 位置参数
概述

<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 Formatter
概述

--noindent

是否禁用缩进 json

表 11.207. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 11.208. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

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

用于控制节点 [required] 的驱动程序。

--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 Formatter
概述

--noindent

是否禁用缩进 json

表 11.212. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 11.213. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

11.53. 裸机节点删除

取消注册的裸机恢复节点

使用方法:

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

表 11.214. 位置参数
概述

<node>

要删除的节点(name 或 uuid)

表 11.215. 可选参数
概述

-h, --help

显示帮助信息并退出

11.54. 裸机节点部署

设置 要部署的裸机恢复节点的置备状态

使用方法:

openstack baremetal node deploy [-h] [--wait [<time-out>]]
                                       [--config-drive <config-drive>]
                                       <node>

表 11.216. 位置参数
概述

<node>

节点的名称或 uuid。

表 11.217. 可选参数
概述

-h, --help

显示帮助信息并退出

--wait [<time-out>]

等待节点到达所需状态 active。(可选)取超时值(以秒为单位)。默认值为 0,表示它将无限期等待。

--config-drive <config-drive>

gzip 压缩的 base64 编码的配置驱动器字符串,或者配置驱动器文件的路径,或者包含配置驱动器文件的目录的路径,或者 JSON 对象以从中构建配置驱动器。如果是目录,则会从它生成一个配置驱动器。如果它是一个带有可选密钥 meta_datauser_datanetwork_data 的 JSON 对象,则在服务器端生成配置驱动器(请参阅裸机 API 参考来获得更详细的信息)。

11.55. 裸机恢复节点注入 nmi

将 NMI 注入到裸机恢复节点

使用方法:

openstack baremetal node inject nmi [-h] <node>

表 11.218. 位置参数
概述

<node>

节点的名称或 uuid。

表 11.219. 可选参数
概述

-h, --help

显示帮助信息并退出

11.56. 裸机节点检查

设置 要检查的裸机恢复节点的置备状态

使用方法:

openstack baremetal node inspect [-h] [--wait [<time-out>]] <node>

表 11.220. 位置参数
概述

<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 服务使用的最大值。

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

将列表限制为这个 chassis 的节点

--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 Formatter
概述

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

当包含引号时,默认为 nonnumeric

表 11.225. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 11.226. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

11.58. 裸机节点维护集

将裸机节点设置为维护模式

使用方法:

openstack baremetal node maintenance set [-h] [--reason <reason>]
                                                <node>

表 11.227. 位置参数
概述

<node>

节点的名称或 uuid。

表 11.228. 可选参数
概述

-h, --help

显示帮助信息并退出

--reason <reason>

设置维护模式的原因。

11.59. 裸机恢复节点维护未设置

从维护模式取消置备裸机节点

使用方法:

openstack baremetal node maintenance unset [-h] <node>

表 11.229. 位置参数
概述

<node>

节点的名称或 uuid。

表 11.230. 可选参数
概述

-h, --help

显示帮助信息并退出

11.60. 裸机节点管理

设置 要管理的裸机节点的置备状态

使用方法:

openstack baremetal node manage [-h] [--wait [<time-out>]] <node>

表 11.231. 位置参数
概述

<node>

节点的名称或 uuid。

表 11.232. 可选参数
概述

-h, --help

显示帮助信息并退出

--wait [<time-out>]

等待节点到达所需状态可管理。(可选)取超时值(以秒为单位)。默认值为 0,表示它将无限期等待。

11.61. 裸机节点通过thru 调用

为节点调用供应商传递方法

使用方法:

openstack baremetal node passthru call [-h] [--arg <key=value>]
                                              [--http-method <http-method>]
                                              <node> <method>

表 11.233. 位置参数
概述

<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. 裸机恢复节点传递列表

列出节点的厂商 passthru 方法

使用方法:

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. 位置参数
概述

<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 Formatter
概述

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

当包含引号时,默认为 nonnumeric

表 11.239. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 11.240. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

11.63. 裸机节点关闭

关闭节点

使用方法:

openstack baremetal node power off [-h]
                                          [--power-timeout <power-timeout>]
                                          [--soft]
                                          <node>

表 11.241. 位置参数
概述

<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. 位置参数
概述

<node>

节点的名称或 uuid。

表 11.244. 可选参数
概述

-h, --help

显示帮助信息并退出

--power-timeout <power-timeout>

超时(以秒为单位,正整数)等待目标电源状态,然后再出现错误。

11.65. 裸机恢复节点提供

设置裸机节点的置备状态 以提供

使用方法:

openstack baremetal node provide [-h] [--wait [<time-out>]] <node>

表 11.245. 位置参数
概述

<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. 位置参数
概述

<node>

节点的名称或 uuid。

表 11.248. 可选参数
概述

-h, --help

显示帮助信息并退出

--soft

请求正常重启。

--power-timeout <power-timeout>

超时(以秒为单位,正整数)等待目标电源状态,然后再出现错误。

11.67. 裸机节点重建

设置要 重建的裸机节点的置备状态

使用方法:

openstack baremetal node rebuild [-h] [--wait [<time-out>]]
                                        [--config-drive <config-drive>]
                                        <node>

表 11.249. 位置参数
概述

<node>

节点的名称或 uuid。

表 11.250. 可选参数
概述

-h, --help

显示帮助信息并退出

--wait [<time-out>]

等待节点到达所需状态 active。(可选)取超时值(以秒为单位)。默认值为 0,表示它将无限期等待。

--config-drive <config-drive>

gzip 压缩的 base64 编码的配置驱动器字符串,或者配置驱动器文件的路径,或者包含配置驱动器文件的目录的路径,或者 JSON 对象以从中构建配置驱动器。如果是目录,则会从它生成一个配置驱动器。如果它是一个带有可选密钥 meta_datauser_datanetwork_data 的 JSON 对象,则在服务器端生成配置驱动器(请参阅裸机 API 参考来获得更详细的信息)。

11.68. 裸机恢复节点删除特征

从节点中删除特征。

使用方法:

openstack baremetal node remove trait [-h] [--all]
                                             <node> [<trait> [<trait> ...]]

表 11.251. 位置参数
概述

<node>

节点的名称或 uuid

<trait>

要删除的特征

表 11.252. 可选参数
概述

-h, --help

显示帮助信息并退出

--all

删除所有特征

11.69. 裸机节点救援

将 baremetal 节点的置备状态设置为 rescue

使用方法:

openstack baremetal node rescue [-h] [--wait [<time-out>]]
                                       --rescue-password <rescue-password>
                                       <node>

表 11.253. 位置参数
概述

<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. 位置参数
概述

<node>

节点的名称或 uuid。

表 11.256. 可选参数
概述

-h, --help

显示帮助信息并退出

--instance-uuid <uuid>

将节点的实例 uuid 设置为 <uuid>

--name <name>

设置节点的名称

--chassis-uuid <chassis UUID>

为节点设置 chassis

--driver <driver>

为节点设置驱动程序

--bios-interface <bios_interface>

为节点设置 bios 接口

--reset-bios-interface

将 bios 接口重置为硬件类型默认值

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

为节点设置 raid 接口

--reset-raid-interface

将 raid 接口重置为硬件类型默认值

--rescue-interface <rescue_interface>

为节点设置救援接口

--reset-rescue-interface

将救援接口重置为硬件类型默认

--storage-interface <storage_interface>

为节点设置存储接口

--reset-storage-interface

将存储接口重置为硬件类型默认

--vendor-interface <vendor_interface>

为节点设置厂商接口

--reset-vendor-interface

将厂商接口重置为硬件类型默认

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

--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. 位置参数
概述

<node>

节点的名称或 uuid (如果指定了 --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 Formatter
概述

--noindent

是否禁用缩进 json

表 11.261. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 11.262. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

11.72. 裸机恢复节点特征列表

列出节点的特征。

使用方法:

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. 位置参数
概述

<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 Formatter
概述

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

当包含引号时,默认为 nonnumeric

表 11.267. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 11.268. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

11.73. 裸机节点取消部署

将裸机节点的置备状态设置为 已删除

使用方法:

openstack baremetal node undeploy [-h] [--wait [<time-out>]] <node>

表 11.269. 位置参数
概述

<node>

节点的名称或 uuid。

表 11.270. 可选参数
概述

-h, --help

显示帮助信息并退出

--wait [<time-out>]

等待节点到达所需状态 available。(可选)取超时值(以秒为单位)。默认值为 0,表示它将无限期等待。

11.74. 裸机节点不可用

将裸机节点的置备状态设置为 unrescue

使用方法:

openstack baremetal node unrescue [-h] [--wait [<time-out>]] <node>

表 11.271. 位置参数
概述

<node>

节点的名称或 uuid。

表 11.272. 可选参数
概述

-h, --help

显示帮助信息并退出

--wait [<time-out>]

等待节点到达所需状态 active。(可选)取超时值(以秒为单位)。默认值为 0,表示它将无限期等待。

11.75. 裸机恢复节点未设置

取消设置裸机属性

使用方法:

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. 位置参数
概述

<node>

节点的名称或 uuid。

表 11.274. 可选参数
概述

-h, --help

显示帮助信息并退出

--instance-uuid

在这个裸机节点上取消设置实例 uuid

--name

取消设置节点的名称

--resource-class

取消设置节点的资源类

--target-raid-config

取消设置节点的目标 raid 配置

--property <key>

在这个 baremetal 节点上取消设置的属性(重复选项以取消设置多个属性)

--extra <key>

此裸机节点上取消设置的额外选项(重复选项可取消设置多个额外)

--driver-info <key>

在这个 baremetal 节点上取消设置驱动程序信息(重复选项以取消设置多个驱动程序信息)

--instance-info <key>

在这个 baremetal 节点上取消设置的实例信息(重复选项以取消设置多个实例信息)

--chassis-uuid

这个裸机节点上的未设置 chassis uuid

--bios-interface

这个裸机节点上的未设置 bios 接口

--boot-interface

在此裸机节点上取消设置引导接口

--console-interface

这个裸机节点上的取消设置控制台接口

--deploy-interface

在此裸机节点上取消设置部署接口

--inspect-interface

这个裸机节点上的取消设置检查接口

--management-interface

这个裸机节点上的取消设置管理接口

--network-interface

在这个裸机节点上取消设置网络接口

--power-interface

在此裸机节点上取消设置电源接口

--raid-interface

在这个裸机节点上取消设置 raid 接口

--rescue-interface

在此裸机节点上取消设置救援接口

--storage-interface

这个裸机节点上取消设置存储接口

--vendor-interface

在这个裸机节点上取消设置厂商接口

--conductor-group

取消设置这个裸机节点的 conductor 组(将使用默认组)

--automated-clean

在这个裸机节点上取消设置自动清理选项(将使用配置中的值)

--protected

在节点上取消设置 protected 标记

--protected-reason

取消设置受保护的原因(当取消保护时自动取消设置)

--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. 位置参数
概述

<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 Formatter
概述

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

当包含引号时,默认为 nonnumeric

表 11.279. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 11.280. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

11.77. 裸机恢复节点 vif attach

将 VIF 附加到指定节点

使用方法:

openstack baremetal node vif attach [-h] [--vif-info <key=value>]
                                           <node> <vif-id>

表 11.281. 位置参数
概述

<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. 位置参数
概述

<node>

节点的名称或 uuid

<vif-id>

从节点分离的 vif 名称或 uuid。

表 11.284. 可选参数
概述

-h, --help

显示帮助信息并退出

11.79. 裸机节点 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. 位置参数
概述

<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 Formatter
概述

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

当包含引号时,默认为 nonnumeric

表 11.289. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 11.290. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--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. 位置参数
概述

<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。keys switch_idport_id 是必需的。如果是 Smart NIC 端口,则所需的键为 port_id 和主机名。参数可以多次指定。

-l <key=value>

已弃用。请使用 --local-link-connection 替代。描述本地链路连接信息的键/值元数据。有效密钥是 switch_infoswitch_idport_id。keys switch_idport_id 是必需的。可多次指定。

--pxe-enabled <boolean>

指明在 pxe 引导此节点时是否应使用此端口。

--port-group <uuid>

此端口所属端口的 UUID。

--physical-network <physical network>

此端口连接的物理网络的名称。

--is-smartnic

指明此端口是否为智能端口

表 11.293. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

表 11.294. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 11.295. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 11.296. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

11.81. 裸机端口删除

删除端口。

使用方法:

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

表 11.297. 位置参数
概述

<port>

要删除的端口的 UUID。

表 11.298. 可选参数
概述

-h, --help

显示帮助信息并退出

11.82. 裸机端口组创建

创建新的裸机端口组。

使用方法:

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>

与此端口组配置相关的 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 Formatter
概述

--noindent

是否禁用缩进 json

表 11.302. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 11.303. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

11.83. 裸机端口组删除

取消注册裸机端口组。

使用方法:

openstack baremetal port group delete [-h]
                                             <port group> [<port group> ...]

表 11.304. 位置参数
概述

<port group>

要删除的端口组(name 或 uuid)。

表 11.305. 可选参数
概述

-h, --help

显示帮助信息并退出

11.84. 裸机端口组列表

列出裸机端口组。

使用方法:

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 服务使用的最大值。

--marker <port group>

端口组 uuid (例如,来自先前请求列表中的最后一个端口组)。在此 UUID 后返回端口组列表。

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

根据指定的端口组字段和指示(如 或 desc)对输出进行排序(默认值: asc 或 dec)。可以用逗号分隔来指定多个字段和方向。

--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 Formatter
概述

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

当包含引号时,默认为 nonnumeric

表 11.309. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 11.310. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

11.85. 裸机端口组集

设置裸机端口组属性。

使用方法:

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. 位置参数
概述

<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. 位置参数
概述

<id>

端口组的 UUID 或名称(如果指定了 --address,则为 mac 地址)。

表 11.314. 可选参数
概述

-h, --help

显示帮助信息并退出

--address

<ID> 是端口组的 mac 地址(而不是 uuid 或 name)。

--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 Formatter
概述

--noindent

是否禁用缩进 json

表 11.317. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 11.318. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

11.87. baremetal port group unset

取消设置裸机端口组属性。

使用方法:

openstack baremetal port group unset [-h] [--name] [--address]
                                            [--extra <key>] [--property <key>]
                                            <port group>

表 11.319. 位置参数
概述

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

仅列出此节点的端口(名称或 uuid)。

--port-group <port group>

仅列出此端口组的端口(name 或 uuid)。

--limit <limit>

要为每个请求返回的最大端口数量,0 代表没有限制。默认为 Baremetal API 服务使用的最大值。

--marker <port>

端口 uuid (例如,来自上一请求列表中的最后端口)。在此 UUID 后返回端口列表。

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

根据指定的端口字段和指示(如 或 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 Formatter
概述

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

当包含引号时,默认为 nonnumeric

表 11.324. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 11.325. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

11.89. 裸机端口集

设置裸机端口属性。

使用方法:

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. 位置参数
概述

<port>

端口的 UUID

表 11.327. 可选参数
概述

-h, --help

显示帮助信息并退出

--node <uuid>

为此端口所属的节点设置 uuid

--address <address>

为这个端口设置 mac 地址

--extra <key=value>

在这个裸机端口上设置额外的额外的选项(重复选项来设置多个附加)

--port-group <uuid>

将此端口所属端口的 uuid 设置为 uuid。

--local-link-connection <key=value>

描述本地链路连接信息的键/值元数据。有效密钥是 switch_infoswitch_idport_idhostname。keys switch_idport_id 是必需的。如果是 Smart NIC 端口,则所需的键为 port_id 和主机名。参数可以多次指定。

--pxe-enabled

表示在 pxe 引导此节点时应使用此端口(默认)

--pxe-disabled

表示在 pxe 引导此节点时不应使用此端口

--physical-network <physical network>

设置此端口连接的物理网络名称。

--is-smartnic

将端口设置为 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. 位置参数
概述

<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 Formatter
概述

--noindent

是否禁用缩进 json

表 11.332. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 11.333. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

11.91. baremetal 端口未设置

取消设置裸机端口属性。

使用方法:

openstack baremetal port unset [-h] [--extra <key>] [--port-group]
                                      [--physical-network] [--is-smartnic]
                                      <port>

表 11.334. 位置参数
概述

<port>

端口的 UUID。

表 11.335. 可选参数
概述

-h, --help

显示帮助信息并退出

--extra <key>

此 baremetal 端口上取消设置的额外选项(重复选项可取消设置多个附加)

--port-group

从端口组中删除端口

--physical-network

取消此 baremetal 端口上的物理网络。

--is-smartnic

将端口设置为非智能端口

11.92. 裸机卷连接器创建

创建新的裸机卷连接器。

使用方法:

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,端口,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 Formatter
概述

--noindent

是否禁用缩进 json

表 11.339. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 11.340. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

11.93. 裸机卷连接器删除

取消注册裸机卷连接器。

使用方法:

openstack baremetal volume connector delete [-h]
                                                   <volume connector>
                                                   [<volume connector> ...]

表 11.341. 位置参数
概述

<volume connector>

要删除的卷连接器的 UUID。

表 11.342. 可选参数
概述

-h, --help

显示帮助信息并退出

11.94. 裸机卷连接器列表

列出裸机卷连接器。

使用方法:

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 服务使用的最大值。

--marker <volume connector>

卷连接器 uuid (例如,来自上一请求列表中的最后一个卷连接器)。在此 UUID 后返回卷连接器列表。

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

通过指定卷连接器字段和指示(asc 或 desc)对输出排序(default:asc)。可以用逗号分隔来指定多个字段和方向。

--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 Formatter
概述

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

当包含引号时,默认为 nonnumeric

表 11.346. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 11.347. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

11.95. 裸机卷连接器集

设置裸机卷连接器属性。

使用方法:

openstack baremetal volume connector set [-h] [--node <uuid>]
                                                [--type <type>]
                                                [--connector-id <connector id>]
                                                [--extra <key=value>]
                                                <volume connector>

表 11.348. 位置参数
概述

<volume connector>

卷连接器的 UUID。

表 11.349. 可选参数
概述

-h, --help

显示帮助信息并退出

--node <uuid>

此卷连接器所属的节点的 UUID。

--type <type>

卷连接器的类型。可以是 iqn,ip,mac,wwnn,wwpn,端口,portgroup.

--connector-id <connector id>

指定类型中的卷连接器 ID。

--extra <key=value>

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

11.96. 裸机卷连接器显示

显示裸机卷连接器详情。

使用方法:

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. 位置参数
概述

<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 Formatter
概述

--noindent

是否禁用缩进 json

表 11.354. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 11.355. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

11.97. 裸机卷连接器未设置

取消设置裸机卷连接器属性。

使用方法:

openstack baremetal volume connector unset [-h] [--extra <key>]
                                                  <volume connector>

表 11.356. 位置参数
概述

<volume connector>

卷连接器的 UUID。

表 11.357. 可选参数
概述

-h, --help

显示帮助信息并退出

--extra <key>

extra to unset (repeat option to unset multiple extras)

11.98. baremetal 卷目标创建

创建新的 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>

与这个卷目标类型相关的 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 Formatter
概述

--noindent

是否禁用缩进 json

表 11.361. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 11.362. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

11.99. baremetal 卷目标删除

取消注册裸机卷目标。

使用方法:

openstack baremetal volume target delete [-h]
                                                <volume target>
                                                [<volume target> ...]

表 11.363. 位置参数
概述

<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 服务使用的最大值。

--marker <volume target>

卷目标 uuid (例如,上一个请求列表中的列表中的最后一个卷目标)。在此 UUID 后返回卷目标列表。

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

根据指定卷目标字段和指示(asc 或 desc)对输出排序(default:asc)。可以用逗号分隔来指定多个字段和方向。

--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 Formatter
概述

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

当包含引号时,默认为 nonnumeric

表 11.368. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 11.369. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--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. 位置参数
概述

<volume target>

卷目标的 UUID。

表 11.371. 可选参数
概述

-h, --help

显示帮助信息并退出

--node <uuid>

此卷目标所属的节点的 UUID。

--type <volume type>

卷目标的类型,例如 iscsifibre_channel

--property <key=value>

与这个卷目标类型相关的 key/value 属性。可多次指定。

--boot-index <boot index>

卷目标引导索引。

--volume-id <volume id>

与此目标关联的卷的 ID。

--extra <key=value>

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

11.102. baremetal 卷目标显示

显示 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. 位置参数
概述

<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 Formatter
概述

--noindent

是否禁用缩进 json

表 11.376. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 11.377. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

11.103. baremetal 卷目标未设置

取消设置裸机卷目标属性。

使用方法:

openstack baremetal volume target unset [-h] [--extra <key>]
                                               [--property <key>]
                                               <volume target>

表 11.378. 位置参数
概述

<volume target>

卷目标的 UUID。

表 11.379. 可选参数
概述

-h, --help

显示帮助信息并退出

--extra <key>

extra to unset (repeat option to unset multiple extras)

--property <key>

在这个 baremetal 卷目标上取消设置的属性(重复选项以取消设置多个属性)。

第 12 章 BGP

本章论述了 bgp 命令下的命令。

12.1. BGP dragent add speaker

将 BGP speaker 添加到动态路由代理

使用方法:

openstack bgp dragent add speaker [-h] <agent-id> <bgp-speaker>

表 12.1. 位置参数
概述

<agent-id>

动态路由代理的 ID

<bgp-speaker>

bgp speaker 的 ID 或名称

表 12.2. 可选参数
概述

-h, --help

显示帮助信息并退出

12.2. BGP dragent remove speaker

从动态路由代理中删除 BGP speaker

使用方法:

openstack bgp dragent remove speaker [-h] <agent-id> <bgp-speaker>

表 12.3. 位置参数
概述

<agent-id>

动态路由代理的 ID

<bgp-speaker>

bgp speaker 的 ID 或名称

表 12.4. 可选参数
概述

-h, --help

显示帮助信息并退出

12.3. BGP peer create

创建 BGP peer

使用方法:

openstack bgp peer create [-h] [-f {json,shell,table,value,yaml}]
                                 [-c COLUMN] [--noindent] [--prefix PREFIX]
                                 [--max-width <integer>] [--fit-width]
                                 [--print-empty] --peer-ip <peer-ip-address>
                                 --remote-as <peer-remote-as>
                                 [--auth-type <peer-auth-type>]
                                 [--password <auth-password>]
                                 [--project <project>]
                                 [--project-domain <project-domain>]
                                 <name>

表 12.5. 位置参数
概述

<name>

要创建的 bgp peer 的名称

表 12.6. 可选参数
概述

-h, --help

显示帮助信息并退出

--peer-ip <peer-ip-address>

peer ip 地址

--remote-as <peer-remote-as>

对等号。(整数 [1, 65535] 被允许)

--auth-type <peer-auth-type>

身份验证算法。支持的算法: none (默认)、md5

--password <auth-password>

身份验证密码

--project <project>

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

--project-domain <project-domain>

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

表 12.7. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

表 12.8. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 12.9. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 12.10. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

12.4. BGP peer delete

删除 BGP peer

使用方法:

openstack bgp peer delete [-h] <bgp-peer>

表 12.11. 位置参数
概述

<bgp-peer>

BGP peer to delete (名称或 ID)

表 12.12. 可选参数
概述

-h, --help

显示帮助信息并退出

12.5. BGP peer list

列出 BGP 对等对象

使用方法:

openstack bgp peer 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]

表 12.13. 可选参数
概述

-h, --help

显示帮助信息并退出

表 12.14. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 12.15. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

表 12.16. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 12.17. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

12.6. BGP peer set

更新 BGP peer

使用方法:

openstack bgp peer set [-h] [--name NAME] [--password <auth-password>]
                              <bgp-peer>

表 12.18. 位置参数
概述

<bgp-peer>

BGP peer 以更新(名称或 ID)

表 12.19. 可选参数
概述

-h, --help

显示帮助信息并退出

--name NAME

更新了 bgp peer 的名称

--password <auth-password>

更新了身份验证密码

12.7. BGP peer 显示

显示 BGP peer (BGP peer)的信息

使用方法:

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

表 12.20. 位置参数
概述

<bgp-peer>

BGP peer to display (名称或 ID)

表 12.21. 可选参数
概述

-h, --help

显示帮助信息并退出

表 12.22. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

表 12.23. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 12.24. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 12.25. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

12.8. BGP speaker add 网络

将网络添加到 BGP speaker

使用方法:

openstack bgp speaker add network [-h] <bgp-speaker> <network>

表 12.26. 位置参数
概述

<bgp-speaker>

BGP 发言人(名称或 ID)

<network>

要添加的网络(名称或 id)

表 12.27. 可选参数
概述

-h, --help

显示帮助信息并退出

12.9. BGP speaker add peer

为 BGP 发言人添加对等点

使用方法:

openstack bgp speaker add peer [-h] <bgp-speaker> <bgp-peer>

表 12.28. 位置参数
概述

<bgp-speaker>

BGP 发言人(名称或 ID)

<bgp-peer>

BGP peer to add (名称或 ID)

表 12.29. 可选参数
概述

-h, --help

显示帮助信息并退出

12.10. BGP speaker create

创建 BGP 发言人

使用方法:

openstack bgp speaker create [-h] [-f {json,shell,table,value,yaml}]
                                    [-c COLUMN] [--noindent] [--prefix PREFIX]
                                    [--max-width <integer>] [--fit-width]
                                    [--print-empty] --local-as <local-as>
                                    [--ip-version {4,6}]
                                    [--advertise-floating-ip-host-routes]
                                    [--no-advertise-floating-ip-host-routes]
                                    [--advertise-tenant-networks]
                                    [--no-advertise-tenant-networks]
                                    [--project <project>]
                                    [--project-domain <project-domain>]
                                    <name>

表 12.30. 位置参数
概述

<name>

要创建的 bgp 发言人的名称

表 12.31. 可选参数
概述

-h, --help

显示帮助信息并退出

--local-as <local-as>

local 作为数字。(整数,在 [1, 65535] 中是允许的)

--ip-version {4,6}

bgp speaker 的 IP 版本(默认为 4)

--advertise-floating-ip-host-routes

通过 BGP speaker. (默认)启用浮动 ip 主机路由的公告。(默认)

--no-advertise-floating-ip-host-routes

禁用 BGP speaker 公告浮动 IP 主机路由。

--advertise-tenant-networks

启用 BGP speaker 的租户网络路由的公告(默认)

--no-advertise-tenant-networks

禁用 BGP 发言人的租户网络路由的公告。

--project <project>

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

--project-domain <project-domain>

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

表 12.32. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

表 12.33. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 12.34. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 12.35. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

12.11. BGP speaker delete

删除 BGP 发言人

使用方法:

openstack bgp speaker delete [-h] <bgp-speaker>

表 12.36. 位置参数
概述

<bgp-speaker>

BGP speaker to delete (名称或 ID)

表 12.37. 可选参数
概述

-h, --help

显示帮助信息并退出

12.12. BGP 发言人列表公告的路由

列出公告的路由

使用方法:

openstack bgp speaker list advertised routes [-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]
                                                    <bgp-speaker>

表 12.38. 位置参数
概述

<bgp-speaker>

BGP 发言人(名称或 ID)

表 12.39. 可选参数
概述

-h, --help

显示帮助信息并退出

表 12.40. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 12.41. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

表 12.42. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 12.43. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

12.13. BGP speaker list

列出 BGP 发言人

使用方法:

openstack bgp speaker 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 <agent-id>]

表 12.44. 可选参数
概述

-h, --help

显示帮助信息并退出

--agent <agent-id>

列出由代理托管的 bgp 发言人(仅限 ID)

表 12.45. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 12.46. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

表 12.47. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 12.48. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

12.14. BGP speaker 删除网络

从 BGP speaker 中删除网络

使用方法:

openstack bgp speaker remove network [-h] <bgp-speaker> <network>

表 12.49. 位置参数
概述

<bgp-speaker>

BGP 发言人(名称或 ID)

<network>

要删除的网络(名称或 id)

表 12.50. 可选参数
概述

-h, --help

显示帮助信息并退出

12.15. BGP speaker remove peer

从 BGP speaker 中删除对等点

使用方法:

openstack bgp speaker remove peer [-h] <bgp-speaker> <bgp-peer>

表 12.51. 位置参数
概述

<bgp-speaker>

BGP 发言人(名称或 ID)

<bgp-peer>

BGP peer to remove (名称或 ID)

表 12.52. 可选参数
概述

-h, --help

显示帮助信息并退出

12.16. BGP speaker set

设置 BGP 发言人属性

使用方法:

openstack bgp speaker set [-h] [--name NAME]
                                 [--advertise-floating-ip-host-routes]
                                 [--no-advertise-floating-ip-host-routes]
                                 [--advertise-tenant-networks]
                                 [--no-advertise-tenant-networks]
                                 <bgp-speaker>

表 12.53. 位置参数
概述

<bgp-speaker>

BGP speaker to update (名称或 ID)

表 12.54. 可选参数
概述

-h, --help

显示帮助信息并退出

--name NAME

要更新的 bgp 发言人的名称

--advertise-floating-ip-host-routes

通过 BGP speaker. (默认)启用浮动 ip 主机路由的公告。(默认)

--no-advertise-floating-ip-host-routes

禁用 BGP speaker 公告浮动 IP 主机路由。

--advertise-tenant-networks

启用 BGP speaker 的租户网络路由的公告(默认)

--no-advertise-tenant-networks

禁用 BGP 发言人的租户网络路由的公告。

12.17. BGP speaker show dragents

列出托管 BGP 发言人的动态路由代理

使用方法:

openstack bgp speaker show dragents [-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]
                                           <bgp-speaker>

表 12.55. 位置参数
概述

<bgp-speaker>

bgp speaker 的 ID 或名称

表 12.56. 可选参数
概述

-h, --help

显示帮助信息并退出

表 12.57. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 12.58. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

表 12.59. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 12.60. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

12.18. BGP speaker show

显示 BGP 发言人

使用方法:

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

表 12.61. 位置参数
概述

<bgp-speaker>

要显示的 BGP 发言人(名称或 ID)

表 12.62. 可选参数
概述

-h, --help

显示帮助信息并退出

表 12.63. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

表 12.64. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 12.65. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 12.66. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

第 13 章 bgpvpn

本章论述了 bgpvpn 命令下的命令。

13.1. bgpvpn create

创建 BGP VPN 资源

使用方法:

openstack bgpvpn 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>]
                               [--name <name>] [--route-target <route-target>]
                               [--import-target <import-target>]
                               [--export-target <export-target>]
                               [--route-distinguisher <route-distinguisher>]
                               [--vni VNI] [--local-pref LOCAL_PREF]
                               [--type {l2,l3}]

表 13.1. 可选参数
概述

-h, --help

显示帮助信息并退出

--project <project>

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

--project-domain <project-domain>

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

--name <name>

bgp vpn 的名称

--route-target <route-target>

添加路由目标以导入/导出列表(多个路由目标的重复选项)

--import-target <import-target>

添加路由目标以导入列表(多个路由目标的重复选项)

--export-target <export-target>

添加路由目标以导出列表(多个路由目标的重复选项)

--route-distinguisher <route-distinguisher>

Add route distinguisher to the route Distinguishers of the route Distinguishers from to advertise a VPN route (repeat option for multiple Route Distinguishers)

--vni VNI

使用 VXLAN 封装时要用于此 bgpvpn 的 VXLAN 网络标识符

--local-pref LOCAL_PREF

此 BGPVPN 的路由广告中要使用的默认 bgp local_pref。

--type {l2,l3}

BGP vpn 类型选择 ip vpn (l3)和以太网 VPN (l2) (默认:l3)

表 13.2. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

表 13.3. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 13.4. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 13.5. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

13.2. bgpvpn delete

删除 BGP VPN 资源

使用方法:

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

表 13.6. 位置参数
概述

<bgpvpn>

BGP vpn (s)以删除(名称或 ID)

表 13.7. 可选参数
概述

-h, --help

显示帮助信息并退出

13.3. bgpvpn list

列出 BGP VPN 资源

使用方法:

openstack bgpvpn 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>] [--long]
                             [--property <key=value>]

表 13.8. 可选参数
概述

-h, --help

显示帮助信息并退出

--project <project>

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

--project-domain <project-domain>

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

--long

列出输出中的其他字段

--property <key=value>

要应用到返回的 bgp vpns 的过滤器属性(重复用于过滤多个属性)

表 13.9. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 13.10. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

表 13.11. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 13.12. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

13.4. bgpvpn 网络关联创建

创建 BGP VPN 网络关联

使用方法:

openstack bgpvpn network association 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>]
                                                   <bgpvpn> <network>

表 13.13. 位置参数
概述

<bgpvpn>

BGP vpn 以应用网络关联(名称或 ID)

<network>

要关联 bgp vpn (name 或 id)的网络。

表 13.14. 可选参数
概述

-h, --help

显示帮助信息并退出

--project <project>

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

--project-domain <project-domain>

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

表 13.15. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

表 13.16. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 13.17. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 13.18. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

13.5. bgpvpn 网络关联删除

为给定的 BGP VPN 删除 BGP VPN 网络关联

使用方法:

openstack bgpvpn network association delete [-h]
                                                   <network association ID>
                                                   [<network association ID> ...]
                                                   <bgpvpn>

表 13.19. 位置参数
概述

<network 关联 ID>

要删除的网络关联 ID

<bgpvpn>

BGP vpn 网络关联属于 (名称或 ID)

表 13.20. 可选参数
概述

-h, --help

显示帮助信息并退出

13.6. bgpvpn 网络关联列表

列出给定 BGP VPN 的网络关联

使用方法:

openstack bgpvpn network association 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]
                                                 [--property <key=value>]
                                                 <bgpvpn>

表 13.21. 位置参数
概述

<bgpvpn>

BGP vpn 列出的关联属于 (名称或 ID)

表 13.22. 可选参数
概述

-h, --help

显示帮助信息并退出

--long

列出输出中的其他字段

--property <key=value>

要应用到返回的 bgp vpns 的过滤器属性(重复用于过滤多个属性)

表 13.23. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 13.24. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

表 13.25. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 13.26. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

13.7. bgpvpn 网络关联显示

显示给定 BGP VPN 网络关联信息

使用方法:

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

表 13.27. 位置参数
概述

<network 关联 ID>

要查找的网络关联 ID

<bgpvpn>

BGP vpn 关联属于(名称或 ID)

表 13.28. 可选参数
概述

-h, --help

显示帮助信息并退出

表 13.29. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

表 13.30. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 13.31. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 13.32. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

13.8. bgpvpn 端口关联创建

创建 BGP VPN 端口关联

使用方法:

openstack bgpvpn port association 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>]
                                                [--advertise-fixed-ips | --no-advertise-fixed-ips]
                                                [--prefix-route prefix=<cidr>[,local_pref=<integer>]]
                                                [--bgpvpn-route bgpvpn=<BGP VPN ID or name>[,local_pref=<integer>]]
                                                <bgpvpn> <port>

表 13.33. 位置参数
概述

<bgpvpn>

BGP vpn 以应用端口关联(名称或 ID)

<port>

要关联 bgp vpn (名称或 id)的端口

表 13.34. 可选参数
概述

-h, --help

显示帮助信息并退出

--project <project>

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

--project-domain <project-domain>

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

--advertise-fixed-ips

修复了端口的 ips 将公告为 bgp VPN (默认)

--no-advertise-fixed-ips

修复了端口的 ips 不会公告到 BGP VPN

--prefix-route prefix=<cidr>[,local_pref=<integer>]

在 cidr 表示法中添加前缀路由。(可选)可控制 BGP LOCAL_PREF 中要公告的路由的值(用于多个前缀路由的重复选项)

--bgpvpn-route bgpvpn=<BGP VPN ID or name>[,local_pref=<integer>]

为路由泄漏添加 bgp vpn 路由。可选(可选)控制 BGP LOCAL_PREF 中要公告的路由的值(多个 BGP VPN 路由的重复选项)

表 13.35. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

表 13.36. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 13.37. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 13.38. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

13.9. bgpvpn 端口关联删除

为给定的 BGP VPN 删除 BGP VPN 端口关联

使用方法:

openstack bgpvpn port association delete [-h]
                                                <port association ID>
                                                [<port association ID> ...]
                                                <bgpvpn>

表 13.39. 位置参数
概述

<port 关联 ID>

要删除的端口关联 ID

<bgpvpn>

BGP vpn 端口关联属于 (名称或 ID)

表 13.40. 可选参数
概述

-h, --help

显示帮助信息并退出

13.10. bgpvpn 端口关联列表

列出给定 BGP VPN 端口关联

使用方法:

openstack bgpvpn port association 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]
                                              [--property <key=value>]
                                              <bgpvpn>

表 13.41. 位置参数
概述

<bgpvpn>

BGP vpn 列出的关联属于 (名称或 ID)

表 13.42. 可选参数
概述

-h, --help

显示帮助信息并退出

--long

列出输出中的其他字段

--property <key=value>

要应用到返回的 bgp vpns 的过滤器属性(重复用于过滤多个属性)

表 13.43. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 13.44. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

表 13.45. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 13.46. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

13.11. bgpvpn 端口关联集

设置 BGP VPN 端口关联属性

使用方法:

openstack bgpvpn port association set [-h]
                                             [--advertise-fixed-ips | --no-advertise-fixed-ips]
                                             [--prefix-route prefix=<cidr>[,local_pref=<integer>]]
                                             [--bgpvpn-route bgpvpn=<BGP VPN ID or name>[,local_pref=<integer>]]
                                             [--no-prefix-route]
                                             [--no-bgpvpn-route]
                                             <port association ID> <bgpvpn>

表 13.47. 位置参数
概述

<port 关联 ID>

要更新的端口关联 ID

<bgpvpn>

BGP vpn 端口关联属于 (名称或 ID)

表 13.48. 可选参数
概述

-h, --help

显示帮助信息并退出

--advertise-fixed-ips

修复了端口的 ips 将公告给 bgp VPN

--no-advertise-fixed-ips

修复了端口的 ips 不会公告到 BGP VPN

--prefix-route prefix=<cidr>[,local_pref=<integer>]

在 cidr 表示法中添加前缀路由。(可选)可控制 BGP LOCAL_PREF 中要公告的路由的值(用于多个前缀路由的重复选项)

--bgpvpn-route bgpvpn=<BGP VPN ID or name>[,local_pref=<integer>]

为路由泄漏添加 bgp vpn 路由。可选(可选)控制 BGP LOCAL_PREF 中要公告的路由的值(多个 BGP VPN 路由的重复选项)

--no-prefix-route

空前缀路由列表

--no-bgpvpn-route

空 bgp vpn 路由列表

13.12. bgpvpn 端口关联显示

显示给定 BGP VPN 端口关联信息

使用方法:

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

表 13.49. 位置参数
概述

<port 关联 ID>

要查找的端口关联 id

<bgpvpn>

BGP vpn 关联属于(名称或 ID)

表 13.50. 可选参数
概述

-h, --help

显示帮助信息并退出

表 13.51. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

表 13.52. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 13.53. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 13.54. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

13.13. bgpvpn 端口关联未设置

取消设置 BGP VPN 端口关联属性

使用方法:

openstack bgpvpn port association unset [-h]
                                               [--advertise-fixed-ips | --no-advertise-fixed-ips]
                                               [--prefix-route <cidr>]
                                               [--bgpvpn-route <BGP VPN ID or name>]
                                               [--all-prefix-routes]
                                               [--all-bgpvpn-routes]
                                               <port association ID> <bgpvpn>

表 13.55. 位置参数
概述

<port 关联 ID>

要更新的端口关联 ID

<bgpvpn>

BGP vpn 端口关联属于 (名称或 ID)

表 13.56. 可选参数
概述

-h, --help

显示帮助信息并退出

--advertise-fixed-ips

修复了端口的 ips 不会公告到 BGP VPN

--no-advertise-fixed-ips

修复了端口的 ips 将公告给 bgp VPN

--prefix-route <cidr>

在 cidr 标记中移除前缀路由(用于多个前缀路由的peat 选项)

--bgpvpn-route <BGP VPN ID 或 name>

删除 bgp vpn route (多个 bgp VPN 路由的重复选项)

--all-prefix-routes

空前缀路由列表

--all-bgpvpn-routes

空 bgp vpn 路由列表

13.14. bgpvpn 路由器关联创建

创建 BGP VPN 路由器关联

使用方法:

openstack bgpvpn router association 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>]
                                                  [--advertise_extra_routes | --no-advertise_extra_routes]
                                                  <bgpvpn> <router>

表 13.57. 位置参数
概述

<bgpvpn>

BGP vpn 以应用路由器关联(名称或 ID)

<router>

要关联 bgp vpn (名称或 id)的路由器.

表 13.58. 可选参数
概述

-h, --help

显示帮助信息并退出

--project <project>

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

--project-domain <project-domain>

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

--advertise_extra_routes

路由将公告为 bgp vpn (默认)

--no-advertise_extra_routes

从路由器的路由不会公告到 BGP VPN

表 13.59. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

表 13.60. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 13.61. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 13.62. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

13.15. bgpvpn 路由器关联删除

删除给定 BGP VPN 的 BGP VPN 路由器关联

使用方法:

openstack bgpvpn router association delete [-h]
                                                  <router association ID>
                                                  [<router association ID> ...]
                                                  <bgpvpn>

表 13.63. 位置参数
概述

<router 关联 ID>

要删除的路由器关联 ID

<bgpvpn>

BGP vpn 路由器关联属于 (名称或 ID)

表 13.64. 可选参数
概述

-h, --help

显示帮助信息并退出

13.16. bgpvpn 路由器关联列表

列出给定 BGP VPN 路由器关联

使用方法:

openstack bgpvpn router association 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]
                                                [--property <key=value>]
                                                <bgpvpn>

表 13.65. 位置参数
概述

<bgpvpn>

BGP vpn 列出的关联属于 (名称或 ID)

表 13.66. 可选参数
概述

-h, --help

显示帮助信息并退出

--long

列出输出中的其他字段

--property <key=value>

要应用到返回的 bgp vpns 的过滤器属性(重复用于过滤多个属性)

表 13.67. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 13.68. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

表 13.69. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 13.70. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

13.17. bgpvpn 路由器关联集

设置 BGP VPN 路由器关联属性

使用方法:

openstack bgpvpn router association set [-h]
                                               [--advertise_extra_routes | --no-advertise_extra_routes]
                                               <router association ID>
                                               <bgpvpn>

表 13.71. 位置参数
概述

<router 关联 ID>

更新的路由器关联 ID

<bgpvpn>

BGP vpn 路由器关联属于 (名称或 ID)

表 13.72. 可选参数
概述

-h, --help

显示帮助信息并退出

--advertise_extra_routes

路由将公告给 bgp vpn

--no-advertise_extra_routes

从路由器的路由不会公告到 BGP VPN

13.18. bgpvpn 路由器关联显示

显示给定 BGP VPN 路由器关联信息

使用方法:

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

表 13.73. 位置参数
概述

<router 关联 ID>

要查找的路由器关联 id

<bgpvpn>

BGP vpn 关联属于(名称或 ID)

表 13.74. 可选参数
概述

-h, --help

显示帮助信息并退出

表 13.75. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

表 13.76. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 13.77. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 13.78. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

13.19. bgpvpn 路由器关联未设置

取消设置 BGP VPN 路由器关联属性

使用方法:

openstack bgpvpn router association unset [-h]
                                                 [--advertise_extra_routes | --no-advertise_extra_routes]
                                                 <router association ID>
                                                 <bgpvpn>

表 13.79. 位置参数
概述

<router 关联 ID>

更新的路由器关联 ID

<bgpvpn>

BGP vpn 路由器关联属于 (名称或 ID)

表 13.80. 可选参数
概述

-h, --help

显示帮助信息并退出

--advertise_extra_routes

从路由器的路由不会公告到 BGP VPN

--no-advertise_extra_routes

路由将公告给 bgp vpn

13.20. bgpvpn set

设置 BGP VPN 属性

使用方法:

openstack bgpvpn set [-h] [--name <name>]
                            [--route-target <route-target>]
                            [--no-route-target]
                            [--import-target <import-target>]
                            [--no-import-target]
                            [--export-target <export-target>]
                            [--no-export-target]
                            [--route-distinguisher <route-distinguisher>]
                            [--no-route-distinguisher] [--vni VNI]
                            [--local-pref LOCAL_PREF]
                            <bgpvpn>

表 13.81. 位置参数
概述

<bgpvpn>

BGP vpn 更新(名称或 ID)

表 13.82. 可选参数
概述

-h, --help

显示帮助信息并退出

--name <name>

bgp vpn 的名称

--route-target <route-target>

添加路由目标以导入/导出列表(多个路由目标的重复选项)

--no-route-target

空路由目标列表

--import-target <import-target>

添加路由目标以导入列表(多个路由目标的重复选项)

--no-import-target

空导入路由目标列表

--export-target <export-target>

添加路由目标以导出列表(多个路由目标的重复选项)

--no-export-target

空导出路由目标列表

--route-distinguisher <route-distinguisher>

Add route distinguisher to the route Distinguishers of the route Distinguishers from to advertise a VPN route (repeat option for multiple Route Distinguishers)

--no-route-distinguisher

空路由可识别器列表

--vni VNI

使用 VXLAN 封装时要用于此 bgpvpn 的 VXLAN 网络标识符

--local-pref LOCAL_PREF

此 BGPVPN 的路由广告中要使用的默认 bgp local_pref。

13.21. bgpvpn show

显示给定 BGP VPN 的信息

使用方法:

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

表 13.83. 位置参数
概述

<bgpvpn>

BGP vpn 以显示(名称或 ID)

表 13.84. 可选参数
概述

-h, --help

显示帮助信息并退出

表 13.85. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

表 13.86. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 13.87. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 13.88. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

13.22. bgpvpn unset

取消设置 BGP VPN 属性

使用方法:

openstack bgpvpn unset [-h] [--route-target <route-target>]
                              [--all-route-target]
                              [--import-target <import-target>]
                              [--all-import-target]
                              [--export-target <export-target>]
                              [--all-export-target]
                              [--route-distinguisher <route-distinguisher>]
                              [--all-route-distinguisher] [--vni VNI]
                              [--local-pref LOCAL_PREF]
                              <bgpvpn>

表 13.89. 位置参数
概述

<bgpvpn>

BGP vpn 更新(名称或 ID)

表 13.90. 可选参数
概述

-h, --help

显示帮助信息并退出

--route-target <route-target>

从导入/导出列表中删除路由目标(在多个 Route 目标的重复选项)

--all-route-target

空路由目标列表

--import-target <import-target>

从导入列表中删除路由目标(多个路由目标的重复选项)

--all-import-target

空导入路由目标列表

--export-target <export-target>

从导出列表中删除路由目标(多个路由目标的重复选项)

--all-export-target

空导出路由目标列表

--route-distinguisher <route-distinguisher>

remove route distinguisher from the route Distinguishers from the route Distinguishers from to advertise a VPN route (repeat option for multiple Route Distinguishers)

--all-route-distinguisher

空路由可识别器列表

--vni VNI

使用 VXLAN 封装时要用于此 bgpvpn 的 VXLAN 网络标识符

--local-pref LOCAL_PREF

此 BGPVPN 的路由广告中要使用的默认 bgp local_pref。

第 14 章 ca

本章论述了 ca 命令下的命令。

14.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

表 14.1. 位置参数
概述

URI

ca 的 uri 引用。

表 14.2. 可选参数
概述

-h, --help

显示帮助信息并退出

表 14.3. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

表 14.4. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 14.5. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 14.6. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

14.2. CA 列表

列出 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]

表 14.7. 可选参数
概述

-h, --help

显示帮助信息并退出

--limit LIMIT, -l LIMIT

指定每个页面列表的项目列表数量(默认为 10;最大:100)

--offset OFFSET,-o OFFSET

指定页面偏移(默认值 0)

--name NAME, -n NAME

指定 ca 名称(默认:none)

表 14.8. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 14.9. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

表 14.10. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 14.11. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

第 15 章 catalog

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

15.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]

表 15.1. 可选参数
概述

-h, --help

显示帮助信息并退出

表 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 Formatter
概述

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

当包含引号时,默认为 nonnumeric

表 15.4. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 15.5. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

15.2. 目录显示

显示服务目录详情

使用方法:

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

表 15.6. 位置参数
概述

<service>

要显示的服务(类型或名称)

表 15.7. 可选参数
概述

-h, --help

显示帮助信息并退出

表 15.8. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

表 15.9. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 15.10. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 15.11. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

第 16 章 Coe

本章论述了 coe 命令下的命令。

16.1. Coe ca 轮转

轮转集群的 CA 证书以撤销访问。

使用方法:

openstack coe ca rotate [-h] <cluster>

表 16.1. 位置参数
概述

<cluster>

集群的 ID 或名称

表 16.2. 可选参数
概述

-h, --help

显示帮助信息并退出

16.2. Coe ca show

显示集群的 CA 证书详情。

使用方法:

openstack coe ca show [-h] <cluster>

表 16.3. 位置参数
概述

<cluster>

集群的 ID 或名称

表 16.4. 可选参数
概述

-h, --help

显示帮助信息并退出

16.3. Coe ca sign

为集群生成 CA 证书。

使用方法:

openstack coe ca sign [-h] <cluster> <csr>

表 16.5. 位置参数
概述

<cluster>

集群的 ID 或名称

<csr>

发送到 magnum 的 csr 文件的路径来签名。

表 16.6. 可选参数
概述

-h, --help

显示帮助信息并退出

16.4. Coe 集群配置

获取集群的配置

使用方法:

openstack coe cluster config [-h] [--dir <dir>] [--force]
                                    [--output-certs] [--use-certificate]
                                    [--use-keystone]
                                    <cluster>

表 16.7. 位置参数
概述

<cluster>

要更新的集群的名称或 uuid

表 16.8. 可选参数
概述

-h, --help

显示帮助信息并退出

--dir <dir>

保存证书和配置文件的目录。

--force

如果不存在,则覆盖文件。

--output-certs

在单独的文件中输出证书。

--use-certificate

在配置文件中使用证书。

--use-keystone

在配置文件中使用 keystone 令牌。

16.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>

表 16.9. 位置参数
概述

<name>

要创建的集群的名称。

表 16.10. 可选参数
概述

-h, --help

显示帮助信息并退出

--cluster-template <cluster-template>

集群模板的 ID 或名称。

--discovery-url <discovery-url>

为节点发现指定自定义 delivery 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 create

16.6. Coe cluster delete

删除集群

使用方法:

openstack coe cluster delete [-h] <cluster> [<cluster> ...]

表 16.11. 位置参数
概述

<cluster>

要删除的集群的 ID 或名称。

表 16.12. 可选参数
概述

-h, --help

显示帮助信息并退出

16.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>]

表 16.13. 可选参数
概述

-h, --help

显示帮助信息并退出

--limit <limit>

要返回的最大集群数量

--sort-key <sort-key>

列以按以下方式排序结果

--sort-dir <sort-dir>

划分的方向。"asc"或"desc"。

表 16.14. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 16.15. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

表 16.16. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 16.17. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

16.8. Coe 集群重新定义大小

调整集群大小

使用方法:

openstack coe cluster resize [-h] [--nodes-to-remove <Server UUID>]
                                    [--nodegroup <nodegroup>]
                                    <cluster> node_count

表 16.18. 位置参数
概述

<cluster>

要更新的集群的名称或 uuid

node_count

cluser 所需的节点数。

表 16.19. 可选参数
概述

-h, --help

显示帮助信息并退出

--nodes-to-remove <Server UUID>

要移除的节点的服务器 ID。重复以添加更多服务器 ID

--nodegroup <nodegroup>

当前集群的节点组的名称或 uuid。

16.9. Coe cluster show

显示集群

使用方法:

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

表 16.20. 位置参数
概述

<cluster>

要显示的集群的 ID 或名称。

表 16.21. 可选参数
概述

-h, --help

显示帮助信息并退出

表 16.22. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

表 16.23. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 16.24. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 16.25. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

16.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>

表 16.26. 位置参数
概述

<name>

要创建的集群模板的名称。

表 16.27. 可选参数
概述

-h, --help

显示帮助信息并退出

--coe <coe>

指定要使用的容器编排引擎。

--image <image>

要为集群自定义的基础镜像的名称或 uuid。

--external-network <external-network>

要连接到此集群模板的外部 neutron 网络名称或 uuid。

--keypair <keypair>

要加载到集群节点的 ssh 密钥对的名称或 uuid。

--fixed-network <fixed-network>

要连接到此集群模型的专用 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 存储驱动程序。支持的:设备映射器、overlay。默认:设备映射器

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

--hidden

表示集群模板应该被隐藏。

--visible

表示集群模板应可见。

表 16.28. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

表 16.29. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 16.30. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 16.31. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

16.11. Coe 集群模板删除

删除集群模板。

使用方法:

openstack coe cluster template delete [-h]
                                             <cluster-templates>
                                             [<cluster-templates> ...]

表 16.32. 位置参数
概述

<cluster-templates>

要删除的(集群模板)的 ID 或名称。

表 16.33. 可选参数
概述

-h, --help

显示帮助信息并退出

16.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>]

表 16.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

表 16.35. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 16.36. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

表 16.37. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 16.38. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

16.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>

表 16.39. 位置参数
概述

<cluster-template>

要显示的集群模板的 ID 或名称。

表 16.40. 可选参数
概述

-h, --help

显示帮助信息并退出

表 16.41. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

表 16.42. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 16.43. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 16.44. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

16.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> ...]

表 16.45. 位置参数
概述

<cluster-template>

要更新的集群模板的名称或 uuid

<op>

操作:其中一项 添加替换或删除

<path=value>

添加/替换或删除的属性(在删除时只需要路径)

表 16.46. 可选参数
概述

-h, --help

显示帮助信息并退出

表 16.47. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

表 16.48. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 16.49. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 16.50. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

16.15. Coe 集群更新

更新集群

使用方法:

openstack coe cluster update [-h] [--rollback]
                                    <cluster> <op> <path=value>
                                    [<path=value> ...]

表 16.51. 位置参数
概述

<cluster>

要更新的集群的名称或 uuid

<op>

操作:其中一项 添加替换或删除

<path=value>

添加/替换或删除的属性(在删除时只需要路径)

表 16.52. 可选参数
概述

-h, --help

显示帮助信息并退出

--rollback

在更新失败时回滚集群。

16.16. Coe 集群升级

升级集群

使用方法:

openstack coe cluster upgrade [-h] [--max-batch-size <max_batch_size>]
                                     [--nodegroup <nodegroup>]
                                     <cluster> cluster_template

表 16.53. 位置参数
概述

<cluster>

要更新的集群的名称或 uuid

cluster_template

新的集群模板 id 将升级到。

表 16.54. 可选参数
概述

-h, --help

显示帮助信息并退出

--max-batch-size <max_batch_size>

每次升级的最大批处理大小。

--nodegroup <nodegroup>

当前集群的节点组的名称或 uuid。

16.17. Coe nodegroup create

创建节点组

使用方法:

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>

表 16.55. 位置参数
概述

<cluster>

要创建的节点组的名称。

<name>

要创建的节点组的名称。

表 16.56. 可选参数
概述

-h, --help

显示帮助信息并退出

--docker-volume-size <docker-volume-size>

要使用的 docker 卷的大小,以 gb 为单位。

--labels <KEY1=VALUE1,KEY2=VALUE2;KEY3=VALUE3…​>

要与节点组关联的 key=valuepairs 形式的任意标签。可以多次使用。

--node-count <node-count>

节点组节点数。

--min-nodes <min-nodes>

节点组最小节点数。

--max-nodes <max-nodes>

节点组最大节点数。

--role <role>

节点组的角色

--image <image>

为 NodeGroup 自定义的基础镜像的名称或 uuid。

--flavor <flavor>

启动此 NodeGroup 中的节点时要使用的 nova 类别名称或 uuid。

16.18. Coe nodegroup delete

删除节点组

使用方法:

openstack coe nodegroup delete [-h]
                                      <cluster> <nodegroup> [<nodegroup> ...]

表 16.57. 位置参数
概述

<cluster>

节点组所属集群的 ID 或名称。

<nodegroup>

要删除的节点组 ID 或名称。

表 16.58. 可选参数
概述

-h, --help

显示帮助信息并退出

16.19. Coe nodegroup 列表

列出节点组

使用方法:

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>

表 16.59. 位置参数
概述

<cluster>

节点组所属集群的 ID 或名称。

表 16.60. 可选参数
概述

-h, --help

显示帮助信息并退出

--limit <limit>

要返回的最大节点组数

--sort-key <sort-key>

列以按以下方式排序结果

--sort-dir <sort-dir>

划分的方向。"asc"或"desc"。

--role <role>

使用此角色列出集群中的节点组

表 16.61. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 16.62. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

表 16.63. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 16.64. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

16.20. Coe 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>

表 16.65. 位置参数
概述

<cluster>

节点组所属集群的 ID 或名称。

<nodegroup>

要显示的节点组 ID 或名称。

表 16.66. 可选参数
概述

-h, --help

显示帮助信息并退出

表 16.67. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

表 16.68. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 16.69. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 16.70. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

16.21. Coe nodegroup 更新

更新 Nodegroup

使用方法:

openstack coe nodegroup update [-h]
                                      <cluster> <nodegroup> <op> <path=value>
                                      [<path=value> ...]

表 16.71. 位置参数
概述

<cluster>

节点组所属集群的 ID 或名称。

<nodegroup>

要更新的集群的名称或 uuid

<op>

操作:其中一项 添加替换或删除

<path=value>

添加/替换或删除的属性(在删除时只需要路径)

表 16.72. 可选参数
概述

-h, --help

显示帮助信息并退出

16.22. Coe 配额创建

创建配额。

使用方法:

openstack coe quotas create [-h] --project-id <project-id> --resource
                                   <resource> [--hard-limit <hard-limit>]

表 16.73. 可选参数
概述

-h, --help

显示帮助信息并退出

--project-id <project-id>

项目 ID

--resource <resource>

资源名称。

--hard-limit <hard-limit>

max 资源限制(默认: hard-limit=1)

16.23. Coe 配额删除

删除指定的资源配额。

使用方法:

openstack coe quotas delete [-h] --project-id <project-id> --resource
                                   <resource>

表 16.74. 可选参数
概述

-h, --help

显示帮助信息并退出

--project-id <project-id>

项目 ID

--resource <resource>

资源名称。

16.24. Coe 配额列表

打印可用配额的列表。

使用方法:

openstack coe quotas list [-h] [--marker <marker>] [--limit <limit>]
                                 [--sort-key <sort-key>]
                                 [--sort-dir <sort-dir>] [--all-tenants]

表 16.75. 可选参数
概述

-h, --help

显示帮助信息并退出

--marker <marker>

上一页面的最后一个配额 uuid;在"标记"后显示配额列表。

--limit <limit>

要返回的最大配额数。

--sort-key <sort-key>

列以按.

--sort-dir <sort-dir>

划分的方向。"asc"或"desc"。

--all-tenants

用于表示列出所有租户配额的标记。

16.25. Coe 配额显示

显示给定项目配额的详细信息。

使用方法:

openstack coe quotas show [-h] --project-id <project-id> --resource
                                 <resource>

表 16.76. 可选参数
概述

-h, --help

显示帮助信息并退出

--project-id <project-id>

项目 ID

--resource <resource>

资源名称。

16.26. Coe 配额更新

更新所给项目配额的信息。

使用方法:

openstack coe quotas update [-h] --project-id <project-id> --resource
                                   <resource> [--hard-limit <hard-limit>]

表 16.77. 可选参数
概述

-h, --help

显示帮助信息并退出

--project-id <project-id>

项目 ID

--resource <resource>

资源名称。

--hard-limit <hard-limit>

max 资源限制(默认: hard-limit=1)

16.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]

表 16.78. 可选参数
概述

-h, --help

显示帮助信息并退出

表 16.79. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 16.80. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

表 16.81. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 16.82. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

16.28. Coe stats list

显示给定 project_id 的 stats

使用方法:

openstack coe stats list [-h] <project>

表 16.83. 位置参数
概述

<project>

项目 ID

表 16.84. 可选参数
概述

-h, --help

显示帮助信息并退出

第 17 章 命令

本章论述了命令 命令

17.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>]

表 17.1. 可选参数
概述

-h, --help

显示帮助信息并退出

--group <group-keyword>

显示命令组过滤的命令,例如:身份、卷、计算、镜像、网络和其他关键字

表 17.2. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 17.3. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

表 17.4. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 17.5. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

第 18 章 complete.adoc

本章论述了 complete.adoc 命令下的命令。

18.1. complete

打印 bash completion 命令

使用方法:

openstack complete [-h] [--name <command_name>] [--shell <shell>]

表 18.1. 可选参数
概述

-h, --help

显示帮助信息并退出

--name <command_name>

使用命令完成支持的命令名称

--shell <shell>

使用 shell。仅将 none 用于数据(默认:bash)

第 19 章 Compute

本章论述了 compute 命令下的命令。

19.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>

表 19.1. 位置参数
概述

<OS>

os 的类型

<architecture>

架构的类型

<version>

版本

<url>

URL

<md5hash>

Md5 hash

<hypervisor>

hypervisor 类型

表 19.2. 可选参数
概述

-h, --help

显示帮助信息并退出

表 19.3. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

表 19.4. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 19.5. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 19.6. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

19.2. 计算代理删除

删除计算代理

使用方法:

openstack compute agent delete [-h] <id> [<id> ...]

表 19.7. 位置参数
概述

<id>

要删除的代理 ID

表 19.8. 可选参数
概述

-h, --help

显示帮助信息并退出

19.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>]

表 19.9. 可选参数
概述

-h, --help

显示帮助信息并退出

--hypervisor <hypervisor>

hypervisor 类型

表 19.10. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 19.11. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

表 19.12. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 19.13. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

19.4. 计算代理集

设置计算代理属性

使用方法:

openstack compute agent set [-h] [--agent-version <version>]
                                   [--url <url>] [--md5hash <md5hash>]
                                   <id>

表 19.14. 位置参数
概述

<id>

代理 ID

表 19.15. 可选参数
概述

-h, --help

显示帮助信息并退出

--agent-version <version>

代理的版本

--url <url>

代理的 URL

--md5hash <md5hash>

代理的 Md5 哈希

19.5. 计算服务删除

删除计算服务

使用方法:

openstack compute service delete [-h] <service> [<service> ...]

表 19.16. 位置参数
概述

<service>

compute 服务可删除(仅id)。如果使用 ''---os-compute- api-version'' 2.53 或更高的版本,该 ID 是通过使用相同 2.53+ 微版本列出计算服务来检索的 UUID。

表 19.17. 可选参数
概述

-h, --help

显示帮助信息并退出

19.6. 计算服务列表

列出计算服务。使用 ''-os-compute-api-version' 2.53 或更高的版本返回 ID 作为 UUID 值,该值可用于在多cell 部署中唯一标识该服务。

使用方法:

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]

表 19.18. 可选参数
概述

-h, --help

显示帮助信息并退出

--host <host>

列出指定主机上的服务(仅限名称)

--service <service>

仅列出指定的服务二进制文件(仅命名)。例如 ''nova-compute'、'nova-conductor' 等。

--long

列出输出中的其他字段

表 19.19. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 19.20. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

表 19.21. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 19.22. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

19.7. 计算服务集

设置计算服务属性

使用方法:

openstack compute service set [-h] [--enable | --disable]
                                     [--disable-reason <reason>]
                                     [--up | --down]
                                     <host> <service>

表 19.23. 位置参数
概述

<host>

主机的名称

<service>

服务的名称(二进制名称),如 ''nova- compute'。

表 19.24. 可选参数
概述

-h, --help

显示帮助信息并退出

--enable

启用服务

--disable

禁用服务

--disable-reason <reason>

禁用服务的原因(在引号中)。应该与 --disable 选项一起使用。

--up

强制服务。需要 ''--os-compute-api- version' 2.11 或更高。

--down

强制服务。需要 ''--os-compute-api- version' 2.11 或更高。

第 20 章 配置

本章论述了 配置 命令下的命令。

20.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]

表 20.1. 可选参数
概述

-h, --help

显示帮助信息并退出

--mask

尝试屏蔽密码(默认)

--unmask

以明文显示密码

表 20.2. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

表 20.3. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 20.4. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 20.5. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

第 21 章 一致性

本章论述了 consistency 命令下的命令。

21.1. 致性组添加卷

添加卷以一致性组

使用方法:

openstack consistency group add volume [-h]
                                              <consistency-group> <volume>
                                              [<volume> ...]

表 21.1. 位置参数
概述

<consistency-group>

包含 <volume> (名称或 ID)的一致性组

<volume>

要添加到 <consistency-group> (名称或 id)的卷(重复选项来添加多个卷)

表 21.2. 可选参数
概述

-h, --help

显示帮助信息并退出

21.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>]

表 21.3. 位置参数
概述

<name>

新一致性组名称(默认为 none)

表 21.4. 可选参数
概述

-h, --help

显示帮助信息并退出

--volume-type <volume-type>

此一致性组的卷类型(name 或 id)

--consistency-group-source <consistency-group>

现有一致性组(名称或 id)

--consistency-group-snapshot <consistency-group-snapshot>

现有一致性组快照(名称或 id)

--description <description>

此一致性组的描述

--availability-zone <availability-zone>

此一致性组的可用性区域(如果从源创建一致性组时)

表 21.5. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

表 21.6. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 21.7. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 21.8. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

21.3. 致性组删除

删除一致性组。

使用方法:

openstack consistency group delete [-h] [--force]
                                          <consistency-group>
                                          [<consistency-group> ...]

表 21.9. 位置参数
概述

<consistency-group>

删除的一致性组(名称或 ID)

表 21.10. 可选参数
概述

-h, --help

显示帮助信息并退出

--force

允许以错误或可用状态以外的状态删除

21.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]

表 21.11. 可选参数
概述

-h, --help

显示帮助信息并退出

--all-projects

显示所有项目的详细信息。仅 admin。(默认为 False)

--long

列出输出中的其他字段

表 21.12. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 21.13. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

表 21.14. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 21.15. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

21.5. 致性组删除卷

从一致性组中删除卷

使用方法:

openstack consistency group remove volume [-h]
                                                 <consistency-group> <volume>
                                                 [<volume> ...]

表 21.16. 位置参数
概述

<consistency-group>

包含 <volume> (名称或 ID)的一致性组

<volume>

从 <consistency-group> (名称或 ID)中删除的卷(用于移除多个卷)

表 21.17. 可选参数
概述

-h, --help

显示帮助信息并退出

21.6. 致性组集

设置一致性组属性

使用方法:

openstack consistency group set [-h] [--name <name>]
                                       [--description <description>]
                                       <consistency-group>

表 21.18. 位置参数
概述

<consistency-group>

致性组进行修改(名称或 ID)

表 21.19. 可选参数
概述

-h, --help

显示帮助信息并退出

--name <name>

新的一致性组名称

--description <description>

新的一致性组描述

21.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>

表 21.20. 位置参数
概述

<consistency-group>

要显示的一致性组(名称或 id)

表 21.21. 可选参数
概述

-h, --help

显示帮助信息并退出

表 21.22. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

表 21.23. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 21.24. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 21.25. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

21.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>]

表 21.26. 位置参数
概述

<snapshot-name>

新一致性组快照的名称(默认为 None)

表 21.27. 可选参数
概述

-h, --help

显示帮助信息并退出

--consistency-group <consistency-group>

一致性到快照(名称或 id)的组(默认为与 <snapshot-name> 相同)

--description <description>

此一致性组快照的描述

表 21.28. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

表 21.29. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 21.30. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 21.31. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

21.9. 致组快照删除

删除一致性组快照。

使用方法:

openstack consistency group snapshot delete [-h]
                                                   <consistency-group-snapshot>
                                                   [<consistency-group-snapshot> ...]

表 21.32. 位置参数
概述

<consistency-group-snapshot>

删除的一致性组快照(名称或 ID)

表 21.33. 可选参数
概述

-h, --help

显示帮助信息并退出

21.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>]

表 21.34. 可选参数
概述

-h, --help

显示帮助信息并退出

--all-projects

显示所有项目(仅管理员)的详细信息(默认为 False)

--long

列出输出中的其他字段

--status <status>

按状态("可用"、"error"、"reating"、"deleting"或 "error_deleting" 来过滤结果。

--consistency-group <consistency-group>

按一致性组(名称或 ID)过滤结果

表 21.35. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 21.36. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

表 21.37. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 21.38. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

21.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>

表 21.39. 位置参数
概述

<consistency-group-snapshot>

以显示一致性组快照(名称或 ID)

表 21.40. 可选参数
概述

-h, --help

显示帮助信息并退出

表 21.41. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

表 21.42. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 21.43. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 21.44. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

第 22 章 控制台

本章论述了 console 命令下的命令。

22.1. 控制台日志显示

显示服务器的控制台输出

使用方法:

openstack console log show [-h] [--lines <num-lines>] <server>

表 22.1. 位置参数
概述

<server>

服务器以显示控制台日志(名称或 id)

表 22.2. 可选参数
概述

-h, --help

显示帮助信息并退出

--lines <num-lines>

日志末尾显示的行数(默认=all)

22.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>

表 22.3. 位置参数
概述

<server>

服务器显示 url (名称或 id)

表 22.4. 可选参数
概述

-h, --help

显示帮助信息并退出

--novnc

显示 novnc 控制台 url (默认)

--xvpvnc

显示 xvpvnc 控制台 url

--spice

显示 spice 控制台 url

--rdp

显示 rdp 控制台 url

--serial

显示串行控制台 url

--mks

显示 webmks 控制台 url

表 22.5. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

表 22.6. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 22.7. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 22.8. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

第 23 章 消费者

本章论述了 使用者 命令。

23.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>]

表 23.1. 可选参数
概述

-h, --help

显示帮助信息并退出

--description <description>

新的用户描述

表 23.2. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

表 23.3. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 23.4. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 23.5. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

23.2. 消费者删除

删除消费者

使用方法:

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

表 23.6. 位置参数
概述

<consumer>

要删除的消费者

表 23.7. 可选参数
概述

-h, --help

显示帮助信息并退出

23.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]

表 23.8. 可选参数
概述

-h, --help

显示帮助信息并退出

表 23.9. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 23.10. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

表 23.11. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 23.12. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

23.4. 消费者集

设置使用者属性

使用方法:

openstack consumer set [-h] [--description <description>] <consumer>

表 23.13. 位置参数
概述

<consumer>

修改的用户

表 23.14. 可选参数
概述

-h, --help

显示帮助信息并退出

--description <description>

新的用户描述

23.5. 消费者显示

显示使用者详情

使用方法:

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

表 23.15. 位置参数
概述

<consumer>

显示使用者

表 23.16. 可选参数
概述

-h, --help

显示帮助信息并退出

表 23.17. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

表 23.18. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 23.19. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 23.20. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

第 24 章 container

本章论述了容器命令下的命令。

24.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> ...]

表 24.1. 位置参数
概述

<container-name>

新容器名称

表 24.2. 可选参数
概述

-h, --help

显示帮助信息并退出

表 24.3. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 24.4. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

表 24.5. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 24.6. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

24.2. 容器删除

删除容器

使用方法:

openstack container delete [-h] [--recursive]
                                  <container> [<container> ...]

表 24.7. 位置参数
概述

<Container>

要删除的容器

表 24.8. 可选参数
概述

-h, --help

显示帮助信息并退出

--recursive, -r

递归删除对象和容器

24.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]

表 24.9. 可选参数
概述

-h, --help

显示帮助信息并退出

--prefix <prefix>

使用 <prefix> 过滤列表

--marker <marker>

用于分页的定位符

--end-marker <end-marker>

结束用于分页的定位符

--limit <num-containers>

限制返回的容器数量

--long

列出输出中的其他字段

--all

列出所有容器(默认为 10000)

表 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 Formatter
概述

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

当包含引号时,默认为 nonnumeric

表 24.12. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 24.13. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

24.4. 容器保存

本地保存容器内容

使用方法:

openstack container save [-h] <container>

表 24.14. 位置参数
概述

<Container>

要保存的容器

表 24.15. 可选参数
概述

-h, --help

显示帮助信息并退出

24.5. 容器集

设置容器属性

使用方法:

openstack container set [-h] --property <key=value> <container>

表 24.16. 位置参数
概述

<Container>

修改容器

表 24.17. 可选参数
概述

-h, --help

显示帮助信息并退出

--property <key=value>

在此容器上设置属性(重复选项以设置多个属性)

24.6. 容器显示

显示容器详情

使用方法:

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

表 24.18. 位置参数
概述

<Container>

显示的容器

表 24.19. 可选参数
概述

-h, --help

显示帮助信息并退出

表 24.20. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

表 24.21. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 24.22. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 24.23. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

24.7. Container unset

取消设置容器属性

使用方法:

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

表 24.24. 位置参数
概述

<Container>

修改容器

表 24.25. 可选参数
概述

-h, --help

显示帮助信息并退出

--property <key>

从容器中删除属性(重复选项以删除多个属性)

第 25 章 credential

本章论述了 凭证 命令下的命令。

25.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>

表 25.1. 位置参数
概述

<user>

拥有凭证的用户(名称或 id)

<data>

新凭证数据

表 25.2. 可选参数
概述

-h, --help

显示帮助信息并退出

--type <type>

新凭证类型:cert、ec2 和 totp,以此类推

--project <project>

限制凭证范围(名称或 ID)的项目

表 25.3. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

表 25.4. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 25.5. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 25.6. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

25.2. 凭证删除

删除凭证

使用方法:

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

表 25.7. 位置参数
概述

<credential-id>

要删除的凭证的 ID

表 25.8. 可选参数
概述

-h, --help

显示帮助信息并退出

25.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>]

表 25.9. 可选参数
概述

-h, --help

显示帮助信息并退出

--user <user>

通过 <user> (名称或 ID)过滤凭证

--user-domain <user-domain>

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

--type <type>

根据 type: cert、ec2 和 totp 过滤凭证

表 25.10. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 25.11. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

表 25.12. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 25.13. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

25.4. 凭证类型

设置凭证属性

使用方法:

openstack credential set [-h] --user <user> --type <type> --data <data>
                                [--project <project>]
                                <credential-id>

表 25.14. 位置参数
概述

<credential-id>

要更改的凭证 ID

表 25.15. 可选参数
概述

-h, --help

显示帮助信息并退出

--user <user>

拥有凭证的用户(名称或 id)

--type <type>

新凭证类型:cert、ec2 和 totp,以此类推

--data <data>

新凭证数据

--project <project>

限制凭证范围(名称或 ID)的项目

25.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>

表 25.16. 位置参数
概述

<credential-id>

要显示的凭证 ID

表 25.17. 可选参数
概述

-h, --help

显示帮助信息并退出

表 25.18. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

表 25.19. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 25.20. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 25.21. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

第 26 章 cron

本章论述了 cron 命令下的命令。

26.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]

表 26.1. 位置参数
概述

name

Cron trigger name

workflow_identifier

工作流名称或 id

workflow_input

工作流输入

表 26.2. 可选参数
概述

-h, --help

显示帮助信息并退出

--params PARAMS

工作流参数

--pattern <* * * * *>

cron 触发器模式

--first-time <YYYY-MM-DD HH:MM>

首次执行的日期和时间。除非也指定了 --utc,否则时间被视为本地时间

--count <integer>

想要执行的数量

--utc

指定的所有时间都应视为 utc

表 26.3. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

表 26.4. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 26.5. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 26.6. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

26.2. Cron trigger delete

删除触发器。

使用方法:

openstack cron trigger delete [-h] cron_trigger [cron_trigger ...]

表 26.7. 位置参数
概述

cron_trigger

cron trigger 的名称。

表 26.8. 可选参数
概述

-h, --help

显示帮助信息并退出

26.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]

表 26.9. 可选参数
概述

-h, --help

显示帮助信息并退出

--marker [MARKER]

以上页面的最后执行 uuid 显示在"标记"后执行列表。

--limit [LIMIT]

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

--sort_keys [SORT_KEYS]

按逗号分隔排列结果的排序键列表。默认: created_at。Example: mistral execution-list --sort_keys=id,description

--sort_dirs [SORT_DIRS]

以逗号分隔的排序指令列表。default: asc。Example: mistral execution-list --sort_keys=id,description --sort_dirs=asc,desc

--filter FILTERS

过滤器. 可以重复。

表 26.10. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 26.11. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

表 26.12. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 26.13. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

26.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

表 26.14. 位置参数
概述

cron_trigger

Cron trigger name

表 26.15. 可选参数
概述

-h, --help

显示帮助信息并退出

表 26.16. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

表 26.17. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 26.18. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 26.19. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

第 27 章 datastore

本章论述了 数据存储 命令中的命令。

27.1. 数据存储列表

列出可用的数据存储

使用方法:

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]

表 27.1. 可选参数
概述

-h, --help

显示帮助信息并退出

表 27.2. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 27.3. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

表 27.4. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 27.5. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

27.2. 数据存储显示

显示数据存储详情

使用方法:

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

表 27.6. 位置参数
概述

<datastore>

数据存储的 ID

表 27.7. 可选参数
概述

-h, --help

显示帮助信息并退出

表 27.8. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

表 27.9. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 27.10. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 27.11. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

27.3. Datastore 版本列表

列出数据存储的可用版本

使用方法:

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>

表 27.12. 位置参数
概述

<datastore>

数据存储的 ID 或名称

表 27.13. 可选参数
概述

-h, --help

显示帮助信息并退出

表 27.14. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 27.15. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

表 27.16. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 27.17. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

27.4. Datastore 版本显示

显示数据存储版本的详细信息。

使用方法:

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>

表 27.18. 位置参数
概述

<datastore_version>

数据存储版本的 ID 或名称。

表 27.19. 可选参数
概述

-h, --help

显示帮助信息并退出

--datastore <datastore>

数据存储的 ID 或名称。如果提供了 datastore_version 的 id,则可选。

表 27.20. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

表 27.21. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 27.22. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 27.23. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

第 28 章 dns

本章论述了 dns 命令下的命令。

28.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]

表 28.1. 可选参数
概述

-h, --help

显示帮助信息并退出

--all-projects

显示所有项目的结果。default: false

--edit-managed

编辑标记为 managed. default: false的资源

--sudo-project-id SUDO_PROJECT_ID

这个命令的模拟项目 ID。default: None

--project-id PROJECT_ID

项目 ID default:当前项目

表 28.2. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

表 28.3. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 28.4. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 28.5. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

28.2. DNS 配额重置

重置配额

使用方法:

openstack dns quota reset [-h] [--all-projects] [--edit-managed]
                                 [--sudo-project-id SUDO_PROJECT_ID]
                                 [--project-id PROJECT_ID]

表 28.6. 可选参数
概述

-h, --help

显示帮助信息并退出

--all-projects

显示所有项目的结果。default: false

--edit-managed

编辑标记为 managed. default: false的资源

--sudo-project-id SUDO_PROJECT_ID

这个命令的模拟项目 ID。default: None

--project-id PROJECT_ID

项目 ID

28.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>]

表 28.7. 可选参数
概述

-h, --help

显示帮助信息并退出

--all-projects

显示所有项目的结果。default: false

--edit-managed

编辑标记为 managed. default: false的资源

--sudo-project-id SUDO_PROJECT_ID

这个命令的模拟项目 ID。default: 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>

zone 配额的新值

表 28.8. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

表 28.9. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 28.10. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 28.11. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

28.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]

表 28.12. 可选参数
概述

-h, --help

显示帮助信息并退出

--hostname HOSTNAME

Hostname

--service_name SERVICE_NAME

服务名称

--status STATUS

状态

--all-projects

显示所有项目的结果。default: false

--edit-managed

编辑标记为 managed. default: false的资源

--sudo-project-id SUDO_PROJECT_ID

这个命令的模拟项目 ID。default: None

表 28.13. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 28.14. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

表 28.15. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 28.16. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

28.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

表 28.17. 位置参数
概述

id

服务状态 ID

表 28.18. 可选参数
概述

-h, --help

显示帮助信息并退出

--all-projects

显示所有项目的结果。default: false

--edit-managed

编辑标记为 managed. default: false的资源

--sudo-project-id SUDO_PROJECT_ID

这个命令的模拟项目 ID。default: None

表 28.19. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

表 28.20. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 28.21. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 28.22. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

第 29 章 domain

本章论述了 domain 命令下的命令。

29.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>

表 29.1. 位置参数
概述

<domain-name>

新域名

表 29.2. 可选参数
概述

-h, --help

显示帮助信息并退出

--description <description>

新域描述

--enable

启用域(默认)

--disable

禁用域

--or-show

返回现有域

表 29.3. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

表 29.4. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 29.5. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 29.6. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

29.2. 域删除

删除域

使用方法:

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

表 29.7. 位置参数
概述

<domain>

要删除的域(名称或 ID)

表 29.8. 可选参数
概述

-h, --help

显示帮助信息并退出

29.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]

表 29.9. 可选参数
概述

-h, --help

显示帮助信息并退出

表 29.10. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 29.11. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

表 29.12. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 29.13. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

29.4. 域设置

设置域属性

使用方法:

openstack domain set [-h] [--name <name>] [--description <description>]
                            [--enable | --disable]
                            <domain>

表 29.14. 位置参数
概述

<domain>

要修改的域(名称或 id)

表 29.15. 可选参数
概述

-h, --help

显示帮助信息并退出

--name <name>

新域名

--description <description>

新域描述

--enable

启用域

--disable

禁用域

29.5. 域显示

显示域详情

使用方法:

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

表 29.16. 位置参数
概述

<domain>

要显示的域(名称或 id)

表 29.17. 可选参数
概述

-h, --help

显示帮助信息并退出

表 29.18. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

表 29.19. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 29.20. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 29.21. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

第 30 章 ec2

本章论述了 ec2 命令下的命令。

30.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>]

表 30.1. 可选参数
概述

-h, --help

显示帮助信息并退出

--project <project>

在项目中创建凭证(名称或 id;默认:当前经过身份验证的用户项目)

--user <user>

为用户创建凭证(name 或 id;默认:当前经过身份验证的用户)

--user-domain <user-domain>

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

--project-domain <project-domain>

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

表 30.2. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

表 30.3. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 30.4. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 30.5. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

30.2. ec2 凭证删除

删除 EC2 凭证

使用方法:

openstack ec2 credentials delete [-h] [--user <user>]
                                        [--user-domain <user-domain>]
                                        <access-key> [<access-key> ...]

表 30.6. 位置参数
概述

<access-key>

凭证访问密钥

表 30.7. 可选参数
概述

-h, --help

显示帮助信息并退出

--user <user>

删除用户的凭证(名称或 id)

--user-domain <user-domain>

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

30.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>]

表 30.8. 可选参数
概述

-h, --help

显示帮助信息并退出

--user <user>

按用户(名称或 ID)过滤列表

--user-domain <user-domain>

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

表 30.9. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 30.10. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

表 30.11. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 30.12. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

30.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>

表 30.13. 位置参数
概述

<access-key>

凭证访问密钥

表 30.14. 可选参数
概述

-h, --help

显示帮助信息并退出

--user <user>

显示用户凭证(名称或 id)

--user-domain <user-domain>

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

表 30.15. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

表 30.16. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 30.17. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 30.18. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

第 31 章 端点

本章论述了 endpoint 命令下的命令。

31.1. 端点添加项目

将项目与端点关联

使用方法:

openstack endpoint add project [-h] [--project-domain <project-domain>]
                                      <endpoint> <project>

表 31.1. 位置参数
概述

<endpoint>

与指定项目关联的端点(名称或 ID)

<project>

与指定端点名称或 ID 关联的项目。

表 31.2. 可选参数
概述

-h, --help

显示帮助信息并退出

--project-domain <project-domain>

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

31.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>

表 31.3. 位置参数
概述

<service>

要与新端点关联的服务(名称或 ID)

<interface>

新端点接口类型(admin、public 或 internal)

<url>

新端点 url

表 31.4. 可选参数
概述

-h, --help

显示帮助信息并退出

--region <region-id>

新端点区域 ID

--enable

启用端点(默认)

--disable

禁用端点

表 31.5. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

表 31.6. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 31.7. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 31.8. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

31.3. 端点删除

删除端点

使用方法:

openstack endpoint delete [-h] <endpoint-id> [<endpoint-id> ...]

表 31.9. 位置参数
概述

<endpoint-id>

要删除的端点(仅限 ID)

表 31.10. 可选参数
概述

-h, --help

显示帮助信息并退出

31.4. 端点组添加项目

将项目添加到端点组

使用方法:

openstack endpoint group add project [-h]
                                            [--project-domain <project-domain>]
                                            <endpoint-group> <project>

表 31.11. 位置参数
概述

<endpoint-group>

端点组(名称或 id)

<project>

要关联的项目(名称或 id)

表 31.12. 可选参数
概述

-h, --help

显示帮助信息并退出

--project-domain <project-domain>

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

31.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>

表 31.13. 位置参数
概述

<name>

端点组名称

<filename>

包含一组新过滤器的 filename

表 31.14. 可选参数
概述

-h, --help

显示帮助信息并退出

--description DESCRIPTION

端点组的描述

表 31.15. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

表 31.16. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 31.17. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 31.18. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

31.6. 端点组删除

删除端点组

使用方法:

openstack endpoint group delete [-h]
                                       <endpoint-group> [<endpoint-group> ...]

表 31.19. 位置参数
概述

<endpoint-group>

要删除的端点组(名称或 ID)

表 31.20. 可选参数
概述

-h, --help

显示帮助信息并退出

31.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>]

表 31.21. 可选参数
概述

-h, --help

显示帮助信息并退出

--endpointgroup <endpoint-group>

端点组(名称或 id)

--project <project>

项目(名称或 ID)

--domain <domain>

拥有 <project> 的域(名称或 ID)

表 31.22. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 31.23. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

表 31.24. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 31.25. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

31.8. endpoint group remove project

从端点组中删除项目

使用方法:

openstack endpoint group remove project [-h]
                                               [--project-domain <project-domain>]
                                               <endpoint-group> <project>

表 31.26. 位置参数
概述

<endpoint-group>

端点组(名称或 id)

<project>

要删除的项目(名称或 id)

表 31.27. 可选参数
概述

-h, --help

显示帮助信息并退出

--project-domain <project-domain>

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

31.9. 端点组集

设置端点组属性

使用方法:

openstack endpoint group set [-h] [--name <name>]
                                    [--filters <filename>]
                                    [--description <description>]
                                    <endpoint-group>

表 31.28. 位置参数
概述

<endpoint-group>

要修改的端点组(名称或 id)

表 31.29. 可选参数
概述

-h, --help

显示帮助信息并退出

--name <name>

新的 enpoint 组名称

--filters <filename>

包含一组新过滤器的 filename

--description <description>

新端点组描述

31.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>

表 31.30. 位置参数
概述

<endpointgroup>

端点组(名称或 id)

表 31.31. 可选参数
概述

-h, --help

显示帮助信息并退出

表 31.32. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

表 31.33. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 31.34. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 31.35. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

31.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>]

表 31.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)。这可在项目名称之间有冲突时使用。

表 31.37. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 31.38. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

表 31.39. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 31.40. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

31.12. 端点移除项目

从端点分离项目

使用方法:

openstack endpoint remove project [-h]
                                         [--project-domain <project-domain>]
                                         <endpoint> <project>

表 31.41. 位置参数
概述

<endpoint>

与指定项目(名称或 ID)分离的端点

<project>

与指定的端点名称或 ID 分离的项目。

表 31.42. 可选参数
概述

-h, --help

显示帮助信息并退出

--project-domain <project-domain>

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

31.13. 端点集

设置端点属性

使用方法:

openstack endpoint set [-h] [--region <region-id>]
                              [--interface <interface>] [--url <url>]
                              [--service <service>] [--enable | --disable]
                              <endpoint-id>

表 31.43. 位置参数
概述

<endpoint-id>

要修改的端点(仅限 ID)

表 31.44. 可选参数
概述

-h, --help

显示帮助信息并退出

--region <region-id>

新端点区域 ID

--interface <interface>

新端点接口类型(admin、public 或 internal)

--url <url>

新端点 url

--service <service>

新端点服务(名称或 id)

--enable

启用端点

--disable

禁用端点

31.14. 端点显示

显示端点详情

使用方法:

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

表 31.45. 位置参数
概述

<endpoint>

要显示的端点(endpoint id、服务 id、服务名称、服务类型)

表 31.46. 可选参数
概述

-h, --help

显示帮助信息并退出

表 31.47. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

表 31.48. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 31.49. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 31.50. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

第 32 章 event

本章论述了 事件 命令下的命令。

32.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]

表 32.1. 位置参数
概述

name

事件触发器名称

workflow_id

工作流 ID

Exchange

事件触发器交换

topic

事件触发器主题

event

事件触发器事件名称

workflow_input

工作流输入

表 32.2. 可选参数
概述

-h, --help

显示帮助信息并退出

--params PARAMS

工作流参数

表 32.3. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

表 32.4. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 32.5. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 32.6. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

32.2. event trigger delete

删除触发器。

使用方法:

openstack event trigger delete [-h]
                                      event_trigger_id [event_trigger_id ...]

表 32.7. 位置参数
概述

event_trigger_id

事件触发器的 ID。

表 32.8. 可选参数
概述

-h, --help

显示帮助信息并退出

32.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]

表 32.9. 可选参数
概述

-h, --help

显示帮助信息并退出

--marker [MARKER]

以上页面的最后执行 uuid 显示在"标记"后执行列表。

--limit [LIMIT]

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

--sort_keys [SORT_KEYS]

按逗号分隔排列结果的排序键列表。默认: created_at。Example: mistral execution-list --sort_keys=id,description

--sort_dirs [SORT_DIRS]

以逗号分隔的排序指令列表。default: asc。Example: mistral execution-list --sort_keys=id,description --sort_dirs=asc,desc

--filter FILTERS

过滤器. 可以重复。

表 32.10. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 32.11. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

表 32.12. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 32.13. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

32.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

表 32.14. 位置参数
概述

event_trigger

事件触发器 ID

表 32.15. 可选参数
概述

-h, --help

显示帮助信息并退出

表 32.16. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

表 32.17. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 32.18. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 32.19. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

第 33 章 extension

本章论述了 扩展 命令下的命令。

33.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]

表 33.1. 可选参数
概述

-h, --help

显示帮助信息并退出

--compute

列出 compute api 的扩展

--identity

列出身份 api 的扩展

--network

列出网络 api 的扩展

--volume

列出块存储 api 的扩展

--long

列出输出中的其他字段

表 33.2. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 33.3. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

表 33.4. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 33.5. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

33.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>

表 33.6. 位置参数
概述

<bx id="1" />

可以扩展到当前显示,当前只支持网络扩展。(名称或别名)

表 33.7. 可选参数
概述

-h, --help

显示帮助信息并退出

表 33.8. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

表 33.9. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 33.10. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 33.11. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

第 34 章 联合

本章论述了 联合 命令下的命令。

34.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]

表 34.1. 可选参数
概述

-h, --help

显示帮助信息并退出

表 34.2. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 34.3. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

表 34.4. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 34.5. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

34.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]

表 34.6. 可选参数
概述

-h, --help

显示帮助信息并退出

表 34.7. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 34.8. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

表 34.9. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 34.10. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

34.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>

表 34.11. 位置参数
概述

<name>

新的联合协议名称(每个身份提供程序必须是唯一的)

表 34.12. 可选参数
概述

-h, --help

显示帮助信息并退出

--identity-provider <identity-provider>

支持新联合协议(名称或 ID)的身份供应商(必需)

--mapping <mapping>

要使用的映射(名称或 ID)(必需)

表 34.13. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

表 34.14. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 34.15. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 34.16. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

34.4. 联合协议删除

删除联合协议

使用方法:

openstack federation protocol delete [-h] --identity-provider
                                            <identity-provider>
                                            <federation-protocol>
                                            [<federation-protocol> ...]

表 34.17. 位置参数
概述

<federation-protocol>

要删除的联合协议(名称或 ID)

表 34.18. 可选参数
概述

-h, --help

显示帮助信息并退出

--identity-provider <identity-provider>

支持 <federation-protocol> 的身份供应商(名称或 ID)(必需)

34.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>

表 34.19. 可选参数
概述

-h, --help

显示帮助信息并退出

--identity-provider <identity-provider>

列出(名称或 id)的身份供应商(必需)

表 34.20. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 34.21. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

表 34.22. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 34.23. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

34.6. 联合协议集

设置联合协议属性

使用方法:

openstack federation protocol set [-h] --identity-provider
                                         <identity-provider>
                                         [--mapping <mapping>]
                                         <name>

表 34.24. 位置参数
概述

<name>

可修改的联合协议(名称或 ID)

表 34.25. 可选参数
概述

-h, --help

显示帮助信息并退出

--identity-provider <identity-provider>

支持 <federation-protocol> 的身份供应商(名称或 ID)(必需)

--mapping <mapping>

要使用的映射(名称或 id)

34.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>

表 34.26. 位置参数
概述

<federation-protocol>

显示的联合协议(名称或 ID)

表 34.27. 可选参数
概述

-h, --help

显示帮助信息并退出

--identity-provider <identity-provider>

支持 <federation-protocol> 的身份供应商(名称或 ID)(必需)

表 34.28. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

表 34.29. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 34.30. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 34.31. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

第 35 章 Flavor

本章论述了 flavor 命令下的命令。

35.1. Flavor create

创建新类别

使用方法:

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>

表 35.1. 位置参数
概述

<flavor-name>

新类别名称

表 35.2. 可选参数
概述

-h, --help

显示帮助信息并退出

--id <id>

唯一类别 ID;自动创建 uuid (默认值: auto

--ram <size-mb>

大小为 mb (默认 256m)

--disk <size-gb>

磁盘大小(默认为 0g)

--ephemeral <size-gb>

gb 中的临时磁盘大小(默认为 0g)

--swap <size-mb>

以 mb 为单位的额外交换空间大小(默认值为 0m)

--vcpus <vcpus>

vcpus 的数量(默认为 1)

--rxtx-factor <factor>

RX/tx 因子(默认 1.0)

--public

类别可用于其他项目(默认)

--private

flavor 不适用于其他项目

--property <key=value>

可添加此类别的属性(重复选项以设置多个属性)

--project <project>

允许 <project> 访问私有类别(名称或 ID)(Must with --private 选项)

--description <description>

类别描述。(由 api 版本 2.55 支持)- 2.latest

--project-domain <project-domain>

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

表 35.3. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

表 35.4. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 35.5. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 35.6. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

35.2. 类别删除

删除类别

使用方法:

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

表 35.7. 位置参数
概述

<flavor>

要删除的类别(名称或 ID)

表 35.8. 可选参数
概述

-h, --help

显示帮助信息并退出

35.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>]

表 35.9. 可选参数
概述

-h, --help

显示帮助信息并退出

--public

仅列出公共类别(默认)

--private

仅列出私有类别

--all

列出所有类别,无论是公共还是私有

--long

列出输出中的其他字段

--marker <flavor-id>

上一个页面的最后一个类别 ID

--limit <num-flavors>

可显示的最大类别数

表 35.10. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 35.11. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

表 35.12. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 35.13. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

35.4. 类别集

设置类别属性

使用方法:

openstack flavor set [-h] [--no-property] [--property <key=value>]
                            [--project <project>]
                            [--description <description>]
                            [--project-domain <project-domain>]
                            <flavor>

表 35.14. 位置参数
概述

<flavor>

修改(名称或 ID)的类别.

表 35.15. 可选参数
概述

-h, --help

显示帮助信息并退出

--no-property

从此类别中删除所有属性(指定 --no-property 和 --property),以在设置新属性前移除当前属性。)

--property <key=value>

用于为这个类别添加或修改的属性(重复选项以设置多个属性)

--project <project>

将类别访问权限设置为项目(名称或 ID)(仅限 admin)

--description <description>

设置类别的描述。(由 api 版本 2.55 支持)- 2.latest

--project-domain <project-domain>

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

35.5. 类别显示

显示类别详情

使用方法:

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

表 35.16. 位置参数
概述

<flavor>

显示的类别(名称或 ID)

表 35.17. 可选参数
概述

-h, --help

显示帮助信息并退出

表 35.18. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

表 35.19. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 35.20. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 35.21. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

35.6. 类别未设置

取消设置类别属性

使用方法:

openstack flavor unset [-h] [--property <key>] [--project <project>]
                              [--project-domain <project-domain>]
                              <flavor>

表 35.22. 位置参数
概述

<flavor>

修改(名称或 ID)的类别.

表 35.23. 可选参数
概述

-h, --help

显示帮助信息并退出

--property <key>

从类别中删除属性(重复选项以取消设置多个属性)

--project <project>

从项目(名称或 ID)中删除类别访问权限(仅限 admin)

--project-domain <project-domain>

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

第 36 章 floating

本章论述了 浮动 命令下的命令。

36.1. floating ip create

创建浮动 IP

使用方法:

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>

表 36.1. 位置参数
概述

<network>

从中分配浮动 ip 的网络(名称或 ID)

表 36.2. 可选参数
概述

-h, --help

显示帮助信息并退出

--subnet <subnet>

要创建浮动 IP (名称或 ID)的子网

--port <port>

要与浮动 IP 关联的端口(名称或 ID)

--floating-ip-address <ip-address>

浮动 IP 地址

--fixed-ip-address <ip-address>

修复了映射到浮动 IP 的 ip 地址

--qos-policy <qos-policy>

将 qos 策略附加到浮动 ip (名称或 id)

--description <description>

设置浮动 IP 描述

--project <project>

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

--dns-domain <dns-domain>

为此浮动 ip 设置 dns domain

--dns-name <dns-name>

为此浮动 ip 设置 dns 名称

--project-domain <project-domain>

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

--tag <tag>

要添加到浮动 ip (repeat 选项以设置多个标签的标签)

--no-tag

没有与浮动 ip 关联的标签

表 36.3. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

表 36.4. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 36.5. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 36.6. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

36.2. floating ip delete

删除浮动 IP

使用方法:

openstack floating ip delete [-h] <floating-ip> [<floating-ip> ...]

表 36.7. 位置参数
概述

<floating-ip>

要删除的浮动 ip (s) (IP 地址或 id)

表 36.8. 可选参数
概述

-h, --help

显示帮助信息并退出

36.3. floating ip list

列出浮动 IP

使用方法:

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>,...]]

表 36.9. 可选参数
概述

-h, --help

显示帮助信息并退出

--network <network>

根据给定网络(名称或 ID)列出浮动 ip (s)

--port <port>

根据给定端口(名称或 ID)列出浮动 ip (s)

--fixed-ip-address <ip-address>

根据给定的固定 IP 地址列出浮动 ip (s)

--floating-ip-address <ip-address>

根据给定的浮动 IP 地址列出浮动 ip (s)

--long

列出输出中的其他字段

--status <status>

根据给定状态列出浮动 ip (s) (ACTIVEDOWN)

--project <project>

根据给定项目(名称或 ID)列出浮动 ip (s)

--project-domain <project-domain>

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

--router <router>

根据给定路由器(名称或 ID)列出浮动 ip (s)

--tags <tag>[,<tag>,…​]

列出 floating ip,它具有所有给定标签(comma- separateds)列表。)

--any-tags <tag>[,<tag>,…​]

列出具有任何给定标签(comma- separated tags 列表)的 floating ip。

--not-tags <tag>[,<tag>,…​]

排除 floating ip,它具有所有给定标签(Comma 分隔标签列表)

--not-any-tags <tag>[,<tag>,…​]

排除有任何给定标签(Comma 分隔标签列表)的 floating ip。)

表 36.10. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 36.11. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

表 36.12. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 36.13. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

36.4. floating ip pool list

列出浮动 IP 地址池

使用方法:

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]

表 36.14. 可选参数
概述

-h, --help

显示帮助信息并退出

表 36.15. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 36.16. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

表 36.17. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 36.18. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

36.5. 浮动 IP 端口转发创建

创建浮动 IP 端口转发

使用方法:

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>

表 36.19. 位置参数
概述

<floating-ip>

端口转发属于的浮动 IP (IP 地址或 ID)

表 36.20. 可选参数
概述

-h, --help

显示帮助信息并退出

--internal-ip-address <internal-ip-address>

与浮动 IP 端口转发关联的网络端口的固定 ipv4 地址

--port <port>

与浮动 IP 端口转发关联的网络端口的名称或 id

--internal-protocol-port <port-number>

与浮动 IP 端口转发关联的网络端口固定 IPv4 地址的协议端口号

--external-protocol-port <port-number>

端口转发浮动 IP 地址的协议端口号

--protocol <protocol>

浮动 IP 端口转发中使用的协议,用于实例:TCP、UDP

表 36.21. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

表 36.22. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 36.23. shell Formatter
概述

--prefix PREFIX

表 36.24. 
概述

--max-width <integer>

--fit-width

--print-empty

36.6. 

使用方法:

openstack floating ip port forwarding delete [-h]
                                                    <floating-ip>
                                                    <port-forwarding-id>
                                                    [<port-forwarding-id> ...]

表 36.25. 
概述

<floating-ip>

<port-forwarding-id>

表 36.26. 
概述

-h, --help

显示帮助信息并退出

36.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>

表 36.27. 
概述

<floating-ip>

表 36.28. 
概述

-h, --help

显示帮助信息并退出

--port <port>

--external-protocol-port <port-number>

表 36.29. 
概述

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

-c COLUMN, --column COLUMN

--sort-column SORT_COLUMN

表 36.30. 
概述

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

表 36.31. 
概述

--noindent

表 36.32. 
概述

--max-width <integer>

--fit-width

--print-empty

36.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>

表 36.33. 
概述

<floating-ip>

<port-forwarding-id>

表 36.34. 
概述

-h, --help

显示帮助信息并退出

--port <port>

--internal-ip-address <internal-ip-address>

--internal-protocol-port <port-number>

--external-protocol-port <port-number>

--protocol <protocol>

36.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>

表 36.35. 
概述

<floating-ip>

<port-forwarding-id>

表 36.36. 
概述

-h, --help

显示帮助信息并退出

表 36.37. 
概述

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

-c COLUMN, --column COLUMN

表 36.38. 
概述

--noindent

表 36.39. 
概述

--prefix PREFIX

表 36.40. 
概述

--max-width <integer>

--fit-width

--print-empty

36.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>

表 36.41. 
概述

<floating-ip>

表 36.42. 
概述

-h, --help

显示帮助信息并退出

--port <port>

--fixed-ip-address <ip-address>

--qos-policy <qos-policy>

--no-qos-policy

--tag <tag>

--no-tag

36.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>

表 36.43. 
概述

<floating-ip>

表 36.44. 
概述

-h, --help

显示帮助信息并退出

表 36.45. 
概述

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

-c COLUMN, --column COLUMN

表 36.46. 
概述

--noindent

表 36.47. 
概述

--prefix PREFIX

表 36.48. 
概述

--max-width <integer>

--fit-width

--print-empty

36.12. 

使用方法:

openstack floating ip unset [-h] [--port] [--qos-policy]
                                   [--tag <tag> | --all-tag]
                                   <floating-ip>

表 36.49. 
概述

<floating-ip>

表 36.50. 
概述

-h, --help

显示帮助信息并退出

--port

--qos-policy

--tag <tag>

--all-tag

第 37 章 group

37.1. 

使用方法:

openstack group add user [-h] [--group-domain <group-domain>]
                                [--user-domain <user-domain>]
                                <group> <user> [<user> ...]

表 37.1. 
概述

<group>

<user>

表 37.2. 
概述

-h, --help

显示帮助信息并退出

--group-domain <group-domain>

--user-domain <user-domain>

37.2. 

使用方法:

openstack group contains user [-h] [--group-domain <group-domain>]
                                     [--user-domain <user-domain>]
                                     <group> <user>

表 37.3. 
概述

<group>

<user>

表 37.4. 
概述

-h, --help

显示帮助信息并退出

--group-domain <group-domain>

--user-domain <user-domain>

37.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>

表 37.5. 
概述

<group-name>

表 37.6. 
概述

-h, --help

显示帮助信息并退出

--domain <domain>

--description <description>

--or-show

表 37.7. 
概述

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

-c COLUMN, --column COLUMN

表 37.8. 
概述

--noindent

表 37.9. 
概述

--prefix PREFIX

表 37.10. 
概述

--max-width <integer>

--fit-width

--print-empty

37.4. 

使用方法:

openstack group delete [-h] [--domain <domain>] <group> [<group> ...]

表 37.11. 
概述

<group>

表 37.12. 
概述

-h, --help

显示帮助信息并退出

--domain <domain>

37.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]

表 37.13. 
概述

-h, --help

显示帮助信息并退出

--domain <domain>

--user <user>

--user-domain <user-domain>

--long

表 37.14. 
概述

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

-c COLUMN, --column COLUMN

--sort-column SORT_COLUMN

表 37.15. 
概述

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

表 37.16. 
概述

--noindent

表 37.17. 
概述

--max-width <integer>

--fit-width

--print-empty

37.6. 

使用方法:

openstack group remove user [-h] [--group-domain <group-domain>]
                                   [--user-domain <user-domain>]
                                   <group> <user> [<user> ...]

表 37.18. 
概述

<group>

<user>

表 37.19. 
概述

-h, --help

显示帮助信息并退出

--group-domain <group-domain>

--user-domain <user-domain>

37.7. 

使用方法:

openstack group set [-h] [--domain <domain>] [--name <name>]
                           [--description <description>]
                           <group>

表 37.20. 
概述

<group>

表 37.21. 
概述

-h, --help

显示帮助信息并退出

--domain <domain>

--name <name>

--description <description>

37.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>

表 37.22. 
概述

<group>

表 37.23. 
概述

-h, --help

显示帮助信息并退出

--domain <domain>

表 37.24. 
概述

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

-c COLUMN, --column COLUMN

表 37.25. 
概述

--noindent

表 37.26. 
概述

--prefix PREFIX

表 37.27. 
概述

--max-width <integer>

--fit-width

--print-empty

第 38 章 help.adoc

38.1. 帮助

使用方法:

openstack help [-h] [cmd [cmd ...]]

表 38.1. 
概述

cmd

表 38.2. 
概述

-h, --help

显示帮助信息并退出

第 39 章 主机

39.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>]

表 39.1. 
概述

-h, --help

显示帮助信息并退出

--zone <zone>

表 39.2. 
概述

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

-c COLUMN, --column COLUMN

--sort-column SORT_COLUMN

表 39.3. 
概述

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

表 39.4. 
概述

--noindent

是否禁用缩进 json

表 39.5. 表格式
概述

--max-width <integer>

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

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

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

39.2. 主机集合

设置主机属性

使用方法:

openstack host set [-h] [--enable | --disable]
                          [--enable-maintenance | --disable-maintenance]
                          <host>

表 39.6. 位置参数
概述

<host>

要修改的主机(仅限名称)

表 39.7. 可选参数
概述

-h, --help

显示帮助信息并退出

--enable

启用主机

--disable

禁用主机

--enable-maintenance

为主机启用维护模式

--disable-maintenance

禁用主机的维护模式

39.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>

表 39.8. 位置参数
概述

<host>

主机的名称

表 39.9. 可选参数
概述

-h, --help

显示帮助信息并退出

表 39.10. 输出格式器
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 39.11. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

表 39.12. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 39.13. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

第 40 章 hypervisor

本章论述了 虚拟机监控程序 命令下的命令。

40.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]

表 40.1. 可选参数
概述

-h, --help

显示帮助信息并退出

--matching <hostname>

使用 <hostname> substring 过滤虚拟机监控程序

--long

列出输出中的其他字段

表 40.2. 输出格式器
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 40.3. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

表 40.4. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 40.5. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

40.2. 管理程序显示

显示虚拟机监控程序详情

使用方法:

openstack hypervisor show [-h] [-f {json,shell,table,value,yaml}]
                                 [-c COLUMN] [--noindent] [--prefix PREFIX]
                                 [--max-width <integer>] [--fit-width]
                                 [--print-empty]
                                 <hypervisor>

表 40.6. 位置参数
概述

<hypervisor>

要显示的虚拟机监控程序(名称或 id)

表 40.7. 可选参数
概述

-h, --help

显示帮助信息并退出

表 40.8. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 40.9. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 40.10. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 40.11. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

40.3. 管理程序统计显示

显示虚拟机监控程序统计详情

使用方法:

openstack hypervisor stats show [-h] [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--noindent]
                                       [--prefix PREFIX]
                                       [--max-width <integer>] [--fit-width]
                                       [--print-empty]

表 40.12. 可选参数
概述

-h, --help

显示帮助信息并退出

表 40.13. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 40.14. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 40.15. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 40.16. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

第 41 章 身份

本章论述了 identity 命令下的命令。

41.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>

表 41.1. 位置参数
概述

<name>

新身份提供程序名称(必须是唯一的)

表 41.2. 可选参数
概述

-h, --help

显示帮助信息并退出

--remote-id <remote-id>

与身份提供程序关联的远程 ID (重复选项以提供多个值)

--remote-id-file <file-name>

包含与身份提供程序关联的多个远程 ID 的文件名称,每行一个

--description <description>

新身份提供程序描述

--domain <domain>

与身份提供程序关联的域。如果没有指定,则会自动创建域。(名称或 ID)

--enable

启用身份提供程序(默认)

--disable

禁用身份提供程序

表 41.3. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 41.4. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 41.5. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 41.6. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

41.2. 身份供应商删除

删除身份提供程序

使用方法:

openstack identity provider delete [-h]
                                          <identity-provider>
                                          [<identity-provider> ...]

表 41.7. 位置参数
概述

<identity-provider>

要删除的身份提供程序

表 41.8. 可选参数
概述

-h, --help

显示帮助信息并退出

41.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]

表 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 Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

表 41.12. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 41.13. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

41.4. 身份提供程序集

设置身份提供程序属性

使用方法:

openstack identity provider set [-h] [--description <description>]
                                       [--remote-id <remote-id> | --remote-id-file <file-name>]
                                       [--enable | --disable]
                                       <identity-provider>

表 41.14. 位置参数
概述

<identity-provider>

要修改的身份提供程序

表 41.15. 可选参数
概述

-h, --help

显示帮助信息并退出

--description <description>

设置身份提供程序描述

--remote-id <remote-id>

与身份提供程序关联的远程 ID (重复选项以提供多个值)

--remote-id-file <file-name>

包含与身份提供程序关联的多个远程 ID 的文件名称,每行一个

--enable

启用身份提供程序

--disable

禁用身份提供程序

41.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>

表 41.16. 位置参数
概述

<identity-provider>

显示的身份提供程序

表 41.17. 可选参数
概述

-h, --help

显示帮助信息并退出

表 41.18. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 41.19. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 41.20. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 41.21. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

第 42 章 镜像

本章论述了 image 命令下的命令。

42.1. 镜像添加项目

将项目与镜像关联

使用方法:

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>

表 42.1. 位置参数
概述

<image>

要共享的镜像(名称或 id)

<project>

与镜像关联的项目(id)

表 42.2. 可选参数
概述

-h, --help

显示帮助信息并退出

--project-domain <project-domain>

项目所属的域(名称或 id)。这可在项目名称之间有冲突时使用。

表 42.3. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 42.4. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 42.5. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 42.6. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

42.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>

表 42.7. 位置参数
概述

<image-name>

新镜像名称

表 42.8. 可选参数
概述

-h, --help

显示帮助信息并退出

--id <id>

要保留的镜像 ID

--container-format <container-format>

镜像容器格式。支持的选项有: ami、ari、aki、bare、docker、ova、ovf。默认格式为: bare

--disk-format <disk-format>

镜像磁盘格式。支持的选项有: ami、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)。这可在项目名称之间有冲突时使用。

表 42.9. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 42.10. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 42.11. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 42.12. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

42.3. image delete

删除镜像

使用方法:

openstack image delete [-h] <image> [<image> ...]

表 42.13. 位置参数
概述

<image>

要删除的镜像(名称或 ID)

表 42.14. 可选参数
概述

-h, --help

显示帮助信息并退出

42.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>]

表 42.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>]

通过所选键和方向(默认:name: name:asc),可以使用逗号分隔的多个键和方向对输出进行排序

--limit <num-images>

要显示的最大镜像数。

--marker <image>

上一页面的最后一个镜像。在标记后显示镜像列表。如果没有指定,则显示所有镜像。(名称或 ID)

表 42.16. 输出格式器
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 42.17. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

表 42.18. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 42.19. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

42.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>

表 42.20. 位置参数
概述

<image>

镜像(名称或 id)

表 42.21. 可选参数
概述

-h, --help

显示帮助信息并退出

--project-domain <project-domain>

项目所属的域(名称或 id)。这可在项目名称之间有冲突时使用。

表 42.22. 输出格式器
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 42.23. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

表 42.24. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 42.25. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

42.6. 镜像移除项目

使用镜像解除关联项目

使用方法:

openstack image remove project [-h] [--project-domain <project-domain>]
                                      <image> <project>

表 42.26. 位置参数
概述

<image>

镜像到未共享(名称或 id)

<project>

要与镜像解除的项目(名称或 id)

表 42.27. 可选参数
概述

-h, --help

显示帮助信息并退出

--project-domain <project-domain>

项目所属的域(名称或 id)。这可在项目名称之间有冲突时使用。

42.7. 镜像保存

本地保存镜像

使用方法:

openstack image save [-h] [--file <filename>] <image>

表 42.28. 位置参数
概述

<image>

要保存的镜像(名称或 id)

表 42.29. 可选参数
概述

-h, --help

显示帮助信息并退出

--file <filename>

下载的镜像保存文件名(默认:stdout)

42.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>

表 42.30. 位置参数
概述

<image>

要修改的镜像(名称或 id)

表 42.31. 可选参数
概述

-h, --help

显示帮助信息并退出

--name <name>

新镜像名称

--min-disk <disk-gb>

引导镜像所需的最小磁盘大小,以 GB 为单位

--min-ram <ram-mb>

引导镜像所需的最小 RAM 大小(以 MB 为单位)

--container-format <container-format>

镜像容器格式。支持的选项有: ami、ari、aki、bare、docker、ova、ovf

--disk-format <disk-format>

镜像磁盘格式。支持的选项有: ami、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

将镜像成员资格重置为 待处理

42.9. image show

显示镜像详情

使用方法:

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>

表 42.32. 位置参数
概述

<image>

要显示的镜像(名称或 id)

表 42.33. 可选参数
概述

-h, --help

显示帮助信息并退出

--human-readable

以人类友好格式显示镜像大小。

表 42.34. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 42.35. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 42.36. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 42.37. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

42.10. 镜像取消设置

取消设置镜像标签和属性

使用方法:

openstack image unset [-h] [--tag <tag>] [--property <property-key>]
                             <image>

表 42.38. 位置参数
概述

<image>

要修改的镜像(名称或 id)

表 42.39. 可选参数
概述

-h, --help

显示帮助信息并退出

--tag <tag>

取消在此镜像上取消设置标签(重复选项以取消设置多个标签)

--property <property-key>

取消设置此镜像上的属性(重复选项以取消设置多个属性)

第 43 章 含义

本章论述了简化命令下 的命令

43.1. 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>

表 43.1. 位置参数
概述

<role>

代表了另一个角色的角色(名称或 id)

表 43.2. 可选参数
概述

-h, --help

显示帮助信息并退出

--implied-role <role>

<role> (名称或 id)被另一个角色表示

表 43.3. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 43.4. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 43.5. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 43.6. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

43.2. implied role delete

删除之前和简化角色之间的关联

使用方法:

openstack implied role delete [-h] --implied-role <role> <role>

表 43.7. 位置参数
概述

<role>

代表了另一个角色的角色(名称或 id)

表 43.8. 可选参数
概述

-h, --help

显示帮助信息并退出

--implied-role <role>

<role> (名称或 id)被另一个角色表示

43.3. implied 角色列表

列出简化的角色

使用方法:

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]

表 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 Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

表 43.12. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 43.13. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

第 44 章 ip

本章论述了 ip 命令下的命令。

44.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>]

表 44.1. 可选参数
概述

-h, --help

显示帮助信息并退出

--ip-version <ip-version>

列出给定 ip version 网络的 ip availability (默认为 4)

--project <project>

列出给定项目的 ip availability (名称或 ID)

--project-domain <project-domain>

项目所属的域(名称或 id)。这可在项目名称之间有冲突时使用。

表 44.2. 输出格式器
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 44.3. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

表 44.4. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 44.5. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

44.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>

表 44.6. 位置参数
概述

<network>

显示特定网络的 ip 可用性(名称或 ID)

表 44.7. 可选参数
概述

-h, --help

显示帮助信息并退出

表 44.8. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 44.9. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 44.10. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 44.11. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

第 45 章 密钥对

本章论述了 keypair 命令下的命令。

45.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>

表 45.1. 位置参数
概述

<name>

新公钥或私钥名称

表 45.2. 可选参数
概述

-h, --help

显示帮助信息并退出

--public-key <file>

要添加的公钥的文件名。如果没有使用,请创建一个私钥。

--private-key <file>

要保存的私钥的文件名。如果没有使用,请在控制台中打印私钥。

表 45.3. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 45.4. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 45.5. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 45.6. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

45.2. 密钥对删除

删除公钥或私钥.

使用方法:

openstack keypair delete [-h] <key> [<key> ...]

表 45.7. 位置参数
概述

<key>

要删除的密钥名称(仅限名称)

表 45.8. 可选参数
概述

-h, --help

显示帮助信息并退出

45.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]

表 45.9. 可选参数
概述

-h, --help

显示帮助信息并退出

表 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 Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

表 45.12. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 45.13. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

45.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>

表 45.14. 位置参数
概述

<key>

要显示的公钥或私钥(仅限名称)

表 45.15. 可选参数
概述

-h, --help

显示帮助信息并退出

--public-key

仅显示使用生成的密钥对裸机公钥

表 45.16. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 45.17. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 45.18. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 45.19. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

第 46 章 l2gw

本章论述了 l2gw 命令下的命令。

46.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>

表 46.1. 位置参数
概述

<GATEWAY-NAME/UUID>

逻辑网关的描述性名称。

<NETWORK-NAME/UUID>

网络名称或 uuid。

表 46.2. 可选参数
概述

-h, --help

显示帮助信息并退出

--default-segmentation-id SEG_ID

将应用于在 l2-gateway-create 命令中没有指定分段 ID 的接口的默认 segmentation-id。

表 46.3. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 46.4. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 46.5. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 46.6. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

46.2. l2gw 连接删除

删除给定的 l2gateway-connection

使用方法:

openstack l2gw connection delete [-h]
                                        <L2_GATEWAY_CONNECTIONS>
                                        [<L2_GATEWAY_CONNECTIONS> ...]

表 46.7. 位置参数
概述

<L2_GATEWAY_CONNECTIONS>

要删除的 l2_gateway_connections (s)的 ID。

表 46.8. 可选参数
概述

-h, --help

显示帮助信息并退出

46.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>]

表 46.9. 可选参数
概述

-h, --help

显示帮助信息并退出

--project <project>

所有者的项目(名称或 id)

--project-domain <project-domain>

项目所属的域(名称或 id)。这可在项目名称之间有冲突时使用。

表 46.10. 输出格式器
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 46.11. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

表 46.12. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 46.13. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

46.4. l2gw 连接显示

显示给定 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>

表 46.14. 位置参数
概述

<L2_GATEWAY_CONNECTION>

要查找的 l2_gateway_connection 的 ID。

表 46.15. 可选参数
概述

-h, --help

显示帮助信息并退出

表 46.16. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 46.17. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 46.18. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 46.19. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

46.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>

表 46.20. 位置参数
概述

<GATEWAY-NAME>

逻辑网关的描述性名称。

表 46.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 选项可以重复)

表 46.22. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 46.23. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 46.24. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 46.25. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

46.6. l2gw delete

删除给定的 l2gateway

使用方法:

openstack l2gw delete [-h] <L2_GATEWAY> [<L2_GATEWAY> ...]

表 46.26. 位置参数
概述

<L2_GATEWAY>

要删除的 l2_gateway 的 ID 或名称。

表 46.27. 可选参数
概述

-h, --help

显示帮助信息并退出

46.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>]

表 46.28. 可选参数
概述

-h, --help

显示帮助信息并退出

--project <project>

所有者的项目(名称或 id)

--project-domain <project-domain>

项目所属的域(名称或 id)。这可在项目名称之间有冲突时使用。

表 46.29. 输出格式器
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 46.30. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

表 46.31. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 46.32. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

46.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>

表 46.33. 位置参数
概述

<L2_GATEWAY>

要查找的 ID 或名称 l2_gateway。

表 46.34. 可选参数
概述

-h, --help

显示帮助信息并退出

表 46.35. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 46.36. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 46.37. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 46.38. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

46.9. l2gw 更新

更新给定的 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>

表 46.39. 位置参数
概述

<L2_GATEWAY>

要更新的 l2_gateway 的 ID 或名称。

表 46.40. 可选参数
概述

-h, --help

显示帮助信息并退出

--name 名称

逻辑网关的描述性名称。

--device name=name,interface_names=INTERFACE-DETAILS

l2gateway 的设备名称和接口名称。INTERFACE-DETAILS 格式为 "<interface_name1>;[<inte rface_name2>][|<seg_id1>[#<seg_id2>]" (--device 选项可以重复)

表 46.41. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 46.42. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 46.43. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 46.44. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

第 47 章 limit

本章论述了 limit 命令下的命令。

47.1. Limit create

创建限制

使用方法:

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>

表 47.1. 位置参数
概述

<resource-name>

要限制的资源的名称

表 47.2. 可选参数
概述

-h, --help

显示帮助信息并退出

--description <description>

限制的描述

--region <region>

要影响的限值的区域。

--project <project>

将资源限值关联到的项目

--service <service>

负责限制的资源的服务

--resource-limit <resource-limit>

项目的资源限制

表 47.3. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 47.4. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 47.5. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 47.6. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

47.2. 限制删除

删除限制

使用方法:

openstack limit delete [-h] <limit-id> [<limit-id> ...]

表 47.7. 位置参数
概述

<limit-id>

限制删除(id)

表 47.8. 可选参数
概述

-h, --help

显示帮助信息并退出

47.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>]

表 47.9. 可选参数
概述

-h, --help

显示帮助信息并退出

--service <service>

负责限制的资源的服务

--resource-name <resource-name>

要限制的资源的名称

--region <region>

注册限制的区域以影响.

--project <project>

列出与项目关联的资源限制

表 47.10. 输出格式器
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 47.11. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

表 47.12. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 47.13. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

47.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>

表 47.14. 位置参数
概述

<limit-id>

限制为更新(id)

表 47.15. 可选参数
概述

-h, --help

显示帮助信息并退出

--description <description>

限制的描述

--resource-limit <resource-limit>

项目的资源限制

表 47.16. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 47.17. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 47.18. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 47.19. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

47.5. limit show

显示限制详情

使用方法:

openstack limit show [-h] [-f {json,shell,table,value,yaml}]
                            [-c COLUMN] [--noindent] [--prefix PREFIX]
                            [--max-width <integer>] [--fit-width]
                            [--print-empty]
                            <limit-id>

表 47.20. 位置参数
概述

<limit-id>

限制为显示(id)

表 47.21. 可选参数
概述

-h, --help

显示帮助信息并退出

表 47.22. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 47.23. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 47.24. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 47.25. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

第 48 章 limits

本章论述了 limits 命令下的命令。

48.1. limits show

显示计算和块存储限制

使用方法:

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>]

表 48.1. 可选参数
概述

-h, --help

显示帮助信息并退出

--absolute

显示绝对限制

--rate

显示速率限值

--reserved

包括保留数 [只能通过 --absolute]

--project <project>

显示特定项目的限值(名称或 id)[只有效使用 --absolute]

--domain <domain>

项目所属的域(名称或 id)[仅对 --absolute]有效.

表 48.2. 输出格式器
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 48.3. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

表 48.4. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 48.5. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

第 49 章 LoadBalancer

本章论述了 loadbalancer 命令下的命令。

49.1. LoadBalancer amphora 配置

更新 amphora 代理配置

使用方法:

openstack loadbalancer amphora configure [-h] <amphora-id>

表 49.1. 位置参数
概述

<amphora-id>

用于配置的amphora 的 UUID。

表 49.2. 可选参数
概述

-h, --help

显示帮助信息并退出

49.2. LoadBalancer amphora 故障切换

强制故障转移 amphora

使用方法:

openstack loadbalancer amphora failover [-h] <amphora-id>

表 49.3. 位置参数
概述

<amphora-id>

amphora 的 UUID。

表 49.4. 可选参数
概述

-h, --help

显示帮助信息并退出

49.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}]

表 49.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 provisioning 状态过滤。

表 49.6. 输出格式器
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 49.7. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

表 49.8. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 49.9. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

49.4. LoadBalancer amphora 显示

显示单个 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>

表 49.10. 位置参数
概述

<amphora-id>

amphora 的 UUID。

表 49.11. 可选参数
概述

-h, --help

显示帮助信息并退出

表 49.12. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 49.13. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 49.14. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 49.15. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

49.5. LoadBalancer 创建

创建负载均衡器

使用方法:

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>]

表 49.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。

表 49.17. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 49.18. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 49.19. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 49.20. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

表 49.21. VIP 网络
概述

至少需要以下参数之一。---vip-port-id <vip_port_id>

为负载均衡器(名称或 ID)设置端口。

--vip-subnet-id <vip_subnet_id>

为负载均衡器(名称或 ID)设置子网。

--vip-network-id <vip_network_id>

为负载均衡器(名称或 ID)设置网络。

49.6. LoadBalancer delete

删除负载均衡器

使用方法:

openstack loadbalancer delete [-h] [--cascade] <load_balancer>

表 49.22. 位置参数
概述

<load_balancer>

要删除的负载均衡器(名称或 id)

表 49.23. 可选参数
概述

-h, --help

显示帮助信息并退出

--cascade

将删除操作传递给负载均衡器的所有子元素。

49.7. LoadBalancer 故障转移

触发负载均衡器故障切换

使用方法:

openstack loadbalancer failover [-h] <load_balancer>

表 49.24. 位置参数
概述

<load_balancer>

负载均衡器的名称或 uuid。

表 49.25. 可选参数
概述

-h, --help

显示帮助信息并退出

49.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]

表 49.26. 可选参数
概述

-h, --help

显示帮助信息并退出

--name <name>

新类别名称。

--flavorprofile <flavor_profile>

将类别添加到 (名称或 ID)的 flavor 配置集。

--description <description>

设置类别描述。

--enable

启用类别。

--disable

禁用类别。

表 49.27. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 49.28. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 49.29. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 49.30. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

49.9. LoadBalancer 类别删除

删除类别

使用方法:

openstack loadbalancer flavor delete [-h] <flavor>

表 49.31. 位置参数
概述

<flavor>

要删除的类别(名称或 ID)

表 49.32. 可选参数
概述

-h, --help

显示帮助信息并退出

49.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]

表 49.33. 可选参数
概述

-h, --help

显示帮助信息并退出

--name <name>

根据类别的名称列出类别。

--flavorprofile <flavor_profile>

根据类别配置文件列出类别。

--enable

列出已启用的类别。

--disable

列出禁用的类别。

表 49.34. 输出格式器
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 49.35. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

表 49.36. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 49.37. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

49.11. LoadBalancer 类别集

更新类型

使用方法:

openstack loadbalancer flavor set [-h] [--name <name>]
                                         [--enable | --disable]
                                         <flavor>

表 49.38. 位置参数
概述

<flavor>

要更新的类别的名称或 uuid。

表 49.39. 可选参数
概述

-h, --help

显示帮助信息并退出

--name <name>

设置类别的名称。

--enable

启用类别。

--disable

禁用类别。

49.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>

表 49.40. 位置参数
概述

<flavor>

类别的名称或 uuid。

表 49.41. 可选参数
概述

-h, --help

显示帮助信息并退出

表 49.42. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 49.43. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 49.44. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 49.45. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

49.13. LoadBalancer 类别取消设置

清除健康状态监控设置

使用方法:

openstack loadbalancer flavor unset [-h] [--description] <flavor>

表 49.46. 位置参数
概述

<flavor>

要更新的类别(名称或 ID)。

表 49.47. 可选参数
概述

-h, --help

显示帮助信息并退出

--description

清除类别描述。

49.14. LoadBalancer 类别配置集创建

创建 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>

表 49.48. 可选参数
概述

-h, --help

显示帮助信息并退出

--name <name>

新的 octavia 类别配置集名称。

--provider <provider name>

类别配置文件的提供程序名称。

--flavor-data <flavor_data>

包含类别元数据的 json 字符串。

表 49.49. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 49.50. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 49.51. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 49.52. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

49.15. LoadBalancer 类别配置集删除

删除类别配置集

使用方法:

openstack loadbalancer flavorprofile delete [-h] <flavor_profile>

表 49.53. 位置参数
概述

<flavor_profile>

要删除的类别配置文件(名称或 ID)

表 49.54. 可选参数
概述

-h, --help

显示帮助信息并退出

49.16. LoadBalancer 类别配置集列表

列出 flavor 配置集

使用方法:

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>]

表 49.55. 可选参数
概述

-h, --help

显示帮助信息并退出

--name <name>

根据类别配置集名称列出 flavor 配置集。

--provider <provider_name>

根据提供程序列出类别配置集。

表 49.56. 输出格式器
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 49.57. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

表 49.58. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 49.59. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

49.17. LoadBalancer 类别配置集设置

更新 flavor 配置集

使用方法:

openstack loadbalancer flavorprofile set [-h] [--name <name>]
                                                [--provider <provider_name>]
                                                [--flavor-data <flavor_data>]
                                                <flavor_profile>

表 49.60. 位置参数
概述

<flavor_profile>

要更新的类别配置集的名称或 uuid。

表 49.61. 可选参数
概述

-h, --help

显示帮助信息并退出

--name <name>

设置类别配置文件的名称。

--provider <provider_name>

设置 flavor 配置集的提供程序。

--flavor-data <flavor_data>

设置 flavor 配置集的类别数据。

49.18. LoadBalancer 类别配置集显示

显示单个 flavor 配置集的详情

使用方法:

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>

表 49.62. 位置参数
概述

<flavor_profile>

要显示的类别配置集的名称或 uuid。

表 49.63. 可选参数
概述

-h, --help

显示帮助信息并退出

表 49.64. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 49.65. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 49.66. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 49.67. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

49.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>

表 49.68. 位置参数
概述

<pool>

为运行状况监控器(名称或 ID)设置池。

表 49.69. 可选参数
概述

-h, --help

显示帮助信息并退出

--name <name>

设置运行状况 monitor 名称。

--delay <delay>

设置向成员发送探测之间的时间(以秒为单位)。

--domain-name <domain_name>

设置域名,它将注入到 HTTP 健康检查的后端服务器。

--expected-codes <codes>

设置来自成员所预期的 http 状态代码列表,以声明它健康。

--http-method {GET,POST,DELETE,PUT,HEAD,OPTIONS,PATCH,CONNECT,TRACE}

设置运行状况监视器用于请求的 http 方法。

--http-version <http_version>

设置 http 版本。

--timeout <timeout>

设置监视器在超时前等待连接的最长时间,以秒为单位。这个值必须小于延迟值。

--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 之前,设置允许检查失败的数量。

--enable

启用运行状况监视器(默认)。

--disable

禁用运行状况监视器。

表 49.70. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 49.71. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 49.72. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 49.73. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

49.20. LoadBalancer healthmonitor delete

删除健康监控器

使用方法:

openstack loadbalancer healthmonitor delete [-h] <health_monitor>

表 49.74. 位置参数
概述

<health_monitor>

要删除的运行状况监视器(名称或 id)。

表 49.75. 可选参数
概述

-h, --help

显示帮助信息并退出

49.21. LoadBalancer healthmonitor 列表

列出运行状况监视器

使用方法:

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]

表 49.76. 可选参数
概述

-h, --help

显示帮助信息并退出

表 49.77. 输出格式器
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 49.78. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

表 49.79. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 49.80. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

49.22. LoadBalancer healthmonitor 设置

更新健康监控器

使用方法:

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>

表 49.81. 位置参数
概述

<health_monitor>

运行状况监视器更新(名称或 id)。

表 49.82. 可选参数
概述

-h, --help

显示帮助信息并退出

--name <name>

设置运行状况监视器名称。

--delay <delay>

设置向成员发送探测之间的时间(以秒为单位)。

--domain-name <domain_name>

设置域名,它将注入到 HTTP 健康检查的后端服务器。

--expected-codes <codes>

设置来自成员所预期的 http 状态代码列表,以声明它健康。

--http-method {GET,POST,DELETE,PUT,HEAD,OPTIONS,PATCH,CONNECT,TRACE}

设置运行状况监视器用于请求的 http 方法。

--http-version <http_version>

设置 http 版本。

--timeout <timeout>

设置监视器在超时前等待连接的最长时间,以秒为单位。这个值必须小于延迟值。

--max-retries <max_retries>

在将成员的操作状态更改为 ONLINE 前设置成功检查的数量。

--max-retries-down <max_retries_down>

在将成员的操作状态更改为 ERROR 之前,设置允许检查失败的数量。

--url-path <url_path>

设置监控器发送的请求的 http url 路径,以测试后端成员的健康状况。

--enable

启用运行状况监视器。

--disable

禁用运行状况监视器。

49.23. LoadBalancer healthmonitor 显示

显示单个健康监控器的详细信息

使用方法:

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>

表 49.83. 位置参数
概述

<health_monitor>

健康监控器的名称或 uuid。

表 49.84. 可选参数
概述

-h, --help

显示帮助信息并退出

表 49.85. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 49.86. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 49.87. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 49.88. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

49.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>

表 49.89. 位置参数
概述

<health_monitor>

运行状况监视器更新(名称或 id)。

表 49.90. 可选参数
概述

-h, --help

显示帮助信息并退出

--domain-name

清除运行状况 monitor 域名。

--expected-codes

将运行状况 monitor 预期的代码重置为 api default。

--http-method

将运行状况 monitor http 方法重置为 api default。

--http-version

将 health monitor http 版本重置为 api default。

--max-retries-down

将运行状况监视器最大重试次数重置为 api 默认。

--name

清除健康状态 monitor 名称。

--url-path

清除健康监控器 url 路径。

49.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>

表 49.91. 位置参数
概述

<listener>

将 l7policy 添加至(名称或 ID)的监听程序。

表 49.92. 可选参数
概述

-h, --help

显示帮助信息并退出

--name <name>

设置 l7policy 名称。

--description <description>

设置 l7policy 描述。

--action {REDIRECT_TO_URL,REDIRECT_TO_POOL,REDIRECT_PREFIX,REJECT}

设置策略的操作。

--redirect-pool <pool>

将池设置为重定向请求(名称或 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。

表 49.93. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 49.94. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 49.95. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 49.96. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

49.26. LoadBalancer l7policy delete

删除 l7policy

使用方法:

openstack loadbalancer l7policy delete [-h] <policy>

表 49.97. 位置参数
概述

<policy>

要删除的 L7policy (名称或 ID)。

表 49.98. 可选参数
概述

-h, --help

显示帮助信息并退出

49.27. LoadBalancer l7policy 列表

列出 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]

表 49.99. 可选参数
概述

-h, --help

显示帮助信息并退出

表 49.100. 输出格式器
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 49.101. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

表 49.102. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 49.103. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

49.28. LoadBalancer l7policy 设置

更新 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>

表 49.104. 位置参数
概述

<policy>

L7policy 以更新(名称或 ID)。

表 49.105. 可选参数
概述

-h, --help

显示帮助信息并退出

--name <name>

设置 l7policy 名称。

--description <description>

设置 l7policy 描述。

--action {REDIRECT_TO_URL,REDIRECT_TO_POOL,REDIRECT_PREFIX,REJECT}

设置策略的操作。

--redirect-pool <pool>

将池设置为重定向请求(名称或 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。

49.29. LoadBalancer l7policy 显示

显示单个 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>

表 49.106. 位置参数
概述

<policy>

l7policy 的名称或 uuid。

表 49.107. 可选参数
概述

-h, --help

显示帮助信息并退出

表 49.108. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 49.109. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 49.110. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 49.111. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

49.30. LoadBalancer l7policy unset

清除 l7policy 设置

使用方法:

openstack loadbalancer l7policy unset [-h] [--description] [--name]
                                             [--redirect-http-code]
                                             <policy>

表 49.112. 位置参数
概述

<policy>

L7policy 以更新(名称或 ID)。

表 49.113. 可选参数
概述

-h, --help

显示帮助信息并退出

--description

清除 l7policy 描述。

--name

清除 l7policy 名称。

--redirect-http-code

清除 l7policy 重定向 http 代码。

49.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>

表 49.114. 位置参数
概述

<l7policy>

L7policy 以将 l7rule 添加到 (名称或 ID)。

表 49.115. 可选参数
概述

-h, --help

显示帮助信息并退出

--compare-type {REGEX,EQUAL_TO,CONTAINS,ENDS_WITH,STARTS_WITH}

为 l7rule 设置比较类型。

--invert

invert l7rule.

--value <value>

将规则值设置为与 on 匹配。

--key <key>

将 l7rule 的值的键设置为 match。

--type {FILE_TYPE,PATH,COOKIE,HOST_NAME,HEADER,SSL_CONN_HAS_CERT,SSL_VERIFY_RESULT,SSL_DN_FIELD}

设置 l7rule 的类型。

--enable

启用 l7rule (默认)。

--disable

禁用 l7rule。

表 49.116. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 49.117. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 49.118. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 49.119. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

49.32. LoadBalancer l7rule delete

删除 l7rule

使用方法:

openstack loadbalancer l7rule delete [-h] <l7policy> <rule_id>

表 49.120. 位置参数
概述

<l7policy>

从(名称或 ID)中删除规则的 L7policy。

<rule_id>

要删除的 L7rule。

表 49.121. 可选参数
概述

-h, --help

显示帮助信息并退出

49.33. LoadBalancer l7rule 列表

列出 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>

表 49.122. 位置参数
概述

<l7policy>

L7policy 可列出 (名称或 ID)的规则。

表 49.123. 可选参数
概述

-h, --help

显示帮助信息并退出

表 49.124. 输出格式器
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 49.125. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

表 49.126. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 49.127. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

49.34. LoadBalancer l7rule 集

更新 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>

表 49.128. 位置参数
概述

<l7policy>

L7policy 可在(名称或 ID)上更新 l7rule。

<l7rule_id>

要更新的 L7rule。

表 49.129. 可选参数
概述

-h, --help

显示帮助信息并退出

--compare-type {REGEX,EQUAL_TO,CONTAINS,ENDS_WITH,STARTS_WITH}

为 l7rule 设置比较类型。

--invert

invert l7rule.

--value <value>

将规则值设置为与 on 匹配。

--key <key>

将 l7rule 的值的键设置为 match。

--type {FILE_TYPE,PATH,COOKIE,HOST_NAME,HEADER,SSL_CONN_HAS_CERT,SSL_VERIFY_RESULT,SSL_DN_FIELD}

设置 l7rule 的类型。

--enable

启用 l7rule。

--disable

禁用 l7rule。

49.35. LoadBalancer l7rule 显示

显示单个 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>

表 49.130. 位置参数
概述

<l7policy>

L7policy 以显示来自(名称或 ID)的规则。

<l7rule_id>

要显示的 L7rule。

表 49.131. 可选参数
概述

-h, --help

显示帮助信息并退出

表 49.132. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 49.133. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 49.134. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 49.135. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

49.36. LoadBalancer l7rule unset

clear l7rule 设置

使用方法:

openstack loadbalancer l7rule unset [-h] [--invert] [--key]
                                           <l7policy> <l7rule_id>

表 49.136. 位置参数
概述

<l7policy>

L7policy 以更新(名称或 ID)。

<l7rule_id>

要更新的 L7rule。

表 49.137. 可选参数
概述

-h, --help

显示帮助信息并退出

--invert

将 l7rule invert 重置为 api default。

--key

清除 l7rule 键。

49.37. LoadBalancer 列表

列出负载均衡器

使用方法:

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>]

表 49.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>

根据类别列出负载均衡器。

表 49.139. 输出格式器
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 49.140. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

表 49.141. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 49.142. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

49.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>

表 49.143. 位置参数
概述

<LoadBalancer>

侦听器的负载均衡器(名称或 ID)。

表 49.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>

uri 到关键管理器服务 secret 容器,包含 TERMINATED_TLS 侦听的证书和密钥。

--sni-container-refs [<container_ref> [<container_ref> …​]]

使用 Server Name Indication 为密钥管理器服务 secret 容器(包含 TERMINATED_TLS)的 uris 列表。

--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>

uri 到包含 TERMINATED_TLS 侦听器的 CA 证书的关键管理器服务 secret 容器。

--client-authentication {NONE,OPTIONAL,MANDATORY}

tls 客户端身份验证验证 TERMINATED_TLS 侦听器的选项。

--client-crl-container-ref <client_crl_container_ref>

key manager 服务 secret 容器包含 TERMINATED_TLS 侦听器的 CA 撤销列表文件。

--allowed-cidr [<allowed_cidr>]

允许访问监听程序的 CIDR (可以多次设置)。

表 49.145. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 49.146. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 49.147. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 49.148. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

49.39. LoadBalancer 侦听器删除

删除监听程序

使用方法:

openstack loadbalancer listener delete [-h] <listener>

表 49.149. 位置参数
概述

<listener>

要删除的监听程序(名称或 id)

表 49.150. 可选参数
概述

-h, --help

显示帮助信息并退出

49.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>]

表 49.151. 可选参数
概述

-h, --help

显示帮助信息并退出

--name <name>

按侦听器名称列出监听程序。

--LoadBalancer <loadbalancer>

按负载均衡器(名称或 id)过滤。

--enable

列出已启用的监听程序。

--disable

列出禁用的监听程序。

--project <project>

按项目 ID 列出监听程序。

表 49.152. 输出格式器
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 49.153. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

表 49.154. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 49.155. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

49.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>

表 49.156. 位置参数
概述

<listener>

修改(名称或 ID)的监听程序。

表 49.157. 可选参数
概述

-h, --help

显示帮助信息并退出

--name <name>

设置侦听器名称。

--description <description>

设置此侦听器的描述。

--connection-limit <limit>

此侦听器允许的最大连接数。默认值为 -1,代表无限连接。

--default-pool <pool>

如果没有 l7 策略,则监听程序使用的池的 id。

--default-tls-container-ref <container-ref>

uri 至密钥管理器服务 secret 容器,包含 TERMINATED_TLSlisteners 的证书和密钥。

--sni-container-refs [<container-ref> [<container-ref> …​]]

使用 Server Name Indication 为密钥管理器服务 secret 容器(包含 TERMINATED_TLS)的 uris 列表。

--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>

uri 到包含 TERMINATED_TLS 侦听器的 CA 证书的关键管理器服务 secret 容器。

--client-authentication {NONE,OPTIONAL,MANDATORY}

tls 客户端身份验证验证 TERMINATED_TLS 侦听器的选项。

--client-crl-container-ref <client_crl_container_ref>

key manager 服务 secret 容器包含 TERMINATED_TLS 侦听器的 CA 撤销列表文件。

--allowed-cidr [<allowed_cidr>]

允许访问监听程序的 CIDR (可以多次设置)。

49.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>

表 49.158. 位置参数
概述

<listener>

侦听器的名称或 uuid

表 49.159. 可选参数
概述

-h, --help

显示帮助信息并退出

表 49.160. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 49.161. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 49.162. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 49.163. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

49.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>

表 49.164. 位置参数
概述

<listener>

侦听器的名称或 uuid

表 49.165. 可选参数
概述

-h, --help

显示帮助信息并退出

表 49.166. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 49.167. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 49.168. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 49.169. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

49.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>

表 49.170. 位置参数
概述

<listener>

修改(名称或 ID)的监听程序。

表 49.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 default。

--timeout-member-data

将 member 数据超时重置为 api 默认值。

--timeout-tcp-inspect

将 tcp 检查超时重置为 api 默认值。

--client-ca-tls-container-ref

从监听程序清除客户端 ca tls 容器引用。

--client-authentication

将客户端身份验证设置重置为 api 默认值。

--client-crl-container-ref

清除来自侦听器的 client crl 容器引用。

--allowed-cidrs

从监听程序清除所有允许的 cidr。

49.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>

表 49.172. 位置参数
概述

<pool>

为创建成员的池的 ID 或名称。

表 49.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

禁用成员

表 49.174. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 49.175. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 49.176. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 49.177. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

49.46. LoadBalancer 成员删除

从池中删除成员

使用方法:

openstack loadbalancer member delete [-h] <pool> <member>

表 49.178. 位置参数
概述

<pool>

用于删除成员的池名称或 ID。

<member>

要删除的成员的名称或 id。

表 49.179. 可选参数
概述

-h, --help

显示帮助信息并退出

49.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>

表 49.180. 位置参数
概述

<pool>

用于列出以下条件的成员的池名称或 ID。

表 49.181. 可选参数
概述

-h, --help

显示帮助信息并退出

表 49.182. 输出格式器
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 49.183. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

表 49.184. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 49.185. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

49.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>

表 49.186. 位置参数
概述

<pool>

要更新的成员所属的池(名称或 ID)。

<member>

要更新的成员的名称或 id

表 49.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

49.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>

表 49.188. 位置参数
概述

<pool>

池名称或 id,以显示.

<member>

要显示的成员的名称或 id。

表 49.189. 可选参数
概述

-h, --help

显示帮助信息并退出

表 49.190. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 49.191. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 49.192. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 49.193. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

49.50. LoadBalancer member unset

清除成员设置

使用方法:

openstack loadbalancer member unset [-h] [--backup] [--monitor-address]
                                           [--monitor-port] [--name]
                                           [--weight]
                                           <pool> <member>

表 49.194. 位置参数
概述

<pool>

要更新的成员所属的池(名称或 ID)。

<member>

要修改的成员(名称或 ID)。

表 49.195. 可选参数
概述

-h, --help

显示帮助信息并退出

--backup

清除备份成员标志。

--monitor-address

清除成员监控器地址。

--monitor-port

清除成员监控器端口。

--name

清除成员名称。

--weight

将 member weight 重置为 api default。

49.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]

表 49.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

禁用后端成员重新加密。

表 49.197. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 49.198. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 49.199. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 49.200. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

49.52. LoadBalancer 池删除

删除池

使用方法:

openstack loadbalancer pool delete [-h] <pool>

表 49.201. 位置参数
概述

<pool>

要删除的池(名称或 id)。

表 49.202. 可选参数
概述

-h, --help

显示帮助信息并退出

49.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>]

表 49.203. 可选参数
概述

-h, --help

显示帮助信息并退出

--LoadBalancer <loadbalancer>

按负载均衡器(名称或 id)过滤。

表 49.204. 输出格式器
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 49.205. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

表 49.206. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 49.207. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

49.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>

表 49.208. 位置参数
概述

<pool>

要更新的池(名称或 id)。

表 49.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>

uri 到主要管理器服务 secret 容器,包含 TERMINATED_TLS 池的证书和密钥,以将来自 TERMINATED_TLS 侦听器的流量重新应用到后端服务器。

--ca-tls-container-ref <ca_tls_container_ref>

uri 到主要管理器服务 secret 容器,包含 TERMINATED_TLS 侦听器的 CA 证书,以检查 ssl 流量中的后端服务器证书。

--crl-container-ref <crl_container_ref>

key manager 服务 secret 容器包含 TERMINATED_TLS 侦听器的 CA 撤销列表文件,以处理 ssl 流量中的后端服务器证书。

--enable-tls

启用后端关联的成员重新加密。

--disable-tls

禁用与后端关联的成员重新加密。

49.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>

表 49.210. 位置参数
概述

<pool>

池的名称或 uuid。

表 49.211. 可选参数
概述

-h, --help

显示帮助信息并退出

表 49.212. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 49.213. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 49.214. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 49.215. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

49.56. LoadBalancer 池未设置

清除池设置

使用方法:

openstack loadbalancer pool unset [-h] [--name] [--description]
                                         [--ca-tls-container-ref]
                                         [--crl-container-ref]
                                         [--session-persistence]
                                         [--tls-container-ref]
                                         <pool>

表 49.216. 位置参数
概述

<pool>

要修改的池(名称或 ID)。

表 49.217. 可选参数
概述

-h, --help

显示帮助信息并退出

--name

清除池名称。

--description

清除此池的描述。

--ca-tls-container-ref

清除此池的证书颁发机构证书引用。

--crl-container-ref

清除此池上的证书撤销列表引用。

--session-persistence

禁用池中的会话持久性。

--tls-container-ref

清除此池的证书引用。

49.57. LoadBalancer 供应商功能列表

列出指定的提供程序驱动程序的类别 capabilicies。

使用方法:

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>

表 49.218. 位置参数
概述

<provider_name>

供应商驱动程序的名称。

表 49.219. 可选参数
概述

-h, --help

显示帮助信息并退出

表 49.220. 输出格式器
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 49.221. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

表 49.222. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 49.223. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

49.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]

表 49.224. 可选参数
概述

-h, --help

显示帮助信息并退出

表 49.225. 输出格式器
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 49.226. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

表 49.227. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 49.228. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

49.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]

表 49.229. 可选参数
概述

-h, --help

显示帮助信息并退出

表 49.230. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 49.231. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 49.232. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 49.233. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

49.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>]

表 49.234. 可选参数
概述

-h, --help

显示帮助信息并退出

--project <project-id>

项目的名称或 uuid。

表 49.235. 输出格式器
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 49.236. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

表 49.237. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 49.238. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

49.61. LoadBalancer 配额重置

将配额重置为默认配额

使用方法:

openstack loadbalancer quota reset [-h] <project>

表 49.239. 位置参数
概述

<project>

重置配额的项目(名称或 ID)

表 49.240. 可选参数
概述

-h, --help

显示帮助信息并退出

49.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>

表 49.241. 位置参数
概述

<project>

项目的名称或 uuid。

表 49.242. 可选参数
概述

-h, --help

显示帮助信息并退出

表 49.243. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 49.244. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 49.245. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 49.246. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

表 49.247. 配额限制
概述

至少需要以下参数之一。---healthmonitor <health_monitor>

健康监控配额的新值。值 -1 表示无限。

--listener <listener>

侦听器 quota. value -1 的新值表示无限。

--loadbalancer <load_balancer>

负载均衡器配额限制的新值。值 -1 表示无限。

--member <member>

member 配额限制的新值。值 -1 表示无限。

--pool <pool>

池配额限制的新值。值 -1 表示无限。

49.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>

表 49.248. 位置参数
概述

<project>

项目的名称或 uuid。

表 49.249. 可选参数
概述

-h, --help

显示帮助信息并退出

表 49.250. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 49.251. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 49.252. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 49.253. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

49.64. LoadBalancer 配额取消设置

清除配额设置

使用方法:

openstack loadbalancer quota unset [-h] [--loadbalancer] [--listener]
                                          [--pool] [--member]
                                          [--healthmonitor]
                                          <project>

表 49.254. 位置参数
概述

<project>

项目的名称或 uuid。

表 49.255. 可选参数
概述

-h, --help

显示帮助信息并退出

--loadbalancer

将负载均衡器配额重置为默认值。

--listener

将监听程序配额重置为默认值。

--pool

将池配额重置为默认值。

--member

将 member 配额重置为默认值。

--healthmonitor

将运行状况监视器配额重置为默认值。

49.65. LoadBalancer 设置

更新负载均衡器

使用方法:

openstack loadbalancer set [-h] [--name <name>]
                                  [--description <description>]
                                  [--vip-qos-policy-id <vip_qos_policy_id>]
                                  [--enable | --disable]
                                  <load_balancer>

表 49.256. 位置参数
概述

<load_balancer>

要更新的负载均衡器的名称或 uuid。

表 49.257. 可选参数
概述

-h, --help

显示帮助信息并退出

--name <name>

设置负载均衡器名称。

--description <description>

设置负载均衡器描述。

--vip-qos-policy-id <vip_qos_policy_id>

为 vip 端口设置 qos 策略 ID。未设置任何。

--enable

启用负载均衡器。

--disable

禁用负载均衡器。

49.66. LoadBalancer 显示

显示单个负载均衡器的详情

使用方法:

openstack loadbalancer show [-h] [-f {json,shell,table,value,yaml}]
                                   [-c COLUMN] [--noindent] [--prefix PREFIX]
                                   [--max-width <integer>] [--fit-width]
                                   [--print-empty]
                                   <load_balancer>

表 49.258. 位置参数
概述

<load_balancer>

负载均衡器的名称或 uuid。

表 49.259. 可选参数
概述

-h, --help

显示帮助信息并退出

表 49.260. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 49.261. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 49.262. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 49.263. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

49.67. LoadBalancer stats 显示

显示负载均衡器的当前统计信息

使用方法:

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>

表 49.264. 位置参数
概述

<load_balancer>

负载均衡器的名称或 uuid。

表 49.265. 可选参数
概述

-h, --help

显示帮助信息并退出

表 49.266. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 49.267. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 49.268. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 49.269. 表格式
概述

--max-width <integer>

最大显示宽度,<1 禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

与显示宽度对应表。如果 --max- width 大于 0,则意味着使用。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always enable

--print-empty

如果没有要显示的数据,打印空表。

49.68. LoadBalancer 状态显示

以 json 格式显示负载均衡器状态树

使用方法:

openstack loadbalancer status show [-h] <load_balancer>

表 49.270. 位置参数
概述

<load_balancer>

负载均衡器的名称或 uuid。

表 49.271. 可选参数
概述

-h, --help

显示帮助信息并退出

49.69. LoadBalancer 取消设置

清除负载均衡器设置

使用方法:

openstack loadbalancer unset [-h] [--name] [--description]
                                    [--vip-qos-policy-id]
                                    <load_balancer>

表 49.272. 位置参数
概述

<load_balancer>

要更新的负载均衡器的名称或 uuid。

表 49.273. 可选参数
概述

-h, --help

显示帮助信息并退出

--name

清除负载均衡器名称。

--description

清除负载均衡器描述。

--vip-qos-policy-id

清除负载均衡器 qos 策略。

第 50 章 映射

本章论述了 mapping 命令下的命令。

50.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>

表 50.1. 位置参数
概述

<name>

新映射名称(必须唯一)

表 50.2. 可选参数
概述

-h, --help

显示帮助信息并退出

--rules <filename>

包含一组映射规则的文件名(必需)

表 50.3. 输出格式
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 50.4. JSON 格式
概述

--noindent

是否禁用缩进 json

表 50.5. Shell 格式
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 50.6. 表格式
概述

--max-width <integer>

最大显示宽度,<1 禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

与显示宽度对应表。如果 --max- width 大于 0,则意味着使用。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always enable

--print-empty

如果没有要显示的数据,打印空表。

50.2. 映射删除

删除映射

使用方法:

openstack mapping delete [-h] <mapping> [<mapping> ...]

表 50.7. 位置参数
概述

<mapping>

要删除的映射

表 50.8. 可选参数
概述

-h, --help

显示帮助信息并退出

50.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]

表 50.9. 可选参数
概述

-h, --help

显示帮助信息并退出

表 50.10. 输出格式
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定要对数据排序的列(指定第一个列具有优先级,而非现有列将被忽略),可以重复

表 50.11. CSV 格式
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 50.12. JSON 格式
概述

--noindent

是否禁用缩进 json

表 50.13. 表格式
概述

--max-width <integer>

最大显示宽度,<1 禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

与显示宽度对应表。如果 --max- width 大于 0,则意味着使用。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always enable

--print-empty

如果没有要显示的数据,打印空表。

50.4. 映射集

设置映射属性

使用方法:

openstack mapping set [-h] [--rules <filename>] <name>

表 50.14. 位置参数
概述

<name>

映射修改

表 50.15. 可选参数
概述

-h, --help

显示帮助信息并退出

--rules <filename>

包含新映射规则集的文件名

50.5. 映射显示

显示映射详情

使用方法:

openstack mapping show [-h] [-f {json,shell,table,value,yaml}]
                              [-c COLUMN] [--noindent] [--prefix PREFIX]
                              [--max-width <integer>] [--fit-width]
                              [--print-empty]
                              <mapping>

表 50.16. 位置参数
概述

<mapping>

映射至显示

表 50.17. 可选参数
概述

-h, --help

显示帮助信息并退出

表 50.18. 输出格式
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 50.19. JSON 格式
概述

--noindent

是否禁用缩进 json

表 50.20. Shell 格式
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 50.21. 表格式
概述

--max-width <integer>

最大显示宽度,<1 禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

与显示宽度对应表。如果 --max- width 大于 0,则意味着使用。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always enable

--print-empty

如果没有要显示的数据,打印空表。

第 51 章 messaging

本章描述了 messaging 命令下的命令。

51.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>

表 51.1. 位置参数
概述

<queue_name>

要声明的队列的名称

表 51.2. 可选参数
概述

-h, --help

显示帮助信息并退出

--ttl <ttl>

声明的时间(以秒为单位)

--grace <grace>

消息宽限期(以秒为单位)

--limit <limit>

声明一组信息,最多限制

表 51.3. 输出格式
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定要对数据排序的列(指定第一个列具有优先级,而非现有列将被忽略),可以重复

表 51.4. CSV 格式
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 51.5. JSON 格式
概述

--noindent

是否禁用缩进 json

表 51.6. 表格式
概述

--max-width <integer>

最大显示宽度,<1 禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

与显示宽度对应表。如果 --max- width 大于 0,则意味着使用。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always enable

--print-empty

如果没有要显示的数据,打印空表。

51.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>

表 51.7. 位置参数
概述

<queue_name>

声明队列的名称

<claim_id>

声明 ID

表 51.8. 可选参数
概述

-h, --help

显示帮助信息并退出

表 51.9. 输出格式
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定要对数据排序的列(指定第一个列具有优先级,而非现有列将被忽略),可以重复

表 51.10. CSV 格式
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 51.11. JSON 格式
概述

--noindent

是否禁用缩进 json

表 51.12. 表格式
概述

--max-width <integer>

最大显示宽度,<1 禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

与显示宽度对应表。如果 --max- width 大于 0,则意味着使用。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always enable

--print-empty

如果没有要显示的数据,打印空表。

51.3. 消息传递声明发行版本

删除声明

使用方法:

openstack messaging claim release [-h] <queue_name> <claim_id>

表 51.13. 位置参数
概述

<queue_name>

声明队列的名称

<claim_id>

要删除的声明 ID

表 51.14. 可选参数
概述

-h, --help

显示帮助信息并退出

51.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>

表 51.15. 位置参数
概述

<queue_name>

声明队列的名称

<claim_id>

声明 ID

表 51.16. 可选参数
概述

-h, --help

显示帮助信息并退出

--ttl <ttl>

声明的时间(以秒为单位)

--grace <grace>

消息宽限期(以秒为单位)

表 51.17. 输出格式
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定要对数据排序的列(指定第一个列具有优先级,而非现有列将被忽略),可以重复

表 51.18. CSV 格式
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 51.19. JSON 格式
概述

--noindent

是否禁用缩进 json

表 51.20. 表格式
概述

--max-width <integer>

最大显示宽度,<1 禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

与显示宽度对应表。如果 --max- width 大于 0,则意味着使用。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always enable

--print-empty

如果没有要显示的数据,打印空表。

51.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>

表 51.21. 位置参数
概述

<flavor_name>

类别的名称

表 51.22. 可选参数
概述

-h, --help

显示帮助信息并退出

--pool_list <pool_list>

类别池列表

--capabilities <capabilities>

描述特定于类别的功能,此选项仅适用于 client api 版本 < 2。

表 51.23. 输出格式
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 51.24. JSON 格式
概述

--noindent

是否禁用缩进 json

表 51.25. Shell 格式
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 51.26. 表格式
概述

--max-width <integer>

最大显示宽度,<1 禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

与显示宽度对应表。如果 --max- width 大于 0,则意味着使用。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always enable

--print-empty

如果没有要显示的数据,打印空表。

51.6. 消息传递类别删除

删除池类别

使用方法:

openstack messaging flavor delete [-h] <flavor_name>

表 51.27. 位置参数
概述

<flavor_name>

类别的名称

表 51.28. 可选参数
概述

-h, --help

显示帮助信息并退出

51.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]

表 51.29. 可选参数
概述

-h, --help

显示帮助信息并退出

--marker <flavor_name>

类别的分页标记

--limit <limit>

页面大小限制

--detailed

如果显示类别的详细功能

表 51.30. 输出格式
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定要对数据排序的列(指定第一个列具有优先级,而非现有列将被忽略),可以重复

表 51.31. CSV 格式
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

表 51.32. JSON 格式
概述

--noindent

是否禁用缩进 json

表 51.33. 表格式
概述

--max-width <integer>

最大显示宽度,<1 禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

与显示宽度对应表。如果 --max- width 大于 0,则意味着使用。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always enable

--print-empty

如果没有要显示的数据,打印空表。

51.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>

表 51.34. 位置参数
概述

<flavor_name>

类别以显示(名称)

表 51.35. 可选参数
概述

-h, --help

显示帮助信息并退出

表 51.36. 输出格式
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 51.37. JSON 格式
概述

--noindent

是否禁用缩进 json

表 51.38. Shell 格式
概述

--prefix PREFIX

在所有变量名称中添加前缀

表 51.39. 表格式
概述

--max-width <integer>

最大显示宽度,<1 禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

与显示宽度对应表。如果 --max- width 大于 0,则意味着使用。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always enable

--print-empty

如果没有要显示的数据,打印空表。

51.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>

表 51.40. 位置参数
概述

<flavor_name>

类别的名称

表 51.41. 可选参数
概述

-h, --help

显示帮助信息并退出

--pool_list <pool_list>

池列出类别位于

--capabilities <capabilities>

描述特定于类别的功能。

表 51.42. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 51.43. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 51.44. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 51.45. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

51.10. 消息传递健康

显示 Zaqar 服务器的详细健康状况

使用方法:

openstack messaging health [-h]

表 51.46. 可选参数
概述

-h, --help

显示帮助信息并退出

51.11. 消息传递主页

显示 Zaqar 服务器的详细资源文档

使用方法:

openstack messaging homedoc [-h]

表 51.47. 可选参数
概述

-h, --help

显示帮助信息并退出

51.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>

表 51.48. 位置参数
概述

<queue_name>

队列的名称

表 51.49. 可选参数
概述

-h, --help

显示帮助信息并退出

--message-ids <message_ids>

要检索的消息 ID 列表

--limit <limit>

要获取的最大消息数

--echo

是否获得此客户端自己的消息

--include-claimed

是否包含声明的信息

--include-delayed

是否包括延迟信息

--client-id <client_id>

每个客户端实例都有一个 uuid。

表 51.50. 输出格式器
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 51.51. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

表 51.52. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 51.53. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

51.13. 消息传递消息发布

给定队列的发布消息

使用方法:

openstack messaging message post [-h] [--client-id <client_id>]
                                        <queue_name> <messages>

表 51.54. 位置参数
概述

<queue_name>

队列的名称

<messages>

要发布的消息。

表 51.55. 可选参数
概述

-h, --help

显示帮助信息并退出

--client-id <client_id>

每个客户端实例都有一个 uuid。

51.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]

表 51.56. 可选参数
概述

-h, --help

显示帮助信息并退出

表 51.57. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 51.58. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 51.59. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 51.60. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

51.15. messaging 池创建

创建池

使用方法:

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>

表 51.61. 位置参数
概述

<pool_name>

池的名称

<pool_uri>

存储引擎 uri

<pool_weight>

池的权重

表 51.62. 可选参数
概述

-h, --help

显示帮助信息并退出

--flavor <flavor>

池的类别

--pool_options <pool_options>

与存储特定选项相关的可选请求组件

表 51.63. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 51.64. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 51.65. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 51.66. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

51.16. messaging 池删除

删除池

使用方法:

openstack messaging pool delete [-h] <pool_name>

表 51.67. 位置参数
概述

<pool_name>

池的名称

表 51.68. 可选参数
概述

-h, --help

显示帮助信息并退出

51.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]

表 51.69. 可选参数
概述

-h, --help

显示帮助信息并退出

--marker <pool_name>

池的分页标记

--limit <limit>

页面大小限制

--detailed

详细输出

表 51.70. 输出格式器
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 51.71. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

表 51.72. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 51.73. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

51.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>

表 51.74. 位置参数
概述

<pool_name>

要显示的池(名称)

表 51.75. 可选参数
概述

-h, --help

显示帮助信息并退出

表 51.76. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 51.77. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 51.78. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 51.79. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

51.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>

表 51.80. 位置参数
概述

<pool_name>

池的名称

表 51.81. 可选参数
概述

-h, --help

显示帮助信息并退出

--pool_uri <pool_uri>

存储引擎 uri

--pool_weight <pool_weight>

池的权重

--flavor <flavor>

池的类别

--pool_options <pool_options>

与存储特定选项相关的可选请求组件

表 51.82. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 51.83. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 51.84. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 51.85. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

51.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>

表 51.86. 位置参数
概述

<queue_name>

队列的名称

表 51.87. 可选参数
概述

-h, --help

显示帮助信息并退出

表 51.88. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 51.89. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 51.90. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 51.91. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

51.21. 消息传递队列删除

删除队列

使用方法:

openstack messaging queue delete [-h] <queue_name>

表 51.92. 位置参数
概述

<queue_name>

队列的名称

表 51.93. 可选参数
概述

-h, --help

显示帮助信息并退出

51.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>

表 51.94. 位置参数
概述

<queue_name>

队列的名称

表 51.95. 可选参数
概述

-h, --help

显示帮助信息并退出

表 51.96. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 51.97. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 51.98. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 51.99. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

51.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]

表 51.100. 可选参数
概述

-h, --help

显示帮助信息并退出

--marker <queue_id>

队列的分页标记

--limit <limit>

页面大小限制

--detailed

如果显示队列的详细信息

表 51.101. 输出格式器
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 51.102. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

表 51.103. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 51.104. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

51.24. 消息传递队列清除

清除队列

使用方法:

openstack messaging queue purge [-h]
                                       [--resource_types <resource_types>]
                                       <queue_name>

表 51.105. 位置参数
概述

<queue_name>

队列的名称

表 51.106. 可选参数
概述

-h, --help

显示帮助信息并退出

--resource_types <resource_types>

资源类型需要清除。

51.25. 消息传递队列设置元数据

设置队列元数据

使用方法:

openstack messaging queue set metadata [-h]
                                              <queue_name> <queue_metadata>

表 51.107. 位置参数
概述

<queue_name>

队列的名称

<queue_metadata>

队列元数据,队列的所有元数据都将被替换为 queue_metadata

表 51.108. 可选参数
概述

-h, --help

显示帮助信息并退出

51.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>

表 51.109. 位置参数
概述

<queue_name>

队列的名称

表 51.110. 可选参数
概述

-h, --help

显示帮助信息并退出

--paths <paths>

以逗号分隔的列表中允许的路径。选项: 消息、订阅、声明

--ttl-seconds <ttl_seconds>

签名过期前的时间长度(以秒为单位)

--methods <methods>

使用 作为逗号分隔列表的 HTTP 方法。选项:GET, HEAD, OPTIONS, POST, PUT, DELETE

表 51.111. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 51.112. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 51.113. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 51.114. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

51.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>

表 51.115. 位置参数
概述

<queue_name>

队列的名称

表 51.116. 可选参数
概述

-h, --help

显示帮助信息并退出

表 51.117. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 51.118. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 51.119. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 51.120. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

51.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>

表 51.121. 位置参数
概述

<queue_name>

要订阅的队列名称

<subscriber>

将通知的订阅者

<ttl>

订阅生存时间(以秒为单位)

表 51.122. 可选参数
概述

-h, --help

显示帮助信息并退出

--options <options>

json 格式的订阅元数据

表 51.123. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 51.124. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 51.125. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 51.126. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

51.29. 消息传递订阅删除

创建一个订阅:

使用方法:

openstack messaging subscription delete [-h]
                                               <queue_name> <subscription_id>

表 51.127. 位置参数
概述

<queue_name>

订阅队列的名称

<subscription_id>

订阅的 ID

表 51.128. 可选参数
概述

-h, --help

显示帮助信息并退出

51.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>

表 51.129. 位置参数
概述

<queue_name>

要订阅的队列名称

表 51.130. 可选参数
概述

-h, --help

显示帮助信息并退出

--marker <subscription_id>

订阅分页标记,前一页面的最后订阅 ID

--limit <limit>

页面大小限制,默认值为 20

表 51.131. 输出格式器
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 51.132. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

表 51.133. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 51.134. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

51.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>

表 51.135. 位置参数
概述

<queue_name>

要订阅的队列名称

<subscription_id>

订阅的 ID

表 51.136. 可选参数
概述

-h, --help

显示帮助信息并退出

表 51.137. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 51.138. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 51.139. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 51.140. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

51.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>

表 51.141. 位置参数
概述

<queue_name>

要订阅的队列名称

<subscription_id>

订阅的 ID

表 51.142. 可选参数
概述

-h, --help

显示帮助信息并退出

--subscriber <subscriber>

将通知的订阅者

--ttl <ttl>

订阅生存时间(以秒为单位)

--options <options>

json 格式的订阅元数据

表 51.143. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 51.144. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 51.145. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 51.146. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

第 52 章 metric

本章论述了 metric 命令下的命令。

52.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]

表 52.1. 位置参数
概述

操作

应用到时间序列的操作

search

用于过滤资源的查询。语法是属性、operator 和值的组合。例如: id=90d58eea-70d7-4294-a49a-170dcdf44c3c 将过滤带有特定 ID 的资源。可以构建更复杂的查询,例如: not (flavor_id!="1" 和 memory>=24)。使用 "" 强制将数据解释为字符串。支持的运算符包括:not 和 记录, PlacementBinding, >=, tc, !=, >, <, =, ==, eq, ne, lt, gt, ge, le, in, le, like, PREROUTING, detector, Bearer, in.

表 52.2. 可选参数
概述

-h, --help

显示帮助信息并退出

--resource-type RESOURCE_TYPE

要查询的资源类型

--start START

周期开始

--stop STOP

周期结束

--granularity GRANULARITY

要检索的粒度

--needed-overlap NEEDED_OVERLAP

数据点间重叠的百分比

--groupby GROUPBY

用于对资源进行分组的属性

--fill FILL

值在序列中缺少值的回填时间戳时使用。值应该是浮点值或 空值

表 52.3. 输出格式器
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 52.4. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

表 52.5. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 52.6. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

52.2. metric archive-policy create

创建归档策略。

使用方法:

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

表 52.7. 位置参数
概述

name

归档策略的名称

表 52.8. 可选参数
概述

-h, --help

显示帮助信息并退出

-d <DEFINITION>, --definition <DEFINITION>

归档策略定义的两个属性(由 ),其名称和值均用 分隔

-b BACK_WINDOW, --back-window BACK_WINDOW

归档策略的后窗口

-m AGGREGATION_METHODS, --aggregation-method AGGREGATION_METHODS

归档策略的聚合方法

表 52.9. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 52.10. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 52.11. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 52.12. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

52.3. metric archive-policy delete

删除归档策略。

使用方法:

openstack metric archive-policy delete [-h] name

表 52.13. 位置参数
概述

name

归档策略的名称

表 52.14. 可选参数
概述

-h, --help

显示帮助信息并退出

52.4. metric archive-policy 列表

列出归档策略。

使用方法:

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]

表 52.15. 可选参数
概述

-h, --help

显示帮助信息并退出

表 52.16. 输出格式器
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 52.17. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

表 52.18. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 52.19. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

52.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

表 52.20. 位置参数
概述

name

规则名称

表 52.21. 可选参数
概述

-h, --help

显示帮助信息并退出

-a ARCHIVE_POLICY_NAME, --archive-policy-name ARCHIVE_POLICY_NAME

归档策略名称

-m METRIC_PATTERN, --metric-pattern METRIC_PATTERN

要匹配的指标名称通配符

表 52.22. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 52.23. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 52.24. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 52.25. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

52.6. metric archive-policy-rule delete

删除归档策略规则。

使用方法:

openstack metric archive-policy-rule delete [-h] name

表 52.26. 位置参数
概述

name

归档策略规则的名称

表 52.27. 可选参数
概述

-h, --help

显示帮助信息并退出

52.7. metric archive-policy-rule 列表

列出归档策略规则。

使用方法:

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]

表 52.28. 可选参数
概述

-h, --help

显示帮助信息并退出

表 52.29. 输出格式器
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 52.30. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

表 52.31. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 52.32. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

52.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

表 52.33. 位置参数
概述

name

归档策略规则的名称

表 52.34. 可选参数
概述

-h, --help

显示帮助信息并退出

表 52.35. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 52.36. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 52.37. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 52.38. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

52.9. metric archive-policy 显示

显示归档策略。

使用方法:

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

表 52.39. 位置参数
概述

name

归档策略的名称

表 52.40. 可选参数
概述

-h, --help

显示帮助信息并退出

表 52.41. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 52.42. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 52.43. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 52.44. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

52.10. metric archive-policy 更新

更新归档策略。

使用方法:

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

表 52.45. 位置参数
概述

name

归档策略的名称

表 52.46. 可选参数
概述

-h, --help

显示帮助信息并退出

-d <DEFINITION>, --definition <DEFINITION>

归档策略定义的两个属性(由 ),其名称和值均用 分隔

表 52.47. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 52.48. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 52.49. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 52.50. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

52.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

表 52.51. 位置参数
概述

metric

指标的 ID 或名称

表 52.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

等待所有测量结果被处理

表 52.53. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 52.54. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 52.55. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 52.56. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

52.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

表 52.57. 位置参数
概述

metric

指标的 ID 或名称

表 52.58. 可选参数
概述

-h, --help

显示帮助信息并退出

--utc

将时间戳返回为 utc

--resource-id RESOURCE_ID, -r RESOURCE_ID

资源 ID

--aggregation AGGREGATION

用于检索的聚合

--start START

周期开始

--stop STOP

周期结束

--granularity GRANULARITY

要检索的粒度

--refresh

强制聚合所有已知的测量结果

--resample RESAMPLE

粒度将 resample 时间序列重新为 (以秒为单位)

--workers WORKERS, -w WORKERS

要使用的 worker 数量

--count COUNT, -n COUNT

要发送的总测量结果数

表 52.59. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 52.60. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 52.61. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 52.62. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

52.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]

表 52.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

保留创建的指标

表 52.64. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 52.65. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 52.66. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 52.67. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

52.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 ...]

表 52.68. 位置参数
概述

metric

指标的 ID 或名称

表 52.69. 可选参数
概述

-h, --help

显示帮助信息并退出

--resource-id RESOURCE_ID, -r RESOURCE_ID

资源 ID

--workers WORKERS, -w WORKERS

要使用的 worker 数量

--count COUNT, -n COUNT

要获取的指标数

表 52.70. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 52.71. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 52.72. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 52.73. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

52.15. 指标功能列表

列出功能。

使用方法:

openstack metric capabilities list [-h]
                                          [-f {json,shell,table,value,yaml}]
                                          [-c COLUMN] [--noindent]
                                          [--prefix PREFIX]
                                          [--max-width <integer>]
                                          [--fit-width] [--print-empty]

表 52.74. 可选参数
概述

-h, --help

显示帮助信息并退出

表 52.75. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 52.76. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 52.77. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 52.78. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

52.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]

表 52.79. 位置参数
概述

METRIC_NAME

指标的名称

表 52.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

指标的单位

表 52.81. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 52.82. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 52.83. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 52.84. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

52.17. metric delete

删除指标。

使用方法:

openstack metric delete [-h] [--resource-id RESOURCE_ID]
                               metric [metric ...]

表 52.85. 位置参数
概述

metric

指标的 ID 或名称

表 52.86. 可选参数
概述

-h, --help

显示帮助信息并退出

--resource-id RESOURCE_ID, -r RESOURCE_ID

资源 ID

52.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>]

表 52.87. 可选参数
概述

-h, --help

显示帮助信息并退出

--limit <LIMIT>

要返回的指标数(默认为 server default)

--marker <MARKER>

上一个列表的最后一个项。在此值后返回下一个结果

--sort <SORT>

指标属性排序(示例:user_id:desc- nullslast

表 52.88. 输出格式器
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 52.89. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

表 52.90. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 52.91. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

52.19. 指标测量结果添加

将测量添加到指标。

使用方法:

openstack metric measures add [-h] [--resource-id RESOURCE_ID] -m
                                     MEASURE
                                     metric

表 52.92. 位置参数
概述

metric

指标的 ID 或名称

表 52.93. 可选参数
概述

-h, --help

显示帮助信息并退出

--resource-id RESOURCE_ID, -r RESOURCE_ID

资源 ID

-m MEASURE, --measure MEASURE

使用 @分隔的测量结果的时间戳和值

52.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]

表 52.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 和 记录, PlacementBinding, >=, tc, !=, >, <, =, ==, eq, ne, lt, gt, ge, le, in, le, like, PREROUTING, detector, Bearer, in.

--resource-type RESOURCE_TYPE

要查询的资源类型

--groupby GROUPBY

用于对资源进行分组的属性

--refresh

强制聚合所有已知的测量结果

--resample RESAMPLE

粒度将 resample 时间序列重新为 (以秒为单位)

--fill FILL

值在序列中缺少值的回填时间戳时使用。值应该是浮点值或 空值

表 52.95. 输出格式器
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 52.96. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

表 52.97. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 52.98. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

52.21. 指标测量结果批处理指标

使用方法:

openstack metric measures batch-metrics [-h] file

表 52.99. 位置参数
概述

file

包含针对 stdin 测量或 - 为 stdin 测量的文件(请参见 Gnocchi REST API 文档,了解格式)

表 52.100. 可选参数
概述

-h, --help

显示帮助信息并退出

52.22. 指标测量结果批处理-resources-metrics

使用方法:

openstack metric measures batch-resources-metrics [-h]
                                                         [--create-metrics]
                                                         file

表 52.101. 位置参数
概述

file

包含针对 stdin 测量或 - 为 stdin 测量的文件(请参见 Gnocchi REST API 文档,了解格式)

表 52.102. 可选参数
概述

-h, --help

显示帮助信息并退出

--create-metrics

创建未知指标

52.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

表 52.103. 位置参数
概述

metric

指标的 ID 或名称

表 52.104. 可选参数
概述

-h, --help

显示帮助信息并退出

--utc

将时间戳返回为 utc

--resource-id RESOURCE_ID, -r RESOURCE_ID

资源 ID

--aggregation AGGREGATION

用于检索的聚合

--start START

周期开始

--stop STOP

周期结束

--granularity GRANULARITY

要检索的粒度

--refresh

强制聚合所有已知的测量结果

--resample RESAMPLE

粒度将 resample 时间序列重新为 (以秒为单位)

表 52.105. 输出格式器
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 52.106. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

表 52.107. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 52.108. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

52.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]

表 52.109. 位置参数
概述

METRIC_NAME

指标的名称

表 52.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

指标的单位

表 52.111. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 52.112. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 52.113. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 52.114. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

52.25. metric metric delete

deprecated:删除指标。

使用方法:

openstack metric metric delete [-h] [--resource-id RESOURCE_ID]
                                      metric [metric ...]

表 52.115. 位置参数
概述

metric

指标的 ID 或名称

表 52.116. 可选参数
概述

-h, --help

显示帮助信息并退出

--resource-id RESOURCE_ID, -r RESOURCE_ID

资源 ID

52.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>]

表 52.117. 可选参数
概述

-h, --help

显示帮助信息并退出

--limit <LIMIT>

要返回的指标数(默认为 server default)

--marker <MARKER>

上一个列表的最后一个项。在此值后返回下一个结果

--sort <SORT>

指标属性排序(示例:user_id:desc- nullslast

表 52.118. 输出格式器
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 52.119. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

表 52.120. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 52.121. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

52.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

表 52.122. 位置参数
概述

metric

指标的 ID 或名称

表 52.123. 可选参数
概述

-h, --help

显示帮助信息并退出

--resource-id RESOURCE_ID, -r RESOURCE_ID

资源 ID

表 52.124. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 52.125. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 52.126. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 52.127. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

52.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

表 52.128. 位置参数
概述

query

用于过滤资源的查询。语法是属性、operator 和值的组合。例如: id=90d58eea-70d7-4294-a49a-170dcdf44c3c 将过滤带有特定 ID 的资源。可以构建更复杂的查询,例如: not (flavor_id!="1" 和 memory>=24)。使用 "" 强制将数据解释为字符串。支持的运算符包括:not 和 记录, PlacementBinding, >=, tc, !=, >, <, =, ==, eq, ne, lt, gt, ge, le, in, le, like, PREROUTING, detector, Bearer, in.

表 52.129. 可选参数
概述

-h, --help

显示帮助信息并退出

--type RESOURCE_TYPE, -t RESOURCE_TYPE

资源类型

表 52.130. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 52.131. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 52.132. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 52.133. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

52.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

表 52.134. 位置参数
概述

resource_id

资源 ID

表 52.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

name:archive_policy_name

表 52.136. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 52.137. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 52.138. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 52.139. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

52.30. 指标资源删除

删除一个资源。

使用方法:

openstack metric resource delete [-h] resource_id

表 52.140. 位置参数
概述

resource_id

资源 ID

表 52.141. 可选参数
概述

-h, --help

显示帮助信息并退出

52.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

表 52.142. 位置参数
概述

resource_id

资源的 ID

表 52.143. 可选参数
概述

-h, --help

显示帮助信息并退出

--details

显示通用资源的所有属性

--limit <LIMIT>

要返回的资源数量(默认为 server default)

--marker <MARKER>

上一个列表的最后一个项。在此值后返回下一个结果

--sort <SORT>

资源属性排序(示例:user_id:desc- nullslast

--type RESOURCE_TYPE, -t RESOURCE_TYPE

资源类型

表 52.144. 输出格式器
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 52.145. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

表 52.146. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 52.147. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

52.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]

表 52.148. 可选参数
概述

-h, --help

显示帮助信息并退出

--details

显示通用资源的所有属性

--history

显示资源的历史记录

--limit <LIMIT>

要返回的资源数量(默认为 server default)

--marker <MARKER>

上一个列表的最后一个项。在此值后返回下一个结果

--sort <SORT>

资源属性排序(示例:user_id:desc- nullslast

--type RESOURCE_TYPE, -t RESOURCE_TYPE

资源类型

表 52.149. 输出格式器
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 52.150. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

表 52.151. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 52.152. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

52.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

表 52.159. 位置参数
概述

resource_id

资源的 ID

表 52.160. 可选参数
概述

-h, --help

显示帮助信息并退出

--type RESOURCE_TYPE, -t RESOURCE_TYPE

资源类型

表 52.161. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 52.162. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 52.163. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 52.164. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

52.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

表 52.165. 位置参数
概述

name

资源类型的名称

表 52.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:…​ 例如:display_name:string:true:max_length=255

表 52.167. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 52.168. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 52.169. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 52.170. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

52.36. metric resource-type delete

删除资源类型。

使用方法:

openstack metric resource-type delete [-h] name

表 52.171. 位置参数
概述

name

资源类型的名称

表 52.172. 可选参数
概述

-h, --help

显示帮助信息并退出

52.37. 指标 resource-type 列表

列出资源类型。

使用方法:

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]

表 52.173. 可选参数
概述

-h, --help

显示帮助信息并退出

表 52.174. 输出格式器
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 52.175. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

表 52.176. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 52.177. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

52.38. metric resource-type 显示

显示资源类型。

使用方法:

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

表 52.178. 位置参数
概述

name

资源类型的名称

表 52.179. 可选参数
概述

-h, --help

显示帮助信息并退出

表 52.180. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 52.181. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 52.182. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 52.183. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

52.39. 指标 resource-type 更新

创建资源类型。

使用方法:

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

表 52.184. 位置参数
概述

name

资源类型的名称

表 52.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:…​ 例如:display_name:string:true:max_length=255

-r REMOVE_ATTRIBUTE, --remove-attribute REMOVE_ATTRIBUTE

属性名称

表 52.186. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 52.187. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 52.188. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 52.189. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

52.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

表 52.190. 位置参数
概述

resource_id

资源 ID

表 52.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

name:archive_policy_name

-d DELETE_METRIC, --delete-metric DELETE_METRIC

要删除的指标的名称

表 52.192. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 52.193. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 52.194. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 52.195. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

52.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]

表 52.196. 可选参数
概述

-h, --help

显示帮助信息并退出

表 52.197. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 52.198. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 52.199. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 52.200. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

52.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

表 52.201. 位置参数
概述

metric

指标的 ID 或名称

表 52.202. 可选参数
概述

-h, --help

显示帮助信息并退出

--resource-id RESOURCE_ID, -r RESOURCE_ID

资源 ID

表 52.203. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 52.204. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 52.205. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 52.206. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

52.43. 指标状态

显示测量处理的状态。

使用方法:

openstack metric status [-h] [-f {json,shell,table,value,yaml}]
                               [-c COLUMN] [--noindent] [--prefix PREFIX]
                               [--max-width <integer>] [--fit-width]
                               [--print-empty]

表 52.207. 可选参数
概述

-h, --help

显示帮助信息并退出

表 52.208. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 52.209. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 52.210. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 52.211. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

第 53 章 module

本章论述了 模块 命令下的命令。

53.1. 模块列表

列出模块版本

使用方法:

openstack module list [-h] [-f {json,shell,table,value,yaml}]
                             [-c COLUMN] [--noindent] [--prefix PREFIX]
                             [--max-width <integer>] [--fit-width]
                             [--print-empty] [--all]

表 53.1. 可选参数
概述

-h, --help

显示帮助信息并退出

--all

显示有版本信息的所有模块

表 53.2. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 53.3. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 53.4. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 53.5. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

第 54 章 network

本章论述了 网络 命令下的命令。

54.1. 网络代理添加网络

将网络添加到代理

使用方法:

openstack network agent add network [-h] [--dhcp] <agent-id> <network>

表 54.1. 位置参数
概述

<agent-id>

添加网络的代理(仅协助)

<network>

要添加到代理的网络(名称或 ID)

表 54.2. 可选参数
概述

-h, --help

显示帮助信息并退出

--dhcp

将网络添加到 dhcp 代理

54.2. 网络代理添加路由器

向代理添加路由器

使用方法:

openstack network agent add router [-h] [--l3] <agent-id> <router>

表 54.3. 位置参数
概述

<agent-id>

添加路由器的代理(仅用于帮助)

<router>

要添加到代理的路由器(名称或 ID)

表 54.4. 可选参数
概述

-h, --help

显示帮助信息并退出

--l3

将路由器添加到 l3 代理

54.3. 网络代理删除

删除网络代理

使用方法:

openstack network agent delete [-h]
                                      <network-agent> [<network-agent> ...]

表 54.5. 位置参数
概述

<network-agent>

要删除的网络代理(仅限 ID)

表 54.6. 可选参数
概述

-h, --help

显示帮助信息并退出

54.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]

表 54.7. 可选参数
概述

-h, --help

显示帮助信息并退出

--agent-type <agent-type>

仅列出指定代理类型的代理。支持的代理类型为 bgp, dhcp, open-vswitch, linux-bridge, ofa, l3, loadbalancer, metering, metadata, macvtap, nic.

--host <host>

仅列出在指定主机上运行的代理

--network <network>

列出托管网络的代理(名称或 id)

--router <router>

列出托管此路由器的代理(名称或 id)

--long

列出输出中的其他字段

表 54.8. 输出格式器
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 54.9. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

表 54.10. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 54.11. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

54.5. 网络代理删除网络

从代理中删除网络。

使用方法:

openstack network agent remove network [-h] [--dhcp]
                                              <agent-id> <network>

表 54.12. 位置参数
概述

<agent-id>

移除网络的代理(仅限 ID)

<network>

要从代理中删除的网络(名称或 id)

表 54.13. 可选参数
概述

-h, --help

显示帮助信息并退出

--dhcp

从 dhcp 代理中删除网络

54.6. 网络代理删除路由器

从代理中删除路由器

使用方法:

openstack network agent remove router [-h] [--l3] <agent-id> <router>

表 54.14. 位置参数
概述

<agent-id>

从中删除路由器的代理(仅限 ID)

<router>

要从代理中删除的路由器(名称或 id)

表 54.15. 可选参数
概述

-h, --help

显示帮助信息并退出

--l3

从 l3 代理中删除路由器

54.7. 网络代理集

设置网络代理属性

使用方法:

openstack network agent set [-h] [--description <description>]
                                   [--enable | --disable]
                                   <network-agent>

表 54.16. 位置参数
概述

<network-agent>

要修改的网络代理(仅限 ID)

表 54.17. 可选参数
概述

-h, --help

显示帮助信息并退出

--description <description>

设置网络代理描述

--enable

启用网络代理

--disable

禁用网络代理

54.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>

表 54.18. 位置参数
概述

<network-agent>

要显示的网络代理(仅限 ID)

表 54.19. 可选参数
概述

-h, --help

显示帮助信息并退出

表 54.20. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 54.21. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 54.22. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 54.23. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

54.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]

表 54.24. 可选参数
概述

-h, --help

显示帮助信息并退出

--project <project>

返回给定项目的自动分配拓扑。默认值是当前项目

--project-domain <project-domain>

项目所属的域(名称或 id)。这可在项目名称之间有冲突时使用。

--check-resources

验证自动分配的拓扑要求。不返回拓扑。

--or-show

如果拓扑存在,则返回拓扑的信息(默认)

表 54.25. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 54.26. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 54.27. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 54.28. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

54.10. 网络自动分配拓扑删除

删除项目的自动分配拓扑

使用方法:

openstack network auto allocated topology delete [-h]
                                                        [--project <project>]
                                                        [--project-domain <project-domain>]

表 54.29. 可选参数
概述

-h, --help

显示帮助信息并退出

--project <project>

删除给定项目的自动分配拓扑。Default 是当前项目

--project-domain <project-domain>

项目所属的域(名称或 id)。这可在项目名称之间有冲突时使用。

54.11. Network create

创建新网络

使用方法:

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>

表 54.30. 位置参数
概述

<name>

新网络名称

表 54.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

使网络 vlan 透明

--no-transparent-vlan

不要使网络 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 或隧道 ID

--dns-domain <dns-domain>

为此网络设置 dns domain (需要 dns integration extension)

--tag <tag>

要添加到网络的标签(重复选项来设置多个标签)

--no-tag

没有与网络关联的标签

表 54.32. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 54.33. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 54.34. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 54.35. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

54.12. Network delete

删除网络

使用方法:

openstack network delete [-h] <network> [<network> ...]

表 54.36. 位置参数
概述

<network>

要删除的网络(名称或 ID)

表 54.37. 可选参数
概述

-h, --help

显示帮助信息并退出

54.13. Network flavor add 配置集

将服务配置集添加到网络类型

使用方法:

openstack network flavor add profile [-h] <flavor> <service-profile>

表 54.38. 位置参数
概述

<flavor>

网络类别(名称或 ID)

<service-profile>

服务配置文件(仅限id)

表 54.39. 可选参数
概述

-h, --help

显示帮助信息并退出

54.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>

表 54.40. 位置参数
概述

<name>

类别的名称

表 54.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

禁用类别

表 54.42. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 54.43. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 54.44. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 54.45. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

54.15. Network flavor delete

删除网络类型

使用方法:

openstack network flavor delete [-h] <flavor> [<flavor> ...]

表 54.46. 位置参数
概述

<flavor>

要删除的类别(名称或 ID)

表 54.47. 可选参数
概述

-h, --help

显示帮助信息并退出

54.16. Network flavor list

列出网络类型

使用方法:

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]

表 54.48. 可选参数
概述

-h, --help

显示帮助信息并退出

表 54.49. 输出格式器
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 54.50. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

表 54.51. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 54.52. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

54.17. Network flavor profile create

创建新网络类别配置集

使用方法:

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]

表 54.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 且反之亦然,则需要此参数

表 54.54. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 54.55. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 54.56. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 54.57. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

54.18. Network flavor profile delete

删除网络 flavor 配置集

使用方法:

openstack network flavor profile delete [-h]
                                               <flavor-profile>
                                               [<flavor-profile> ...]

表 54.58. 位置参数
概述

<flavor-profile>

要删除的 flavor 配置集(仅限id only)

表 54.59. 可选参数
概述

-h, --help

显示帮助信息并退出

54.19. Network flavor 配置集列表

列出网络类别配置集

使用方法:

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]

表 54.60. 可选参数
概述

-h, --help

显示帮助信息并退出

表 54.61. 输出格式器
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 54.62. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

表 54.63. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 54.64. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

54.20. 网络 flavor 配置集集

设置网络类别配置集属性

使用方法:

openstack network flavor profile set [-h]
                                            [--project-domain <project-domain>]
                                            [--description <description>]
                                            [--enable | --disable]
                                            [--driver DRIVER]
                                            [--metainfo METAINFO]
                                            <flavor-profile>

表 54.65. 位置参数
概述

<flavor-profile>

要更新的类别配置集(仅id only)

表 54.66. 可选参数
概述

-h, --help

显示帮助信息并退出

--project-domain <project-domain>

项目所属的域(名称或 id)。这可在项目名称之间有冲突时使用。

--description <description>

类别配置集的描述

--enable

启用 flavor 配置集

--disable

禁用 flavor 配置集

--driver DRIVER

到驱动程序的 Python 模块路径。如果缺少 --metainfo,这就会需要,反之亦然

--metainfo METAINFO

类别配置集的 metainfo。如果缺少 --driver 且反之亦然,则需要此参数

54.21. Network flavor profile show

显示网络 flavor 配置集详情

使用方法:

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>

表 54.67. 位置参数
概述

<flavor-profile>

要显示的 flavor 配置集(仅id only)

表 54.68. 可选参数
概述

-h, --help

显示帮助信息并退出

表 54.69. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 54.70. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 54.71. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 54.72. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

54.22. Network flavor remove 配置集

从网络类型中删除服务配置集

使用方法:

openstack network flavor remove profile [-h] <flavor> <service-profile>

表 54.73. 位置参数
概述

<flavor>

网络类别(名称或 ID)

<service-profile>

服务配置文件(仅限id)

表 54.74. 可选参数
概述

-h, --help

显示帮助信息并退出

54.23. 网络类别集

设置网络类别属性

使用方法:

openstack network flavor set [-h] [--description DESCRIPTION]
                                    [--disable | --enable] [--name <name>]
                                    <flavor>

表 54.75. 位置参数
概述

<flavor>

要更新的类别(名称或 id)

表 54.76. 可选参数
概述

-h, --help

显示帮助信息并退出

--description DESCRIPTION

设置网络类别描述

--disable

禁用网络类型

--enable

启用网络类型

--name <name>

设置类别名称

54.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>

表 54.77. 位置参数
概述

<flavor>

显示的类别(名称或 ID)

表 54.78. 可选参数
概述

-h, --help

显示帮助信息并退出

表 54.79. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 54.80. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 54.81. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 54.82. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

54.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>,...]]

表 54.83. 可选参数
概述

-h, --help

显示帮助信息并退出

--external

列出外部网络

--internal

列出内部网络

--long

列出输出中的其他字段

--name <name>

根据名称列出网络

--enable

列出已启用的网络

--disable

列出禁用的网络

--project <project>

根据其项目列出网络(名称或 ID)

--project-domain <project-domain>

项目所属的域(名称或 id)。这可在项目名称之间有冲突时使用。

--share

列出项目间共享的网络

--no-share

列出项目间不共享的网络

--status <status>

根据其状态列出网络(活动BUILDDOWNERROR)

--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 或 Tunnel ID 列出网络

--agent <agent-id>

列出代理托管的网络(仅限 ID)

--tags <tag>[,<tag>,…​]

列出具有所有给定标签(组合的标记列表)的网络。

--any-tags <tag>[,<tag>,…​]

列出具有任何给定标签(组合的标记列表)的网络。

--not-tags <tag>[,<tag>,…​]

排除具有所有给定标签(s) (comma- separated tags 列表)的网络。

--not-any-tags <tag>[,<tag>,…​]

排除具有任何给定标签(组合标签列表)的网络。

表 54.84. 输出格式器
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 54.85. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

表 54.86. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 54.87. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

54.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>

表 54.88. 位置参数
概述

<name>

网络日志的名称

表 54.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 选项的组合。

表 54.90. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 54.91. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 54.92. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 54.93. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

54.27. Network log delete

删除网络日志

使用方法:

openstack network log delete [-h] <network-log> [<network-log> ...]

表 54.94. 位置参数
概述

<network-log>

要删除的网络日志(名称或 ID)

表 54.95. 可选参数
概述

-h, --help

显示帮助信息并退出

54.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]

表 54.96. 可选参数
概述

-h, --help

显示帮助信息并退出

--long

列出输出中的其他字段

表 54.97. 输出格式器
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 54.98. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

表 54.99. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 54.100. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

54.29. 网络日志集

设置网络日志属性

使用方法:

openstack network log set [-h] [--description <description>]
                                 [--enable | --disable] [--name <name>]
                                 <network-log>

表 54.101. 位置参数
概述

<network-log>

要设置的网络日志(名称或 id)

表 54.102. 可选参数
概述

-h, --help

显示帮助信息并退出

--description <description>

网络日志的描述

--enable

启用此日志(默认为禁用)

--disable

禁用此日志

--name <name>

网络日志的名称

54.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>

表 54.103. 位置参数
概述

<network-log>

网络日志以显示(名称或 id)

表 54.104. 可选参数
概述

-h, --help

显示帮助信息并退出

表 54.105. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 54.106. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 54.107. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 54.108. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

54.31. 网络可日志的资源列表

列出支持的 loggable 资源

使用方法:

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]

表 54.109. 可选参数
概述

-h, --help

显示帮助信息并退出

--long

列出输出中的其他字段

表 54.110. 输出格式器
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 54.111. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

表 54.112. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 54.113. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

54.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>

表 54.114. 位置参数
概述

<name>

计量名称

表 54.115. 可选参数
概述

-h, --help

显示帮助信息并退出

--description <description>

为 meter 创建描述

--project <project>

所有者的项目(名称或 id)

--project-domain <project-domain>

项目所属的域(名称或 id)。这可在项目名称之间有冲突时使用。

--share

在项目间共享计量

--no-share

不要在项目间共享计量

表 54.116. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 54.117. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 54.118. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 54.119. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

54.33. 网络计量删除

删除网络计量

使用方法:

openstack network meter delete [-h] <meter> [<meter> ...]

表 54.120. 位置参数
概述

<meter>

要删除的计量(名称或 id)

表 54.121. 可选参数
概述

-h, --help

显示帮助信息并退出

54.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]

表 54.122. 可选参数
概述

-h, --help

显示帮助信息并退出

表 54.123. 输出格式器
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 54.124. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

表 54.125. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 54.126. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

54.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>

表 54.127. 位置参数
概述

<meter>

与此 metering 规则关联的标签(名称或 ID)

表 54.128. 可选参数
概述

-h, --help

显示帮助信息并退出

--project <project>

所有者的项目(名称或 id)

--project-domain <project-domain>

项目所属的域(名称或 id)。这可在项目名称之间有冲突时使用。

--exclude

从流量数中排除远程 ip 前缀

--include

包括来自流量数的远程 ip 前缀(默认)

--ingress

将规则应用到传入流量(默认)

--egress

将规则应用到传出流量

--remote-ip-prefix <remote-ip-prefix>

与这个规则关联的远程 ip 前缀

表 54.129. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 54.130. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 54.131. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 54.132. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

54.36. 网络计量规则删除

删除计量规则

使用方法:

openstack network meter rule delete [-h]
                                           <meter-rule-id>
                                           [<meter-rule-id> ...]

表 54.133. 位置参数
概述

<meter-rule-id>

要删除的计量规则(仅限 ID)

表 54.134. 可选参数
概述

-h, --help

显示帮助信息并退出

54.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]

表 54.135. 可选参数
概述

-h, --help

显示帮助信息并退出

表 54.136. 输出格式器
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 54.137. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

表 54.138. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 54.139. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

54.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>

表 54.140. 位置参数
概述

<meter-rule-id>

计量规则(仅限 ID)

表 54.141. 可选参数
概述

-h, --help

显示帮助信息并退出

表 54.142. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 54.143. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 54.144. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 54.145. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

54.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>

表 54.146. 位置参数
概述

<meter>

要显示的计量(名称或 id)

表 54.147. 可选参数
概述

-h, --help

显示帮助信息并退出

表 54.148. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 54.149. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 54.150. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 54.151. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

54.40. 网络板子网

将网络子网注册到子网池中

使用方法:

openstack network onboard subnets [-h] <network> <subnetpool>

表 54.152. 位置参数
概述

<network>

在加入与此网络关联的所有子网

<subnetpool>

用于加入子网的目标子网池

表 54.153. 可选参数
概述

-h, --help

显示帮助信息并退出

54.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>

表 54.154. 位置参数
概述

<name>

要创建的 qos 策略的名称

表 54.155. 可选参数
概述

-h, --help

显示帮助信息并退出

--description <description>

qos 策略的描述

--share

使 qos 策略可供其他项目访问

--no-share

使 qos 策略不能被其他项目访问(默认)

--project <project>

所有者的项目(名称或 id)

--project-domain <project-domain>

项目所属的域(名称或 id)。这可在项目名称之间有冲突时使用。

--default

将它设置为默认网络 qos 策略

--no-default

将它设置为非默认网络 qos 策略

表 54.156. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 54.157. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 54.158. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 54.159. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

54.42. Network qos policy delete

删除 Qos 策略

使用方法:

openstack network qos policy delete [-h]
                                           <qos-policy> [<qos-policy> ...]

表 54.160. 位置参数
概述

<qos-policy>

要删除的 QoS 策略(名称或 ID)

表 54.161. 可选参数
概述

-h, --help

显示帮助信息并退出

54.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]

表 54.162. 可选参数
概述

-h, --help

显示帮助信息并退出

--project <project>

根据项目(名称或 ID)列出 qos 策略

--project-domain <project-domain>

项目所属的域(名称或 id)。这可在项目名称之间有冲突时使用。

--share

列出项目之间共享的 qos 策略

--no-share

列出不在项目之间共享的 qos 策略

表 54.163. 输出格式器
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 54.164. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

表 54.165. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 54.166. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

54.44. 网络 qos 策略集

设置 QoS 策略属性

使用方法:

openstack network qos policy set [-h] [--name <name>]
                                        [--description <description>]
                                        [--share | --no-share]
                                        [--default | --no-default]
                                        <qos-policy>

表 54.167. 位置参数
概述

<qos-policy>

要修改的 QoS 策略(名称或 id)

表 54.168. 可选参数
概述

-h, --help

显示帮助信息并退出

--name <name>

设置 qos 策略名称

--description <description>

qos 策略的描述

--share

使 qos 策略可供其他项目访问

--no-share

使 qos 策略不能被其他项目访问

--default

将它设置为默认网络 qos 策略

--no-default

将它设置为非默认网络 qos 策略

54.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>

表 54.169. 位置参数
概述

<qos-policy>

显示的 QoS 策略(名称或 id)

表 54.170. 可选参数
概述

-h, --help

显示帮助信息并退出

表 54.171. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 54.172. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 54.173. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 54.174. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

54.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>

表 54.175. 位置参数
概述

<qos-policy>

包含规则(名称或 ID)的 QoS 策略

表 54.176. 可选参数
概述

-h, --help

显示帮助信息并退出

--type <type>

QoS 规则类型(最小带宽、dscp-marking、bandwidth-limit)

--max-kbps <max-kbps>

kbps 的最大带宽

--max-burst-kbits <max-burst-kbits>

kilobits、0 或没有指定的最大突发意味着自动表示自动,即带宽限制的 80%,用于典型的 TCP 流量。有关检查 QoS 用户工作流的详情。

--dscp-mark <dscp-mark>

DSCP 标记:值可以是 0,甚至来自 8-56,不包括 42、44、50、52 和 54

--min-kbps <min-kbps>

kbps 中最低保证带宽

--ingress

项目视角的入站流量方向

--egress

从项目的角度显示出口流量方向

表 54.177. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 54.178. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 54.179. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 54.180. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

54.47. Network qos rule delete

删除网络 QoS 规则

使用方法:

openstack network qos rule delete [-h] <qos-policy> <rule-id>

表 54.181. 位置参数
概述

<qos-policy>

包含规则(名称或 ID)的 QoS 策略

<rule-id>

要删除的网络 qos 规则(id)

表 54.182. 可选参数
概述

-h, --help

显示帮助信息并退出

54.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>

表 54.183. 位置参数
概述

<qos-policy>

包含规则(名称或 ID)的 QoS 策略

表 54.184. 可选参数
概述

-h, --help

显示帮助信息并退出

表 54.185. 输出格式器
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 54.186. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

表 54.187. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 54.188. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

54.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>

表 54.189. 位置参数
概述

<qos-policy>

包含规则(名称或 ID)的 QoS 策略

<rule-id>

要删除的网络 qos 规则(id)

表 54.190. 可选参数
概述

-h, --help

显示帮助信息并退出

--max-kbps <max-kbps>

kbps 的最大带宽

--max-burst-kbits <max-burst-kbits>

kilobits、0 或没有指定的最大突发意味着自动表示自动,即带宽限制的 80%,用于典型的 TCP 流量。有关检查 QoS 用户工作流的详情。

--dscp-mark <dscp-mark>

DSCP 标记:值可以是 0,甚至来自 8-56,不包括 42、44、50、52 和 54

--min-kbps <min-kbps>

kbps 中最低保证带宽

--ingress

项目视角的入站流量方向

--egress

从项目的角度显示出口流量方向

54.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>

表 54.191. 位置参数
概述

<qos-policy>

包含规则(名称或 ID)的 QoS 策略

<rule-id>

要删除的网络 qos 规则(id)

表 54.192. 可选参数
概述

-h, --help

显示帮助信息并退出

表 54.193. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 54.194. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 54.195. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 54.196. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

54.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]

表 54.197. 可选参数
概述

-h, --help

显示帮助信息并退出

表 54.198. 输出格式器
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 54.199. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

表 54.200. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 54.201. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

54.52. 网络 qos 规则类型显示

显示支持的 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>

表 54.202. 位置参数
概述

<qos-rule-type-name>

qos 规则类型的名称

表 54.203. 可选参数
概述

-h, --help

显示帮助信息并退出

表 54.204. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 54.205. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 54.206. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 54.207. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

54.53. 网络 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>

表 54.208. 位置参数
概述

<rbac-object>

此 rbac 策略影响的对象(名称或 ID)

表 54.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)。这可在项目名称之间有冲突时使用。

表 54.210. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 54.211. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 54.212. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 54.213. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

54.54. 网络 rbac 删除

删除网络 RBAC 策略

使用方法:

openstack network rbac delete [-h] <rbac-policy> [<rbac-policy> ...]

表 54.214. 位置参数
概述

<rbac-policy>

要删除的 RBAC 策略(仅限 ID)

表 54.215. 可选参数
概述

-h, --help

显示帮助信息并退出

54.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]

表 54.216. 可选参数
概述

-h, --help

显示帮助信息并退出

--type <type>

根据给定对象类型("security_group", "qos_policy" 或 "network")列出网络 rbac 策略。

--action <action>

根据给定操作("access_as_external"或 "access_as_shared" 列出网络 rbac 策略)

--long

列出输出中的其他字段

表 54.217. 输出格式器
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 54.218. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

表 54.219. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 54.220. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

54.56. 网络 rbac 设置

设置网络 RBAC 策略属性

使用方法:

openstack network rbac set [-h] [--target-project <target-project>]
                                  [--target-project-domain <target-project-domain>]
                                  <rbac-policy>

表 54.221. 位置参数
概述

<rbac-policy>

要修改的 RBAC 策略(仅限id)

表 54.222. 可选参数
概述

-h, --help

显示帮助信息并退出

--target-project <target-project>

将实施 rbac 策略的项目(名称或 ID)

--target-project-domain <target-project-domain>

目标主机所属的域(名称或 ID)。这可在项目名称之间发生冲突时使用。

54.57. 网络 rbac 显示

显示网络 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>

表 54.223. 位置参数
概述

<rbac-policy>

RBAC 策略(仅限 ID)

表 54.224. 可选参数
概述

-h, --help

显示帮助信息并退出

表 54.225. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 54.226. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 54.227. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 54.228. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

54.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>

表 54.229. 位置参数
概述

<name>

新网络片段名称

表 54.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)

表 54.231. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 54.232. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 54.233. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 54.234. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

54.59. Network segment delete

删除网络段

使用方法:

openstack network segment delete [-h]
                                        <network-segment>
                                        [<network-segment> ...]

表 54.235. 位置参数
概述

<network-segment>

要删除的网络段(名称或 ID)

表 54.236. 可选参数
概述

-h, --help

显示帮助信息并退出

54.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>]

表 54.237. 可选参数
概述

-h, --help

显示帮助信息并退出

--long

列出输出中的其他字段

--network <network>

列出属于此网络的网络段(名称或 ID)

表 54.238. 输出格式器
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 54.239. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

表 54.240. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 54.241. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

54.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>

表 54.242. 位置参数
概述

<name>

新网络片段范围的名称

表 54.243. 可选参数
概述

-h, --help

显示帮助信息并退出

--private

网络网段范围专门用于分配给项目

--shared

网络网段范围与其他项目共享

--project <project>

网络网段范围所有者(name 或 id)。在共享网段范围时是可选的

--project-domain <project-domain>

项目所属的域(名称或 id)。这可在项目名称之间有冲突时使用。

--network-type <network-type>

此网络段范围的网络类型(geneve、gre、vlan 或 vxlan)

--physical-network <physical-network-name>

此网络段范围的物理网络名称

--minimum <minimum-segmentation-id>

此网络段范围的最低片段标识符基于网络类型,VLAN ID 用于 vlan 网络类型,以及 geneve、gre 和 vxlan 网络类型的隧道 ID

--maximum <maximum-segmentation-id>

此网络段范围的最大片段标识符,它基于网络类型,VLAN ID 用于 vlan 网络类型,以及 geneve、gre 和 vxlan 网络类型的隧道 ID

表 54.244. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 54.245. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 54.246. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 54.247. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

54.62. 网络网段范围删除

删除网络段范围

使用方法:

openstack network segment range delete [-h]
                                              <network-segment-range>
                                              [<network-segment-range> ...]

表 54.248. 位置参数
概述

<network-segment-range>

要删除的网络段范围(名称或 ID)

表 54.249. 可选参数
概述

-h, --help

显示帮助信息并退出

54.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]

表 54.250. 可选参数
概述

-h, --help

显示帮助信息并退出

--long

列出输出中的其他字段

--used

列出使用中有片段的网络片段范围

--unused

列出没有使用片段的网络片段范围

--available

列出可用片段的网络片段范围

--unavailable

列出网络段范围,但不可用片段

表 54.251. 输出格式器
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 54.252. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

表 54.253. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 54.254. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

54.64. 网络片段设置

设置网络片段范围属性

使用方法:

openstack network segment range set [-h] [--name <name>]
                                           [--minimum <minimum-segmentation-id>]
                                           [--maximum <maximum-segmentation-id>]
                                           <network-segment-range>

表 54.255. 位置参数
概述

<network-segment-range>

要修改的网络段范围(name 或 id)

表 54.256. 可选参数
概述

-h, --help

显示帮助信息并退出

--name <name>

设置网络片段名称

--minimum <minimum-segmentation-id>

设置网络网段范围最小片段标识符

--maximum <maximum-segmentation-id>

设置网络网段范围最大片段标识符

54.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>

表 54.257. 位置参数
概述

<network-segment-range>

要显示的网络段范围(name 或 id)

表 54.258. 可选参数
概述

-h, --help

显示帮助信息并退出

表 54.259. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 54.260. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 54.261. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 54.262. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

54.66. 网络片段设置

设置网络片段属性

使用方法:

openstack network segment set [-h] [--description <description>]
                                     [--name <name>]
                                     <network-segment>

表 54.263. 位置参数
概述

<network-segment>

要修改的网络段(名称或 id)

表 54.264. 可选参数
概述

-h, --help

显示帮助信息并退出

--description <description>

设置网络片段描述

--name <name>

设置网络片段名称

54.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>

表 54.265. 位置参数
概述

<network-segment>

要显示的网络片段(名称或 id)

表 54.266. 可选参数
概述

-h, --help

显示帮助信息并退出

表 54.267. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 54.268. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 54.269. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 54.270. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

54.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]

表 54.271. 可选参数
概述

-h, --help

显示帮助信息并退出

表 54.272. 输出格式器
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 54.273. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

表 54.274. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 54.275. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

54.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>

表 54.276. 位置参数
概述

<network>

要修改的网络(名称或 id)

表 54.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 或隧道 ID

--dns-domain <dns-domain>

为此网络设置 dns domain (需要 dns integration extension)

54.70. 网络显示

显示网络详情

使用方法:

openstack network show [-h] [-f {json,shell,table,value,yaml}]
                              [-c COLUMN] [--noindent] [--prefix PREFIX]
                              [--max-width <integer>] [--fit-width]
                              [--print-empty]
                              <network>

表 54.278. 位置参数
概述

<network>

要显示的网络(名称或 id)

表 54.279. 可选参数
概述

-h, --help

显示帮助信息并退出

表 54.280. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 54.281. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 54.282. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 54.283. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

54.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>

表 54.284. 可选参数
概述

-h, --help

显示帮助信息并退出

--trunk <trunk>

列出属于这个中继的子端口(名称或 id)

表 54.285. 输出格式器
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 54.286. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

表 54.287. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 54.288. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

54.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>

表 54.289. 位置参数
概述

<name>

要创建的中继的名称

表 54.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)。这可在项目名称之间有冲突时使用。

表 54.291. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 54.292. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 54.293. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 54.294. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

54.73. 网络中继删除

删除给定网络中继

使用方法:

openstack network trunk delete [-h] <trunk> [<trunk> ...]

表 54.295. 位置参数
概述

<trunk>

要删除的中继(名称或 ID)

表 54.296. 可选参数
概述

-h, --help

显示帮助信息并退出

54.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]

表 54.297. 可选参数
概述

-h, --help

显示帮助信息并退出

--long

列出输出中的其他字段

表 54.298. 输出格式器
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 54.299. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

表 54.300. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 54.301. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

54.75. 网络中继集

设置网络中继属性

使用方法:

openstack network trunk set [-h] [--name <name>]
                                   [--description <description>]
                                   [--subport <port=,segmentation-type=,segmentation-id=>]
                                   [--enable | --disable]
                                   <trunk>

表 54.302. 位置参数
概述

<trunk>

中继以修改(名称或 ID)

表 54.303. 可选参数
概述

-h, --help

显示帮助信息并退出

--name <name>

设置中继名称

--description <description>

中继的描述

--subport <port=,segmentation-type=,segmentation-id⇒

要添加的 Subport。子端口格式为 port=<name 或 ID>,segmentation-type=,segmentation-ID=(--subport)选项可以重复

--enable

启用中继

--disable

禁用中继

54.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>

表 54.304. 位置参数
概述

<trunk>

显示中继(名称或 id)

表 54.305. 可选参数
概述

-h, --help

显示帮助信息并退出

表 54.306. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 54.307. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 54.308. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 54.309. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

54.77. 网络中继未设置

从给定网络中继中取消设置子端口

使用方法:

openstack network trunk unset [-h] --subport <subport> <trunk>

表 54.310. 位置参数
概述

<trunk>

取消此中继的子端口(名称或 ID)

表 54.311. 可选参数
概述

-h, --help

显示帮助信息并退出

--subport <subport>

要删除的子端口(端口的名称或 id)(--subport)选项可以重复

54.78. 网络取消设置

取消设置网络属性

使用方法:

openstack network unset [-h] [--tag <tag> | --all-tag] <network>

表 54.312. 位置参数
概述

<network>

要修改的网络(名称或 id)

表 54.313. 可选参数
概述

-h, --help

显示帮助信息并退出

--tag <tag>

要从网络中删除标签(重复选项以删除多个标签)

--all-tag

清除与网络关联的所有标签

第 55 章 对象

本章论述了 对象 命令下的命令。

55.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> ...]

表 55.1. 位置参数
概述

<Container>

容器用于新对象

<filename>

要上传的本地文件名

表 55.2. 可选参数
概述

-h, --help

显示帮助信息并退出

--name <name>

上传文件并将其重命名。只能在上传单个对象时使用。

表 55.3. 输出格式器
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 55.4. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

表 55.5. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 55.6. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

55.2. 对象删除

从容器中删除对象

使用方法:

openstack object delete [-h] <container> <object> [<object> ...]

表 55.7. 位置参数
概述

<Container>

从 <container> 中删除对象

<object>

要删除的对象

表 55.8. 可选参数
概述

-h, --help

显示帮助信息并退出

55.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>

表 55.9. 位置参数
概述

<Container>

容器列表

表 55.10. 可选参数
概述

-h, --help

显示帮助信息并退出

--prefix <prefix>

使用 <prefix> 过滤列表

--delimiter <delimiter>

使用 <delimiter> 滚动项目

--marker <marker>

用于分页的定位符

--end-marker <end-marker>

结束用于分页的定位符

--limit <num-objects>

限制返回的对象数量

--long

列出输出中的其他字段

--all

列出容器中的所有对象(默认为 10000)

表 55.11. 输出格式器
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 55.12. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

表 55.13. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 55.14. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

55.4. 对象保存

本地保存对象

使用方法:

openstack object save [-h] [--file <filename>] <container> <object>

表 55.15. 位置参数
概述

<Container>

从 <container> 下载 <object>

<object>

要保存的对象

表 55.16. 可选参数
概述

-h, --help

显示帮助信息并退出

--file <filename>

目标文件名(默认为对象名称);使用 - 作为文件名将打印文件到 stdout

55.5. 对象集

设置对象属性

使用方法:

openstack object set [-h] --property <key=value> <container> <object>

表 55.17. 位置参数
概述

<Container>

从 <container> 修改 <object>

<object>

要修改的对象

表 55.18. 可选参数
概述

-h, --help

显示帮助信息并退出

--property <key=value>

在此对象上设置属性(重复选项以设置多个属性)

55.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>

表 55.19. 位置参数
概述

<Container>

显示来自 <container> 的 <object>

<object>

要显示的对象

表 55.20. 可选参数
概述

-h, --help

显示帮助信息并退出

表 55.21. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 55.22. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 55.23. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 55.24. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

55.7. 对象存储帐户集

设置帐户属性

使用方法:

openstack object store account set [-h] --property <key=value>

表 55.25. 可选参数
概述

-h, --help

显示帮助信息并退出

--property <key=value>

在此帐户上设置属性(重复选项以设置多个属性)

55.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]

表 55.26. 可选参数
概述

-h, --help

显示帮助信息并退出

表 55.27. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 55.28. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 55.29. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 55.30. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

55.9. 对象存储帐户取消设置

取消设置帐户属性

使用方法:

openstack object store account unset [-h] --property <key>

表 55.31. 可选参数
概述

-h, --help

显示帮助信息并退出

--property <key>

要从帐户中删除的属性(删除多个属性的重复选项)

55.10. 对象未设置

取消设置对象属性

使用方法:

openstack object unset [-h] --property <key> <container> <object>

表 55.32. 位置参数
概述

<Container>

从 <container> 修改 <object>

<object>

要修改的对象

表 55.33. 可选参数
概述

-h, --help

显示帮助信息并退出

--property <key>

要从对象中删除的属性(用于移除多个属性的重复选项)

第 56 章 编配

本章论述了 orchestration 命令下的命令。

56.1. 编配构建信息

检索构建信息。

使用方法:

openstack orchestration build info [-h]
                                          [-f {json,shell,table,value,yaml}]
                                          [-c COLUMN] [--noindent]
                                          [--prefix PREFIX]
                                          [--max-width <integer>]
                                          [--fit-width] [--print-empty]

表 56.1. 可选参数
概述

-h, --help

显示帮助信息并退出

表 56.2. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 56.3. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 56.4. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 56.5. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

56.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]

表 56.6. 可选参数
概述

-h, --help

显示帮助信息并退出

--filter <key=value>

过滤要在返回的资源类型上应用的参数。这可以多次指定。它可以是任何名称、版本或 support_status

--long

显示资源类型,以及每种资源类型对应的描述。

表 56.7. 输出格式器
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 56.8. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

表 56.9. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 56.10. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

56.3. orchestration 资源类型显示

显示资源类型的详细信息,并选择性地生成模板。

使用方法:

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>

表 56.11. 位置参数
概述

<resource-type>

资源类型以显示详细信息

表 56.12. 可选参数
概述

-h, --help

显示帮助信息并退出

--template-type <template-type>

生成、热或 cfn 的可选模板类型

--long

显示资源类型及对应的描述。

表 56.13. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 yaml

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 56.14. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 56.15. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 56.16. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

56.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]

表 56.17. 可选参数
概述

-h, --help

显示帮助信息并退出

表 56.18. 输出格式器
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 56.19. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

表 56.20. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 56.21. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

56.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>

表 56.22. 位置参数
概述

<template-version>

用于获取功能的模板版本

表 56.23. 可选参数
概述

-h, --help

显示帮助信息并退出

--with_conditions

显示模板的条件功能。

表 56.24. 输出格式器
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 56.25. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

表 56.26. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 56.27. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

56.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>

表 56.28. 可选参数
概述

-h, --help

显示帮助信息并退出

-e <environment>, --environment <environment>

到环境的路径。可以多次指定。

--show-nested

也从嵌套模板解析参数

--parameter <key=value>

用于创建堆栈的参数值。这可以多次指定

--ignore-errors <error1,error2,…​>

要忽略的 heat 错误列表

-t <template>, --template <template>

模板的路径

表 56.29. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 yaml

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 56.30. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 56.31. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 56.32. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

56.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]

表 56.33. 可选参数
概述

-h, --help

显示帮助信息并退出

表 56.34. 输出格式器
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 56.35. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

表 56.36. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 56.37. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

第 57 章 overcloud

本章论述了 overcloud 命令下的命令。

57.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]

表 57.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 端口变为活动状态的超时。

57.2. 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]
                                       <cell name>

表 57.2. 位置参数
概述

<cell name>

用于额外单元的堆栈名称。

表 57.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 → 多个计算堆栈

--output-file <output file>, -o <output file>

单元数据导出的输出文件的名称。它默认为 "<name>.yaml"。

--config-download-dir CONFIG_DOWNLOAD_DIR

搜索 config-download 导出数据的目录。默认为 $HOME/config-download

--force-overwrite, -f

如果输出文件存在,则覆盖输出文件。

57.3. Overcloud 配置下载

下载 Overcloud 配置

使用方法:

openstack overcloud config download [-h] [--name NAME]
                                           [--config-dir CONFIG_DIR]
                                           [--config-type CONFIG_TYPE]
                                           [--no-preserve-config]

表 57.4. 可选参数
概述

-h, --help

显示帮助信息并退出

--name NAME

计划的名称,用于对象存储容器、工作流环境和编排堆栈名称。

--config-dir CONFIG_DIR

将推送配置文件的目录

--config-type CONFIG_TYPE

要从部署中提取的对象配置类型,默认为所有可用的键

--no-preserve-config

如果指定,将删除并重新创建 --config- dir (如果已存在)。默认为使用现有 dir 位置并覆盖文件。默认情况下,--config-dir 中的文件不会保留堆栈中的文件。

57.4. 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>]

表 57.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 构建目录>

TripleO 容器构建目录,为每个镜像存储配置和日志及其依赖项。

57.5. overcloud 容器镜像准备

生成定义镜像、标签和注册表的文件。

使用方法:

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]

表 57.6. 可选参数
概述

-h, --help

显示帮助信息并退出

--template-file <yaml 模板文件>

构建镜像配置文件的 YAML 模板文件。Default: /usr/share/tripleo-common/container- images/overcloud_containers.yaml.j2

--push-destination <location>

要将镜像推送到的镜像 registry 的位置。如果指定,将为每个镜像条目设置 push_destination。

--tag <tag>

覆盖默认标签替换。如果指定了 --tag-from- 标签,则使用该标签开始发现。默认: 16.1

--tag-from-label <image label>

使用指定标签的值来发现标签。标签可以以模板格式合并,例如: {version}-{release}

--namespace <namespace>

覆盖默认命名空间替换。默认值:registry.redhat.io/rhosp-rhel8

--prefix <prefix>

覆盖默认名称前缀替换。默认:openstack-

--suffix <suffix>

覆盖默认名称后缀替换。默认:

--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>

自动添加到更新命令的环境文件。条目将过滤为仅包含容器化服务使用的镜像。可以多次指定。目录中的文件以升序载入。

--output-env-file <file path>

用于编写 heat 环境文件的文件,该文件指定了所有镜像参数。所有现有文件都会被覆盖。

--roles-file ROLES_FILE, -r ROLES_FILE

角色文件覆盖了用于部署的 t-h-t 模板目录中的默认 roles_data.yaml。可以是绝对路径,也可以是相对于 templates dir 的路径。

--modify-role MODIFY_ROLE

每个镜像上传拉取和推送之间的 ansible 角色名称。

--modify-vars MODIFY_VARS

Ansible 变量文件包含调用角色 --modify-role 时要使用的变量。

57.6. overcloud 容器镜像标签发现

发现镜像的 versioned 标签。

使用方法:

openstack overcloud container image tag discover [-h] --image
                                                        <container image>
                                                        [--tag-from-label <image label>]

表 57.7. 可选参数
概述

-h, --help

显示帮助信息并退出

--image <container image>

要发现标签的镜像的完全限定名称(排除 registry 和 stable 标签)。

--tag-from-label <image label>

使用指定标签的值来发现标签。标签可以以模板格式合并,例如: {version}-{release}

57.7. overcloud 容器镜像上传

将 overcloud 容器镜像推送到注册表。

使用方法:

openstack overcloud container image upload [-h] --config-file <yaml
                                                  config file>
                                                  [--cleanup <full, partial, none>]

表 57.8. 可选参数
概述

-h, --help

显示帮助信息并退出

--config-file <yaml config file>

指定镜像构建的 YAML 配置文件可多次指定。顺序将被保留,之后的文件将覆盖之前文件中的一些选项。其他选项将附加。

--cleanup <full, partial, none>

上传后左侧的本地镜像的清理行为。默认 将尝试删除所有本地镜像。部分 将保留在此主机上部署所需的镜像。none 不会执行清理。

57.8. Overcloud 凭证

创建 overcloudrc 文件

使用方法:

openstack overcloud credentials [-h] [--directory [DIRECTORY]] plan

表 57.9. 位置参数
概述

plan

您要为其创建 rc 文件的目录名称。

表 57.10. 可选参数
概述

-h, --help

显示帮助信息并退出

--directory [DIRECTORY]

创建 rc 文件的目录。默认为当前目录。

57.9. overcloud 删除

删除 overcloud 堆栈和计划

使用方法:

openstack overcloud delete [-h] [-y] [-s] [stack]

表 57.11. 位置参数
概述

堆栈

要删除的 heat 堆栈的名称或 id (默认=env: OVERCLOUD_STACK_NAME)

表 57.12. 可选参数
概述

-h, --help

显示帮助信息并退出

-Y, --yes

跳过 yes/no 提示符(假设是)。

-s, --skip-ipa-cleanup

跳过从 FreeIPA 中删除 overcloud 主机、服务和 dns 记录。这对使用来自 FreeIPA 的 TLS 的证书进行部署尤为重要。默认情况下,在删除 overcloud 之前,overcloud 主机、服务和 DNS 记录将从 FreeIPA 中删除。使用此选项可能需要在以后手动清理 FreeIPA。

57.10. 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]

表 57.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 存储节点的 Nova 类别(DEPRECATED.使用环境文件并设置参数 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- 下载时要用于保存输出的目录。该目录必须可由 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>

描述 baremetal 部署的配置文件

--limit LIMIT

标识将限制 config-download Ansible playbook 执行的节点的逗号分隔列表或逗号分隔的字符串。例如:--limit "compute-0,compute-1,compute-5"。

--tags TAGS

运行 config-download ansible-playbook 命令时要使用的标签列表。

--skip-tags SKIP_TAGS

运行 config- 下载 ansible-playbook 命令时要跳过的标签列表。

57.11. Overcloud 执行

在服务器上执行 Heat 软件配置。

使用方法:

openstack overcloud execute [-h] [-s SERVER_NAME] [-g GROUP] file_in

表 57.14. 位置参数
概述

file_in

None

表 57.15. 可选参数
概述

-h, --help

显示帮助信息并退出

-s SERVER_NAME, --server_name SERVER_NAME

要匹配的 Nova server_name 或部分名称。

-g GROUP, --group GROUP

Heat 软件配置"group"类型。默认为"script"。

57.12. 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]

表 57.16. 可选参数
概述

-h, --help

显示帮助信息并退出

--stack <stack>

要从中导出 ceph 信息的 overcloud 堆栈的名称。如果传递以逗号分隔的堆栈列表,则所有堆栈的 Ceph 信息将导出到一个文件。(默认值=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

57.13. overcloud 导出

导出用作另一个堆栈导入的堆栈信息

使用方法:

openstack overcloud export [-h] [--stack <stack>]
                                  [--output-file <output file>]
                                  [--force-overwrite]
                                  [--config-download-dir CONFIG_DOWNLOAD_DIR]
                                  [--no-password-excludes]

表 57.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,其中某些密码将被排除在通常不需要的情况下。

57.14. overcloud external-update 运行

运行外部次要更新 Ansible playbook,这将运行外部次要更新 Ansible playbook,并从 undercloud 执行任务。更新 playbook 在完成 overcloud 更新准备 命令后可用。

使用方法:

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]

表 57.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

直接通过 system 命令运行 ansible-playbook,而不是通过 TripleO mistral 工作流运行 Ansible。

-Y, --yes

使用 -y 或 --yes 跳过任何升级操作前所需的确认。请谨慎使用这个选项!

--limit LIMIT

标识将限制 config-download Ansible playbook 执行的节点的逗号分隔列表或逗号分隔的字符串。例如:--limit "compute-0,compute-1,compute-5"。

57.15. overcloud external-upgrade 运行

运行外部主要升级 Ansible playbook,这将运行外部主要升级 Ansible playbook,并从 undercloud 执行任务。升级 playbook 在完成 overcloud 升级准备命令后可用。

使用方法:

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]

表 57.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

直接通过 system 命令运行 ansible-playbook,而不是通过 TripleO mistral 工作流运行 Ansible。

-Y, --yes

使用 -y 或 --yes 跳过任何升级操作前所需的确认。请谨慎使用这个选项!

--limit LIMIT

标识将限制 config-download Ansible playbook 执行的节点的逗号分隔列表或逗号分隔的字符串。例如:--limit "compute-0,compute-1,compute-5"。

57.16. Overcloud 故障

获取部署失败

使用方法:

openstack overcloud failures [-h] [--plan PLAN]

表 57.20. 可选参数
概述

-h, --help

显示帮助信息并退出

--plan PLAN, --stack PLAN

堆栈/环境的名称(默认:overcloud)

57.17. 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

表 57.21. 位置参数
概述

instackenv

None

表 57.22. 可选参数
概述

-h, --help

显示帮助信息并退出

-a FENCE_ACTION, --action FENCE_ACTION

已弃用:这个选项被忽略。

--delay DELAY

启动隔离前等待延迟秒数

--ipmi-lanplus

已弃用:这是默认值。

--ipmi-no-lanplus

不要使用 lanplus。默认为: false

--ipmi-cipher IPMI_CIPHER

要使用的 Ciphersuite (与 ipmitool -c 参数相同)。

--ipmi-level IPMI_LEVEL

ipmi 设备上的 Privilegel 级别。有效的级别:回调、用户、操作员、管理员。

--output OUTPUT

向文件写入参数

57.18. overcloud 镜像构建

overcloud 的构建镜像

使用方法:

openstack overcloud image build [-h] [--config-file <yaml config file>]
                                       [--image-name <image name>] [--no-skip]
                                       [--output-directory OUTPUT_DIRECTORY]

表 57.23. 可选参数
概述

-h, --help

显示帮助信息并退出

--config-file <yaml config file>

指定镜像构建的 YAML 配置文件可多次指定。顺序将被保留,之后的文件将覆盖之前文件中的一些选项。其他选项将附加。

--image-name <image name>

要构建的镜像的名称。可以多次指定。如果未指定,将构建给定 YAML 文件中的所有镜像。

--no-skip

如果存在缓存的镜像,则跳过构建。

--output-directory OUTPUT_DIRECTORY

镜像的输出目录。如果未设置,则默认为 $TRIPLEO_ROOT,或者当前目录。

57.19. 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]

表 57.24. 可选参数
概述

-h, --help

显示帮助信息并退出

--image-path IMAGE_PATH

包含镜像文件的目录路径

--os-image-name OS_IMAGE_NAME

OpenStack 磁盘镜像文件名

--ironic-python-agent-name IPA_NAME

OpenStack ironic-python-agent (代理)镜像文件名

--http-boot HTTP_BOOT

ironic-python-agent 镜像的根目录。如果上传多个架构/平台的镜像,则有不同的参数,则会为每个架构/平台创建不同的文件夹。

--update-existing

更新镜像(如果已存在)

--whole-disk

设置后,要上传的 overcloud-full 镜像将被视为整个磁盘

--architecture ARCHITECTURE

这些镜像的架构类型、x86_64、 i386ppc64le 是常见选项。这个选项必须至少匹配 instackenv.json 中的一个 arch

--Platform PLATFORM

这些镜像的平台类型。平台是架构的子类别。例如,您可能具有 x86_64 的通用镜像,但提供特定于 SandyBridge (SNB)的镜像。

--image-type {os,ironic-python-agent}

如果指定,允许限制镜像类型上传(用于 overcloud 镜像或 ironic-python-agent 的 ironic-python-agent)

--progress

显示上传文件操作的进度条

--local

在本地复制文件,即使有镜像服务端点

--local-path LOCAL_PATH

没有镜像端点或指定 --local 时镜像文件复制目的地的根目录

57.20. overcloud netenv validate

验证网络环境文件。

使用方法:

openstack overcloud netenv validate [-h] [-f NETENV]

表 57.25. 可选参数
概述

-h, --help

显示帮助信息并退出

-f NETENV, --file NETENV

网络环境文件的路径

57.21. Overcloud 节点 bios 配置

在给定节点上应用 BIOS 配置

使用方法:

openstack overcloud node bios configure [-h] [--all-manageable]
                                               [--configuration <configuration>]
                                               [<node_uuid> [<node_uuid> ...]]

表 57.26. 位置参数
概述

<node_uuid>

节点的裸机节点 uuid 用于配置 bios

表 57.27. 可选参数
概述

-h, --help

显示帮助信息并退出

--all-manageable

为当前处于 manageable 状态的节点配置 bios

--configuration <configuration>

BIOS 配置(yaml/json 字符串或文件名)。

57.22. Overcloud 节点 bios 重置

将 BIOS 配置重置为工厂默认值

使用方法:

openstack overcloud node bios reset [-h] [--all-manageable]
                                           [<node_uuid> [<node_uuid> ...]]

表 57.28. 位置参数
概述

<node_uuid>

节点的裸机节点 uuid 以重置 bios

表 57.29. 可选参数
概述

-h, --help

显示帮助信息并退出

--all-manageable

在所有节点上重置 bios,处于 manageable 状态

57.23. Overcloud 节点清理

通过清理运行节点。

使用方法:

openstack overcloud node clean [-h] [--all-manageable] [--provide]
                                      [<node_uuid> [<node_uuid> ...]]

表 57.30. 位置参数
概述

<node_uuid>

要清理节点的裸机节点 uuid

表 57.31. 可选参数
概述

-h, --help

显示帮助信息并退出

--all-manageable

清理当前处于 manageable 状态的节点

--provide

在清理后提供(make available)节点

57.24. 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> ...]]

表 57.32. 位置参数
概述

<node_uuid>

待配置节点的裸机节点 uuid

表 57.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)的列表:最大或最小。为使其在内省后运行此命令。

--root-device-minimum-size ROOT_DEVICE_MINIMUM_SIZE

检测到的根设备的最小大小(以 gib 为单位)。与 --root-device 一起使用。

--overwrite-root-device-hints

使用 --root-device 时是否覆盖现有的 root 设备 hints。

57.25. overcloud 节点删除

删除 overcloud 节点。

使用方法:

openstack overcloud node delete [-h] [-b <BAREMETAL DEPLOYMENT FILE>]
                                       [--stack STACK]
                                       [--templates [TEMPLATES]]
                                       [-e <HEAT ENVIRONMENT FILE>]
                                       [--timeout <TIMEOUT>] [-y]
                                       [<node> [<node> ...]]

表 57.34. 位置参数
概述

<node>

要删除的节点 ID (在 --baremetal-deployment 文件中指定)

表 57.35. 可选参数
概述

-h, --help

显示帮助信息并退出

-b <BAREMETAL DEPLOYMENT FILE>, --baremetal-deployment <BAREMETAL DEPLOYMENT FILE>

描述 baremetal 部署的配置文件

--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/no 提示符(假设是)。

57.26. 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]

表 57.36. 可选参数
概述

-h, --help

显示帮助信息并退出

--ip <ips>

探测的 IP 地址

--range <range>

IP 范围到探测

--credentials <key:value>

可能凭证的键/值对

--port <ports>

探测的 BMC 端口

--introspect

内省导入的节点

--run-validations

运行预部署验证。这些外部验证来自 TripleO 验证项目。

--provide

提供(使节点可用)

--no-deploy-image

跳过设置部署内核和 ramdisk。

--instance-boot-option {local,netboot}

是否设置用于从本地硬盘(本地)或网络(netboot)引导的实例。

--concurrency CONCURRENCY

要同时内省的最大节点数。

57.27. 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

表 57.37. 位置参数
概述

env_file

None

表 57.38. 可选参数
概述

-h, --help

显示帮助信息并退出

--introspect

内省导入的节点

--run-validations

运行预部署验证。这些外部验证来自 TripleO 验证项目。

--validate-only

验证 env_file,然后在不实际导入节点的情况下退出。

--provide

提供(使节点可用)

--no-deploy-image

跳过设置部署内核和 ramdisk。

--instance-boot-option {local,netboot}

是否设置用于从本地硬盘(本地)或网络(netboot)引导的实例。

--http-boot HTTP_BOOT

ironic-python-agent 镜像的根目录

--concurrency CONCURRENCY

要同时内省的最大节点数。

57.28. overcloud 节点内省

内省指定节点或所有节点处于 manageable 状态。

使用方法:

openstack overcloud node introspect [-h] [--all-manageable] [--provide]
                                           [--run-validations]
                                           [--concurrency CONCURRENCY]
                                           [<node_uuid> [<node_uuid> ...]]

表 57.39. 位置参数
概述

<node_uuid>

要内省节点的裸机恢复节点 uuid

表 57.40. 可选参数
概述

-h, --help

显示帮助信息并退出

--all-manageable

内省当前处于 manageable 状态的节点

--provide

提供(使节点可用)一旦内省

--run-validations

运行预部署验证。这些外部验证来自 TripleO 验证项目。

--concurrency CONCURRENCY

要同时内省的最大节点数。

57.29. Overcloud 节点提供

根据 UUID 或当前 manageable 状态,将节点标记为可用的。

使用方法:

openstack overcloud node provide [-h] [--all-manageable]
                                        [<node_uuid> [<node_uuid> ...]]

表 57.41. 位置参数
概述

<node_uuid>

要提供节点的裸机节点 uuid

表 57.42. 可选参数
概述

-h, --help

显示帮助信息并退出

--all-manageable

提供当前处于 manageable 状态的节点

57.30. 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>

表 57.43. 位置参数
概述

<baremetal_deployment.yaml>

描述 baremetal 部署的配置文件

表 57.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

ssh 访问overcloud 节点的密钥路径。如果未定义 keywill,则会自动探测到键。

--concurrency CONCURRENCY

要一次置备的节点数。(默认=20)

--timeout TIMEOUT

等待节点置备完成的秒数。(default=3600)

57.31. overcloud 节点取消置备

使用 Ironic 取消置备节点。

使用方法:

openstack overcloud node unprovision [-h] [--stack STACK] [--all] [-y]
                                            <baremetal_deployment.yaml>

表 57.45. 位置参数
概述

<baremetal_deployment.yaml>

描述 baremetal 部署的配置文件

表 57.46. 可选参数
概述

-h, --help

显示帮助信息并退出

--stack STACK

heat 堆栈的名称或 id (default=env: OVERCLOUD_STACK_NAME)

--all

在部署中取消置备每个实例

-Y, --yes

跳过 yes/no 提示符(假设是)

57.32. overcloud 参数集

为计划设置参数

使用方法:

openstack overcloud parameters set [-h] name file_in

表 57.47. 位置参数
概述

name

计划的名称,用于 swift 容器、Mistral 环境和 Heat 堆栈名称。

file_in

None

表 57.48. 可选参数
概述

-h, --help

显示帮助信息并退出

57.33. Overcloud 计划创建

创建部署计划

使用方法:

openstack overcloud plan create [-h] [--templates TEMPLATES]
                                       [--plan-environment-file PLAN_ENVIRONMENT_FILE]
                                       [--disable-password-generation]
                                       [--source-url SOURCE_URL]
                                       name

表 57.49. 位置参数
概述

name

计划的名称,用于对象存储容器、工作流环境和编排堆栈名称。

表 57.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 上打包的模板。

57.34. overcloud 计划删除

删除 overcloud 部署计划。如果堆栈具有相同名称,则不会删除计划。

使用方法:

openstack overcloud plan delete [-h] <name> [<name> ...]

表 57.51. 位置参数
概述

<name>

要删除的计划的名称

表 57.52. 可选参数
概述

-h, --help

显示帮助信息并退出

57.35. Overcloud 计划部署

部署部署计划

使用方法:

openstack overcloud plan deploy [-h] [--timeout <TIMEOUT>]
                                       [--run-validations]
                                       name

表 57.53. 位置参数
概述

name

要部署的计划的名称。

表 57.54. 可选参数
概述

-h, --help

显示帮助信息并退出

--timeout <TIMEOUT>, -t <TIMEOUT>

部署超时时间(以分钟为单位)。

--run-validations

运行预部署验证。这些外部验证来自 TripleO 验证项目。

57.36. Overcloud 计划导出

导出部署计划

使用方法:

openstack overcloud plan export [-h] [--output-file <output file>]
                                       [--force-overwrite]
                                       <name>

表 57.55. 位置参数
概述

<name>

要导出的计划的名称。

表 57.56. 可选参数
概述

-h, --help

显示帮助信息并退出

--output-file <output file>, -o <output file>

导出的输出文件的名称。它将默认为 "<name>.tar.gz"。

--force-overwrite, -f

如果输出文件存在,则覆盖输出文件。

57.37. 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]

表 57.57. 可选参数
概述

-h, --help

显示帮助信息并退出

表 57.58. 输出格式器
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 57.59. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

表 57.60. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 57.61. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

57.38. 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]

表 57.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 类别

表 57.63. 输出格式器
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 57.64. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

表 57.65. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 57.66. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

57.39. 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]

表 57.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 类别

57.40. overcloud raid create

在给定节点中创建 RAID

使用方法:

openstack overcloud raid create [-h] --node NODE configuration

表 57.68. 位置参数
概述

配置

RAID 配置(yaml/json 字符串或文件名)。

表 57.69. 可选参数
概述

-h, --help

显示帮助信息并退出

--node NODE

要在 上创建 raid 的节点(希望处于 manageable 状态)。可多次指定。

57.41. overcloud 角色列表

列出可用的角色(DEPRECATED)。请改用 "openstack overcloud roles list"。

使用方法:

openstack overcloud role list [-h] [--roles-path <roles directory>]

表 57.70. 可选参数
概述

-h, --help

显示帮助信息并退出

--roles-path <roles directory>

包含角色 yaml 文件的文件系统路径。默认为 /usr/share/openstack-tripleo-heat- templates/roles

57.42. overcloud 角色显示

显示有关给定角色(DEPRECATED)的信息。请使用 "openstack overcloud roles show" intead。

使用方法:

openstack overcloud role show [-h] [--roles-path <roles directory>]
                                     <role>

表 57.71. 位置参数
概述

<role>

用于显示更多相关信息的角色。

表 57.72. 可选参数
概述

-h, --help

显示帮助信息并退出

--roles-path <roles directory>

包含角色 yaml 文件的文件系统路径。默认为 /usr/share/openstack-tripleo-heat- templates/roles

57.43. overcloud 角色生成

生成 roles_data.yaml 文件

使用方法:

openstack overcloud roles generate [-h]
                                          [--roles-path <roles directory>]
                                          [-o <output file>] [--skip-validate]
                                          <role> [<role> ...]

表 57.73. 位置参数
概述

<role>

用于为部署生成 roles_data.yaml 文件的角色列表。注意:如果没有角色具有"主要"和"controller"标签,则顺序很重要。如果没有标记角色,则列出的第一个角色将被视为主要角色。这通常是控制器角色。

表 57.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 时跳过角色元数据类型验证

57.44. 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]

表 57.75. 可选参数
概述

-h, --help

显示帮助信息并退出

--name NAME

计划的名称,用于对象存储容器、工作流环境和编排堆栈名称。

--detail

包括每个角色的详情

--current

仅显示计划当前启用的角色的信息。

表 57.76. 输出格式器
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 57.77. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

表 57.78. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 57.79. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

57.45. 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>

表 57.80. 位置参数
概述

<role>

要查找的角色的名称。

表 57.81. 可选参数
概述

-h, --help

显示帮助信息并退出

--name NAME

计划的名称,用于对象存储容器、工作流环境和编排堆栈名称。

表 57.82. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 57.83. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 57.84. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 57.85. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

57.46. overcloud 状态

获取部署状态

使用方法:

openstack overcloud status [-h] [--plan PLAN]

表 57.86. 可选参数
概述

-h, --help

显示帮助信息并退出

--plan PLAN, --stack PLAN

堆栈/环境的名称(默认:overcloud)

57.47. Overcloud 支持报告收集

在所选服务器上运行 sosreport。

使用方法:

openstack overcloud support report collect [-h] [-c CONTAINER]
                                                  [-o DESTINATION]
                                                  [--skip-container-delete]
                                                  [-t TIMEOUT]
                                                  [-n CONCURRENCY]
                                                  [--collect-only | --download-only]
                                                  server_name

表 57.87. 位置参数
概述

server_name

要匹配的 Nova server_name 或部分名称。例如 "controller" 将与某一环境的所有控制器匹配。

表 57.88. 可选参数
概述

-h, --help

显示帮助信息并退出

-c CONTAINER, --container CONTAINER

用于存储日志的 Swift 容器

-O DESTINATION, --output DESTINATION

报告的输出目录

--skip-container-delete

下载文件后,请勿删除容器。如果仅提供 --collect-only 或 --download- only,则忽略。

-T TIMEOUT, --timeout TIMEOUT

等待日志收集和容器删除工作流的最长时间。

-n CONCURRENCY, --concurrency CONCURRENCY

要运行的并行日志收集和对象删除任务的数量。

--collect-only

跳过日志下载,仅收集日志并放入容器中

--download-only

跳过生成,只从提供的容器下载

57.48. 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] [-y]

表 57.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 存储节点的 Nova 类别(DEPRECATED.使用环境文件并设置参数 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- 下载时要用于保存输出的目录。该目录必须可由 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>

描述 baremetal 部署的配置文件

--limit LIMIT

标识将限制 config-download Ansible playbook 执行的节点的逗号分隔列表或逗号分隔的字符串。例如:--limit "compute-0,compute-1,compute-5"。

--tags TAGS

运行 config-download ansible-playbook 命令时要使用的标签列表。

--skip-tags SKIP_TAGS

运行 config- 下载 ansible-playbook 命令时要跳过的标签列表。

-Y, --yes

使用 -y 或 --yes 跳过任何更新操作前所需的确认。请谨慎使用这个选项!

57.49. 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] [-y]

表 57.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 存储节点的 Nova 类别(DEPRECATED.使用环境文件并设置参数 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- 下载时要用于保存输出的目录。该目录必须可由 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>

描述 baremetal 部署的配置文件

--limit LIMIT

标识将限制 config-download Ansible playbook 执行的节点的逗号分隔列表或逗号分隔的字符串。例如:--limit "compute-0,compute-1,compute-5"。

--tags TAGS

运行 config-download ansible-playbook 命令时要使用的标签列表。

--skip-tags SKIP_TAGS

运行 config- 下载 ansible-playbook 命令时要跳过的标签列表。

-Y, --yes

使用 -y 或 --yes 跳过任何更新操作前所需的确认。请谨慎使用这个选项!

57.50. 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]

表 57.91. 可选参数
概述

-h, --help

显示帮助信息并退出

--limit LIMIT

标识将限制 config-download Ansible playbook 执行的节点的逗号分隔列表或逗号分隔的字符串。例如:--limit "compute-0,compute-1,compute-5"。

--playbook PLAYBOOK

用于次要更新时使用的 Ansible playbook。默认为 全部 特殊值,它会导致执行所有更新 playbook。这是 update_steps_playbook.yaml,然后是deploy_steps_playbook.yaml。如果您更喜欢手动运行,则将其设置为每个 playbook,以连续调用该 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

直接通过 system 命令运行 ansible-playbook,而不是通过 TripleO mistral 工作流运行 Ansible。

--tags TAGS

运行 config-download ansible-playbook 命令时要使用的标签列表。

--skip-tags SKIP_TAGS

运行 config- 下载 ansible-playbook 命令时要跳过的标签列表。

-Y, --yes

使用 -y 或 --yes 跳过任何更新操作前所需的确认。请谨慎使用这个选项!

57.51. 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] [-y]

表 57.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 存储节点的 Nova 类别(DEPRECATED.使用环境文件并设置参数 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- 下载时要用于保存输出的目录。该目录必须可由 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>

描述 baremetal 部署的配置文件

--limit LIMIT

标识将限制 config-download Ansible playbook 执行的节点的逗号分隔列表或逗号分隔的字符串。例如:--limit "compute-0,compute-1,compute-5"。

--tags TAGS

运行 config-download ansible-playbook 命令时要使用的标签列表。

--skip-tags SKIP_TAGS

运行 config- 下载 ansible-playbook 命令时要跳过的标签列表。

-Y, --yes

使用 -y 或 --yes 跳过任何升级操作前所需的确认。请谨慎使用这个选项!

57.52. 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] [-y]

表 57.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 存储节点的 Nova 类别(DEPRECATED.使用环境文件并设置参数 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- 下载时要用于保存输出的目录。该目录必须可由 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>

描述 baremetal 部署的配置文件

--limit LIMIT

标识将限制 config-download Ansible playbook 执行的节点的逗号分隔列表或逗号分隔的字符串。例如:--limit "compute-0,compute-1,compute-5"。

--tags TAGS

运行 config-download ansible-playbook 命令时要使用的标签列表。

--skip-tags SKIP_TAGS

运行 config- 下载 ansible-playbook 命令时要跳过的标签列表。

-Y, --yes

使用 -y 或 --yes 跳过任何升级操作前所需的确认。请谨慎使用这个选项!

57.53. Overcloud 升级运行

在 Overcloud 节点上运行重大升级 ansible playbook,这将在 overcloud 上运行主要升级 ansible playbook。默认情况下,执行所有 playbook,即 upgrade_steps_playbook.yaml,然后是 deploy_steps_playbook.yaml,然后是 post_upgrade_steps_playbook.yaml。升级 playbook 在完成 overcloud 升级准备命令后可用。此 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]

表 57.94. 可选参数
概述

-h, --help

显示帮助信息并退出

--limit LIMIT

标识将限制 config-download Ansible playbook 执行的节点的逗号分隔列表或逗号分隔的字符串。例如:--limit "compute-0,compute-1,compute-5"。

--playbook PLAYBOOK

用于主要升级的 Ansible playbook。默认为 special 值,它 会导致所有 升级 playbook 运行。这是 upgrade_steps_playbook.yaml,然后 deploy_steps_playbook.yaml,然后 post_upgrade_steps_playbook.yaml。如果您更喜欢手动运行,则将其设置为每个 playbook,以连续调用该 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。当前支持的值有 验证和 预升级。在特定的 验证中,如果您需要在升级失败时重新运行,且无法启动某些服务,特定验证 很有用。

--stack STACK

heat 堆栈的名称或 id (default=env: OVERCLOUD_STACK_NAME)

--no-workflow

直接通过 system 命令运行 ansible-playbook,而不是通过 TripleO mistral 工作流运行 Ansible。

-Y, --yes

使用 -y 或 --yes 跳过任何升级操作前所需的确认。请谨慎使用这个选项!

第 58 章 policy

本章论述了 policy 命令下的命令。

58.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>

表 58.1. 位置参数
概述

<filename>

新的序列化策略规则文件

表 58.2. 可选参数
概述

-h, --help

显示帮助信息并退出

--type <type>

策略规则文件的新 mime 类型(默认为 application/json)

表 58.3. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 58.4. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 58.5. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 58.6. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

58.2. 策略删除

删除策略

使用方法:

openstack policy delete [-h] <policy> [<policy> ...]

表 58.7. 位置参数
概述

<policy>

要删除的策略

表 58.8. 可选参数
概述

-h, --help

显示帮助信息并退出

58.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]

表 58.9. 可选参数
概述

-h, --help

显示帮助信息并退出

--long

列出输出中的其他字段

表 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 Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

表 58.12. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 58.13. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

58.4. 策略集

设置策略属性

使用方法:

openstack policy set [-h] [--type <type>] [--rules <filename>] <policy>

表 58.14. 位置参数
概述

<policy>

修改的策略

表 58.15. 可选参数
概述

-h, --help

显示帮助信息并退出

--type <type>

策略规则文件的新 mime 类型

--rules <filename>

新的序列化策略规则文件

58.5. 策略显示

显示策略详情

使用方法:

openstack policy show [-h] [-f {json,shell,table,value,yaml}]
                             [-c COLUMN] [--noindent] [--prefix PREFIX]
                             [--max-width <integer>] [--fit-width]
                             [--print-empty]
                             <policy>

表 58.16. 位置参数
概述

<policy>

显示的策略

表 58.17. 可选参数
概述

-h, --help

显示帮助信息并退出

表 58.18. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 58.19. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 58.20. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 58.21. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

第 59 章 port

本章论述了 port 命令下的命令。

59.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>

表 59.1. 位置参数
概述

<name>

此端口的名称

表 59.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 类型(direct | direct-physical | macvtap | normal | baremetal | virtio-forwarder, default: normal)

--host <host-id>

在主机 <host-id> 分配端口(仅限id)

--dns-domain dns-domain

将 dns domain 设置为此端口(需要端口的 dns_domain 扩展)

--dns-name <dns-name>

为这个端口设置 dns name (需要 dns integration extension)

--fixed-ip subnet=<subnet>,ip-address=<ip-address>

此端口所需的 ip 和/或子网(名称或 id):subnet=<subnet>,ip-address=<ip-address> (用于设置多个固定 IP 地址)

--no-fixed-ip

没有这个端口的 ip 或 subnet。

--binding-profile <binding-profile>

要传递的自定义数据:profile. 数据可能会作为 <key>=<value> 或 JSON 传递。(重复选项可设置多个绑定: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}](用于设置多个额外 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>]

添加与这个端口关联的 allowed-address 对: ip-address=<ip-address>[,mac-address=<mac-address>](用于设置多个 allowed-address 对)

--tag <tag>

要添加到端口的标签(重复选项来设置多个标签)

--no-tag

没有与端口关联的标签

表 59.3. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 59.4. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 59.5. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 59.6. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

59.2. port delete

删除端口

使用方法:

openstack port delete [-h] <port> [<port> ...]

表 59.7. 位置参数
概述

<port>

要删除的端口(名称或 ID)

表 59.8. 可选参数
概述

-h, --help

显示帮助信息并退出

59.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>,...]]

表 59.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>

过滤端口(名称或 ID)所需的 ip 和/或子网:subnet=<subnet>,ip-address=<ip-address>,ip- substring=<ip-substring> (用于设置多个固定 IP 地址)

--tags <tag>[,<tag>,…​]

列出具有所有给定标签(comma- separateds)列表的端口。)

--any-tags <tag>[,<tag>,…​]

列出具有任何给定标签(组合的标记列表)的端口。)

--not-tags <tag>[,<tag>,…​]

排除包含所有给定标签的端口(组合标签列表)

--not-any-tags <tag>[,<tag>,…​]

排除具有任何给定标签(组合标签列表)的端口。

表 59.10. 输出格式器
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 59.11. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

表 59.12. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 59.13. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

59.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>

表 59.14. 位置参数
概述

<port>

要修改的端口(名称或 id)

表 59.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 类型(direct | direct-physical | macvtap | normal | baremetal | virtio-forwarder, default: normal)

--host <host-id>

在主机 <host-id> 分配端口(仅限id)

--dns-domain dns-domain

将 dns domain 设置为此端口(需要端口的 dns_domain 扩展)

--dns-name <dns-name>

为这个端口设置 dns name (需要 dns integration extension)

--enable

启用端口

--disable

禁用端口

--name <name>

设置端口名称

--fixed-ip subnet=<subnet>,ip-address=<ip-address>

此端口所需的 ip 和/或子网(名称或 id):subnet=<subnet>,ip-address=<ip-address> (用于设置多个固定 IP 地址)

--no-fixed-ip

清除固定 ip address.Specify 和 --fixed-ip 和 --no-fixed-ip 的现有信息,以覆盖当前的固定 IP 地址。

--binding-profile <binding-profile>

要传递的自定义数据:profile. 数据可能会作为 <key>=<value> 或 JSON 传递。(重复选项可设置多个绑定:profile 数据)

--no-binding-profile

清除 binding:profile 的现有信息。指定 --binding-profile 和 --no-binding-profile 以覆盖当前的绑定: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>]

添加与这个端口关联的 allowed-address 对: ip-address=<ip-address>[,mac-address=<mac-address>](用于设置多个 allowed-address 对)

--no-allowed-address

清除与此端口关联的现有 allowed-address 对。(指定 --allowed-address 和 --no- allowed-address 以覆盖当前的允许的地址对)

--data-plane-status <status>

设置此端口的 data plane 状态(active | down)。使用端口 unset 命令将其设定为 None (需要 data plane 状态扩展)

--tag <tag>

要添加到端口的标签(重复选项来设置多个标签)

--no-tag

与端口关联的显式标签。指定 --tag 和 --no-tag 以覆盖当前标签

59.5. 端口显示

显示端口详情

使用方法:

openstack port show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN]
                           [--noindent] [--prefix PREFIX]
                           [--max-width <integer>] [--fit-width]
                           [--print-empty]
                           <port>

表 59.16. 位置参数
概述

<port>

要显示的端口(名称或 id)

表 59.17. 可选参数
概述

-h, --help

显示帮助信息并退出

表 59.18. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 59.19. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 59.20. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 59.21. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

59.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>

表 59.22. 位置参数
概述

<port>

要修改的端口(名称或 id)

表 59.23. 可选参数
概述

-h, --help

显示帮助信息并退出

--fixed-ip subnet=<subnet>,ip-address=<ip-address>

需要的 ip 和/或子网应从此端口中删除(名称或 ID):子网=<subnet>,ip- address=<ip-address> (重复选项以取消多个固定 IP 地址)

--binding-profile <binding-profile-key>

需要的键应该从绑定中删除(重复选项以取消设置多个绑定:profile 数据)

--security-group <security-group>

应该移除此端口(名称或 ID)的安全组(重复选项以取消多个安全组)

--allowed-address ip-address=<ip-address>[,mac-address=<mac-address>]

需要的 allowed-address 对应该从此端口中删除: ip-address=<ip-address>[,mac- address=<mac-address>](repeat 选项来取消多个 allowed-address 对。)

--qos-policy

移除附加到端口的 qos 策略

--data-plane-status

清除 data plane 状态的现有信息

--tag <tag>

要从端口中删除标签(重复选项以删除多个标签)

--all-tag

清除与端口关联的所有标签

第 60 章 project

本章论述了 项目 命令下的命令。

60.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>

表 60.1. 位置参数
概述

<project-name>

新项目名称

表 60.2. 可选参数
概述

-h, --help

显示帮助信息并退出

--domain <domain>

拥有该项目的域(名称或 ID)

--parent <project>

项目的父项(名称或 id)

--description <description>

项目描述

--enable

启用项目

--disable

禁用项目

--property <key=value>

向 <name> 添加属性(重复选项来设置多个属性)

--or-show

返回现有项目

--tag <tag>

要添加到项目的标签(重复选项来设置多个标签)

表 60.3. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 60.4. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 60.5. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 60.6. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

60.2. 删除项目

删除项目

使用方法:

openstack project delete [-h] [--domain <domain>]
                                <project> [<project> ...]

表 60.7. 位置参数
概述

<project>

要删除的项目(名称或 ID)

表 60.8. 可选参数
概述

-h, --help

显示帮助信息并退出

--domain <domain>

拥有 <project> 的域(名称或 ID)

60.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>,...]]

表 60.9. 可选参数
概述

-h, --help

显示帮助信息并退出

--domain <domain>

通过 <domain> (名称或 ID)过滤项目

--user <user>

通过 <user> (名称或 ID)过滤项目

--my-projects

列出经过身份验证的用户的项目。会取代其他过滤器。

--long

列出输出中的其他字段

--sort <key>[:<direction>]

按所选的键和指示排序输出(asc 或 desc),重复此选项来指定多个键和方向。

--tags <tag>[,<tag>,…​]

列出具有所有给定标签(comma- separateds)列表的项目。)

--tags-any <tag>[,<tag>,…​]

列出具有任何给定标签(组合为标签列表)的项目。

--not-tags <tag>[,<tag>,…​]

排除具有所有给定标签(comma- separated tags 列表)的项目。

--not-tags-any <tag>[,<tag>,…​]

排除具有任何给定标签(组合标签列表)的项目。

表 60.10. 输出格式器
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 60.11. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

表 60.12. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 60.13. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

60.4. 项目清除

清理与项目关联的资源

使用方法:

openstack project purge [-h] [--dry-run] [--keep-project]
                               (--auth-project | --project <project>)
                               [--project-domain <project-domain>]

表 60.14. 可选参数
概述

-h, --help

显示帮助信息并退出

--dry-run

列出项目的资源

--keep-project

清理项目资源,但不删除项目

--auth-project

删除用于身份验证的项目的资源

--project <project>

要清理的项目(名称或 id)

--project-domain <project-domain>

项目所属的域(名称或 id)。这可在项目名称之间有冲突时使用。

60.5. 项目集

设置项目属性

使用方法:

openstack project set [-h] [--name <name>] [--domain <domain>]
                             [--description <description>]
                             [--enable | --disable] [--property <key=value>]
                             [--tag <tag>] [--clear-tags] [--remove-tag <tag>]
                             <project>

表 60.15. 位置参数
概述

<project>

要修改的项目(名称或 id)

表 60.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>

要从项目中删除的标签(重复选项以删除多个标签)

60.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>

表 60.17. 位置参数
概述

<project>

要显示的项目(名称或 id)

表 60.18. 可选参数
概述

-h, --help

显示帮助信息并退出

--domain <domain>

拥有 <project> 的域(名称或 ID)

--parents

将项目的父项显示为列表

--children

将项目的子树(子树)显示为列表

表 60.19. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 60.20. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 60.21. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 60.22. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

第 61 章 PTR

本章论述了 ptr 命令下的命令。

61.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]

表 61.1. 可选参数
概述

-h, --help

显示帮助信息并退出

--all-projects

显示所有项目的结果。default: false

--edit-managed

编辑标记为 managed. default: false的资源

--sudo-project-id SUDO_PROJECT_ID

这个命令的模拟项目 ID。default: None

表 61.2. 输出格式器
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 61.3. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

表 61.4. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 61.5. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

61.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

表 61.6. 位置参数
概述

floatingip_id

格式的浮动 IP ID:floatingip_id

ptrdname

Ptrd 名称

表 61.7. 可选参数
概述

-h, --help

显示帮助信息并退出

--description DESCRIPTION

Description

--no-description—​ttl TTL

TTL

--no-ttl—​all-projects

显示所有项目的结果。default: false

--edit-managed

编辑标记为 managed. default: false的资源

--sudo-project-id SUDO_PROJECT_ID

这个命令的模拟项目 ID。default: None

表 61.8. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 61.9. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 61.10. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 61.11. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

61.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

表 61.12. 位置参数
概述

floatingip_id

格式的浮动 IP ID:floatingip_id

表 61.13. 可选参数
概述

-h, --help

显示帮助信息并退出

--all-projects

显示所有项目的结果。default: false

--edit-managed

编辑标记为 managed. default: false的资源

--sudo-project-id SUDO_PROJECT_ID

这个命令的模拟项目 ID。default: None

表 61.14. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 61.15. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 61.16. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 61.17. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

61.4. PTR 记录未设置

unset floatingip ptr 记录

使用方法:

openstack ptr record unset [-h] [--all-projects] [--edit-managed]
                                  [--sudo-project-id SUDO_PROJECT_ID]
                                  floatingip_id

表 61.18. 位置参数
概述

floatingip_id

格式的浮动 IP ID:floatingip_id

表 61.19. 可选参数
概述

-h, --help

显示帮助信息并退出

--all-projects

显示所有项目的结果。default: false

--edit-managed

编辑标记为 managed. default: false的资源

--sudo-project-id SUDO_PROJECT_ID

这个命令的模拟项目 ID。default: None

第 62 章 quota

本章论述了 quota 命令下的命令。

62.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)

表 62.1. 可选参数
概述

-h, --help

显示帮助信息并退出

--project <project>

列出此项目的 <project> 配额(名称或 ID)

--detail

显示配额使用量的详细信息

--compute

列出计算配额

--volume

列出卷配额

--network

列出网络配额

表 62.2. 输出格式器
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 62.3. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

表 62.4. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 62.5. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

62.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>

表 62.6. 位置参数
概述

<project/class>

为此项目或类设置配额(名称/id)

表 62.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>

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>

GB 配额的新值

--per-volume-gigabytes <per-volume-gigabytes>

per-volume-gigabytes 配额的新值

--snapshots <snapshots>

快照配额的新值

--volumes <volumes>

卷配额的新值

--floating-ips <floating-ips>

floating-ips 配额的新值

--secgroup-rules <secgroup-rules>

secgroup-rules 配额的新值

--secgroups <secgroups>

secgroups 配额的新值

--networks <networks>

网络配额的新值

--subnets <subnets>

子网配额的新值

--ports <ports>

端口配额的新值

--routers <routers>

路由器配额的新值

--rbac-policies <rbac-policies>

rbac-policies 配额的新值

--subnetpools <subnetpools>

subnetpools 配额的新值

--volume-type <volume-type>

为特定 <volume-type> 设置配额

62.3. 配额显示

显示项目或类的配额。指定 ''--os-compute-api-version 2.50' 或 higher,以查看 ''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>]

表 62.8. 位置参数
概述

<project/class>

显示此项目或类配额(名称或 ID)

表 62.9. 可选参数
概述

-h, --help

显示帮助信息并退出

--class

显示 <class> 的配额

--default

显示 <project> 的默认配额

表 62.10. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 62.11. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 62.12. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 62.13. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

第 63 章 recordset

本章描述了 recordset 命令下的命令。

63.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

表 63.1. 位置参数
概述

zone_id

区域 ID

name

RecordSet name

表 63.2. 可选参数
概述

-h, --help

显示帮助信息并退出

--record RECORD

RecordSet 记录,根据需要重复

--type TYPE

RecordSet 类型

--ttl TTL

生存时间(秒)

--description DESCRIPTION

Description

--all-projects

显示所有项目的结果。default: false

--edit-managed

编辑标记为 managed. default: false的资源

--sudo-project-id SUDO_PROJECT_ID

这个命令的模拟项目 ID。default: None

表 63.3. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 63.4. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 63.5. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 63.6. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

63.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

表 63.7. 位置参数
概述

zone_id

区域 ID

id

RecordSet id

表 63.8. 可选参数
概述

-h, --help

显示帮助信息并退出

--all-projects

显示所有项目的结果。default: false

--edit-managed

编辑标记为 managed. default: false的资源

--sudo-project-id SUDO_PROJECT_ID

这个命令的模拟项目 ID。default: None

表 63.9. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 63.10. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 63.11. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 63.12. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

63.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

表 63.13. 位置参数
概述

zone_id

区域 ID。用于列出所有记录集指定 all

表 63.14. 可选参数
概述

-h, --help

显示帮助信息并退出

--name NAME

RecordSet name

--type TYPE

RecordSet 类型

--data DATA

RecordSet 记录数据

--ttl TTL

生存时间(秒)

--description DESCRIPTION

Description

--status STATUS

RecordSet 状态

--action ACTION

RecordSet 操作

--all-projects

显示所有项目的结果。default: false

--edit-managed

编辑标记为 managed. default: false的资源

--sudo-project-id SUDO_PROJECT_ID

这个命令的模拟项目 ID。default: None

表 63.15. 输出格式器
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 63.16. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

表 63.17. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 63.18. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

63.4. RecordSet set

设置记录属性

使用方法:

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

表 63.19. 位置参数
概述

zone_id

区域 ID

id

RecordSet id

表 63.20. 可选参数
概述

-h, --help

显示帮助信息并退出

--record RECORD

RecordSet 记录,根据需要重复

--description DESCRIPTION

Description

--no-description—​ttl TTL

TTL

--no-ttl—​all-projects

显示所有项目的结果。default: false

--edit-managed

编辑标记为 managed. default: false的资源

--sudo-project-id SUDO_PROJECT_ID

这个命令的模拟项目 ID。default: None

表 63.21. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 63.22. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 63.23. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 63.24. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

63.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

表 63.25. 位置参数
概述

zone_id

区域 ID

id

RecordSet id

表 63.26. 可选参数
概述

-h, --help

显示帮助信息并退出

--all-projects

显示所有项目的结果。default: false

--edit-managed

编辑标记为 managed. default: false的资源

--sudo-project-id SUDO_PROJECT_ID

这个命令的模拟项目 ID。default: None

表 63.27. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 63.28. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 63.29. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 63.30. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

第 64 章 region

本章论述了 region 命令下的命令。

64.1. 地区创建

创建新区域

使用方法:

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>

表 64.1. 位置参数
概述

<region-id>

新区域 ID

表 64.2. 可选参数
概述

-h, --help

显示帮助信息并退出

--parent-region <region-id>

父区域 ID

--description <description>

新区域描述

表 64.3. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 64.4. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 64.5. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 64.6. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

64.2. region delete

删除区域

使用方法:

openstack region delete [-h] <region-id> [<region-id> ...]

表 64.7. 位置参数
概述

<region-id>

要删除的区域 ID

表 64.8. 可选参数
概述

-h, --help

显示帮助信息并退出

64.3. 区域列表

列出区域

使用方法:

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>]

表 64.9. 可选参数
概述

-h, --help

显示帮助信息并退出

--parent-region <region-id>

按父区域 ID 过滤

表 64.10. 输出格式器
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 64.11. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

表 64.12. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 64.13. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

64.4. region set

设置区域属性

使用方法:

openstack region set [-h] [--parent-region <region-id>]
                            [--description <description>]
                            <region-id>

表 64.14. 位置参数
概述

<region-id>

要修改的区域

表 64.15. 可选参数
概述

-h, --help

显示帮助信息并退出

--parent-region <region-id>

新的父区域 ID

--description <description>

新区域描述

64.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>

表 64.16. 位置参数
概述

<region-id>

要显示的区域

表 64.17. 可选参数
概述

-h, --help

显示帮助信息并退出

表 64.18. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 64.19. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 64.20. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 64.21. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

第 65 章 注册

本章论述了 注册 命令下的命令。

65.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>

表 65.1. 位置参数
概述

<resource-name>

要限制的资源的名称

表 65.2. 可选参数
概述

-h, --help

显示帮助信息并退出

--description <description>

注册限制的描述

--region <region>

注册限制的区域以影响

--service <service>

负责限制的资源的服务(必需)

--default-limit <default-limit>

要花费的资源的默认限制(必需)

表 65.3. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 65.4. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 65.5. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 65.6. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

65.2. 注册的限制删除

删除注册的限制

使用方法:

openstack registered limit delete [-h]
                                         <registered-limit-id>
                                         [<registered-limit-id> ...]

表 65.7. 位置参数
概述

<registered-limit-id>

注册要删除的限制(id)

表 65.8. 可选参数
概述

-h, --help

显示帮助信息并退出

65.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>]

表 65.9. 可选参数
概述

-h, --help

显示帮助信息并退出

--service <service>

负责限制的资源的服务

--resource-name <resource-name>

要限制的资源的名称

--region <region>

要影响的限值的区域。

表 65.10. 输出格式器
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 65.11. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

表 65.12. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 65.13. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

65.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>

表 65.14. 位置参数
概述

<registered-limit-id>

注册的限制为更新(id)

表 65.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 必须与现有值不同,否则它将是重复的条目

表 65.16. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 65.17. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 65.18. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 65.19. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

65.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>

表 65.20. 位置参数
概述

<registered-limit-id>

注册的显示限制(id)

表 65.21. 可选参数
概述

-h, --help

显示帮助信息并退出

表 65.22. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 65.23. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 65.24. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 65.25. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

第 66 章 request

本章论述了 request 命令下的命令。

66.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>

表 66.1. 可选参数
概述

-h, --help

显示帮助信息并退出

--request-key <request-key>

要授权的请求令牌(仅限 ID)(必需)

--role <role>

要授权的角色(名称或 id)(重复选项来设置多个值)(必需)

表 66.2. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 66.3. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 66.4. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 66.5. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

66.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>]

表 66.6. 可选参数
概述

-h, --help

显示帮助信息并退出

--consumer-key <consumer-key>

consumer key (必需)

--consumer-secret <consumer-secret>

consumer secret (必需)

--project <project>

消费者要访问的项目(名称或 ID)(必需)

--domain <domain>

拥有 <project> 的域(名称或 ID)

表 66.7. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 66.8. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 66.9. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 66.10. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

第 67 章 resource

本章论述了 resource 命令下的命令。

67.1. resource member create

将资源共享给另一租户。

使用方法:

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

表 67.1. 位置参数
概述

resource_id

要共享的资源 ID。

resource_type

资源类型。

member_id

资源所共享的项目 ID。

表 67.2. 可选参数
概述

-h, --help

显示帮助信息并退出

表 67.3. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 67.4. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 67.5. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 67.6. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

67.2. resource member delete

删除资源共享关系。

使用方法:

openstack resource member delete [-h] resource resource_type member_id

表 67.7. 位置参数
概述

resource

要共享的资源 ID。

resource_type

资源类型。

member_id

资源所共享的项目 ID。

表 67.8. 可选参数
概述

-h, --help

显示帮助信息并退出

67.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

表 67.9. 位置参数
概述

resource_id

要共享的资源 ID。

resource_type

资源类型。

表 67.10. 可选参数
概述

-h, --help

显示帮助信息并退出

--marker [MARKER]

以上页面的最后执行 uuid 显示在"标记"后执行列表。

--limit [LIMIT]

在单个结果中返回的最大条目数。

--sort_keys [SORT_KEYS]

按逗号分隔排列结果的排序键列表。默认: created_at。Example: mistral execution-list --sort_keys=id,description

--sort_dirs [SORT_DIRS]

以逗号分隔的排序指令列表。default: asc。Example: mistral execution-list --sort_keys=id,description --sort_dirs=asc,desc

--filter FILTERS

过滤器. 可以重复。

表 67.11. 输出格式器
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 67.12. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

表 67.13. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 67.14. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

67.4. resource member show

显示具体的成员信息。

使用方法:

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

表 67.15. 位置参数
概述

resource

要共享的资源 ID。

resource_type

资源类型。

表 67.16. 可选参数
概述

-h, --help

显示帮助信息并退出

-m MEMBER_ID, --member-id MEMBER_ID

资源所共享的项目 ID。如果您是资源成员,则不需要提供此 param。

表 67.17. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 67.18. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 67.19. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 67.20. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

67.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

表 67.21. 位置参数
概述

resource_id

要共享的资源 ID。

resource_type

资源类型。

表 67.22. 可选参数
概述

-h, --help

显示帮助信息并退出

-m MEMBER_ID, --member-id MEMBER_ID

资源所共享的项目 ID。如果您是资源成员,则不需要提供此 param。

-s {pending,accepted,rejected}, --status {pending,accepted,rejected}

共享状态。

表 67.23. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 67.24. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 67.25. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 67.26. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

第 68 章 role

本章论述了 role 命令下的命令。

68.1. role add

为系统、域或项目的用户或组添加角色分配

使用方法:

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>

表 68.1. 位置参数
概述

<role>

要添加到 <user> 的角色(名称或 id)

表 68.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>

68.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]

表 68.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

表 68.4. 
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

-c COLUMN, --column COLUMN

--sort-column SORT_COLUMN

表 68.5. 
概述

--quote {all,minimal,none,nonnumeric}

表 68.6. 
概述

--noindent

表 68.7. 
概述

--max-width <integer>

--fit-width

--print-empty

68.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>

表 68.8. 
概述

<role-name>

表 68.9. 
概述

-h, --help

显示帮助信息并退出

--domain <domain>

--or-show

表 68.10. 
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

-c COLUMN, --column COLUMN

表 68.11. 
概述

--noindent

表 68.12. 
概述

--prefix PREFIX

表 68.13. 
概述

--max-width <integer>

--fit-width

--print-empty

68.4. 

使用方法:

openstack role delete [-h] [--domain <domain>] <role> [<role> ...]

表 68.14. 
概述

<role>

表 68.15. 
概述

-h, --help

显示帮助信息并退出

--domain <domain>

68.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>]

表 68.16. 
概述

-h, --help

显示帮助信息并退出

--domain <domain>

表 68.17. 
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

-c COLUMN, --column COLUMN

--sort-column SORT_COLUMN

表 68.18. 
概述

--quote {all,minimal,none,nonnumeric}

表 68.19. 
概述

--noindent

表 68.20. 
概述

--max-width <integer>

--fit-width

--print-empty

68.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>

表 68.21. 
概述

<role>

表 68.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>

68.7. 

使用方法:

openstack role set [-h] [--domain <domain>] [--name <name>] <role>

表 68.23. 
概述

<role>

表 68.24. 
概述

-h, --help

显示帮助信息并退出

--domain <domain>

--name <name>

68.8. 

使用方法:

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>

表 68.25. 
概述

<role>

表 68.26. 
概述

-h, --help

显示帮助信息并退出

--domain <domain>

表 68.27. 
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

-c COLUMN, --column COLUMN

表 68.28. 
概述

--noindent

表 68.29. 
概述

--prefix PREFIX

表 68.30. 
概述

--max-width <integer>

--fit-width

--print-empty

第 69 章 路由器

69.1. 

使用方法:

openstack router add port [-h] <router> <port>

表 69.1. 
概述

<router>

<port>

表 69.2. 
概述

-h, --help

显示帮助信息并退出

69.2. 

使用方法:

openstack router add subnet [-h] <router> <subnet>

表 69.3. 
概述

<router>

<subnet>

表 69.4. 
概述

-h, --help

显示帮助信息并退出

69.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>

表 69.5. 
概述

<name>

表 69.6. 
概述

-h, --help

显示帮助信息并退出

--enable

--disable

--distributed

--centralized

--ha

--no-ha

--description <description>

--project <project>

--project-domain <project-domain>

--availability-zone-hint <availability-zone>

--tag <tag>

--no-tag

表 69.7. 
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

-c COLUMN, --column COLUMN

表 69.8. 
概述

--noindent

表 69.9. 
概述

--prefix PREFIX

表 69.10. 
概述

--max-width <integer>

--fit-width

--print-empty

69.4. 

使用方法:

openstack router delete [-h] <router> [<router> ...]

表 69.11. 
概述

<router>

表 69.12. 
概述

-h, --help

显示帮助信息并退出

69.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>,...]]

表 69.13. 
概述

-h, --help

显示帮助信息并退出

--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>,…​]

表 69.14. 
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

-c COLUMN, --column COLUMN

--sort-column SORT_COLUMN

表 69.15. 
概述

--quote {all,minimal,none,nonnumeric}

表 69.16. 
概述

--noindent

表 69.17. 
概述

--max-width <integer>

--fit-width

--print-empty

69.6. 

使用方法:

openstack router remove port [-h] <router> <port>

表 69.18. 
概述

<router>

<port>

表 69.19. 
概述

-h, --help

显示帮助信息并退出

69.7. 

使用方法:

openstack router remove subnet [-h] <router> <subnet>

表 69.20. 
概述

<router>

<subnet>

表 69.21. 
概述

-h, --help

显示帮助信息并退出

69.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>

表 69.22. 
概述

<router>

表 69.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 和/或子网(name 或 id):subnet=<subnet>,ip-address=<ip-address> (重复选项来设置多个固定 IP 地址)

--enable-snat

在外部网关中启用源 nat

--disable-snat

在外部网关中禁用源 nat

--qos-policy <qos-policy>

将 qos 策略附加到路由器网关 ips

--no-qos-policy

从路由器网关 ips 移除 qos 策略

--tag <tag>

要添加到路由器的标签(重复选项来设置多个标签)

--no-tag

清除与路由器关联的标签。指定 --tag 和 --no-tag 以覆盖当前标签

69.9. 路由器显示

显示路由器详情

使用方法:

openstack router show [-h] [-f {json,shell,table,value,yaml}]
                             [-c COLUMN] [--noindent] [--prefix PREFIX]
                             [--max-width <integer>] [--fit-width]
                             [--print-empty]
                             <router>

表 69.24. 位置参数
概述

<router>

要显示的路由器(名称或 id)

表 69.25. 可选参数
概述

-h, --help

显示帮助信息并退出

表 69.26. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 69.27. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 69.28. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 69.29. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

69.10. 路由器未设置

取消设置路由器属性

使用方法:

openstack router unset [-h]
                              [--route destination=<subnet>,gateway=<ip-address>]
                              [--external-gateway] [--qos-policy]
                              [--tag <tag> | --all-tag]
                              <router>

表 69.30. 位置参数
概述

<router>

要修改的路由器(名称或 id)

表 69.31. 可选参数
概述

-h, --help

显示帮助信息并退出

--route destination=<subnet>,gateway=<ip-address>

要从路由器目的地删除的路由:目的地子网(在 CIDR 表示法中)网关: nexthop IP 地址(用于取消多个路由的peat 选项)

--external-gateway

从路由器删除外部网关信息

--qos-policy

从路由器网关 ips 移除 qos 策略

--tag <tag>

要从路由器中删除标签(重复选项以删除多个标签)

--all-tag

清除与路由器关联的所有标签

第 70 章 secret

本章论述了 secret 命令下的命令。

70.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]

表 70.1. 可选参数
概述

-h, --help

显示帮助信息并退出

--name NAME, -n NAME

人类友好名称。

--type TYPE

要创建的容器类型(默认:通用)。

--secret SECRET, -s SECRET

一个 secret 用于在容器中存储(可以多次设置)。Example: --secret "private_key=https://url.test/v1/secrets/1-2-3-4"

表 70.2. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 70.3. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 70.4. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 70.5. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

70.2. Secret 容器删除

通过提供 href 来删除容器。

使用方法:

openstack secret container delete [-h] URI

表 70.6. 位置参数
概述

URI

容器的 uri 引用

表 70.7. 可选参数
概述

-h, --help

显示帮助信息并退出

70.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

表 70.8. 位置参数
概述

URI

容器的 uri 引用。

表 70.9. 可选参数
概述

-h, --help

显示帮助信息并退出

表 70.10. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 70.11. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 70.12. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 70.13. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

70.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]

表 70.14. 可选参数
概述

-h, --help

显示帮助信息并退出

--limit LIMIT, -l LIMIT

指定每个页面列表的项目列表数量(默认为 10;最大:100)

--offset OFFSET,-o OFFSET

指定页面偏移(默认值 0)

--name NAME, -n NAME

指定容器名称(默认:none)

--type TYPE, -t TYPE

指定列表的类型过滤器(默认:none)。

表 70.15. 输出格式器
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 70.16. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

表 70.17. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 70.18. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

70.5. Secret delete

通过提供 URI 来删除 secret。

使用方法:

openstack secret delete [-h] URI

表 70.19. 位置参数
概述

URI

secret 的 uri 引用

表 70.20. 可选参数
概述

-h, --help

显示帮助信息并退出

70.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

表 70.21. 位置参数
概述

URI

secret 的 uri 引用。

表 70.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)。

表 70.23. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 70.24. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 70.25. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 70.26. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

70.7. 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]

表 70.27. 可选参数
概述

-h, --help

显示帮助信息并退出

--limit LIMIT, -l LIMIT

指定每个页面列表的项目列表数量(默认为 10;最大:100)

--offset OFFSET,-o OFFSET

指定页面偏移(默认值 0)

--name NAME, -n NAME

指定 secret 名称(默认:none)

--algorithm ALGORITHM, -a ALGORITHM

列表的算法过滤器(默认:无)。

--bit-length BIT_LENGTH, -b BIT_LENGTH

列表的位长度过滤器(默认为 0)。

--mode MODE, -m MODE

列表的算法模式过滤器(默认:无)。

--secret-type SECRET_TYPE, -s SECRET_TYPE

指定 secret 类型(默认:none)。

表 70.28. 输出格式器
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 70.29. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

表 70.30. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 70.31. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

70.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

表 70.32. 位置参数
概述

type

要创建的顺序(密钥、非对证书)的类型。

表 70.33. 可选参数
概述

-h, --help

显示帮助信息并退出

--name NAME, -n NAME

人类友好名称。

--algorithm ALGORITHM, -a ALGORITHM

与请求的密钥一起使用的算法(默认:aes)。

--bit-length BIT_LENGTH, -b BIT_LENGTH

请求的机密密钥的位长度(默认为 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

secret 的过期时间,格式为 iso 8601。

--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 的文件。

表 70.34. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 70.35. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 70.36. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 70.37. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

70.9. secret order delete

通过提供 href 来删除订单。

使用方法:

openstack secret order delete [-h] URI

表 70.38. 位置参数
概述

URI

顺序的 uri 引用

表 70.39. 可选参数
概述

-h, --help

显示帮助信息并退出

70.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

表 70.40. 位置参数
概述

URI

uri 引用顺序。

表 70.41. 可选参数
概述

-h, --help

显示帮助信息并退出

表 70.42. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 70.43. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 70.44. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 70.45. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

70.11. Secret 顺序列表

列出订单.

使用方法:

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]

表 70.46. 可选参数
概述

-h, --help

显示帮助信息并退出

--limit LIMIT, -l LIMIT

指定每个页面列表的项目列表数量(默认为 10;最大:100)

--offset OFFSET,-o OFFSET

指定页面偏移(默认值 0)

表 70.47. 输出格式器
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 70.48. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

表 70.49. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 70.50. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

70.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>]

表 70.51. 可选参数
概述

-h, --help

显示帮助信息并退出

--name NAME, -n NAME

人类友好名称。

--secret-type SECRET_TYPE, -s SECRET_TYPE

机密类型;必须是对称、公共、私有、证书、密码短语(默认)之一。

--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

secret 的过期时间,格式为 iso 8601。

--payload PAYLOAD, -p PAYLOAD

未加密的 secret 数据。

--file <filename>, -F <filename>

包含 secret 有效负载的文件

表 70.52. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 70.53. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 70.54. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 70.55. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

70.13. secret 更新

更新 Barbican 中没有有效负载的 secret。

使用方法:

openstack secret update [-h] URI payload

表 70.56. 位置参数
概述

URI

secret 的 uri 引用。

有效负载

未加密的 secret

表 70.57. 可选参数
概述

-h, --help

显示帮助信息并退出

第 71 章 安全

本章论述了 安全 命令下的命令。

71.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>

表 71.1. 位置参数
概述

<name>

新安全组名称

表 71.2. 可选参数
概述

-h, --help

显示帮助信息并退出

--description <description>

安全组描述

--project <project>

所有者的项目(名称或 id)

--project-domain <project-domain>

项目所属的域(名称或 id)。这可在项目名称之间有冲突时使用。

--tag <tag>

要添加到安全组中的标签(重复选项来设置多个标签)

--no-tag

没有与安全组关联的标签

表 71.3. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 71.4. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 71.5. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 71.6. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

71.2. 安全组删除

删除安全组

使用方法:

openstack security group delete [-h] <group> [<group> ...]

表 71.7. 位置参数
概述

<bx id="1" />

要删除的安全组(名称或 ID)

表 71.8. 可选参数
概述

-h, --help

显示帮助信息并退出

71.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>,...]]

表 71.9. 可选参数
概述

-h, --help

显示帮助信息并退出

--project <project>

根据项目列出安全组(名称或 ID)

--project-domain <project-domain>

项目所属的域(名称或 id)。这可在项目名称之间有冲突时使用。

--tags <tag>[,<tag>,…​]

列出具有所有给定标签(Comma 分隔标签列表)的安全组。

--any-tags <tag>[,<tag>,…​]

列出具有任何给定标签(Comma 分隔标签列表)的安全组。

--not-tags <tag>[,<tag>,…​]

排除具有所有给定标签(Comma 分隔标签列表)的安全组

--not-any-tags <tag>[,<tag>,…​]

排除具有任何给定标签(Comma 分隔标签列表)的安全组

表 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 Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

表 71.12. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 71.13. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

71.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>

表 71.14. 位置参数
概述

<bx id="1" />

在此安全组中创建规则(名称或 ID)

表 71.15. 可选参数
概述

-h, --help

显示帮助信息并退出

--remote-ip <ip-address>

远程 IP 地址块(使用 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-frag, ipv6-nonxt, ipv6-opts, ipv6-route, ospf, pgm, rsvp, sctp, sctp, udp, lite, vrrp 和 integer representation [255] 或任何协议。

--ingress

规则适用于传入流量(默认)

--egress

规则应用到外设网络流量

--ethertype <ethertype>

网络流量的 ethertype (ipv4, ipv6;默认:基于 IP 协议)

--project <project>

所有者的项目(名称或 id)

--project-domain <project-domain>

项目所属的域(名称或 id)。这可在项目名称之间有冲突时使用。

表 71.16. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 71.17. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 71.18. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 71.19. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

71.5. 安全组规则删除

删除安全组规则.

使用方法:

openstack security group rule delete [-h] <rule> [<rule> ...]

表 71.20. 位置参数
概述

<rule>

要删除的安全组规则(仅限 ID)

表 71.21. 可选参数
概述

-h, --help

显示帮助信息并退出

71.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>]

表 71.22. 位置参数
概述

<bx id="1" />

列出此安全组中的所有规则(名称或 ID)

表 71.23. 可选参数
概述

-h, --help

显示帮助信息并退出

--protocol <protocol>

使用 ip 协议(ah, dhcp, egp, esp, gre, icmp, igmp, ipv6-encap, ipv6-frag, ipv6-frag, ipv6-nonxt, ipv6-opts, ipv6-route, ospf, pgm, rsvp, sctp, sctp, udp, lite, vrrp 表示 [255] 或任何协议。

--ethertype <ethertype>

按 ethertype (ipv4 或 ipv6)列出规则。

--ingress

列出应用到进入网络流量的规则

--egress

列出应用到传出网络流量的规则

--long

列出输出中的其他字段

表 71.24. 输出格式器
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 71.25. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

表 71.26. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 71.27. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

71.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>

表 71.28. 位置参数
概述

<rule>

显示的安全组规则(仅id only)

表 71.29. 可选参数
概述

-h, --help

显示帮助信息并退出

表 71.30. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 71.31. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 71.32. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 71.33. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

71.8. 安全组集

设置安全组属性

使用方法:

openstack security group set [-h] [--name <new-name>]
                                    [--description <description>]
                                    [--tag <tag>] [--no-tag]
                                    <group>

表 71.34. 位置参数
概述

<bx id="1" />

要修改的安全组(名称或 id)

表 71.35. 可选参数
概述

-h, --help

显示帮助信息并退出

--name <new-name>

新安全组名称

--description <description>

新安全组描述

--tag <tag>

要添加到安全组中的标签(重复选项来设置多个标签)

--no-tag

清除与安全组关联的标签。指定 --tag 和 --no-tag 以覆盖当前标签

71.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>

表 71.36. 位置参数
概述

<bx id="1" />

要显示的安全组(名称或 id)

表 71.37. 可选参数
概述

-h, --help

显示帮助信息并退出

表 71.38. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 71.39. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 71.40. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 71.41. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

71.10. 安全组取消设置

取消设置安全组属性

使用方法:

openstack security group unset [-h] [--tag <tag> | --all-tag] <group>

表 71.42. 位置参数
概述

<bx id="1" />

要修改的安全组(名称或 id)

表 71.43. 可选参数
概述

-h, --help

显示帮助信息并退出

--tag <tag>

要从安全组中删除的标签(重复选项以删除多个标签)

--all-tag

清除与安全组关联的所有标签

第 72 章 server

本章论述了 server 命令下的命令。

72.1. 服务器添加固定 ip

为服务器添加固定 IP 地址

使用方法:

openstack server add fixed ip [-h] [--fixed-ip-address <ip-address>]
                                     <server> <network>

表 72.1. 位置参数
概述

<server>

要接收固定的 IP 地址(名称或 ID)的服务器

<network>

从(名称或 ID)分配固定 IP 地址的网络

表 72.2. 可选参数
概述

-h, --help

显示帮助信息并退出

--fixed-ip-address <ip-address>

请求的固定 IP 地址

72.2. 服务器添加浮动 IP

向服务器添加浮动 IP 地址

使用方法:

openstack server add floating ip [-h] [--fixed-ip-address <ip-address>]
                                        <server> <ip-address>

表 72.3. 位置参数
概述

<server>

要接收浮动 IP 地址的服务器(名称或 ID)

<ip-address>

要分配给第一个可用服务器端口的浮动 IP 地址(仅限 IP)

表 72.4. 可选参数
概述

-h, --help

显示帮助信息并退出

--fixed-ip-address <ip-address>

修复了与这个浮动 IP 地址关联的 ip 地址。将使用包含固定 IP 地址的第一个服务器端口

72.3. 服务器添加网络

将网络添加到服务器

使用方法:

openstack server add network [-h] <server> <network>

表 72.5. 位置参数
概述

<server>

将网络添加到的服务器(名称或 ID)

<network>

要添加到服务器的网络(名称或 ID)

表 72.6. 可选参数
概述

-h, --help

显示帮助信息并退出

72.4. 服务器添加端口

向服务器添加端口

使用方法:

openstack server add port [-h] <server> <port>

表 72.7. 位置参数
概述

<server>

将端口添加到的服务器(名称或 ID)

<port>

要添加到服务器的端口(名称或 ID)

表 72.8. 可选参数
概述

-h, --help

显示帮助信息并退出

72.5. 服务器添加安全组

将安全组添加到服务器

使用方法:

openstack server add security group [-h] <server> <group>

表 72.9. 位置参数
概述

<server>

服务器(名称或 id)

<bx id="1" />

要添加的安全组(名称或 id)

表 72.10. 可选参数
概述

-h, --help

显示帮助信息并退出

72.6. 服务器添加卷

添加卷到 server。指定 ''--os-compute-api-version 2.20' 或更高的版本,将卷添加到状态为 ''SHELVED' 或 ''SHELVED_OFFLOADED' 的服务器中。

使用方法:

openstack server add volume [-h] [--device <device>] <server> <volume>

表 72.11. 位置参数
概述

<server>

服务器(名称或 id)

<volume>

要添加的卷(名称或 id)

表 72.12. 可选参数
概述

-h, --help

显示帮助信息并退出

--device <device>

卷的服务器内部设备名称

72.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>

表 72.13. 位置参数
概述

<server>

服务器备份(名称或 id)

表 72.14. 可选参数
概述

-h, --help

显示帮助信息并退出

--name <image-name>

备份镜像的名称(默认:服务器名称)

--type <backup-type>

用于填充备份镜像的 backup_type 属性(默认:空)

--rotate <count>

要保留的备份数(默认为 1)

--wait

等待备份镜像创建完成

表 72.15. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 72.16. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 72.17. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 72.18. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

72.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>

表 72.19. 位置参数
概述

<server-name>

新服务器名称

表 72.20. 可选参数
概述

-h, --help

显示帮助信息并退出

--image <image>

从该镜像创建服务器引导磁盘(名称或 ID)

--image-property <key=value>

要匹配的 image 属性

--volume <volume>

使用此卷创建服务器作为引导磁盘(名称或 ID)。这个选项自动创建引导索引为 0 的块设备映射。在很多虚拟机监控程序上(例如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>

请求管理程序主机名以创建服务器。默认情况下,管理员仅支持使用 --os-compute-api- 版本 2.74 或更高版本。)

--boot-from-volume <volume-size>

当与 '--image' 或 ''-image-property' 选项结合使用时,此选项会自动创建一个块设备映射,其引导索引为 0,并告知计算服务从指定镜像创建给定大小(以 GB 为单位)的卷,并将它用作服务器的根磁盘。服务器删除时不会删除 root 卷。此选项与 '--volume' 选项相互排斥。

--block-device-mapping <dev-name=mapping>

在服务器上创建块设备。使用 <dev-name>=<id>:<type>:<size (GB)>:<delete-on- terminate> <dev-name>: block 设备名称格式的块设备映射,如: vdb、xvdc (必需)<id>: 卷的名称或 ID、卷快照或镜像(必需)<type>: volume、snapshot 或 image; default: volume (optional)<size (GB)>: if create from image or snapshot (optional)<delete-on-terminate>: true 或 false; default: false (可选)<size (可选)>: 卷大小(可选)<delete-on-terminate>: true 或 false;默认:false (可选)<size (GB)>: 卷大小(可选)<delete-on-terminate>: true 或 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 附加到端口,v4-fixed-ip: IPv4 固定地址(可选)、v6-fixed-ip: IPv6 的 IPv6 固定地址(可选),没有附加网络(v2.37+)。指定 --nic 的 auto 或 none 不能与任何其他 --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>

要启动的最小服务器数量(default=1)

--max <count>

要启动的最大服务器数(default=1)

--wait

等待构建完成

表 72.21. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 72.22. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 72.23. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 72.24. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

72.9. server delete

删除服务器

使用方法:

openstack server delete [-h] [--wait] <server> [<server> ...]

表 72.25. 位置参数
概述

<server>

要删除的服务器(名称或 ID)

表 72.26. 可选参数
概述

-h, --help

显示帮助信息并退出

--wait

等待删除完成

72.10. 服务器转储创建

在 server (s) Trigger 崩溃转储(在服务器)中创建转储文件,并在服务器中创建在 Linux 中 kdump 等功能。它将在服务器中创建转储服务器的转储文件,并将使服务器崩溃。OSC 将转储文件(服务器转储)视为一种资源类型。此命令需要 ''--os-compute-api- version' 2.17 或更高版本。

使用方法:

openstack server dump create [-h] <server> [<server> ...]

表 72.27. 位置参数
概述

<server>

server (s)用于创建转储文件(名称或 ID)

表 72.28. 可选参数
概述

-h, --help

显示帮助信息并退出

72.11. 服务器事件列表

列出服务器的最新事件。指定 ''--os-compute-api-version 2.21'' 或 higher 来显示已删除服务器的事件。

使用方法:

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>

表 72.29. 位置参数
概述

<server>

服务器列出事件(名称或 id)

表 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 Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

表 72.33. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 72.34. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

72.12. 服务器事件显示

显示服务器事件详细信息。指定 ''--os-compute-api-version 2.21'' 或更高的内容,以显示已删除服务器的事件详情。指定 ''--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>

表 72.35. 位置参数
概述

<server>

服务器显示事件详细信息(名称或 ID)

<request-id>

要显示的事件的请求 ID (仅限 ID)

表 72.36. 可选参数
概述

-h, --help

显示帮助信息并退出

表 72.37. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 72.38. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 72.39. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 72.40. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

72.13. Server group create

创建新的服务器组。

使用方法:

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>]
                                     <name>

表 72.41. 位置参数
概述

<name>

新服务器组名称

表 72.42. 可选参数
概述

-h, --help

显示帮助信息并退出

--policy <policy>

为 <name> 添加策略( 关联性 或反关联性 ),默认为 关联性。为 soft-affinitysoft-anti-affinity 策略指定 --os-compute-api- 版本 2.15 或更高版本。

表 72.43. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 72.44. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 72.45. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 72.46. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

72.14. Server group delete

删除现有服务器组。

使用方法:

openstack server group delete [-h] <server-group> [<server-group> ...]

表 72.47. 位置参数
概述

<server-group>

要删除的服务器组(名称或 ID)

表 72.48. 可选参数
概述

-h, --help

显示帮助信息并退出

72.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]

表 72.49. 可选参数
概述

-h, --help

显示帮助信息并退出

--all-projects

显示所有项目的信息(仅管理员)

--long

列出输出中的其他字段

表 72.50. 输出格式器
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 72.51. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

表 72.52. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 72.53. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

72.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>

表 72.54. 位置参数
概述

<server-group>

要显示的服务器组(name 或 id)

表 72.55. 可选参数
概述

-h, --help

显示帮助信息并退出

表 72.56. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 72.57. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 72.58. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 72.59. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

72.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>

表 72.60. 位置参数
概述

<server>

创建镜像的服务器(名称或 id)

表 72.61. 可选参数
概述

-h, --help

显示帮助信息并退出

--name <image-name>

新磁盘镜像的名称(默认:服务器名称)

--wait

等待操作完成

表 72.62. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 72.63. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 72.64. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 72.65. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

72.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]

表 72.66. 可选参数
概述

-h, --help

显示帮助信息并退出

--reservation-id <reservation-id>

仅返回与保留匹配的实例

--ip <ip-address-regex>

匹配 ip 地址的正则表达式

--ip6 <ip-address-regex>

与 ipv6 地址匹配的正则表达式。请注意,此选项仅在使用 ''--os-compute-api-version' 2.5 或更高时,将只适用于非管理员用户。

--name <name-regex>

用于匹配名称的正则表达式

--instance-name <server-name>

用于匹配实例名称的正则表达式(仅限管理员)

--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.mutual with "--name-lookup-one-by-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 或更高。

表 72.67. 输出格式器
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 72.68. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

表 72.69. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 72.70. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

72.19. 服务器锁定

锁定服务器。非管理员用户将无法执行操作

使用方法:

openstack server lock [-h] [--reason <reason>] <server> [<server> ...]

表 72.71. 位置参数
概述

<server>

要锁定的服务器(名称或 ID)

表 72.72. 可选参数
概述

-h, --help

显示帮助信息并退出

--reason <reason>

锁定服务器的原因。需要 ''--os- compute-api-version'' 2.73 或更高。

72.20. 服务器迁移

将服务器迁移到其他主机

使用方法:

openstack server migrate [-h] [--live-migration]
                                [--live <hostname> | --host <hostname>]
                                [--shared-migration | --block-migration]
                                [--disk-overcommit | --no-disk-overcommit]
                                [--wait]
                                <server>

表 72.73. 位置参数
概述

<server>

服务器(名称或 id)

表 72.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 或更高。

--shared-migration

执行共享实时迁移(默认)

--block-migration

执行块实时迁移

--disk-overcommit

在目标主机上允许磁盘过量使用

--no-disk-overcommit

不要在目标主机上过量使用磁盘(默认)

--wait

等待迁移完成

72.21. 服务器暂停

暂停服务器

使用方法:

openstack server pause [-h] <server> [<server> ...]

表 72.75. 位置参数
概述

<server>

server (s)可暂停(名称或 ID)

表 72.76. 可选参数
概述

-h, --help

显示帮助信息并退出

72.22. 服务器重新引导

执行硬或软服务器重启

使用方法:

openstack server reboot [-h] [--hard | --soft] [--wait] <server>

表 72.77. 位置参数
概述

<server>

服务器(名称或 id)

表 72.78. 可选参数
概述

-h, --help

显示帮助信息并退出

--hard

执行硬重启

--soft

执行软重启

--wait

等待重启完成

72.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>

表 72.79. 位置参数
概述

<server>

服务器(名称或 id)

表 72.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

表 72.81. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 72.82. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 72.83. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 72.84. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

72.24. 服务器移除固定 ip

从服务器中删除固定 IP 地址

使用方法:

openstack server remove fixed ip [-h] <server> <ip-address>

表 72.85. 位置参数
概述

<server>

从中删除固定 IP 地址的服务器(名称或 ID)

<ip-address>

修复了要从服务器中删除的 ip 地址(仅ip )

表 72.86. 可选参数
概述

-h, --help

显示帮助信息并退出

72.25. 服务器移除浮动 IP

从服务器移除浮动 IP 地址

使用方法:

openstack server remove floating ip [-h] <server> <ip-address>

表 72.87. 位置参数
概述

<server>

从中删除浮动 IP 地址的服务器(名称或 ID)

<ip-address>

从服务器中删除的浮动 ip 地址(仅ip )

表 72.88. 可选参数
概述

-h, --help

显示帮助信息并退出

72.26. 服务器移除网络

从服务器中删除网络的所有端口

使用方法:

openstack server remove network [-h] <server> <network>

表 72.89. 位置参数
概述

<server>

从中删除端口的服务器(名称或 id)

<network>

从服务器中删除的网络(名称或 id)

表 72.90. 可选参数
概述

-h, --help

显示帮助信息并退出

72.27. 服务器移除端口

从服务器中删除端口

使用方法:

openstack server remove port [-h] <server> <port>

表 72.91. 位置参数
概述

<server>

从中删除端口的服务器(名称或 id)

<port>

从服务器中删除的端口(名称或 id)

表 72.92. 可选参数
概述

-h, --help

显示帮助信息并退出

72.28. 服务器移除安全组

从服务器移除安全组

使用方法:

openstack server remove security group [-h] <server> <group>

表 72.93. 位置参数
概述

<server>

要使用的服务器名称或 ID

<bx id="1" />

要从服务器中删除的安全组的名称或 id

表 72.94. 可选参数
概述

-h, --help

显示帮助信息并退出

72.29. 服务器移除卷

从 server 移除卷。指定 ''--os-compute-api-version 2.20' 或更高的版本 2.20',从状态为 ''SHELVED' 或 ''SHELVED_OFFLOADED' 的服务器中删除卷。

使用方法:

openstack server remove volume [-h] <server> <volume>

表 72.95. 位置参数
概述

<server>

服务器(名称或 id)

<volume>

要移除的卷(名称或 id)

表 72.96. 可选参数
概述

-h, --help

显示帮助信息并退出

72.30. 服务器救援

将 server 置于救援模式中

使用方法:

openstack server rescue [-h] [--image <image>] [--password <password>]
                               <server>

表 72.97. 位置参数
概述

<server>

服务器(名称或 id)

表 72.98. 可选参数
概述

-h, --help

显示帮助信息并退出

--image <image>

用于救援模式的镜像(名称或 id)。默认为当前使用之一。

--password <password>

在 rescued 实例上设置密码

72.31. 服务器重新定义大小确认

确认服务器重新定义大小。确认(验证)调整大小的操作成功并释放旧服务器。

使用方法:

openstack server resize confirm [-h] <server>

表 72.99. 位置参数
概述

<server>

服务器(名称或 id)

表 72.100. 可选参数
概述

-h, --help

显示帮助信息并退出

72.32. 服务器调整大小恢复

恢复服务器调整大小。恢复调整大小的操作。释放新服务器,然后重新启动旧服务器。

使用方法:

openstack server resize revert [-h] <server>

表 72.101. 位置参数
概述

<server>

服务器(名称或 id)

表 72.102. 可选参数
概述

-h, --help

显示帮助信息并退出

72.33. 服务器重新定义大小

将服务器扩展为新类别。通过创建新服务器并将原始磁盘的内容复制到新磁盘来实现大小操作。用户还有两步过程:首先执行调整大小,第二个步骤是确认(验证)成功并释放旧服务器,或者声明恢复以释放新服务器并重新启动旧服务器。

使用方法:

openstack server resize [-h] [--flavor <flavor> | --confirm | --revert]
                               [--wait]
                               <server>

表 72.103. 位置参数
概述

<server>

服务器(名称或 id)

表 72.104. 可选参数
概述

-h, --help

显示帮助信息并退出

--flavor <flavor>

将 server 的大小调整为指定类别

--confirm

确认服务器重新定义大小完成

--revert

在调整大小前恢复服务器状态

--wait

等待调整大小完成

72.34. 服务器恢复

恢复服务器

使用方法:

openstack server restore [-h] <server> [<server> ...]

表 72.105. 位置参数
概述

<server>

要恢复的服务器(名称或 ID)

表 72.106. 可选参数
概述

-h, --help

显示帮助信息并退出

72.35. 服务器恢复

恢复服务器

使用方法:

openstack server resume [-h] <server> [<server> ...]

表 72.107. 位置参数
概述

<server>

要恢复的服务器(名称或 ID)

表 72.108. 可选参数
概述

-h, --help

显示帮助信息并退出

72.36. 服务器集

设置服务器属性

使用方法:

openstack server set [-h] [--name <new-name>] [--root-password]
                            [--property <key=value>] [--state <state>]
                            [--description <description>]
                            <server>

表 72.109. 位置参数
概述

<server>

服务器(名称或 id)

表 72.110. 可选参数
概述

-h, --help

显示帮助信息并退出

--name <new-name>

新服务器名称

--root-password

设置新的 root 密码(仅限交互)

--property <key=value>

为这个服务器添加/更改属性(重复选项以设置多个属性)

--state <state>

新的服务器状态(valid 值:active、error)

--description <description>

新服务器描述(由 --os-compute-api- 版本 2.19 或更高版本支持)

72.37. 服务器搁置

搁置服务器.

使用方法:

openstack server shelve [-h] <server> [<server> ...]

表 72.111. 位置参数
概述

<server>

server (s) to shelve (名称或 ID)

表 72.112. 可选参数
概述

-h, --help

显示帮助信息并退出

72.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>

表 72.113. 位置参数
概述

<server>

服务器(名称或 id)

表 72.114. 可选参数
概述

-h, --help

显示帮助信息并退出

--diagnostics

显示服务器诊断信息

表 72.115. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 72.116. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 72.117. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 72.118. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

72.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>

表 72.119. 位置参数
概述

<server>

服务器(名称或 id)

表 72.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 地址(公共、私有等)

72.40. 服务器启动

启动服务器。

使用方法:

openstack server start [-h] <server> [<server> ...]

表 72.121. 位置参数
概述

<server>

要启动的服务器(名称或 ID)

表 72.122. 可选参数
概述

-h, --help

显示帮助信息并退出

72.41. 服务器停止

停止服务器。

使用方法:

openstack server stop [-h] <server> [<server> ...]

表 72.123. 位置参数
概述

<server>

要停止的服务器(名称或 ID)

表 72.124. 可选参数
概述

-h, --help

显示帮助信息并退出

72.42. 服务器挂起

挂起服务器

使用方法:

openstack server suspend [-h] <server> [<server> ...]

表 72.125. 位置参数
概述

<server>

要挂起的服务器(名称或 ID)

表 72.126. 可选参数
概述

-h, --help

显示帮助信息并退出

72.43. 服务器解锁

解锁服务器

使用方法:

openstack server unlock [-h] <server> [<server> ...]

表 72.127. 位置参数
概述

<server>

服务器解锁(名称或 ID)

表 72.128. 可选参数
概述

-h, --help

显示帮助信息并退出

72.44. 服务器取消暂停

取消暂停服务器

使用方法:

openstack server unpause [-h] <server> [<server> ...]

表 72.129. 位置参数
概述

<server>

要取消暂停的服务器(名称或 ID)

表 72.130. 可选参数
概述

-h, --help

显示帮助信息并退出

72.45. 服务器卸载

从救援模式恢复服务器

使用方法:

openstack server unrescue [-h] <server>

表 72.131. 位置参数
概述

<server>

服务器(名称或 id)

表 72.132. 可选参数
概述

-h, --help

显示帮助信息并退出

72.46. server unset

取消设置服务器属性

使用方法:

openstack server unset [-h] [--property <key>] [--description] <server>

表 72.133. 位置参数
概述

<server>

服务器(名称或 id)

表 72.134. 可选参数
概述

-h, --help

显示帮助信息并退出

--property <key>

从 server 移除的属性键(用于移除多个值的重复选项)

--description

取消设置服务器描述(由 --os-compute-api- 版本 2.19 或更高版本支持)

72.47. Server unshelve

取消搁置服务器.

使用方法:

openstack server unshelve [-h] [--availability-zone AVAILABILITY_ZONE]
                                 <server> [<server> ...]

表 72.135. 位置参数
概述

<server>

server (s) to unshelve (名称或 id)

表 72.136. 可选参数
概述

-h, --help

显示帮助信息并退出

--availability-zone AVAILABILITY_ZONE

清除 SHELVED_OFFLOADED 服务器(受 --os-compute- api-version 2.77 或更高版本支持)的可用区的名称。)

第 73 章 service

本章论述了 service 命令下的命令。

73.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>

表 73.1. 位置参数
概述

<type>

新服务类型(计算、镜像、身份、卷等)

表 73.2. 可选参数
概述

-h, --help

显示帮助信息并退出

--name <name>

新的服务名称

--description <description>

新的服务描述

--enable

启用服务(默认)

--disable

禁用服务

表 73.3. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 73.4. JSON Formatter
概述

--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. service delete

删除服务

使用方法:

openstack service delete [-h] <service> [<service> ...]

表 73.7. 位置参数
概述

<service>

要删除的服务(类型、名称或 ID)

表 73.8. 可选参数
概述

-h, --help

显示帮助信息并退出

73.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]

表 73.9. 可选参数
概述

-h, --help

显示帮助信息并退出

--long

列出输出中的其他字段

表 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 Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

表 73.12. JSON Formatter
概述

--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. Service provider create

创建新服务供应商

使用方法:

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>

表 73.14. 位置参数
概述

<name>

新的服务提供商名称(必须是唯一的)

表 73.15. 可选参数
概述

-h, --help

显示帮助信息并退出

--auth-url <auth-url>

远程联合服务供应商的身份验证 URL (必需)

--description <description>

新的服务提供商描述

--service-provider-url <sp-url>

发送 saml assertions 的服务 URL (必需)

--enable

启用服务提供程序(默认)

--disable

禁用服务供应商

表 73.16. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 73.17. JSON Formatter
概述

--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. Service provider delete

删除服务供应商

使用方法:

openstack service provider delete [-h]
                                         <service-provider>
                                         [<service-provider> ...]

表 73.20. 位置参数
概述

<service-provider>

要删除的服务供应商

表 73.21. 可选参数
概述

-h, --help

显示帮助信息并退出

73.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]

表 73.22. 可选参数
概述

-h, --help

显示帮助信息并退出

表 73.23. 输出格式器
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 73.24. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

表 73.25. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 73.26. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

73.7. 服务供应商设置

设置服务供应商属性

使用方法:

openstack service provider set [-h] [--auth-url <auth-url>]
                                      [--description <description>]
                                      [--service-provider-url <sp-url>]
                                      [--enable | --disable]
                                      <service-provider>

表 73.27. 位置参数
概述

<service-provider>

要修改的服务供应商

表 73.28. 可选参数
概述

-h, --help

显示帮助信息并退出

--auth-url <auth-url>

远程联合服务供应商的新身份验证 URL

--description <description>

新的服务提供商描述

--service-provider-url <sp-url>

新的服务提供商 url,其中会发送 saml assertions

--enable

启用服务供应商

--disable

禁用服务供应商

73.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>

表 73.29. 位置参数
概述

<service-provider>

要显示的服务提供商

表 73.30. 可选参数
概述

-h, --help

显示帮助信息并退出

表 73.31. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 73.32. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 73.33. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 73.34. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

73.9. 服务集

设置服务属性

使用方法:

openstack service set [-h] [--type <type>] [--name <service-name>]
                             [--description <description>]
                             [--enable | --disable]
                             <service>

表 73.35. 位置参数
概述

<service>

要修改的服务(类型、名称或 ID)

表 73.36. 可选参数
概述

-h, --help

显示帮助信息并退出

--type <type>

新服务类型(计算、镜像、身份、卷等)

--name <service-name>

新的服务名称

--description <description>

新的服务描述

--enable

启用服务

--disable

禁用服务

73.10. 服务显示

显示服务详情

使用方法:

openstack service show [-h] [-f {json,shell,table,value,yaml}]
                              [-c COLUMN] [--noindent] [--prefix PREFIX]
                              [--max-width <integer>] [--fit-width]
                              [--print-empty]
                              <service>

表 73.37. 位置参数
概述

<service>

要显示的服务(类型、名称或 ID)

表 73.38. 可选参数
概述

-h, --help

显示帮助信息并退出

表 73.39. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 73.40. JSON Formatter
概述

--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 章 sfc

本章论述了 sfc 命令下的命令。

74.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>

表 74.1. 位置参数
概述

<name>

流类符的名称

表 74.2. 可选参数
概述

-h, --help

显示帮助信息并退出

--description <description>

流类描述

--protocol <protocol>

IP 协议名称。协议名称应当与 iana 标准相同。

--ethertype {IPv4,IPv6}

L2 ethertype,默认为 ipv4

--source-port <min-port>:<max-port>

源协议端口(allowed range [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- 端口在允许范围内。

--source-ip-prefix <source-ip-prefix>

cidr 标记中的源 ip 地址

--destination-ip-prefix <destination-ip-prefix>

cidr 标记中的目的地 IP 地址

--logical-source-port <logical-source-port>

Neutron 源端口(名称或 id)

--logical-destination-port <logical-destination-port>

Neutron 目的地端口(名称或 id)

--l7-parameters L7_PARAMETERS

l7 参数的字典。当前,这个选项不支持值。

表 74.3. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 74.4. JSON Formatter
概述

--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. SFC 流类删除

删除给定的流类符

使用方法:

openstack sfc flow classifier delete [-h] <flow-classifier>

表 74.7. 位置参数
概述

<flow-classifier>

要删除的流类符(名称或 ID)

表 74.8. 可选参数
概述

-h, --help

显示帮助信息并退出

74.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]

表 74.9. 可选参数
概述

-h, --help

显示帮助信息并退出

--long

列出输出中的其他字段

表 74.10. 输出格式器
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 74.11. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

表 74.12. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 74.13. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

74.4. SFC 流类集

设置流类符属性

使用方法:

openstack sfc flow classifier set [-h] [--name <name>]
                                         [--description <description>]
                                         <flow-classifier>

表 74.14. 位置参数
概述

<flow-classifier>

要修改的流类符(名称或 ID)

表 74.15. 可选参数
概述

-h, --help

显示帮助信息并退出

--name <name>

流类符的名称

--description <description>

流类描述

74.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>

表 74.16. 位置参数
概述

<flow-classifier>

要显示流类符(名称或 ID)

表 74.17. 可选参数
概述

-h, --help

显示帮助信息并退出

表 74.18. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 74.19. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 74.20. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 74.21. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

74.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>

表 74.22. 位置参数
概述

<name>

端口链的名称

表 74.23. 可选参数
概述

-h, --help

显示帮助信息并退出

--description <description>

端口链的描述

--flow-classifier <flow-classifier>

添加流类符(名称或 ID)。此选项可以重复。

--chain-parameters correlation=<correlation-type>,symmetric=<boolean>

链参数字典。支持 correlation=(mpls|nsh) (默认为 mpls)和 symmetric=(true|false)。

--port-pair-group <port-pair-group>

添加端口对组(名称或 id)。此选项可以重复。

表 74.24. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 74.25. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 74.26. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 74.27. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

74.7. sfc port chain delete

删除指定端口链

使用方法:

openstack sfc port chain delete [-h] <port-chain>

表 74.28. 位置参数
概述

<port-chain>

要删除的端口链(名称或 id)

表 74.29. 可选参数
概述

-h, --help

显示帮助信息并退出

74.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]

表 74.30. 可选参数
概述

-h, --help

显示帮助信息并退出

--long

列出输出中的其他字段

表 74.31. 输出格式器
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 74.32. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

表 74.33. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 74.34. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

74.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>

表 74.35. 位置参数
概述

<port-chain>

要修改的端口链(名称或 id)

表 74.36. 可选参数
概述

-h, --help

显示帮助信息并退出

--name <name>

端口链的名称

--description <description>

端口链的描述

--flow-classifier <flow-classifier>

添加流类符(名称或 ID)。此选项可以重复。

--no-flow-classifier

从端口链中删除关联的流类符

--port-pair-group <port-pair-group>

添加端口对组(name 或 id)。保留当前端口对组,添加的端口对组将放在端口链的末尾。这个选项可以重复。

--no-port-pair-group

从端口链中删除关联的端口对组。必须至少指定一个 --port-pair-group。

74.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>

表 74.37. 位置参数
概述

<port-chain>

要显示的端口链(名称或 id)

表 74.38. 可选参数
概述

-h, --help

显示帮助信息并退出

表 74.39. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 74.40. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 74.41. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 74.42. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

74.11. SFC 端口链未设置

取消设置端口链属性

使用方法:

openstack sfc port chain unset [-h]
                                      [--flow-classifier <flow-classifier> | --all-flow-classifier]
                                      [--port-pair-group <port-pair-group>]
                                      <port-chain>

表 74.43. 位置参数
概述

<port-chain>

要取消设置的端口链(名称或 id)

表 74.44. 可选参数
概述

-h, --help

显示帮助信息并退出

--flow-classifier <flow-classifier>

从端口链(名称或 ID)中删除流分类器。这个选项可以重复。

--all-flow-classifier

从端口链中删除所有流类符

--port-pair-group <port-pair-group>

从端口链(名称或 ID)中删除端口对组。这个选项可以重复。

74.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>

表 74.45. 位置参数
概述

<name>

端口对的名称

表 74.46. 可选参数
概述

-h, --help

显示帮助信息并退出

--description <description>

端口对的描述

--service-function-parameters correlation=<correlation-type>,weight=<weight>

支持服务函数参数的字典。目前,支持 correlation=(None|mpls|nsh)和 weight。weight 是一个整数,它会影响为流的 port 对选择端口对。权重越高,流量越大将哈希到端口对。默认权重为 1。

--Ingress <ingress>

Ingress neutron 端口(名称或 id)

--egress <egress>

出口 neutron 端口(名称或 id)

表 74.47. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 74.48. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 74.49. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 74.50. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

74.13. SFC 端口对删除

删除给定的端口对

使用方法:

openstack sfc port pair delete [-h] <port-pair>

表 74.51. 位置参数
概述

<port-pair>

要删除的端口对(名称或 id)

表 74.52. 可选参数
概述

-h, --help

显示帮助信息并退出

74.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>

表 74.53. 位置参数
概述

<name>

端口对组群的名称

表 74.54. 可选参数
概述

-h, --help

显示帮助信息并退出

--description <description>

端口对组的描述

--port-pair <port-pair>

端口对(名称或 id)。此选项可以重复。

--enable-tap

此端口对组的端口对部署为 passive tap 服务功能

--disable-tap

此端口对组的端口对部署为 l3 服务功能(默认)

--port-pair-group-parameters lb-fields=<lb-fields>

port pair group 参数的字典。当前只支持一个参数 lb-fields>,它是一个并分开的负载均衡字段列表。

表 74.55. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 74.56. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 74.57. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 74.58. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

74.15. SFC 端口对组删除

删除给定的端口对组

使用方法:

openstack sfc port pair group delete [-h] <port-pair-group>

表 74.59. 位置参数
概述

<port-pair-group>

要删除的端口对组(name 或 id)

表 74.60. 可选参数
概述

-h, --help

显示帮助信息并退出

74.16. SFC 端口对组列表

列出端口对组

使用方法:

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]

表 74.61. 可选参数
概述

-h, --help

显示帮助信息并退出

--long

列出输出中的其他字段

表 74.62. 输出格式器
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 74.63. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

表 74.64. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 74.65. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

74.17. SFC 端口对组集

设置端口对组属性

使用方法:

openstack sfc port pair group set [-h] [--name <name>]
                                         [--description <description>]
                                         [--port-pair <port-pair>]
                                         [--no-port-pair]
                                         <port-pair-group>

表 74.66. 位置参数
概述

<port-pair-group>

要修改的端口组(name 或 id)

表 74.67. 可选参数
概述

-h, --help

显示帮助信息并退出

--name <name>

端口对组群的名称

--description <description>

端口对组的描述

--port-pair <port-pair>

端口对(名称或 id)。此选项可以重复。

--no-port-pair

从端口对组中删除所有端口对

74.18. SFC 端口对组显示

显示端口对组详情

使用方法:

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>

表 74.68. 位置参数
概述

<port-pair-group>

要显示的端口对组(名称或 ID)

表 74.69. 可选参数
概述

-h, --help

显示帮助信息并退出

表 74.70. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 74.71. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 74.72. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 74.73. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

74.19. SFC 端口对组未设置

从端口对组取消设置端口对

使用方法:

openstack sfc port pair group unset [-h]
                                           [--port-pair <port-pair> | --all-port-pair]
                                           <port-pair-group>

表 74.74. 位置参数
概述

<port-pair-group>

要取消设置的端口对组(name 或 id)

表 74.75. 可选参数
概述

-h, --help

显示帮助信息并退出

--port-pair <port-pair>

从端口对(名称或 ID)中删除端口对。这个选项可以重复。

--all-port-pair

从端口对组中删除所有端口对

74.20. SFC 端口对列表

列出端口对

使用方法:

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]

表 74.76. 可选参数
概述

-h, --help

显示帮助信息并退出

--long

列出输出中的其他字段

表 74.77. 输出格式器
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 74.78. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

表 74.79. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 74.80. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

74.21. SFC 端口对集

设置端口对属性

使用方法:

openstack sfc port pair set [-h] [--name <name>]
                                   [--description <description>]
                                   <port-pair>

表 74.81. 位置参数
概述

<port-pair>

要修改的端口对(名称或 id)

表 74.82. 可选参数
概述

-h, --help

显示帮助信息并退出

--name <name>

端口对的名称

--description <description>

端口对的描述

74.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>

表 74.83. 位置参数
概述

<port-pair>

要显示的端口对(名称或 id)

表 74.84. 可选参数
概述

-h, --help

显示帮助信息并退出

表 74.85. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 74.86. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 74.87. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 74.88. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

74.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>

表 74.89. 位置参数
概述

<name>

服务图形的名称。

表 74.90. 可选参数
概述

-h, --help

显示帮助信息并退出

--description DESCRIPTION

服务图形的描述。

--branching-point SRC_CHAIN:DST_CHAIN_1,DST_CHAIN_2,DST_CHAIN_N

服务图形分支点:键是源端口链,而值为目标端口链的列表。这个选项可以重复。

表 74.91. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 74.92. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 74.93. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 74.94. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

74.24. SFC 服务图形删除

删除给定服务图。

使用方法:

openstack sfc service graph delete [-h] <service-graph>

表 74.95. 位置参数
概述

<service-graph>

要删除的服务图形的 ID 或名称。

表 74.96. 可选参数
概述

-h, --help

显示帮助信息并退出

74.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]

表 74.97. 可选参数
概述

-h, --help

显示帮助信息并退出

--long

列出输出中的其他字段

表 74.98. 输出格式器
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 74.99. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

表 74.100. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 74.101. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

74.26. SFC 服务图集

设置服务图形属性

使用方法:

openstack sfc service graph set [-h] [--name <name>]
                                       [--description <description>]
                                       <service-graph>

表 74.102. 位置参数
概述

<service-graph>

要修改的服务图(名称或 id)

表 74.103. 可选参数
概述

-h, --help

显示帮助信息并退出

--name <name>

服务图形的名称

--description <description>

服务图的描述

74.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>

表 74.104. 位置参数
概述

<service-graph>

要显示的服务图形的 ID 或名称。

表 74.105. 可选参数
概述

-h, --help

显示帮助信息并退出

表 74.106. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 74.107. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 74.108. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 74.109. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

第 75 章 软件

本章论述了 软件 命令下的命令。

75.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>

表 75.1. 位置参数
概述

<config-name>

要创建的软件配置的名称

表 75.2. 可选参数
概述

-h, --help

显示帮助信息并退出

--config-file <config-file>

包含定义 <inputs>、<outputs> 和 <options> 的 map 的 json/yaml 的路径

--definition-file <destination-file>

软件配置脚本/数据的路径

--group <group>

软件配置期望的工具名

表 75.3. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 json

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 75.4. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 75.5. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 75.6. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

75.2. 软件配置删除

删除软件配置

使用方法:

openstack software config delete [-h] <config> [<config> ...]

表 75.7. 位置参数
概述

<config>

要删除的软件配置的 ID

表 75.8. 可选参数
概述

-h, --help

显示帮助信息并退出

75.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>]

表 75.9. 可选参数
概述

-h, --help

显示帮助信息并退出

--limit <limit>

限制返回的配置数量

--marker <id>

返回给定配置 ID 后出现的配置

表 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 Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

表 75.12. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 75.13. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

75.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>

表 75.14. 位置参数
概述

<config>

配置的 ID

表 75.15. 可选参数
概述

-h, --help

显示帮助信息并退出

--config-only

仅显示 <config> 属性的值。

表 75.16. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 yaml

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 75.17. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 75.18. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 75.19. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

75.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>

表 75.20. 位置参数
概述

<deployment-name>

与此部署关联的派生配置的名称。这用于对当前部署到服务器的配置列表应用排序顺序。

表 75.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 将创建一个通过 HTTP PUT 信号的 Swift TempURL。ZAQAR_SIGNAL 将使用提供的 keystone 凭证创建一个专用的 zaqar 队列。NO_SIGNAL 将导致资源进入 COMPLETE 状态,而不等待任何信号

--container <container>

要将 temp_url_signal 对象存储在的可选容器名称。如果没有指定容器,则会使用来自 DEPLOY_NAME 的名称来创建

--timeout <timeout>

部署超时时间(分钟)

--server <server>

要部署到的服务器 ID

表 75.22. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 yaml

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 75.23. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 75.24. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 75.25. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

75.6. 软件部署删除

删除软件部署和关联配置。

使用方法:

openstack software deployment delete [-h]
                                            <deployment> [<deployment> ...]

表 75.26. 位置参数
概述

<deployment>

要删除的部署的 ID。

表 75.27. 可选参数
概述

-h, --help

显示帮助信息并退出

75.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]

表 75.28. 可选参数
概述

-h, --help

显示帮助信息并退出

--server <server>

要获取部署的服务器的 ID

--long

列出输出中的更多字段

表 75.29. 输出格式器
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 75.30. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

表 75.31. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 75.32. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

75.8. 软件部署元数据显示

获取指定服务器的部署配置元数据。

使用方法:

openstack software deployment metadata show [-h] <server>

表 75.33. 位置参数
概述

<server>

要获取部署的服务器的 ID

表 75.34. 可选参数
概述

-h, --help

显示帮助信息并退出

75.9. 软件部署输出显示

显示特定的部署输出。

使用方法:

openstack software deployment output show [-h] [--all] [--long]
                                                 <deployment> [<output-name>]

表 75.35. 位置参数
概述

<deployment>

用于显示输出的部署 ID

<output-name>

要显示的输出名称

表 75.36. 可选参数
概述

-h, --help

显示帮助信息并退出

--all

显示所有部署输出

--long

在输出中显示完整的部署日志

75.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>

表 75.37. 位置参数
概述

<deployment>

部署的 ID

表 75.38. 可选参数
概述

-h, --help

显示帮助信息并退出

--long

显示输出中的更多字段

表 75.39. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 75.40. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 75.41. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 75.42. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

第 76 章 堆栈

本章论述了 stack 命令下的命令。

76.1. 堆栈(bandbandon)

放弃堆栈和输出结果.

使用方法:

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>

表 76.1. 位置参数
概述

<stack>

abandon 的堆栈名称或 ID

表 76.2. 可选参数
概述

-h, --help

显示帮助信息并退出

--output-file <output-file>

输出带结果的文件

表 76.3. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 json

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 76.4. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 76.5. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 76.6. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

76.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>

表 76.7. 位置参数
概述

<stack-name>

要采用的堆栈的名称

表 76.8. 可选参数
概述

-h, --help

显示帮助信息并退出

-e <environment>, --environment <environment>

到环境的路径。可以多次指定。

--timeout <timeout>

堆栈创建超时时间(以分钟为单位)

--enable-rollback

在创建/更新失败时启用回滚

--parameter <key=value>

用于创建堆栈的参数值可以多次指定。

--wait

等待堆栈采用完成

--adopt-file <adopt-file>

采用堆栈数据文件的路径

表 76.9. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 76.10. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 76.11. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 76.12. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

76.3. 堆栈取消

取消堆栈的当前任务。取消支持的任务:* 更新 * 创建

使用方法:

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> ...]

表 76.13. 位置参数
概述

<stack>

要取消的堆栈(名称或 ID)

表 76.14. 可选参数
概述

-h, --help

显示帮助信息并退出

--wait

等待取消完成

--no-rollback

取消且无回滚

表 76.15. 输出格式器
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 76.16. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

表 76.17. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 76.18. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

76.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> ...]

表 76.19. 位置参数
概述

<stack>

要检查更新的堆栈(名称或 ID)

表 76.20. 可选参数
概述

-h, --help

显示帮助信息并退出

--wait

等待检查完成

表 76.21. 输出格式器
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 76.22. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

表 76.23. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 76.24. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

76.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>

表 76.25. 位置参数
概述

<stack-name>

要创建的堆栈的名称

表 76.26. 可选参数
概述

-h, --help

显示帮助信息并退出

-e <environment>, --environment <environment>

到环境的路径。可以多次指定。

--timeout <timeout>

堆栈在几分钟内创建超时

--pre-create <resource>

设置预创建 hook 的资源名称。嵌套堆栈中的资源可以使用斜杠作为分隔符来设置:'nested_stack/another/my_resource''。您可以使用通配符来匹配多个堆栈或资源: ''nested_stack/an*/*_resource''。这可以多次指定

--enable-rollback

在创建/更新失败时启用回滚

--parameter <key=value>

用于创建堆栈的参数值。这可以多次指定

--parameter-file <key=file>

用于创建堆栈的文件中的参数值。这可以多次指定。参数值将是文件的内容

--wait

等待堆栈创建_complete 或 CREATE_FAILED

--tags <tag1,tag2…​>

与堆栈关联的标签列表

--dry-run

不要实际执行堆栈创建,但显示要创建的内容

-t <template>, --template <template>

模板的路径

表 76.27. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 76.28. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 76.29. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 76.30. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

76.6. 堆栈删除

删除堆栈。

使用方法:

openstack stack delete [-h] [-y] [--wait] <stack> [<stack> ...]

表 76.31. 位置参数
概述

<stack>

要删除的堆栈(名称或 ID)

表 76.32. 可选参数
概述

-h, --help

显示帮助信息并退出

-Y, --yes

跳过 yes/no 提示符(假设是)

--wait

等待堆栈删除完成

76.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>

表 76.33. 位置参数
概述

<NAME 或 ID>

要查询的堆栈的名称或 id

表 76.34. 可选参数
概述

-h, --help

显示帮助信息并退出

表 76.35. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 yaml

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 76.36. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 76.37. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 76.38. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

76.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>

表 76.39. 位置参数
概述

<stack>

用于显示事件的堆栈名称或 id

表 76.40. 可选参数
概述

-h, --help

显示帮助信息并退出

--resource <resource>

显示. 备注的事件的名称:不能使用 --nested-depth 指定。

--filter <key=value>

过滤要在返回的事件上应用的参数

--limit <limit>

限制返回的事件数量

--marker <id>

仅返回在给定 ID 后出现的事件

--nested-depth <depth>

显示事件的嵌套堆栈的深度。注: 这不能使用 --resource 指定

--sort <key>[:<direction>]

按所选的键和指示(即为 desc)对输出进行排序(默认值: asc)。指定要在多个键上排序的次数。sort 键可以是:"event_time" (default), "resource_name", "links", "logical_resource_id", "resource_status", "resource_status_reason", "physical_resource_id" 或 "id"。您可以将键留空,并指定 ":desc" 以便按反转时间排序。

--follow

打印事件,直到停止进程

表 76.41. 输出格式器
概述

-f {csv,json,log,table,value,yaml}, --format {csv,json,log,table,value,yaml}

输出格式,默认为 log

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 76.42. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

表 76.43. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 76.44. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

76.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>

表 76.45. 位置参数
概述

<stack>

用于显示事件的堆栈名称或 id

<resource>

资源事件的名称

<event>

显示详情的事件 ID

表 76.46. 可选参数
概述

-h, --help

显示帮助信息并退出

表 76.47. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 76.48. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 76.49. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 76.50. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

76.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>

表 76.51. 位置参数
概述

<stack>

要导出的堆栈的名称或 id

表 76.52. 可选参数
概述

-h, --help

显示帮助信息并退出

--output-file <output-file>

用于输出导出数据的文件

表 76.53. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 json

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 76.54. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 76.55. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 76.56. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

76.11. 堆栈失败列表

显示有关失败堆栈资源的信息。

使用方法:

openstack stack failures list [-h] [--long] <stack>

表 76.57. 位置参数
概述

<stack>

要显示的堆栈(名称或 id)

表 76.58. 可选参数
概述

-h, --help

显示帮助信息并退出

--long

在输出中显示完整的部署日志

76.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>

表 76.59. 位置参数
概述

<NAME 或 ID>

要查询的堆栈的名称或 id

表 76.60. 可选参数
概述

-h, --help

显示帮助信息并退出

表 76.61. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 yaml

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 76.62. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 76.63. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 76.64. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

76.13. 堆栈 hook 清除

在给定堆栈中清除资源 hook。

使用方法:

openstack stack hook clear [-h] [--pre-create] [--pre-update]
                                  [--pre-delete]
                                  <stack> <resource> [<resource> ...]

表 76.65. 位置参数
概述

<stack>

要显示的堆栈(名称或 id)

<resource>

用于清除 hook 的资源名称可清除。嵌套堆栈中的资源可以使用斜杠作为分隔符设置:"'nested_stack/another/my_resource'"。您可以使用通配符来匹配多个堆栈或资源: ''nested_stack/an*/*_resource''

表 76.66. 可选参数
概述

-h, --help

显示帮助信息并退出

--pre-create

清除预先创建 hook

--pre-update

清除预更新 hook

--pre-delete

清除前删除 hook

76.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>

表 76.67. 位置参数
概述

<stack>

要显示的堆栈(名称或 id)

表 76.68. 可选参数
概述

-h, --help

显示帮助信息并退出

--nested-depth <nested-depth>

显示 hook 的嵌套堆栈的深度

表 76.69. 输出格式器
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 76.70. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

表 76.71. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 76.72. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

76.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]

表 76.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>]

按所选的键和指示(即为 desc)对输出进行排序(默认值: asc)。指定要在多个属性上排序的次数

--all-projects

包含所有项目(仅限管理员)

--short

列出输出中的更少字段

--long

列出输出中的附加字段,它被 --all-projects表示

表 76.74. 输出格式器
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 76.75. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

表 76.76. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 76.77. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

76.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>

表 76.78. 位置参数
概述

<stack>

要查询的堆栈的名称或 id

表 76.79. 可选参数
概述

-h, --help

显示帮助信息并退出

表 76.80. 输出格式器
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 76.81. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

表 76.82. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 76.83. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

76.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>]

表 76.84. 位置参数
概述

<stack>

要查询的堆栈的名称或 id

<output>

要显示的输出名称

表 76.85. 可选参数
概述

-h, --help

显示帮助信息并退出

--all

显示所有堆栈输出

表 76.86. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 76.87. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 76.88. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 76.89. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

76.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>

表 76.90. 位置参数
概述

<stack>

要查询的堆栈的名称或 id

表 76.91. 可选参数
概述

-h, --help

显示帮助信息并退出

--long

启用在资源列表中为每个资源显示的详细信息

-n <nested-depth>, --nested-depth <nested-depth>

嵌套堆栈的深度,显示资源

--filter <key=value>

过滤参数,以根据其名称、状态、类型、操作、ID 和 physical_resource_id 应用到返回的资源

表 76.92. 输出格式器
概述

-f {csv,dot,json,table,value,yaml}, --format {csv,dot,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 76.93. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

表 76.94. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 76.95. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

76.19. 堆栈资源标记不健康

设置资源的健康状况。

使用方法:

openstack stack resource mark unhealthy [-h] [--reset]
                                               <stack> <resource> [reason]

表 76.96. 位置参数
概述

<stack>

资源所属的堆栈名称或 ID

<resource>

资源名称

reason

状态更改原因

表 76.97. 可选参数
概述

-h, --help

显示帮助信息并退出

--reset

将资源设置为健康

76.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>

表 76.98. 位置参数
概述

<stack>

要显示的堆栈(名称或 id)

<resource>

要显示元数据的资源名称

表 76.99. 可选参数
概述

-h, --help

显示帮助信息并退出

表 76.100. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 json

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 76.101. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 76.102. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 76.103. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

76.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>

表 76.104. 位置参数
概述

<stack>

要查询的堆栈的名称或 id

<resource>

资源名称

表 76.105. 可选参数
概述

-h, --help

显示帮助信息并退出

--with-attr <attribute>

要显示的属性,可多次指定

表 76.106. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 76.107. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 76.108. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 76.109. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

76.22. 堆栈资源信号

发送带有可选数据的资源。

使用方法:

openstack stack resource signal [-h] [--data <data>]
                                       [--data-file <data-file>]
                                       <stack> <resource>

表 76.110. 位置参数
概述

<stack>

资源所属的堆栈名称或 ID

<resource>

信号的问题名称

表 76.111. 可选参数
概述

-h, --help

显示帮助信息并退出

--data <data>

要发送到信号处理程序的 JSON 数据

--data-file <data-file>

包含发送到信号处理程序的 json 数据的文件

76.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> ...]

表 76.112. 位置参数
概述

<stack>

要恢复的堆栈(名称或 ID)

表 76.113. 可选参数
概述

-h, --help

显示帮助信息并退出

--wait

等待恢复完成

表 76.114. 输出格式器
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 76.115. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

表 76.116. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 76.117. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

76.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>

表 76.118. 位置参数
概述

<stack>

要显示的堆栈(名称或 id)

表 76.119. 可选参数
概述

-h, --help

显示帮助信息并退出

--no-resolve-outputs

不要解析堆栈的输出。

表 76.120. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 76.121. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 76.122. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 76.123. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

76.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>

表 76.124. 位置参数
概述

<stack>

堆栈的名称或 id

表 76.125. 可选参数
概述

-h, --help

显示帮助信息并退出

--name <name>

快照的名称

表 76.126. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 76.127. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 76.128. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 76.129. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

76.26. 堆栈快照删除

删除堆栈快照。

使用方法:

openstack stack snapshot delete [-h] [-y] <stack> <snapshot>

表 76.130. 位置参数
概述

<stack>

堆栈的名称或 id

<snapshot>

堆栈快照的 ID

表 76.131. 可选参数
概述

-h, --help

显示帮助信息并退出

-Y, --yes

跳过 yes/no 提示符(假设是)

76.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>

表 76.132. 位置参数
概述

<stack>

包含快照的堆栈名称或 ID

表 76.133. 可选参数
概述

-h, --help

显示帮助信息并退出

表 76.134. 输出格式器
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 76.135. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

表 76.136. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 76.137. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

76.28. 堆栈快照恢复

恢复堆栈快照

使用方法:

openstack stack snapshot restore [-h] <stack> <snapshot>

表 76.138. 位置参数
概述

<stack>

包含快照的堆栈名称或 ID

<snapshot>

恢复的快照 ID

表 76.139. 可选参数
概述

-h, --help

显示帮助信息并退出

76.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>

表 76.140. 位置参数
概述

<stack>

包含快照的堆栈名称或 ID

<snapshot>

要显示的快照 ID

表 76.141. 可选参数
概述

-h, --help

显示帮助信息并退出

表 76.142. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 yaml

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 76.143. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 76.144. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 76.145. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

76.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> ...]

表 76.146. 位置参数
概述

<stack>

要暂停的堆栈(名称或 ID)

表 76.147. 可选参数
概述

-h, --help

显示帮助信息并退出

--wait

等待挂起完成

表 76.148. 输出格式器
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 76.149. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

表 76.150. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 76.151. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

76.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>

表 76.152. 位置参数
概述

<stack>

要查询的堆栈的名称或 id

表 76.153. 可选参数
概述

-h, --help

显示帮助信息并退出

表 76.154. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 yaml

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 76.155. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 76.156. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 76.157. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

76.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>

表 76.158. 位置参数
概述

<stack>

要更新的堆栈名称或 ID

表 76.159. 可选参数
概述

-h, --help

显示帮助信息并退出

-t <template>, --template <template>

模板的路径

-e <environment>, --environment <environment>

到环境的路径。可以多次指定。

--pre-update <resource>

要将预更新 hook 设置为的资源的名称。嵌套堆栈中的资源可以使用斜杠作为分隔符来设置:'nested_stack/another/my_resource''。您可以使用通配符来匹配多个堆栈或资源: ''nested_stack/an*/*_resource''。这可以多次指定

--timeout <timeout>

堆栈更新超时(以分钟为单位)

--rollback <value>

在更新失败时设置回滚。值 "enabled" 会将回滚设置为启用。值 "disabled" 将回滚设置为 disabled。值 "keep" 使用现有堆栈的值进行更新(默认)

--dry-run

不要实际执行堆栈更新,但显示将要更改的内容

--show-nested

在执行 --dry-run 时显示嵌套堆栈

--parameter <key=value>

用于创建堆栈的参数值。这可以多次指定

--parameter-file <key=file>

用于创建堆栈的文件中的参数值。这可以多次指定。参数值将是文件的内容

--existing

重新使用当前堆栈的模板、参数和环境。如果省略了模板参数,则使用现有模板。如果没有指定 --environment,则会使用现有的环境。参数中指定的参数将针对当前堆栈中的现有值进行补丁。省略的参数会保留现有值

--clear-parameter <parameter>

从 stack-update 的当前堆栈的参数集合中删除参数。将使用模板中的默认值。这可以多次指定

--tags <tag1,tag2…​>

与堆栈关联的标签的更新列表

--wait

等待堆栈变为 update_complete 或 UPDATE_FAILED

--converge

以事实上观察堆栈更新。

表 76.160. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 76.161. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 76.162. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 76.163. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

第 77 章 子网

本章论述了 subnet 命令下的命令。

77.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>

表 77.1. 位置参数
概述

<name>

新子网名称

表 77.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 格式,使用 prefix-delegation,并在外部分配 ip

--use-default-subnet-pool

为 --ip-version 使用默认子网池

--prefix-length <prefix-length>

从子网池子网分配的前缀长度

--subnet-range <subnet-range>

cidr 标记中的子网范围(如果未指定 --subnet- 池,否则可选)

--dhcp

启用 dhcp (默认)

--no-dhcp

禁用 dhcp

--gateway <gateway>

为子网指定网关。三个选项为:<ip-address>:将特定 IP 地址用作网关,自动从子网中选择网关地址,不会从子网中选择:此子网不使用网关,例如:--gateway 192.168.9.1、--gateway auto、--gateway none (默认自动)。

--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 地址 e.g.: start=192.168.199.2,end=192.168.199.254 (重复选项来添加多个 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 目标:目标子网(在 CIDR 表示法中)网关: nexthop IP 地址(用于添加多个路由)

--service-type <service-type>

此子网的服务类型,如 network:floatingip_agent_gateway。必须是网络端口的有效设备所有者值(重复选项来设置多个服务类型)

--tag <tag>

要添加到子网的标签(重复选项来设置多个标签)

--no-tag

没有与子网关联的标签

表 77.3. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 77.4. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 77.5. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 77.6. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

77.2. 子网删除

删除子网

使用方法:

openstack subnet delete [-h] <subnet> [<subnet> ...]

表 77.7. 位置参数
概述

<subnet>

要删除的子网(名称或 ID)

表 77.8. 可选参数
概述

-h, --help

显示帮助信息并退出

77.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>,...]]

表 77.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 <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>,…​]

排除具有任何给定标签(组合标签列表)的子网。)

表 77.10. 输出格式器
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 77.11. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

表 77.12. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 77.13. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

77.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>

表 77.14. 位置参数
概述

<name>

新子网池的名称

表 77.15. 可选参数
概述

-h, --help

显示帮助信息并退出

--pool-prefix <pool-prefix>

设置子网池前缀(在 cidr 表示法中)(使用 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>

为此子网池设置默认的 per-project 配额,作为可以从子网池分配的 IP 地址数

--tag <tag>

要添加到子网池的标签(重复选项来设置多个标签)

--no-tag

没有与子网池关联的标签

表 77.16. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 77.17. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 77.18. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 77.19. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

77.5. 子网池删除

删除子网池

使用方法:

openstack subnet pool delete [-h] <subnet-pool> [<subnet-pool> ...]

表 77.20. 位置参数
概述

<subnet-pool>

要删除的子网池(名称或 ID)

表 77.21. 可选参数
概述

-h, --help

显示帮助信息并退出

77.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>,...]]

表 77.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>,…​]

排除具有所有给定标签(Comma 分隔标签列表)的子网池。

--not-any-tags <tag>[,<tag>,…​]

排除具有任何给定标签(Comma 分隔标签列表)的子网池。

表 77.23. 输出格式器
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

表 77.24. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

表 77.25. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 77.26. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

77.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>

表 77.27. 位置参数
概述

<subnet-pool>

要修改的子网池(名称或 ID)

表 77.28. 可选参数
概述

-h, --help

显示帮助信息并退出

--name <name>

设置子网池名称

--pool-prefix <pool-prefix>

设置子网池前缀(在 cidr 表示法中)(使用 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>

为此子网池设置默认的 per-project 配额,作为可以从子网池分配的 IP 地址数

--tag <tag>

要添加到子网池的标签(重复选项来设置多个标签)

--no-tag

清除与子网池关联的标签。指定 --tag 和 --no-tag 以覆盖当前标签

77.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>

表 77.29. 位置参数
概述

<subnet-pool>

要显示的子网池(名称或 id)

表 77.30. 可选参数
概述

-h, --help

显示帮助信息并退出

表 77.31. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 77.32. JSON Formatter
概述

--noindent

是否禁用缩进 json

表 77.33. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

表 77.34. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

77.9. 子网池未设置

取消设置子网池属性

使用方法:

openstack subnet pool unset [-h] [--tag <tag> | --all-tag]
                                   <subnet-pool>

表 77.35. 位置参数
概述

<subnet-pool>

要修改的子网池(名称或 ID)

表 77.36. 可选参数
概述

-h, --help

显示帮助信息并退出

--tag <tag>

要从子网池中删除标签(重复选项以删除多个标签)

--all-tag

清除与子网池关联的所有标签

77.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>

表 77.37. 位置参数
概述

<subnet>

要修改的子网(名称或 ID)

表 77.38. 可选参数
概述

-h, --help

显示帮助信息并退出

--name <name>

更新了子网的名称

--dhcp

启用 dhcp