命令行界面参考


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>]
Copy to Clipboard Toggle word wrap

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 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> 关联的验证器(必需)

Expand
表 2.2. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 2.3. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 2.4. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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
Copy to Clipboard Toggle word wrap

Expand
表 3.1. 位置参数
概述

URI

secret 或容器的 uri 引用。

Expand
表 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
Copy to Clipboard Toggle word wrap

Expand
表 3.3. 位置参数
概述

URI

secret 或容器的 uri 引用。

Expand
表 3.4. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 3.5. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 3.6. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 3.7. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 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
Copy to Clipboard Toggle word wrap

Expand
表 3.9. 位置参数
概述

URI

secret 或容器的 uri 引用。

Expand
表 3.10. 可选参数
概述

-h, --help

显示帮助信息并退出

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

acl 的 Keystone userid.

--project-access

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

--no-project-access

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

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

为设置 barbican 操作 acl 的类型

Expand
表 3.11. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 3.12. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 3.13. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 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
Copy to Clipboard Toggle word wrap

Expand
表 3.15. 位置参数
概述

URI

secret 或容器的 uri 引用。

Expand
表 3.16. 可选参数
概述

-h, --help

显示帮助信息并退出

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

acl 的 Keystone userid.

--project-access

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

--no-project-access

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

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

为设置 barbican 操作 acl 的类型

Expand
表 3.17. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 3.18. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 3.19. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 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
Copy to Clipboard Toggle word wrap

Expand
表 3.21. 位置参数
概述

URI

secret 或容器的 uri 引用。

Expand
表 3.22. 可选参数
概述

-h, --help

显示帮助信息并退出

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

acl 的 Keystone userid.

--project-access

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

--no-project-access

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

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

为设置 barbican 操作 acl 的类型

Expand
表 3.23. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 3.24. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 3.25. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 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
Copy to Clipboard Toggle word wrap

Expand
表 4.1. 位置参数
概述

定义

操作定义文件

Expand
表 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"。

Expand
表 4.3. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 4.4. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 4.5. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 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
Copy to Clipboard Toggle word wrap

Expand
表 4.7. 位置参数
概述

name

操作名称

Expand
表 4.8. 可选参数
概述

-h, --help

显示帮助信息并退出

4.3. 操作定义删除

删除操作.

使用方法:

openstack action definition delete [-h] action [action ...]
Copy to Clipboard Toggle word wrap

Expand
表 4.9. 位置参数
概述

action

操作的名称或 id。

Expand
表 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]
Copy to Clipboard Toggle word wrap

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

过滤器. 可以重复。

Expand
表 4.12. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 4.13. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 4.14. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 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
Copy to Clipboard Toggle word wrap

Expand
表 4.16. 位置参数
概述

action

操作(名称或 id)

Expand
表 4.17. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 4.18. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 4.19. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 4.20. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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
Copy to Clipboard Toggle word wrap

Expand
表 4.22. 位置参数
概述

定义

操作定义文件

Expand
表 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"。

Expand
表 4.24. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 4.25. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 4.26. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 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 ...]
Copy to Clipboard Toggle word wrap

Expand
表 4.28. 位置参数
概述

action_execution

操作执行标识符 ID。

Expand
表 4.29. 可选参数
概述

-h, --help

显示帮助信息并退出

4.8. 操作执行输入显示

显示操作执行输入数据。

使用方法:

openstack action execution input show [-h] id
Copy to Clipboard Toggle word wrap

Expand
表 4.30. 位置参数
概述

id

操作执行 ID.

Expand
表 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]
Copy to Clipboard Toggle word wrap

Expand
表 4.32. 位置参数
概述

task_execution_id

任务执行 ID。

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

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

Expand
表 4.34. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 4.35. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 4.36. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 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
Copy to Clipboard Toggle word wrap

Expand
表 4.38. 位置参数
概述

id

操作执行 ID.

Expand
表 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]
Copy to Clipboard Toggle word wrap

Expand
表 4.40. 位置参数
概述

name

要执行的操作名称。

输入

操作输入.

Expand
表 4.41. 可选参数
概述

-h, --help

显示帮助信息并退出

-s, --save-result

将结果保存到 db 中。

--run-sync

同步运行操作。

-t TARGET, --target TARGET

操作将针对 <target> executor 执行。

Expand
表 4.42. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 4.43. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 4.44. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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
Copy to Clipboard Toggle word wrap

Expand
表 4.46. 位置参数
概述

action_execution

操作执行 ID.

Expand
表 4.47. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 4.48. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 4.49. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 4.50. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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
Copy to Clipboard Toggle word wrap

Expand
表 4.52. 位置参数
概述

id

操作执行 ID.

Expand
表 4.53. 可选参数
概述

-h, --help

显示帮助信息并退出

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

操作执行状态

--output OUTPUT

操作执行输出

Expand
表 4.54. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 4.55. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 4.56. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 5.1. 位置参数
概述

<name>

新地址范围名称

Expand
表 5.2. 可选参数
概述

-h, --help

显示帮助信息并退出

--ip-version {4,6}

IP 版本(默认为 4)

--project <project>

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

--project-domain <project-domain>

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

--share

在项目间共享地址范围

--no-share

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

Expand
表 5.3. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 5.4. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 5.5. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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> ...]
Copy to Clipboard Toggle word wrap

Expand
表 5.7. 位置参数
概述

<address-scope>

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

Expand
表 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]
Copy to Clipboard Toggle word wrap

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

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

Expand
表 5.10. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 5.11. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 5.12. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 5.14. 位置参数
概述

<address-scope>

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

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 5.16. 位置参数
概述

<address-scope>

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

Expand
表 5.17. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 5.18. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 5.19. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 5.20. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 6.1. 位置参数
概述

<aggregate>

聚合(名称或 ID)

<host>

要添加到 <aggregate> 的主机

Expand
表 6.2. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 6.3. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 6.4. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 6.5. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 6.7. 位置参数
概述

<name>

新聚合名称

Expand
表 6.8. 可选参数
概述

-h, --help

显示帮助信息并退出

--zone <availability-zone>

可用区名称

--property <key=value>

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

Expand
表 6.9. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 6.10. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 6.11. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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> ...]
Copy to Clipboard Toggle word wrap

Expand
表 6.13. 位置参数
概述

<aggregate>

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

Expand
表 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]
Copy to Clipboard Toggle word wrap

Expand
表 6.15. 可选参数
概述

-h, --help

显示帮助信息并退出

--long

列出输出中的其他字段

Expand
表 6.16. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 6.17. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 6.18. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 6.20. 位置参数
概述

<aggregate>

聚合(名称或 ID)

<host>

从 <aggregate> 中删除的主机

Expand
表 6.21. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 6.22. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 6.23. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 6.24. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 6.26. 位置参数
概述

<aggregate>

聚合以修改(名称或 ID)

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 6.28. 位置参数
概述

<aggregate>

聚合显示(名称或 id)

Expand
表 6.29. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 6.30. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 6.31. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 6.32. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 6.34. 位置参数
概述

<aggregate>

聚合以修改(名称或 ID)

Expand
表 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>]
Copy to Clipboard Toggle word wrap

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

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

Expand
表 7.2. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 7.3. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 7.4. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 7.5. 表格式
概述

--max-width <integer>

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

--fit-width

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

--print-empty

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

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

要评估的阈值。

Expand
表 7.7. 事件警报
概述

--event-type <EVENT_TYPE>

要评估的事件类型

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

--granularity <GRANULARITY>

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

--aggregation-method <AGGR_METHOD>

与阈值相比的 aggregation_method。

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

根据警报类型的指标 ID 或名称

Expand
表 7.9. Gnocchi 资源阈值警报
概述

--resource-type <RESOURCE_TYPE>

资源的类型。

--resource-id <RESOURCE_ID>

资源的 ID。

Expand
表 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>]
Copy to Clipboard Toggle word wrap

Expand
表 7.11. 位置参数
概述

<ALARM ID 或 NAME>

警报的 ID 或名称。

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 7.18. 位置参数
概述

<alarm-id>

警报 ID

Expand
表 7.19. 可选参数
概述

-h, --help

显示帮助信息并退出

--limit <LIMIT>

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

--marker <MARKER>

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

--sort <SORT_KEY:SORT_DIR>

资源属性的排序。例如 timestamp:desc

Expand
表 7.20. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 7.21. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 7.22. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 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>]
Copy to Clipboard Toggle word wrap

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

Expand
表 7.25. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 7.26. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 7.27. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 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>]
Copy to Clipboard Toggle word wrap

Expand
表 7.29. 位置参数
概述

<ALARM ID 或 NAME>

警报的 ID 或名称。

Expand
表 7.30. 可选参数
概述

-h, --help

显示帮助信息并退出

--name <NAME>

警报的名称

Expand
表 7.31. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 7.32. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 7.33. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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>]
Copy to Clipboard Toggle word wrap

Expand
表 7.35. 位置参数
概述

<ALARM ID 或 NAME>

警报的 ID 或名称。

Expand
表 7.36. 可选参数
概述

-h, --help

显示帮助信息并退出

--name <NAME>

警报的名称

Expand
表 7.37. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 7.38. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 7.39. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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>]
Copy to Clipboard Toggle word wrap

Expand
表 7.41. 位置参数
概述

<ALARM ID 或 NAME>

警报的 ID 或名称。

Expand
表 7.42. 可选参数
概述

-h, --help

显示帮助信息并退出

--name <NAME>

警报的名称

--state <STATE>

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

Expand
表 7.43. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 7.44. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 7.45. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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>]
Copy to Clipboard Toggle word wrap

Expand
表 7.47. 位置参数
概述

<ALARM ID 或 NAME>

警报的 ID 或名称。

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

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

Expand
表 7.49. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 7.50. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 7.51. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 7.52. 表格式
概述

--max-width <integer>

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

--fit-width

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

--print-empty

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

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

要评估的阈值。

Expand
表 7.54. 事件警报
概述

--event-type <EVENT_TYPE>

要评估的事件类型

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

--granularity <GRANULARITY>

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

--aggregation-method <AGGR_METHOD>

与阈值相比的 aggregation_method。

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

根据警报类型的指标 ID 或名称

Expand
表 7.56. Gnocchi 资源阈值警报
概述

--resource-type <RESOURCE_TYPE>

资源的类型。

--resource-id <RESOURCE_ID>

资源的 ID。

Expand
表 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]
Copy to Clipboard Toggle word wrap

Expand
表 8.1. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 8.2. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 8.3. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 8.4. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 9.1. 位置参数
概述

<name>

应用程序凭证的名称

Expand
表 9.2. 可选参数
概述

-h, --help

显示帮助信息并退出

--secret <secret>

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

--role <role>

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

--expiration <expiration>

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

--description <description>

应用程序凭证描述

--unrestricted

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

--restricted

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

Expand
表 9.3. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 9.4. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 9.5. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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> ...]
Copy to Clipboard Toggle word wrap

Expand
表 9.7. 位置参数
概述

<application-credential>

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

Expand
表 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>]
Copy to Clipboard Toggle word wrap

Expand
表 9.9. 可选参数
概述

-h, --help

显示帮助信息并退出

--user <user>

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

--user-domain <user-domain>

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

Expand
表 9.10. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 9.11. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 9.12. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 9.14. 位置参数
概述

<application-credential>

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

Expand
表 9.15. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 9.16. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 9.17. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 9.18. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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]
Copy to Clipboard Toggle word wrap

Expand
表 10.1. 可选参数
概述

-h, --help

显示帮助信息并退出

--compute

列出计算可用区

--network

列出网络可用区

--volume

列出卷可用区

--long

列出输出中的其他字段

Expand
表 10.2. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 10.3. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 10.4. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 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]
Copy to Clipboard Toggle word wrap

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

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

Expand
表 11.2. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 11.3. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 11.4. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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> ...]
Copy to Clipboard Toggle word wrap

Expand
表 11.6. 位置参数
概述

<allocation>

分配要删除的分配(name 或 uuid)。

Expand
表 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> ...]]
Copy to Clipboard Toggle word wrap

Expand
表 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 时,不能使用。

Expand
表 11.9. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 11.10. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 11.11. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 11.13. 位置参数
概述

<allocation>

分配的名称或 uuid

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 11.15. 位置参数
概述

<id>

分配的 UUID 或名称

Expand
表 11.16. 可选参数
概述

-h, --help

显示帮助信息并退出

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

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

Expand
表 11.17. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 11.18. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 11.19. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 11.21. 位置参数
概述

<allocation>

分配的名称或 uuid

Expand
表 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>]
Copy to Clipboard Toggle word wrap

Expand
表 11.23. 可选参数
概述

-h, --help

显示帮助信息并退出

--description <description>

chassis 描述

--extra <key=value>

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

--uuid <uuid>

chassis 的唯一 uuid

Expand
表 11.24. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 11.25. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 11.26. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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> ...]
Copy to Clipboard Toggle word wrap

Expand
表 11.28. 位置参数
概述

<chassis>

要删除的机箱的 UUID

Expand
表 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>]]
Copy to Clipboard Toggle word wrap

Expand
表 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)。可以用逗号分隔来指定多个字段和方向。

Expand
表 11.31. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 11.32. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 11.33. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 11.35. 位置参数
概述

<chassis>

chassis 的 UUID

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 11.37. 位置参数
概述

<chassis>

chassis 的 UUID

Expand
表 11.38. 可选参数
概述

-h, --help

显示帮助信息并退出

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

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

Expand
表 11.39. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 11.40. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 11.41. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 11.43. 位置参数
概述

<chassis>

chassis 的 UUID

Expand
表 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> ...]]
Copy to Clipboard Toggle word wrap

Expand
表 11.45. 可选参数
概述

-h, --help

显示帮助信息并退出

--limit <limit>

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

--marker <conductor>

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

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

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

--long

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

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

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

Expand
表 11.46. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 11.47. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 11.48. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 11.50. 位置参数
概述

<conductor>

编排器的主机名

Expand
表 11.51. 可选参数
概述

-h, --help

显示帮助信息并退出

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

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

Expand
表 11.52. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 11.53. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 11.54. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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> ...]
Copy to Clipboard Toggle word wrap

Expand
表 11.56. 位置参数
概述

<file>

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

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 11.58. 位置参数
概述

<name>

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

Expand
表 11.59. 可选参数
概述

-h, --help

显示帮助信息并退出

--uuid <uuid>

deploy 模板的 UUID。

--extra <key=value>

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

--steps <steps>

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

Expand
表 11.60. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 11.61. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 11.62. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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> ...]
Copy to Clipboard Toggle word wrap

Expand
表 11.64. 位置参数
概述

<template>

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

Expand
表 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> ...]]
Copy to Clipboard Toggle word wrap

Expand
表 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 时无法使用。

Expand
表 11.67. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 11.68. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 11.69. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 11.71. 位置参数
概述

<template>

部署模板的名称或 uuid

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 11.73. 位置参数
概述

<template>

部署模板的名称或 uuid。

Expand
表 11.74. 可选参数
概述

-h, --help

显示帮助信息并退出

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

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

Expand
表 11.75. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 11.76. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 11.77. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 11.79. 位置参数
概述

<template>

部署模板的名称或 uuid

Expand
表 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]
Copy to Clipboard Toggle word wrap

Expand
表 11.81. 可选参数
概述

-h, --help

显示帮助信息并退出

--type <type>

驱动程序类型("classic"或"ynamic")。默认值为所有它们。

--long

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

Expand
表 11.82. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 11.83. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 11.84. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 11.86. 位置参数
概述

<driver>

驱动程序的名称。

<method>

供应商传递方法需要被调用。

Expand
表 11.87. 可选参数
概述

-h, --help

显示帮助信息并退出

--arg <key=value>

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

--http-method <http-method>

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

Expand
表 11.88. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 11.89. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 11.90. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 11.92. 位置参数
概述

<driver>

驱动程序的名称。

Expand
表 11.93. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 11.94. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 11.95. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 11.96. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 11.98. 位置参数
概述

<driver>

驱动程序的名称。

Expand
表 11.99. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 11.100. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 11.101. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 11.102. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 11.104. 位置参数
概述

<driver>

驱动程序的名称。

Expand
表 11.105. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 11.106. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 11.107. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 11.108. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 11.110. 位置参数
概述

<driver>

驱动程序的名称。

Expand
表 11.111. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 11.112. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 11.113. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 11.114. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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
Copy to Clipboard Toggle word wrap

Expand
表 11.116. 位置参数
概述

node

裸机恢复节点 uuid 或名称

Expand
表 11.117. 可选参数
概述

-h, --help

显示帮助信息并退出

11.29. 裸机内省数据保存

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

使用方法:

openstack baremetal introspection data save [-h] [--file <filename>]
                                                   node
Copy to Clipboard Toggle word wrap

Expand
表 11.118. 位置参数
概述

node

裸机恢复节点 uuid 或名称

Expand
表 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
Copy to Clipboard Toggle word wrap

Expand
表 11.120. 位置参数
概述

node_ident

裸机恢复节点 uuid 或名称

Expand
表 11.121. 可选参数
概述

-h, --help

显示帮助信息并退出

--vlan VLAN

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

--long

显示有关接口的详细信息。

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

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

Expand
表 11.122. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 11.123. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 11.124. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 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
Copy to Clipboard Toggle word wrap

Expand
表 11.126. 位置参数
概述

node_ident

裸机恢复节点 uuid 或名称

interface

接口名称

Expand
表 11.127. 可选参数
概述

-h, --help

显示帮助信息并退出

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

显示一个或多个字段。

Expand
表 11.128. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 11.129. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 11.130. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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]
Copy to Clipboard Toggle word wrap

Expand
表 11.132. 可选参数
概述

-h, --help

显示帮助信息并退出

--marker MARKER

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

--limit LIMIT

要返回的项目数量

Expand
表 11.133. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 11.134. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 11.135. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 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
Copy to Clipboard Toggle word wrap

Expand
表 11.137. 位置参数
概述

node

裸机恢复节点 uuid 或名称

Expand
表 11.138. 可选参数
概述

-h, --help

显示帮助信息并退出

11.34. 裸机内省规则删除

删除内省规则。

使用方法:

openstack baremetal introspection rule delete [-h] uuid
Copy to Clipboard Toggle word wrap

Expand
表 11.139. 位置参数
概述

uuid

规则 uuid

Expand
表 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
Copy to Clipboard Toggle word wrap

Expand
表 11.141. 位置参数
概述

file

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

Expand
表 11.142. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 11.143. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 11.144. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 11.145. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 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]
Copy to Clipboard Toggle word wrap

Expand
表 11.147. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 11.148. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 11.149. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 11.150. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 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]
Copy to Clipboard Toggle word wrap

Expand
表 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
Copy to Clipboard Toggle word wrap

Expand
表 11.153. 位置参数
概述

uuid

规则 uuid

Expand
表 11.154. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 11.155. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 11.156. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 11.157. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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 ...]
Copy to Clipboard Toggle word wrap

Expand
表 11.159. 位置参数
概述

node

裸机恢复节点 uuid 或名称

Expand
表 11.160. 可选参数
概述

-h, --help

显示帮助信息并退出

--wait

等待内省完成,结果将在结尾显示

--check-errors

检查内省期间发生了错误;如果出现任何错误,则仅显示错误;只能与 --wait 一起使用

Expand
表 11.161. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 11.162. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 11.163. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 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
Copy to Clipboard Toggle word wrap

Expand
表 11.165. 位置参数
概述

node

裸机恢复节点 uuid 或名称

Expand
表 11.166. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 11.167. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 11.168. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 11.169. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 11.171. 位置参数
概述

<node>

节点的名称或 uuid。

Expand
表 11.172. 可选参数
概述

-h, --help

显示帮助信息并退出

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

将特征添加到节点。

使用方法:

openstack baremetal node add trait [-h] <node> <trait> [<trait> ...]
Copy to Clipboard Toggle word wrap

Expand
表 11.173. 位置参数
概述

<node>

节点的名称或 uuid

<trait>

要添加的特征

Expand
表 11.174. 可选参数
概述

-h, --help

显示帮助信息并退出

11.43. 裸机恢复节点采用

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

使用方法:

openstack baremetal node adopt [-h] [--wait [<time-out>]] <node>
Copy to Clipboard Toggle word wrap

Expand
表 11.175. 位置参数
概述

<node>

节点的名称或 uuid。

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 11.177. 位置参数
概述

<node>

节点的名称或 uuid

Expand
表 11.178. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 11.179. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 11.180. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 11.181. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 11.183. 位置参数
概述

<node>

节点的名称或 uuid

<setting name>

将名称设置为 show

Expand
表 11.184. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 11.185. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 11.186. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 11.187. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 11.189. 位置参数
概述

<node>

节点的名称或 uuid

<device>

bios、cdrom、disk、pxe、secure、wanboot 的一个

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 11.191. 位置参数
概述

<node>

节点的名称或 uuid

Expand
表 11.192. 可选参数
概述

-h, --help

显示帮助信息并退出

--supported

显示支持的引导设备

Expand
表 11.193. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 11.194. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 11.195. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 11.197. 位置参数
概述

<node>

节点的名称或 uuid。

Expand
表 11.198. 可选参数
概述

-h, --help

显示帮助信息并退出

--wait [<time-out>]

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

--clean-steps <clean-steps>

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

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

禁用节点的控制台访问

使用方法:

openstack baremetal node console disable [-h] <node>
Copy to Clipboard Toggle word wrap

Expand
表 11.199. 位置参数
概述

<node>

节点的名称或 uuid

Expand
表 11.200. 可选参数
概述

-h, --help

显示帮助信息并退出

11.50. 裸机节点控制台启用

为节点启用控制台访问

使用方法:

openstack baremetal node console enable [-h] <node>
Copy to Clipboard Toggle word wrap

Expand
表 11.201. 位置参数
概述

<node>

节点的名称或 uuid

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 11.203. 位置参数
概述

<node>

节点的名称或 uuid

Expand
表 11.204. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 11.205. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 11.206. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 11.207. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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>]
Copy to Clipboard Toggle word wrap

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

节点的描述。

Expand
表 11.210. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 11.211. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 11.212. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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> ...]
Copy to Clipboard Toggle word wrap

Expand
表 11.214. 位置参数
概述

<node>

要删除的节点(name 或 uuid)

Expand
表 11.215. 可选参数
概述

-h, --help

显示帮助信息并退出

11.54. 裸机节点部署

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

使用方法:

openstack baremetal node deploy [-h] [--wait [<time-out>]]
                                       [--config-drive <config-drive>]
                                       <node>
Copy to Clipboard Toggle word wrap

Expand
表 11.216. 位置参数
概述

<node>

节点的名称或 uuid。

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 11.218. 位置参数
概述

<node>

节点的名称或 uuid。

Expand
表 11.219. 可选参数
概述

-h, --help

显示帮助信息并退出

11.56. 裸机节点检查

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

使用方法:

openstack baremetal node inspect [-h] [--wait [<time-out>]] <node>
Copy to Clipboard Toggle word wrap

Expand
表 11.220. 位置参数
概述

<node>

节点的名称或 uuid。

Expand
表 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> ...]]
Copy to Clipboard Toggle word wrap

Expand
表 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 时无法使用。

Expand
表 11.223. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 11.224. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 11.225. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 11.227. 位置参数
概述

<node>

节点的名称或 uuid。

Expand
表 11.228. 可选参数
概述

-h, --help

显示帮助信息并退出

--reason <reason>

设置维护模式的原因。

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

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

使用方法:

openstack baremetal node maintenance unset [-h] <node>
Copy to Clipboard Toggle word wrap

Expand
表 11.229. 位置参数
概述

<node>

节点的名称或 uuid。

Expand
表 11.230. 可选参数
概述

-h, --help

显示帮助信息并退出

11.60. 裸机节点管理

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

使用方法:

openstack baremetal node manage [-h] [--wait [<time-out>]] <node>
Copy to Clipboard Toggle word wrap

Expand
表 11.231. 位置参数
概述

<node>

节点的名称或 uuid。

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 11.233. 位置参数
概述

<node>

节点的名称或 uuid

<method>

执行供应商传递方法

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 11.235. 位置参数
概述

<node>

节点的名称或 uuid

Expand
表 11.236. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 11.237. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 11.238. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 11.239. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 11.241. 位置参数
概述

<node>

节点的名称或 uuid。

Expand
表 11.242. 可选参数
概述

-h, --help

显示帮助信息并退出

--power-timeout <power-timeout>

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

--soft

请求正常关机.

11.64. 裸机节点电源

打开节点

使用方法:

openstack baremetal node power on [-h]
                                         [--power-timeout <power-timeout>]
                                         <node>
Copy to Clipboard Toggle word wrap

Expand
表 11.243. 位置参数
概述

<node>

节点的名称或 uuid。

Expand
表 11.244. 可选参数
概述

-h, --help

显示帮助信息并退出

--power-timeout <power-timeout>

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

11.65. 裸机恢复节点提供

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

使用方法:

openstack baremetal node provide [-h] [--wait [<time-out>]] <node>
Copy to Clipboard Toggle word wrap

Expand
表 11.245. 位置参数
概述

<node>

节点的名称或 uuid。

Expand
表 11.246. 可选参数
概述

-h, --help

显示帮助信息并退出

--wait [<time-out>]

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

11.66. 裸机节点重新引导

重新引导裸机节点

使用方法:

openstack baremetal node reboot [-h] [--soft]
                                       [--power-timeout <power-timeout>]
                                       <node>
Copy to Clipboard Toggle word wrap

Expand
表 11.247. 位置参数
概述

<node>

节点的名称或 uuid。

Expand
表 11.248. 可选参数
概述

-h, --help

显示帮助信息并退出

--soft

请求正常重启。

--power-timeout <power-timeout>

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

11.67. 裸机节点重建

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

使用方法:

openstack baremetal node rebuild [-h] [--wait [<time-out>]]
                                        [--config-drive <config-drive>]
                                        <node>
Copy to Clipboard Toggle word wrap

Expand
表 11.249. 位置参数
概述

<node>

节点的名称或 uuid。

Expand
表 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> ...]]
Copy to Clipboard Toggle word wrap

Expand
表 11.251. 位置参数
概述

<node>

节点的名称或 uuid

<trait>

要删除的特征

Expand
表 11.252. 可选参数
概述

-h, --help

显示帮助信息并退出

--all

删除所有特征

11.69. 裸机节点救援

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

使用方法:

openstack baremetal node rescue [-h] [--wait [<time-out>]]
                                       --rescue-password <rescue-password>
                                       <node>
Copy to Clipboard Toggle word wrap

Expand
表 11.253. 位置参数
概述

<node>

节点的名称或 uuid。

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 11.255. 位置参数
概述

<node>

节点的名称或 uuid。

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 11.257. 位置参数
概述

<node>

节点的名称或 uuid (如果指定了 --instance,则为 uuid 实例)

Expand
表 11.258. 可选参数
概述

-h, --help

显示帮助信息并退出

--instance

<node> 是一个实例 uuid。

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

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

Expand
表 11.259. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 11.260. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 11.261. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 11.263. 位置参数
概述

<node>

节点的名称或 uuid

Expand
表 11.264. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 11.265. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 11.266. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 11.267. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 11.269. 位置参数
概述

<node>

节点的名称或 uuid。

Expand
表 11.270. 可选参数
概述

-h, --help

显示帮助信息并退出

--wait [<time-out>]

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

11.74. 裸机节点不可用

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

使用方法:

openstack baremetal node unrescue [-h] [--wait [<time-out>]] <node>
Copy to Clipboard Toggle word wrap

Expand
表 11.271. 位置参数
概述

<node>

节点的名称或 uuid。

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 11.273. 位置参数
概述

<node>

节点的名称或 uuid。

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 11.275. 位置参数
概述

<node>

节点的名称或 uuid

Expand
表 11.276. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 11.277. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 11.278. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 11.279. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 11.281. 位置参数
概述

<node>

节点的名称或 uuid

<vif-id>

要附加到节点的 vif 的名称或 uuid。

Expand
表 11.282. 可选参数
概述

-h, --help

显示帮助信息并退出

--vif-info <key=value>

记录任意键/值元数据。可以多次指定。必需的 id 参数不能指定为密钥。

11.78. 裸机节点 vif detach

从给定节点分离 VIF

使用方法:

openstack baremetal node vif detach [-h] <node> <vif-id>
Copy to Clipboard Toggle word wrap

Expand
表 11.283. 位置参数
概述

<node>

节点的名称或 uuid

<vif-id>

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

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 11.285. 位置参数
概述

<node>

节点的名称或 uuid

Expand
表 11.286. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 11.287. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 11.288. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 11.289. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 11.291. 位置参数
概述

<address>

此端口的 MAC 地址。

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

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

Expand
表 11.293. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 11.294. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 11.295. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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> ...]
Copy to Clipboard Toggle word wrap

Expand
表 11.297. 位置参数
概述

<port>

要删除的端口的 UUID。

Expand
表 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]
Copy to Clipboard Toggle word wrap

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

属于此端口组成员的端口不能用作独立端口。

Expand
表 11.300. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 11.301. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 11.302. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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> ...]
Copy to Clipboard Toggle word wrap

Expand
表 11.304. 位置参数
概述

<port group>

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

Expand
表 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> ...]]
Copy to Clipboard Toggle word wrap

Expand
表 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 时,不能使用。

Expand
表 11.307. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 11.308. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 11.309. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 11.311. 位置参数
概述

<port group>

端口组的名称或 uuid。

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 11.313. 位置参数
概述

<id>

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

Expand
表 11.314. 可选参数
概述

-h, --help

显示帮助信息并退出

--address

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

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

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

Expand
表 11.315. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 11.316. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 11.317. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 11.319. 位置参数
概述

<port group>

端口组的名称或 uuid。

Expand
表 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> ...]]
Copy to Clipboard Toggle word wrap

Expand
表 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 时无法使用。

Expand
表 11.322. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 11.323. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 11.324. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 11.326. 位置参数
概述

<port>

端口的 UUID

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 11.328. 位置参数
概述

<id>

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

Expand
表 11.329. 可选参数
概述

-h, --help

显示帮助信息并退出

--address

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

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

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

Expand
表 11.330. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 11.331. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 11.332. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 11.334. 位置参数
概述

<port>

端口的 UUID。

Expand
表 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>]
Copy to Clipboard Toggle word wrap

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

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

Expand
表 11.337. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 11.338. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 11.339. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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> ...]
Copy to Clipboard Toggle word wrap

Expand
表 11.341. 位置参数
概述

<volume connector>

要删除的卷连接器的 UUID。

Expand
表 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> ...]]
Copy to Clipboard Toggle word wrap

Expand
表 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 时无法使用。

Expand
表 11.344. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 11.345. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 11.346. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 11.348. 位置参数
概述

<volume connector>

卷连接器的 UUID。

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 11.350. 位置参数
概述

<id>

卷连接器的 UUID。

Expand
表 11.351. 可选参数
概述

-h, --help

显示帮助信息并退出

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

个或多个卷连接器字段。只有这些字段从服务器获取。

Expand
表 11.352. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 11.353. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 11.354. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 11.356. 位置参数
概述

<volume connector>

卷连接器的 UUID。

Expand
表 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>]
Copy to Clipboard Toggle word wrap

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

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

Expand
表 11.359. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 11.360. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 11.361. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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> ...]
Copy to Clipboard Toggle word wrap

Expand
表 11.363. 位置参数
概述

<volume target>

要删除的卷目标的 UUID。

Expand
表 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> ...]]
Copy to Clipboard Toggle word wrap

Expand
表 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 时无法使用。

Expand
表 11.366. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 11.367. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 11.368. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 11.370. 位置参数
概述

<volume target>

卷目标的 UUID。

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 11.372. 位置参数
概述

<id>

卷目标的 UUID。

Expand
表 11.373. 可选参数
概述

-h, --help

显示帮助信息并退出

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

一个或多个卷目标字段。只有这些字段将从服务器中获取。

Expand
表 11.374. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 11.375. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 11.376. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 11.378. 位置参数
概述

<volume target>

卷目标的 UUID。

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 12.1. 位置参数
概述

<agent-id>

动态路由代理的 ID

<bgp-speaker>

bgp speaker 的 ID 或名称

Expand
表 12.2. 可选参数
概述

-h, --help

显示帮助信息并退出

12.2. BGP dragent remove speaker

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

使用方法:

openstack bgp dragent remove speaker [-h] <agent-id> <bgp-speaker>
Copy to Clipboard Toggle word wrap

Expand
表 12.3. 位置参数
概述

<agent-id>

动态路由代理的 ID

<bgp-speaker>

bgp speaker 的 ID 或名称

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 12.5. 位置参数
概述

<name>

要创建的 bgp peer 的名称

Expand
表 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)。这可在项目名称之间有冲突时使用。

Expand
表 12.7. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 12.8. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 12.9. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 12.11. 位置参数
概述

<bgp-peer>

BGP peer to delete (名称或 ID)

Expand
表 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]
Copy to Clipboard Toggle word wrap

Expand
表 12.13. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 12.14. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 12.15. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 12.16. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 12.18. 位置参数
概述

<bgp-peer>

BGP peer 以更新(名称或 ID)

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 12.20. 位置参数
概述

<bgp-peer>

BGP peer to display (名称或 ID)

Expand
表 12.21. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 12.22. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 12.23. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 12.24. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 12.26. 位置参数
概述

<bgp-speaker>

BGP 发言人(名称或 ID)

<network>

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

Expand
表 12.27. 可选参数
概述

-h, --help

显示帮助信息并退出

12.9. BGP speaker add peer

为 BGP 发言人添加对等点

使用方法:

openstack bgp speaker add peer [-h] <bgp-speaker> <bgp-peer>
Copy to Clipboard Toggle word wrap

Expand
表 12.28. 位置参数
概述

<bgp-speaker>

BGP 发言人(名称或 ID)

<bgp-peer>

BGP peer to add (名称或 ID)

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 12.30. 位置参数
概述

<name>

要创建的 bgp 发言人的名称

Expand
表 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)。这可在项目名称之间有冲突时使用。

Expand
表 12.32. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 12.33. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 12.34. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 12.36. 位置参数
概述

<bgp-speaker>

BGP speaker to delete (名称或 ID)

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 12.38. 位置参数
概述

<bgp-speaker>

BGP 发言人(名称或 ID)

Expand
表 12.39. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 12.40. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 12.41. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 12.42. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 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>]
Copy to Clipboard Toggle word wrap

Expand
表 12.44. 可选参数
概述

-h, --help

显示帮助信息并退出

--agent <agent-id>

列出由代理托管的 bgp 发言人(仅限 ID)

Expand
表 12.45. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 12.46. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 12.47. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 12.49. 位置参数
概述

<bgp-speaker>

BGP 发言人(名称或 ID)

<network>

要删除的网络(名称或 id)

Expand
表 12.50. 可选参数
概述

-h, --help

显示帮助信息并退出

12.15. BGP speaker remove peer

从 BGP speaker 中删除对等点

使用方法:

openstack bgp speaker remove peer [-h] <bgp-speaker> <bgp-peer>
Copy to Clipboard Toggle word wrap

Expand
表 12.51. 位置参数
概述

<bgp-speaker>

BGP 发言人(名称或 ID)

<bgp-peer>

BGP peer to remove (名称或 ID)

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 12.53. 位置参数
概述

<bgp-speaker>

BGP speaker to update (名称或 ID)

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 12.55. 位置参数
概述

<bgp-speaker>

bgp speaker 的 ID 或名称

Expand
表 12.56. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 12.57. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 12.58. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 12.59. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 12.61. 位置参数
概述

<bgp-speaker>

要显示的 BGP 发言人(名称或 ID)

Expand
表 12.62. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 12.63. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 12.64. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 12.65. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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}]
Copy to Clipboard Toggle word wrap

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

Expand
表 13.2. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 13.3. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 13.4. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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> ...]
Copy to Clipboard Toggle word wrap

Expand
表 13.6. 位置参数
概述

<bgpvpn>

BGP vpn (s)以删除(名称或 ID)

Expand
表 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>]
Copy to Clipboard Toggle word wrap

Expand
表 13.8. 可选参数
概述

-h, --help

显示帮助信息并退出

--project <project>

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

--project-domain <project-domain>

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

--long

列出输出中的其他字段

--property <key=value>

要应用到返回的 bgp vpns 的过滤器属性(重复用于过滤多个属性)

Expand
表 13.9. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 13.10. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 13.11. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 13.13. 位置参数
概述

<bgpvpn>

BGP vpn 以应用网络关联(名称或 ID)

<network>

要关联 bgp vpn (name 或 id)的网络。

Expand
表 13.14. 可选参数
概述

-h, --help

显示帮助信息并退出

--project <project>

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

--project-domain <project-domain>

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

Expand
表 13.15. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 13.16. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 13.17. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 13.19. 位置参数
概述

<network 关联 ID>

要删除的网络关联 ID

<bgpvpn>

BGP vpn 网络关联属于 (名称或 ID)

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 13.21. 位置参数
概述

<bgpvpn>

BGP vpn 列出的关联属于 (名称或 ID)

Expand
表 13.22. 可选参数
概述

-h, --help

显示帮助信息并退出

--long

列出输出中的其他字段

--property <key=value>

要应用到返回的 bgp vpns 的过滤器属性(重复用于过滤多个属性)

Expand
表 13.23. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 13.24. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 13.25. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 13.27. 位置参数
概述

<network 关联 ID>

要查找的网络关联 ID

<bgpvpn>

BGP vpn 关联属于(名称或 ID)

Expand
表 13.28. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 13.29. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 13.30. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 13.31. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 13.33. 位置参数
概述

<bgpvpn>

BGP vpn 以应用端口关联(名称或 ID)

<port>

要关联 bgp vpn (名称或 id)的端口

Expand
表 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 路由的重复选项)

Expand
表 13.35. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 13.36. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 13.37. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 13.39. 位置参数
概述

<port 关联 ID>

要删除的端口关联 ID

<bgpvpn>

BGP vpn 端口关联属于 (名称或 ID)

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 13.41. 位置参数
概述

<bgpvpn>

BGP vpn 列出的关联属于 (名称或 ID)

Expand
表 13.42. 可选参数
概述

-h, --help

显示帮助信息并退出

--long

列出输出中的其他字段

--property <key=value>

要应用到返回的 bgp vpns 的过滤器属性(重复用于过滤多个属性)

Expand
表 13.43. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 13.44. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 13.45. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 13.47. 位置参数
概述

<port 关联 ID>

要更新的端口关联 ID

<bgpvpn>

BGP vpn 端口关联属于 (名称或 ID)

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 13.49. 位置参数
概述

<port 关联 ID>

要查找的端口关联 id

<bgpvpn>

BGP vpn 关联属于(名称或 ID)

Expand
表 13.50. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 13.51. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 13.52. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 13.53. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 13.55. 位置参数
概述

<port 关联 ID>

要更新的端口关联 ID

<bgpvpn>

BGP vpn 端口关联属于 (名称或 ID)

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 13.57. 位置参数
概述

<bgpvpn>

BGP vpn 以应用路由器关联(名称或 ID)

<router>

要关联 bgp vpn (名称或 id)的路由器.

Expand
表 13.58. 可选参数
概述

-h, --help

显示帮助信息并退出

--project <project>

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

--project-domain <project-domain>

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

--advertise_extra_routes

路由将公告为 bgp vpn (默认)

--no-advertise_extra_routes

从路由器的路由不会公告到 BGP VPN

Expand
表 13.59. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 13.60. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 13.61. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 13.63. 位置参数
概述

<router 关联 ID>

要删除的路由器关联 ID

<bgpvpn>

BGP vpn 路由器关联属于 (名称或 ID)

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 13.65. 位置参数
概述

<bgpvpn>

BGP vpn 列出的关联属于 (名称或 ID)

Expand
表 13.66. 可选参数
概述

-h, --help

显示帮助信息并退出

--long

列出输出中的其他字段

--property <key=value>

要应用到返回的 bgp vpns 的过滤器属性(重复用于过滤多个属性)

Expand
表 13.67. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 13.68. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 13.69. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 13.71. 位置参数
概述

<router 关联 ID>

更新的路由器关联 ID

<bgpvpn>

BGP vpn 路由器关联属于 (名称或 ID)

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 13.73. 位置参数
概述

<router 关联 ID>

要查找的路由器关联 id

<bgpvpn>

BGP vpn 关联属于(名称或 ID)

Expand
表 13.74. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 13.75. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 13.76. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 13.77. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 13.79. 位置参数
概述

<router 关联 ID>

更新的路由器关联 ID

<bgpvpn>

BGP vpn 路由器关联属于 (名称或 ID)

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 13.81. 位置参数
概述

<bgpvpn>

BGP vpn 更新(名称或 ID)

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 13.83. 位置参数
概述

<bgpvpn>

BGP vpn 以显示(名称或 ID)

Expand
表 13.84. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 13.85. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 13.86. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 13.87. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 13.89. 位置参数
概述

<bgpvpn>

BGP vpn 更新(名称或 ID)

Expand
表 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
Copy to Clipboard Toggle word wrap

Expand
表 14.1. 位置参数
概述

URI

ca 的 uri 引用。

Expand
表 14.2. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 14.3. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 14.4. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 14.5. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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]
Copy to Clipboard Toggle word wrap

Expand
表 14.7. 可选参数
概述

-h, --help

显示帮助信息并退出

--limit LIMIT, -l LIMIT

指定每个页面列表的项目列表数量(默认为 10;最大:100)

--offset OFFSET,-o OFFSET

指定页面偏移(默认值 0)

--name NAME, -n NAME

指定 ca 名称(默认:none)

Expand
表 14.8. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 14.9. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 14.10. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 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]
Copy to Clipboard Toggle word wrap

Expand
表 15.1. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 15.2. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 15.3. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 15.4. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 15.6. 位置参数
概述

<service>

要显示的服务(类型或名称)

Expand
表 15.7. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 15.8. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 15.9. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 15.10. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 16.1. 位置参数
概述

<cluster>

集群的 ID 或名称

Expand
表 16.2. 可选参数
概述

-h, --help

显示帮助信息并退出

16.2. Coe ca show

显示集群的 CA 证书详情。

使用方法:

openstack coe ca show [-h] <cluster>
Copy to Clipboard Toggle word wrap

Expand
表 16.3. 位置参数
概述

<cluster>

集群的 ID 或名称

Expand
表 16.4. 可选参数
概述

-h, --help

显示帮助信息并退出

16.3. Coe ca sign

为集群生成 CA 证书。

使用方法:

openstack coe ca sign [-h] <cluster> <csr>
Copy to Clipboard Toggle word wrap

Expand
表 16.5. 位置参数
概述

<cluster>

集群的 ID 或名称

<csr>

发送到 magnum 的 csr 文件的路径来签名。

Expand
表 16.6. 可选参数
概述

-h, --help

显示帮助信息并退出

16.4. Coe 集群配置

获取集群的配置

使用方法:

openstack coe cluster config [-h] [--dir <dir>] [--force]
                                    [--output-certs] [--use-certificate]
                                    [--use-keystone]
                                    <cluster>
Copy to Clipboard Toggle word wrap

Expand
表 16.7. 位置参数
概述

<cluster>

要更新的集群的名称或 uuid

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 16.9. 位置参数
概述

<name>

要创建的集群的名称。

Expand
表 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> ...]
Copy to Clipboard Toggle word wrap

Expand
表 16.11. 位置参数
概述

<cluster>

要删除的集群的 ID 或名称。

Expand
表 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>]
Copy to Clipboard Toggle word wrap

Expand
表 16.13. 可选参数
概述

-h, --help

显示帮助信息并退出

--limit <limit>

要返回的最大集群数量

--sort-key <sort-key>

列以按以下方式排序结果

--sort-dir <sort-dir>

划分的方向。"asc"或"desc"。

Expand
表 16.14. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 16.15. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 16.16. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 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
Copy to Clipboard Toggle word wrap

Expand
表 16.18. 位置参数
概述

<cluster>

要更新的集群的名称或 uuid

node_count

cluser 所需的节点数。

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 16.20. 位置参数
概述

<cluster>

要显示的集群的 ID 或名称。

Expand
表 16.21. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 16.22. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 16.23. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 16.24. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 16.26. 位置参数
概述

<name>

要创建的集群模板的名称。

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

表示集群模板应可见。

Expand
表 16.28. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 16.29. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 16.30. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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> ...]
Copy to Clipboard Toggle word wrap

Expand
表 16.32. 位置参数
概述

<cluster-templates>

要删除的(集群模板)的 ID 或名称。

Expand
表 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>]
Copy to Clipboard Toggle word wrap

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

Expand
表 16.35. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 16.36. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 16.37. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 16.39. 位置参数
概述

<cluster-template>

要显示的集群模板的 ID 或名称。

Expand
表 16.40. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 16.41. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 16.42. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 16.43. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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> ...]
Copy to Clipboard Toggle word wrap

Expand
表 16.45. 位置参数
概述

<cluster-template>

要更新的集群模板的名称或 uuid

<op>

操作:其中一项 添加替换或删除

<path=value>

添加/替换或删除的属性(在删除时只需要路径)

Expand
表 16.46. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 16.47. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 16.48. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 16.49. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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> ...]
Copy to Clipboard Toggle word wrap

Expand
表 16.51. 位置参数
概述

<cluster>

要更新的集群的名称或 uuid

<op>

操作:其中一项 添加替换或删除

<path=value>

添加/替换或删除的属性(在删除时只需要路径)

Expand
表 16.52. 可选参数
概述

-h, --help

显示帮助信息并退出

--rollback

在更新失败时回滚集群。

16.16. Coe 集群升级

升级集群

使用方法:

openstack coe cluster upgrade [-h] [--max-batch-size <max_batch_size>]
                                     [--nodegroup <nodegroup>]
                                     <cluster> cluster_template
Copy to Clipboard Toggle word wrap

Expand
表 16.53. 位置参数
概述

<cluster>

要更新的集群的名称或 uuid

cluster_template

新的集群模板 id 将升级到。

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 16.55. 位置参数
概述

<cluster>

要创建的节点组的名称。

<name>

要创建的节点组的名称。

Expand
表 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> ...]
Copy to Clipboard Toggle word wrap

Expand
表 16.57. 位置参数
概述

<cluster>

节点组所属集群的 ID 或名称。

<nodegroup>

要删除的节点组 ID 或名称。

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 16.59. 位置参数
概述

<cluster>

节点组所属集群的 ID 或名称。

Expand
表 16.60. 可选参数
概述

-h, --help

显示帮助信息并退出

--limit <limit>

要返回的最大节点组数

--sort-key <sort-key>

列以按以下方式排序结果

--sort-dir <sort-dir>

划分的方向。"asc"或"desc"。

--role <role>

使用此角色列出集群中的节点组

Expand
表 16.61. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 16.62. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 16.63. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 16.65. 位置参数
概述

<cluster>

节点组所属集群的 ID 或名称。

<nodegroup>

要显示的节点组 ID 或名称。

Expand
表 16.66. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 16.67. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 16.68. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 16.69. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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> ...]
Copy to Clipboard Toggle word wrap

Expand
表 16.71. 位置参数
概述

<cluster>

节点组所属集群的 ID 或名称。

<nodegroup>

要更新的集群的名称或 uuid

<op>

操作:其中一项 添加替换或删除

<path=value>

添加/替换或删除的属性(在删除时只需要路径)

Expand
表 16.72. 可选参数
概述

-h, --help

显示帮助信息并退出

16.22. Coe 配额创建

创建配额。

使用方法:

openstack coe quotas create [-h] --project-id <project-id> --resource
                                   <resource> [--hard-limit <hard-limit>]
Copy to Clipboard Toggle word wrap

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 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]
Copy to Clipboard Toggle word wrap

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 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>]
Copy to Clipboard Toggle word wrap

Expand
表 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]
Copy to Clipboard Toggle word wrap

Expand
表 16.78. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 16.79. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 16.80. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 16.81. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 16.83. 位置参数
概述

<project>

项目 ID

Expand
表 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>]
Copy to Clipboard Toggle word wrap

Expand
表 17.1. 可选参数
概述

-h, --help

显示帮助信息并退出

--group <group-keyword>

显示命令组过滤的命令,例如:身份、卷、计算、镜像、网络和其他关键字

Expand
表 17.2. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 17.3. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 17.4. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 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>]
Copy to Clipboard Toggle word wrap

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 19.1. 位置参数
概述

<OS>

os 的类型

<architecture>

架构的类型

<version>

版本

<url>

URL

<md5hash>

Md5 hash

<hypervisor>

hypervisor 类型

Expand
表 19.2. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 19.3. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 19.4. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 19.5. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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> ...]
Copy to Clipboard Toggle word wrap

Expand
表 19.7. 位置参数
概述

<id>

要删除的代理 ID

Expand
表 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>]
Copy to Clipboard Toggle word wrap

Expand
表 19.9. 可选参数
概述

-h, --help

显示帮助信息并退出

--hypervisor <hypervisor>

hypervisor 类型

Expand
表 19.10. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 19.11. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 19.12. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 19.14. 位置参数
概述

<id>

代理 ID

Expand
表 19.15. 可选参数
概述

-h, --help

显示帮助信息并退出

--agent-version <version>

代理的版本

--url <url>

代理的 URL

--md5hash <md5hash>

代理的 Md5 哈希

19.5. 计算服务删除

删除计算服务

使用方法:

openstack compute service delete [-h] <service> [<service> ...]
Copy to Clipboard Toggle word wrap

Expand
表 19.16. 位置参数
概述

<service>

compute 服务可删除(仅id)。如果使用 ''---os-compute- api-version'' 2.53 或更高的版本,该 ID 是通过使用相同 2.53+ 微版本列出计算服务来检索的 UUID。

Expand
表 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]
Copy to Clipboard Toggle word wrap

Expand
表 19.18. 可选参数
概述

-h, --help

显示帮助信息并退出

--host <host>

列出指定主机上的服务(仅限名称)

--service <service>

仅列出指定的服务二进制文件(仅命名)。例如 ''nova-compute'、'nova-conductor' 等。

--long

列出输出中的其他字段

Expand
表 19.19. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 19.20. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 19.21. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 19.23. 位置参数
概述

<host>

主机的名称

<service>

服务的名称(二进制名称),如 ''nova- compute'。

Expand
表 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]
Copy to Clipboard Toggle word wrap

Expand
表 20.1. 可选参数
概述

-h, --help

显示帮助信息并退出

--mask

尝试屏蔽密码(默认)

--unmask

以明文显示密码

Expand
表 20.2. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 20.3. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 20.4. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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> ...]
Copy to Clipboard Toggle word wrap

Expand
表 21.1. 位置参数
概述

<consistency-group>

包含 <volume> (名称或 ID)的一致性组

<volume>

要添加到 <consistency-group> (名称或 id)的卷(重复选项来添加多个卷)

Expand
表 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>]
Copy to Clipboard Toggle word wrap

Expand
表 21.3. 位置参数
概述

<name>

新一致性组名称(默认为 none)

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

此一致性组的可用性区域(如果从源创建一致性组时)

Expand
表 21.5. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 21.6. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 21.7. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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> ...]
Copy to Clipboard Toggle word wrap

Expand
表 21.9. 位置参数
概述

<consistency-group>

删除的一致性组(名称或 ID)

Expand
表 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]
Copy to Clipboard Toggle word wrap

Expand
表 21.11. 可选参数
概述

-h, --help

显示帮助信息并退出

--all-projects

显示所有项目的详细信息。仅 admin。(默认为 False)

--long

列出输出中的其他字段

Expand
表 21.12. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 21.13. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 21.14. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 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> ...]
Copy to Clipboard Toggle word wrap

Expand
表 21.16. 位置参数
概述

<consistency-group>

包含 <volume> (名称或 ID)的一致性组

<volume>

从 <consistency-group> (名称或 ID)中删除的卷(用于移除多个卷)

Expand
表 21.17. 可选参数
概述

-h, --help

显示帮助信息并退出

21.6. 致性组集

设置一致性组属性

使用方法:

openstack consistency group set [-h] [--name <name>]
                                       [--description <description>]
                                       <consistency-group>
Copy to Clipboard Toggle word wrap

Expand
表 21.18. 位置参数
概述

<consistency-group>

致性组进行修改(名称或 ID)

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 21.20. 位置参数
概述

<consistency-group>

要显示的一致性组(名称或 id)

Expand
表 21.21. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 21.22. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 21.23. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 21.24. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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>]
Copy to Clipboard Toggle word wrap

Expand
表 21.26. 位置参数
概述

<snapshot-name>

新一致性组快照的名称(默认为 None)

Expand
表 21.27. 可选参数
概述

-h, --help

显示帮助信息并退出

--consistency-group <consistency-group>

一致性到快照(名称或 id)的组(默认为与 <snapshot-name> 相同)

--description <description>

此一致性组快照的描述

Expand
表 21.28. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 21.29. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 21.30. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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> ...]
Copy to Clipboard Toggle word wrap

Expand
表 21.32. 位置参数
概述

<consistency-group-snapshot>

删除的一致性组快照(名称或 ID)

Expand
表 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>]
Copy to Clipboard Toggle word wrap

Expand
表 21.34. 可选参数
概述

-h, --help

显示帮助信息并退出

--all-projects

显示所有项目(仅管理员)的详细信息(默认为 False)

--long

列出输出中的其他字段

--status <status>

按状态("可用"、"error"、"reating"、"deleting"或 "error_deleting" 来过滤结果。

--consistency-group <consistency-group>

按一致性组(名称或 ID)过滤结果

Expand
表 21.35. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 21.36. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 21.37. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 21.39. 位置参数
概述

<consistency-group-snapshot>

以显示一致性组快照(名称或 ID)

Expand
表 21.40. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 21.41. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 21.42. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 21.43. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 22.1. 位置参数
概述

<server>

服务器以显示控制台日志(名称或 id)

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 22.3. 位置参数
概述

<server>

服务器显示 url (名称或 id)

Expand
表 22.4. 可选参数
概述

-h, --help

显示帮助信息并退出

--novnc

显示 novnc 控制台 url (默认)

--xvpvnc

显示 xvpvnc 控制台 url

--spice

显示 spice 控制台 url

--rdp

显示 rdp 控制台 url

--serial

显示串行控制台 url

--mks

显示 webmks 控制台 url

Expand
表 22.5. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 22.6. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 22.7. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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>]
Copy to Clipboard Toggle word wrap

Expand
表 23.1. 可选参数
概述

-h, --help

显示帮助信息并退出

--description <description>

新的用户描述

Expand
表 23.2. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 23.3. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 23.4. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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> ...]
Copy to Clipboard Toggle word wrap

Expand
表 23.6. 位置参数
概述

<consumer>

要删除的消费者

Expand
表 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]
Copy to Clipboard Toggle word wrap

Expand
表 23.8. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 23.9. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 23.10. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 23.11. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 23.13. 位置参数
概述

<consumer>

修改的用户

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 23.15. 位置参数
概述

<consumer>

显示使用者

Expand
表 23.16. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 23.17. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 23.18. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 23.19. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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> ...]
Copy to Clipboard Toggle word wrap

Expand
表 24.1. 位置参数
概述

<container-name>

新容器名称

Expand
表 24.2. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 24.3. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 24.4. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 24.5. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 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> ...]
Copy to Clipboard Toggle word wrap

Expand
表 24.7. 位置参数
概述

<Container>

要删除的容器

Expand
表 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]
Copy to Clipboard Toggle word wrap

Expand
表 24.9. 可选参数
概述

-h, --help

显示帮助信息并退出

--prefix <prefix>

使用 <prefix> 过滤列表

--marker <marker>

用于分页的定位符

--end-marker <end-marker>

结束用于分页的定位符

--limit <num-containers>

限制返回的容器数量

--long

列出输出中的其他字段

--all

列出所有容器(默认为 10000)

Expand
表 24.10. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 24.11. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 24.12. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 24.14. 位置参数
概述

<Container>

要保存的容器

Expand
表 24.15. 可选参数
概述

-h, --help

显示帮助信息并退出

24.5. 容器集

设置容器属性

使用方法:

openstack container set [-h] --property <key=value> <container>
Copy to Clipboard Toggle word wrap

Expand
表 24.16. 位置参数
概述

<Container>

修改容器

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 24.18. 位置参数
概述

<Container>

显示的容器

Expand
表 24.19. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 24.20. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 24.21. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 24.22. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 24.24. 位置参数
概述

<Container>

修改容器

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 25.1. 位置参数
概述

<user>

拥有凭证的用户(名称或 id)

<data>

新凭证数据

Expand
表 25.2. 可选参数
概述

-h, --help

显示帮助信息并退出

--type <type>

新凭证类型:cert、ec2 和 totp,以此类推

--project <project>

限制凭证范围(名称或 ID)的项目

Expand
表 25.3. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 25.4. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 25.5. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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> ...]
Copy to Clipboard Toggle word wrap

Expand
表 25.7. 位置参数
概述

<credential-id>

要删除的凭证的 ID

Expand
表 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>]
Copy to Clipboard Toggle word wrap

Expand
表 25.9. 可选参数
概述

-h, --help

显示帮助信息并退出

--user <user>

通过 <user> (名称或 ID)过滤凭证

--user-domain <user-domain>

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

--type <type>

根据 type: cert、ec2 和 totp 过滤凭证

Expand
表 25.10. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 25.11. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 25.12. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 25.14. 位置参数
概述

<credential-id>

要更改的凭证 ID

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 25.16. 位置参数
概述

<credential-id>

要显示的凭证 ID

Expand
表 25.17. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 25.18. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 25.19. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 25.20. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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]
Copy to Clipboard Toggle word wrap

Expand
表 26.1. 位置参数
概述

name

Cron trigger name

workflow_identifier

工作流名称或 id

workflow_input

工作流输入

Expand
表 26.2. 可选参数
概述

-h, --help

显示帮助信息并退出

--params PARAMS

工作流参数

--pattern <* * * * *>

cron 触发器模式

--first-time <YYYY-MM-DD HH:MM>

首次执行的日期和时间。除非也指定了 --utc,否则时间被视为本地时间

--count <integer>

想要执行的数量

--utc

指定的所有时间都应视为 utc

Expand
表 26.3. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 26.4. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 26.5. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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 ...]
Copy to Clipboard Toggle word wrap

Expand
表 26.7. 位置参数
概述

cron_trigger

cron trigger 的名称。

Expand
表 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]
Copy to Clipboard Toggle word wrap

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

过滤器. 可以重复。

Expand
表 26.10. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 26.11. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 26.12. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 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
Copy to Clipboard Toggle word wrap

Expand
表 26.14. 位置参数
概述

cron_trigger

Cron trigger name

Expand
表 26.15. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 26.16. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 26.17. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 26.18. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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]
Copy to Clipboard Toggle word wrap

Expand
表 27.1. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 27.2. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 27.3. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 27.4. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 27.6. 位置参数
概述

<datastore>

数据存储的 ID

Expand
表 27.7. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 27.8. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 27.9. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 27.10. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 27.12. 位置参数
概述

<datastore>

数据存储的 ID 或名称

Expand
表 27.13. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 27.14. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 27.15. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 27.16. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 27.18. 位置参数
概述

<datastore_version>

数据存储版本的 ID 或名称。

Expand
表 27.19. 可选参数
概述

-h, --help

显示帮助信息并退出

--datastore <datastore>

数据存储的 ID 或名称。如果提供了 datastore_version 的 id,则可选。

Expand
表 27.20. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 27.21. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 27.22. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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]
Copy to Clipboard Toggle word wrap

Expand
表 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:当前项目

Expand
表 28.2. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 28.3. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 28.4. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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]
Copy to Clipboard Toggle word wrap

Expand
表 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>]
Copy to Clipboard Toggle word wrap

Expand
表 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 配额的新值

Expand
表 28.8. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 28.9. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 28.10. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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]
Copy to Clipboard Toggle word wrap

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

Expand
表 28.13. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 28.14. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 28.15. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 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
Copy to Clipboard Toggle word wrap

Expand
表 28.17. 位置参数
概述

id

服务状态 ID

Expand
表 28.18. 可选参数
概述

-h, --help

显示帮助信息并退出

--all-projects

显示所有项目的结果。default: false

--edit-managed

编辑标记为 managed. default: false的资源

--sudo-project-id SUDO_PROJECT_ID

这个命令的模拟项目 ID。default: None

Expand
表 28.19. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 28.20. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 28.21. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 29.1. 位置参数
概述

<domain-name>

新域名

Expand
表 29.2. 可选参数
概述

-h, --help

显示帮助信息并退出

--description <description>

新域描述

--enable

启用域(默认)

--disable

禁用域

--or-show

返回现有域

Expand
表 29.3. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 29.4. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 29.5. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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> ...]
Copy to Clipboard Toggle word wrap

Expand
表 29.7. 位置参数
概述

<domain>

要删除的域(名称或 ID)

Expand
表 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]
Copy to Clipboard Toggle word wrap

Expand
表 29.9. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 29.10. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 29.11. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 29.12. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 29.14. 位置参数
概述

<domain>

要修改的域(名称或 id)

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 29.16. 位置参数
概述

<domain>

要显示的域(名称或 id)

Expand
表 29.17. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 29.18. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 29.19. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 29.20. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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>]
Copy to Clipboard Toggle word wrap

Expand
表 30.1. 可选参数
概述

-h, --help

显示帮助信息并退出

--project <project>

在项目中创建凭证(名称或 id;默认:当前经过身份验证的用户项目)

--user <user>

为用户创建凭证(name 或 id;默认:当前经过身份验证的用户)

--user-domain <user-domain>

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

--project-domain <project-domain>

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

Expand
表 30.2. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 30.3. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 30.4. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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> ...]
Copy to Clipboard Toggle word wrap

Expand
表 30.6. 位置参数
概述

<access-key>

凭证访问密钥

Expand
表 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>]
Copy to Clipboard Toggle word wrap

Expand
表 30.8. 可选参数
概述

-h, --help

显示帮助信息并退出

--user <user>

按用户(名称或 ID)过滤列表

--user-domain <user-domain>

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

Expand
表 30.9. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 30.10. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 30.11. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 30.13. 位置参数
概述

<access-key>

凭证访问密钥

Expand
表 30.14. 可选参数
概述

-h, --help

显示帮助信息并退出

--user <user>

显示用户凭证(名称或 id)

--user-domain <user-domain>

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

Expand
表 30.15. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 30.16. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 30.17. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 31.1. 位置参数
概述

<endpoint>

与指定项目关联的端点(名称或 ID)

<project>

与指定端点名称或 ID 关联的项目。

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 31.3. 位置参数
概述

<service>

要与新端点关联的服务(名称或 ID)

<interface>

新端点接口类型(admin、public 或 internal)

<url>

新端点 url

Expand
表 31.4. 可选参数
概述

-h, --help

显示帮助信息并退出

--region <region-id>

新端点区域 ID

--enable

启用端点(默认)

--disable

禁用端点

Expand
表 31.5. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 31.6. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 31.7. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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> ...]
Copy to Clipboard Toggle word wrap

Expand
表 31.9. 位置参数
概述

<endpoint-id>

要删除的端点(仅限 ID)

Expand
表 31.10. 可选参数
概述

-h, --help

显示帮助信息并退出

31.4. 端点组添加项目

将项目添加到端点组

使用方法:

openstack endpoint group add project [-h]
                                            [--project-domain <project-domain>]
                                            <endpoint-group> <project>
Copy to Clipboard Toggle word wrap

Expand
表 31.11. 位置参数
概述

<endpoint-group>

端点组(名称或 id)

<project>

要关联的项目(名称或 id)

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 31.13. 位置参数
概述

<name>

端点组名称

<filename>

包含一组新过滤器的 filename

Expand
表 31.14. 可选参数
概述

-h, --help

显示帮助信息并退出

--description DESCRIPTION

端点组的描述

Expand
表 31.15. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 31.16. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 31.17. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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> ...]
Copy to Clipboard Toggle word wrap

Expand
表 31.19. 位置参数
概述

<endpoint-group>

要删除的端点组(名称或 ID)

Expand
表 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>]
Copy to Clipboard Toggle word wrap

Expand
表 31.21. 可选参数
概述

-h, --help

显示帮助信息并退出

--endpointgroup <endpoint-group>

端点组(名称或 id)

--project <project>

项目(名称或 ID)

--domain <domain>

拥有 <project> 的域(名称或 ID)

Expand
表 31.22. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 31.23. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 31.24. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 31.26. 位置参数
概述

<endpoint-group>

端点组(名称或 id)

<project>

要删除的项目(名称或 id)

Expand
表 31.27. 可选参数
概述

-h, --help

显示帮助信息并退出

--project-domain <project-domain>

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

31.9. 端点组集

设置端点组属性

使用方法:

openstack endpoint group set [-h] [--name <name>]
                                    [--filters <filename>]
                                    [--description <description>]
                                    <endpoint-group>
Copy to Clipboard Toggle word wrap

Expand
表 31.28. 位置参数
概述

<endpoint-group>

要修改的端点组(名称或 id)

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 31.30. 位置参数
概述

<endpointgroup>

端点组(名称或 id)

Expand
表 31.31. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 31.32. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 31.33. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 31.34. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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>]
Copy to Clipboard Toggle word wrap

Expand
表 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)。这可在项目名称之间有冲突时使用。

Expand
表 31.37. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 31.38. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 31.39. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 31.41. 位置参数
概述

<endpoint>

与指定项目(名称或 ID)分离的端点

<project>

与指定的端点名称或 ID 分离的项目。

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 31.43. 位置参数
概述

<endpoint-id>

要修改的端点(仅限 ID)

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 31.45. 位置参数
概述

<endpoint>

要显示的端点(endpoint id、服务 id、服务名称、服务类型)

Expand
表 31.46. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 31.47. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 31.48. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 31.49. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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]
Copy to Clipboard Toggle word wrap

Expand
表 32.1. 位置参数
概述

name

事件触发器名称

workflow_id

工作流 ID

Exchange

事件触发器交换

topic

事件触发器主题

event

事件触发器事件名称

workflow_input

工作流输入

Expand
表 32.2. 可选参数
概述

-h, --help

显示帮助信息并退出

--params PARAMS

工作流参数

Expand
表 32.3. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 32.4. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 32.5. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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 ...]
Copy to Clipboard Toggle word wrap

Expand
表 32.7. 位置参数
概述

event_trigger_id

事件触发器的 ID。

Expand
表 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]
Copy to Clipboard Toggle word wrap

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

过滤器. 可以重复。

Expand
表 32.10. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 32.11. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 32.12. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 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
Copy to Clipboard Toggle word wrap

Expand
表 32.14. 位置参数
概述

event_trigger

事件触发器 ID

Expand
表 32.15. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 32.16. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 32.17. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 32.18. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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]
Copy to Clipboard Toggle word wrap

Expand
表 33.1. 可选参数
概述

-h, --help

显示帮助信息并退出

--compute

列出 compute api 的扩展

--identity

列出身份 api 的扩展

--network

列出网络 api 的扩展

--volume

列出块存储 api 的扩展

--long

列出输出中的其他字段

Expand
表 33.2. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 33.3. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 33.4. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 33.6. 位置参数
概述

<bx id="1" />

可以扩展到当前显示,当前只支持网络扩展。(名称或别名)

Expand
表 33.7. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 33.8. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 33.9. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 33.10. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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]
Copy to Clipboard Toggle word wrap

Expand
表 34.1. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 34.2. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 34.3. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 34.4. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 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]
Copy to Clipboard Toggle word wrap

Expand
表 34.6. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 34.7. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 34.8. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 34.9. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 34.11. 位置参数
概述

<name>

新的联合协议名称(每个身份提供程序必须是唯一的)

Expand
表 34.12. 可选参数
概述

-h, --help

显示帮助信息并退出

--identity-provider <identity-provider>

支持新联合协议(名称或 ID)的身份供应商(必需)

--mapping <mapping>

要使用的映射(名称或 ID)(必需)

Expand
表 34.13. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 34.14. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 34.15. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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> ...]
Copy to Clipboard Toggle word wrap

Expand
表 34.17. 位置参数
概述

<federation-protocol>

要删除的联合协议(名称或 ID)

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 34.19. 可选参数
概述

-h, --help

显示帮助信息并退出

--identity-provider <identity-provider>

列出(名称或 id)的身份供应商(必需)

Expand
表 34.20. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 34.21. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 34.22. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 34.24. 位置参数
概述

<name>

可修改的联合协议(名称或 ID)

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 34.26. 位置参数
概述

<federation-protocol>

显示的联合协议(名称或 ID)

Expand
表 34.27. 可选参数
概述

-h, --help

显示帮助信息并退出

--identity-provider <identity-provider>

支持 <federation-protocol> 的身份供应商(名称或 ID)(必需)

Expand
表 34.28. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 34.29. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 34.30. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 35.1. 位置参数
概述

<flavor-name>

新类别名称

Expand
表 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)。这可在项目名称之间有冲突时使用。

Expand
表 35.3. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 35.4. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 35.5. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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> ...]
Copy to Clipboard Toggle word wrap

Expand
表 35.7. 位置参数
概述

<flavor>

要删除的类别(名称或 ID)

Expand
表 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>]
Copy to Clipboard Toggle word wrap

Expand
表 35.9. 可选参数
概述

-h, --help

显示帮助信息并退出

--public

仅列出公共类别(默认)

--private

仅列出私有类别

--all

列出所有类别,无论是公共还是私有

--long

列出输出中的其他字段

--marker <flavor-id>

上一个页面的最后一个类别 ID

--limit <num-flavors>

可显示的最大类别数

Expand
表 35.10. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 35.11. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 35.12. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 35.14. 位置参数
概述

<flavor>

修改(名称或 ID)的类别.

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 35.16. 位置参数
概述

<flavor>

显示的类别(名称或 ID)

Expand
表 35.17. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 35.18. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 35.19. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 35.20. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 35.22. 位置参数
概述

<flavor>

修改(名称或 ID)的类别.

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 36.1. 位置参数
概述

<network>

从中分配浮动 ip 的网络(名称或 ID)

Expand
表 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 关联的标签

Expand
表 36.3. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 36.4. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 36.5. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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> ...]
Copy to Clipboard Toggle word wrap

Expand
表 36.7. 位置参数
概述

<floating-ip>

要删除的浮动 ip (s) (IP 地址或 id)

Expand
表 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>,...]]
Copy to Clipboard Toggle word wrap

Expand
表 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。)

Expand
表 36.10. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 36.11. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 36.12. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 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]
Copy to Clipboard Toggle word wrap

Expand
表 36.14. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 36.15. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 36.16. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 36.17. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 36.19. 位置参数
概述

<floating-ip>

端口转发属于的浮动 IP (IP 地址或 ID)

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

Expand
表 36.21. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 36.22. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 36.23. shell Formatter
概述

--prefix PREFIX

Expand
表 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> ...]
Copy to Clipboard Toggle word wrap

Expand
表 36.25. 
概述

<floating-ip>

<port-forwarding-id>

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 36.27. 
概述

<floating-ip>

Expand
表 36.28. 
概述

-h, --help

显示帮助信息并退出

--port <port>

--external-protocol-port <port-number>

Expand
表 36.29. 
概述

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

-c COLUMN, --column COLUMN

--sort-column SORT_COLUMN

Expand
表 36.30. 
概述

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

Expand
表 36.31. 
概述

--noindent

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 36.33. 
概述

<floating-ip>

<port-forwarding-id>

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 36.35. 
概述

<floating-ip>

<port-forwarding-id>

Expand
表 36.36. 
概述

-h, --help

显示帮助信息并退出

Expand
表 36.37. 
概述

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

-c COLUMN, --column COLUMN

Expand
表 36.38. 
概述

--noindent

Expand
表 36.39. 
概述

--prefix PREFIX

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 36.41. 
概述

<floating-ip>

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 36.43. 
概述

<floating-ip>

Expand
表 36.44. 
概述

-h, --help

显示帮助信息并退出

Expand
表 36.45. 
概述

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

-c COLUMN, --column COLUMN

Expand
表 36.46. 
概述

--noindent

Expand
表 36.47. 
概述

--prefix PREFIX

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 36.49. 
概述

<floating-ip>

Expand
表 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> ...]
Copy to Clipboard Toggle word wrap

Expand
表 37.1. 
概述

<group>

<user>

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 37.3. 
概述

<group>

<user>

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 37.5. 
概述

<group-name>

Expand
表 37.6. 
概述

-h, --help

显示帮助信息并退出

--domain <domain>

--description <description>

--or-show

Expand
表 37.7. 
概述

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

-c COLUMN, --column COLUMN

Expand
表 37.8. 
概述

--noindent

Expand
表 37.9. 
概述

--prefix PREFIX

Expand
表 37.10. 
概述

--max-width <integer>

--fit-width

--print-empty

37.4. 

使用方法:

openstack group delete [-h] [--domain <domain>] <group> [<group> ...]
Copy to Clipboard Toggle word wrap

Expand
表 37.11. 
概述

<group>

Expand
表 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]
Copy to Clipboard Toggle word wrap

Expand
表 37.13. 
概述

-h, --help

显示帮助信息并退出

--domain <domain>

--user <user>

--user-domain <user-domain>

--long

Expand
表 37.14. 
概述

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

-c COLUMN, --column COLUMN

--sort-column SORT_COLUMN

Expand
表 37.15. 
概述

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

Expand
表 37.16. 
概述

--noindent

Expand
表 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> ...]
Copy to Clipboard Toggle word wrap

Expand
表 37.18. 
概述

<group>

<user>

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 37.20. 
概述

<group>

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 37.22. 
概述

<group>

Expand
表 37.23. 
概述

-h, --help

显示帮助信息并退出

--domain <domain>

Expand
表 37.24. 
概述

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

-c COLUMN, --column COLUMN

Expand
表 37.25. 
概述

--noindent

Expand
表 37.26. 
概述

--prefix PREFIX

Expand
表 37.27. 
概述

--max-width <integer>

--fit-width

--print-empty

第 38 章 help.adoc

38.1. 帮助

使用方法:

openstack help [-h] [cmd [cmd ...]]
Copy to Clipboard Toggle word wrap

Expand
表 38.1. 
概述

cmd

Expand
表 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>]
Copy to Clipboard Toggle word wrap

Expand
表 39.1. 
概述

-h, --help

显示帮助信息并退出

--zone <zone>

Expand
表 39.2. 
概述

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

-c COLUMN, --column COLUMN

--sort-column SORT_COLUMN

Expand
表 39.3. 
概述

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

Expand
表 39.4. 
概述

--noindent

是否禁用缩进 json

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 39.6. 位置参数
概述

<host>

要修改的主机(仅限名称)

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 39.8. 位置参数
概述

<host>

主机的名称

Expand
表 39.9. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 39.10. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 39.11. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 39.12. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 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]
Copy to Clipboard Toggle word wrap

Expand
表 40.1. 可选参数
概述

-h, --help

显示帮助信息并退出

--matching <hostname>

使用 <hostname> substring 过滤虚拟机监控程序

--long

列出输出中的其他字段

Expand
表 40.2. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 40.3. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 40.4. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 40.6. 位置参数
概述

<hypervisor>

要显示的虚拟机监控程序(名称或 id)

Expand
表 40.7. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 40.8. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 40.9. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 40.10. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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]
Copy to Clipboard Toggle word wrap

Expand
表 40.12. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 40.13. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 40.14. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 40.15. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 41.1. 位置参数
概述

<name>

新身份提供程序名称(必须是唯一的)

Expand
表 41.2. 可选参数
概述

-h, --help

显示帮助信息并退出

--remote-id <remote-id>

与身份提供程序关联的远程 ID (重复选项以提供多个值)

--remote-id-file <file-name>

包含与身份提供程序关联的多个远程 ID 的文件名称,每行一个

--description <description>

新身份提供程序描述

--domain <domain>

与身份提供程序关联的域。如果没有指定,则会自动创建域。(名称或 ID)

--enable

启用身份提供程序(默认)

--disable

禁用身份提供程序

Expand
表 41.3. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 41.4. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 41.5. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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> ...]
Copy to Clipboard Toggle word wrap

Expand
表 41.7. 位置参数
概述

<identity-provider>

要删除的身份提供程序

Expand
表 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]
Copy to Clipboard Toggle word wrap

Expand
表 41.9. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 41.10. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 41.11. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 41.12. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 41.14. 位置参数
概述

<identity-provider>

要修改的身份提供程序

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 41.16. 位置参数
概述

<identity-provider>

显示的身份提供程序

Expand
表 41.17. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 41.18. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 41.19. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 41.20. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 42.1. 位置参数
概述

<image>

要共享的镜像(名称或 id)

<project>

与镜像关联的项目(id)

Expand
表 42.2. 可选参数
概述

-h, --help

显示帮助信息并退出

--project-domain <project-domain>

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

Expand
表 42.3. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 42.4. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 42.5. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 42.7. 位置参数
概述

<image-name>

新镜像名称

Expand
表 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)。这可在项目名称之间有冲突时使用。

Expand
表 42.9. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 42.10. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 42.11. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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> ...]
Copy to Clipboard Toggle word wrap

Expand
表 42.13. 位置参数
概述

<image>

要删除的镜像(名称或 ID)

Expand
表 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>]
Copy to Clipboard Toggle word wrap

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

Expand
表 42.16. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 42.17. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 42.18. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 42.20. 位置参数
概述

<image>

镜像(名称或 id)

Expand
表 42.21. 可选参数
概述

-h, --help

显示帮助信息并退出

--project-domain <project-domain>

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

Expand
表 42.22. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 42.23. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 42.24. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 42.26. 位置参数
概述

<image>

镜像到未共享(名称或 id)

<project>

要与镜像解除的项目(名称或 id)

Expand
表 42.27. 可选参数
概述

-h, --help

显示帮助信息并退出

--project-domain <project-domain>

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

42.7. 镜像保存

本地保存镜像

使用方法:

openstack image save [-h] [--file <filename>] <image>
Copy to Clipboard Toggle word wrap

Expand
表 42.28. 位置参数
概述

<image>

要保存的镜像(名称或 id)

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 42.30. 位置参数
概述

<image>

要修改的镜像(名称或 id)

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 42.32. 位置参数
概述

<image>

要显示的镜像(名称或 id)

Expand
表 42.33. 可选参数
概述

-h, --help

显示帮助信息并退出

--human-readable

以人类友好格式显示镜像大小。

Expand
表 42.34. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 42.35. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 42.36. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 42.38. 位置参数
概述

<image>

要修改的镜像(名称或 id)

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 43.1. 位置参数
概述

<role>

代表了另一个角色的角色(名称或 id)

Expand
表 43.2. 可选参数
概述

-h, --help

显示帮助信息并退出

--implied-role <role>

<role> (名称或 id)被另一个角色表示

Expand
表 43.3. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 43.4. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 43.5. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 43.7. 位置参数
概述

<role>

代表了另一个角色的角色(名称或 id)

Expand
表 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]
Copy to Clipboard Toggle word wrap

Expand
表 43.9. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 43.10. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 43.11. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 43.12. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 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>]
Copy to Clipboard Toggle word wrap

Expand
表 44.1. 可选参数
概述

-h, --help

显示帮助信息并退出

--ip-version <ip-version>

列出给定 ip version 网络的 ip availability (默认为 4)

--project <project>

列出给定项目的 ip availability (名称或 ID)

--project-domain <project-domain>

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

Expand
表 44.2. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 44.3. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 44.4. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 44.6. 位置参数
概述

<network>

显示特定网络的 ip 可用性(名称或 ID)

Expand
表 44.7. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 44.8. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 44.9. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 44.10. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 45.1. 位置参数
概述

<name>

新公钥或私钥名称

Expand
表 45.2. 可选参数
概述

-h, --help

显示帮助信息并退出

--public-key <file>

要添加的公钥的文件名。如果没有使用,请创建一个私钥。

--private-key <file>

要保存的私钥的文件名。如果没有使用,请在控制台中打印私钥。

Expand
表 45.3. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 45.4. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 45.5. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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> ...]
Copy to Clipboard Toggle word wrap

Expand
表 45.7. 位置参数
概述

<key>

要删除的密钥名称(仅限名称)

Expand
表 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]
Copy to Clipboard Toggle word wrap

Expand
表 45.9. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 45.10. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 45.11. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 45.12. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 45.14. 位置参数
概述

<key>

要显示的公钥或私钥(仅限名称)

Expand
表 45.15. 可选参数
概述

-h, --help

显示帮助信息并退出

--public-key

仅显示使用生成的密钥对裸机公钥

Expand
表 45.16. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 45.17. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 45.18. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 46.1. 位置参数
概述

<GATEWAY-NAME/UUID>

逻辑网关的描述性名称。

<NETWORK-NAME/UUID>

网络名称或 uuid。

Expand
表 46.2. 可选参数
概述

-h, --help

显示帮助信息并退出

--default-segmentation-id SEG_ID

将应用于在 l2-gateway-create 命令中没有指定分段 ID 的接口的默认 segmentation-id。

Expand
表 46.3. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 46.4. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 46.5. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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> ...]
Copy to Clipboard Toggle word wrap

Expand
表 46.7. 位置参数
概述

<L2_GATEWAY_CONNECTIONS>

要删除的 l2_gateway_connections (s)的 ID。

Expand
表 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>]
Copy to Clipboard Toggle word wrap

Expand
表 46.9. 可选参数
概述

-h, --help

显示帮助信息并退出

--project <project>

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

--project-domain <project-domain>

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

Expand
表 46.10. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 46.11. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 46.12. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 46.14. 位置参数
概述

<L2_GATEWAY_CONNECTION>

要查找的 l2_gateway_connection 的 ID。

Expand
表 46.15. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 46.16. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 46.17. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 46.18. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 46.20. 位置参数
概述

<GATEWAY-NAME>

逻辑网关的描述性名称。

Expand
表 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 选项可以重复)

Expand
表 46.22. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 46.23. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 46.24. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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> ...]
Copy to Clipboard Toggle word wrap

Expand
表 46.26. 位置参数
概述

<L2_GATEWAY>

要删除的 l2_gateway 的 ID 或名称。

Expand
表 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>]
Copy to Clipboard Toggle word wrap

Expand
表 46.28. 可选参数
概述

-h, --help

显示帮助信息并退出

--project <project>

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

--project-domain <project-domain>

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

Expand
表 46.29. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 46.30. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 46.31. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 46.33. 位置参数
概述

<L2_GATEWAY>

要查找的 ID 或名称 l2_gateway。

Expand
表 46.34. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 46.35. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 46.36. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 46.37. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 46.39. 位置参数
概述

<L2_GATEWAY>

要更新的 l2_gateway 的 ID 或名称。

Expand
表 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 选项可以重复)

Expand
表 46.41. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 46.42. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 46.43. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 47.1. 位置参数
概述

<resource-name>

要限制的资源的名称

Expand
表 47.2. 可选参数
概述

-h, --help

显示帮助信息并退出

--description <description>

限制的描述

--region <region>

要影响的限值的区域。

--project <project>

将资源限值关联到的项目

--service <service>

负责限制的资源的服务

--resource-limit <resource-limit>

项目的资源限制

Expand
表 47.3. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 47.4. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 47.5. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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> ...]
Copy to Clipboard Toggle word wrap

Expand
表 47.7. 位置参数
概述

<limit-id>

限制删除(id)

Expand
表 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>]
Copy to Clipboard Toggle word wrap

Expand
表 47.9. 可选参数
概述

-h, --help

显示帮助信息并退出

--service <service>

负责限制的资源的服务

--resource-name <resource-name>

要限制的资源的名称

--region <region>

注册限制的区域以影响.

--project <project>

列出与项目关联的资源限制

Expand
表 47.10. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 47.11. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 47.12. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 47.14. 位置参数
概述

<limit-id>

限制为更新(id)

Expand
表 47.15. 可选参数
概述

-h, --help

显示帮助信息并退出

--description <description>

限制的描述

--resource-limit <resource-limit>

项目的资源限制

Expand
表 47.16. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 47.17. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 47.18. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 47.20. 位置参数
概述

<limit-id>

限制为显示(id)

Expand
表 47.21. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 47.22. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 47.23. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 47.24. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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>]
Copy to Clipboard Toggle word wrap

Expand
表 48.1. 可选参数
概述

-h, --help

显示帮助信息并退出

--absolute

显示绝对限制

--rate

显示速率限值

--reserved

包括保留数 [只能通过 --absolute]

--project <project>

显示特定项目的限值(名称或 id)[只有效使用 --absolute]

--domain <domain>

项目所属的域(名称或 id)[仅对 --absolute]有效.

Expand
表 48.2. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 48.3. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 48.4. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 49.1. 位置参数
概述

<amphora-id>

用于配置的amphora 的 UUID。

Expand
表 49.2. 可选参数
概述

-h, --help

显示帮助信息并退出

49.2. LoadBalancer amphora 故障切换

强制故障转移 amphora

使用方法:

openstack loadbalancer amphora failover [-h] <amphora-id>
Copy to Clipboard Toggle word wrap

Expand
表 49.3. 位置参数
概述

<amphora-id>

amphora 的 UUID。

Expand
表 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}]
Copy to Clipboard Toggle word wrap

Expand
表 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 状态过滤。

Expand
表 49.6. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 49.7. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 49.8. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 49.10. 位置参数
概述

<amphora-id>

amphora 的 UUID。

Expand
表 49.11. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 49.12. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 49.13. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 49.14. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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>]
Copy to Clipboard Toggle word wrap

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

Expand
表 49.17. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 49.18. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 49.19. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 49.20. 表格式
概述

--max-width <integer>

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

--fit-width

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

--print-empty

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

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 49.22. 位置参数
概述

<load_balancer>

要删除的负载均衡器(名称或 id)

Expand
表 49.23. 可选参数
概述

-h, --help

显示帮助信息并退出

--cascade

将删除操作传递给负载均衡器的所有子元素。

49.7. LoadBalancer 故障转移

触发负载均衡器故障切换

使用方法:

openstack loadbalancer failover [-h] <load_balancer>
Copy to Clipboard Toggle word wrap

Expand
表 49.24. 位置参数
概述

<load_balancer>

负载均衡器的名称或 uuid。

Expand
表 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]
Copy to Clipboard Toggle word wrap

Expand
表 49.26. 可选参数
概述

-h, --help

显示帮助信息并退出

--name <name>

新类别名称。

--flavorprofile <flavor_profile>

将类别添加到 (名称或 ID)的 flavor 配置集。

--description <description>

设置类别描述。

--enable

启用类别。

--disable

禁用类别。

Expand
表 49.27. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 49.28. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 49.29. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 49.31. 位置参数
概述

<flavor>

要删除的类别(名称或 ID)

Expand
表 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]
Copy to Clipboard Toggle word wrap

Expand
表 49.33. 可选参数
概述

-h, --help

显示帮助信息并退出

--name <name>

根据类别的名称列出类别。

--flavorprofile <flavor_profile>

根据类别配置文件列出类别。

--enable

列出已启用的类别。

--disable

列出禁用的类别。

Expand
表 49.34. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 49.35. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 49.36. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 49.38. 位置参数
概述

<flavor>

要更新的类别的名称或 uuid。

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 49.40. 位置参数
概述

<flavor>

类别的名称或 uuid。

Expand
表 49.41. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 49.42. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 49.43. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 49.44. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 49.46. 位置参数
概述

<flavor>

要更新的类别(名称或 ID)。

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 49.48. 可选参数
概述

-h, --help

显示帮助信息并退出

--name <name>

新的 octavia 类别配置集名称。

--provider <provider name>

类别配置文件的提供程序名称。

--flavor-data <flavor_data>

包含类别元数据的 json 字符串。

Expand
表 49.49. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 49.50. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 49.51. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 49.53. 位置参数
概述

<flavor_profile>

要删除的类别配置文件(名称或 ID)

Expand
表 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>]
Copy to Clipboard Toggle word wrap

Expand
表 49.55. 可选参数
概述

-h, --help

显示帮助信息并退出

--name <name>

根据类别配置集名称列出 flavor 配置集。

--provider <provider_name>

根据提供程序列出类别配置集。

Expand
表 49.56. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 49.57. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 49.58. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 49.60. 位置参数
概述

<flavor_profile>

要更新的类别配置集的名称或 uuid。

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 49.62. 位置参数
概述

<flavor_profile>

要显示的类别配置集的名称或 uuid。

Expand
表 49.63. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 49.64. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 49.65. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 49.66. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 49.68. 位置参数
概述

<pool>

为运行状况监控器(名称或 ID)设置池。

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

禁用运行状况监视器。

Expand
表 49.70. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 49.71. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 49.72. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 49.74. 位置参数
概述

<health_monitor>

要删除的运行状况监视器(名称或 id)。

Expand
表 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]
Copy to Clipboard Toggle word wrap

Expand
表 49.76. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 49.77. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 49.78. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 49.79. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 49.81. 位置参数
概述

<health_monitor>

运行状况监视器更新(名称或 id)。

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 49.83. 位置参数
概述

<health_monitor>

健康监控器的名称或 uuid。

Expand
表 49.84. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 49.85. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 49.86. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 49.87. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 49.89. 位置参数
概述

<health_monitor>

运行状况监视器更新(名称或 id)。

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 49.91. 位置参数
概述

<listener>

将 l7policy 添加至(名称或 ID)的监听程序。

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

Expand
表 49.93. 输出格式器
概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 49.94. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 49.95. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 49.97. 位置参数
概述

<policy>

要删除的 L7policy (名称或 ID)。

Expand
表 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]
Copy to Clipboard Toggle word wrap

Expand
表 49.99. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 49.100. 输出格式器
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

Expand
表 49.101. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

Expand
表 49.102. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 49.104. 位置参数
概述

<policy>

L7policy 以更新(名称或 ID)。

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 49.106. 位置参数
概述

<policy>

l7policy 的名称或 uuid。

Expand
表 49.107. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 49.108. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 49.109. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 49.110. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 49.112. 位置参数
概述

<policy>

L7policy 以更新(名称或 ID)。

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 49.114. 位置参数
概述

<l7policy>

L7policy 以将 l7rule 添加到 (名称或 ID)。

Expand
表 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。

Expand
表 49.116. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 49.117. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 49.118. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 49.120. 位置参数
概述

<l7policy>

从(名称或 ID)中删除规则的 L7policy。

<rule_id>

要删除的 L7rule。

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 49.122. 位置参数
概述

<l7policy>

L7policy 可列出 (名称或 ID)的规则。

Expand
表 49.123. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 49.124. 输出格式器
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

Expand
表 49.125. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

Expand
表 49.126. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 49.128. 位置参数
概述

<l7policy>

L7policy 可在(名称或 ID)上更新 l7rule。

<l7rule_id>

要更新的 L7rule。

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 49.130. 位置参数
概述

<l7policy>

L7policy 以显示来自(名称或 ID)的规则。

<l7rule_id>

要显示的 L7rule。

Expand
表 49.131. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 49.132. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 49.133. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 49.134. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 49.136. 位置参数
概述

<l7policy>

L7policy 以更新(名称或 ID)。

<l7rule_id>

要更新的 L7rule。

Expand
表 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>]
Copy to Clipboard Toggle word wrap

Expand
表 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>

根据类别列出负载均衡器。

Expand
表 49.139. 输出格式器
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

Expand
表 49.140. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

Expand
表 49.141. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 49.143. 位置参数
概述

<LoadBalancer>

侦听器的负载均衡器(名称或 ID)。

Expand
表 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 (可以多次设置)。

Expand
表 49.145. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 49.146. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 49.147. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 49.149. 位置参数
概述

<listener>

要删除的监听程序(名称或 id)

Expand
表 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>]
Copy to Clipboard Toggle word wrap

Expand
表 49.151. 可选参数
概述

-h, --help

显示帮助信息并退出

--name <name>

按侦听器名称列出监听程序。

--LoadBalancer <loadbalancer>

按负载均衡器(名称或 id)过滤。

--enable

列出已启用的监听程序。

--disable

列出禁用的监听程序。

--project <project>

按项目 ID 列出监听程序。

Expand
表 49.152. 输出格式器
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

Expand
表 49.153. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

Expand
表 49.154. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 49.156. 位置参数
概述

<listener>

修改(名称或 ID)的监听程序。

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 49.158. 位置参数
概述

<listener>

侦听器的名称或 uuid

Expand
表 49.159. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 49.160. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 49.161. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 49.162. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 49.164. 位置参数
概述

<listener>

侦听器的名称或 uuid

Expand
表 49.165. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 49.166. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 49.167. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 49.168. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 49.170. 位置参数
概述

<listener>

修改(名称或 ID)的监听程序。

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 49.172. 位置参数
概述

<pool>

为创建成员的池的 ID 或名称。

Expand
表 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

禁用成员

Expand
表 49.174. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 49.175. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 49.176. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 49.178. 位置参数
概述

<pool>

用于删除成员的池名称或 ID。

<member>

要删除的成员的名称或 id。

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 49.180. 位置参数
概述

<pool>

用于列出以下条件的成员的池名称或 ID。

Expand
表 49.181. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 49.182. 输出格式器
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

Expand
表 49.183. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

Expand
表 49.184. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 49.186. 位置参数
概述

<pool>

要更新的成员所属的池(名称或 ID)。

<member>

要更新的成员的名称或 id

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 49.188. 位置参数
概述

<pool>

池名称或 id,以显示.

<member>

要显示的成员的名称或 id。

Expand
表 49.189. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 49.190. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 49.191. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 49.192. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 49.194. 位置参数
概述

<pool>

要更新的成员所属的池(名称或 ID)。

<member>

要修改的成员(名称或 ID)。

Expand
表 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]
Copy to Clipboard Toggle word wrap

Expand
表 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

禁用后端成员重新加密。

Expand
表 49.197. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 49.198. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 49.199. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 49.201. 位置参数
概述

<pool>

要删除的池(名称或 id)。

Expand
表 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>]
Copy to Clipboard Toggle word wrap

Expand
表 49.203. 可选参数
概述

-h, --help

显示帮助信息并退出

--LoadBalancer <loadbalancer>

按负载均衡器(名称或 id)过滤。

Expand
表 49.204. 输出格式器
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

Expand
表 49.205. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

Expand
表 49.206. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 49.208. 位置参数
概述

<pool>

要更新的池(名称或 id)。

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 49.210. 位置参数
概述

<pool>

池的名称或 uuid。

Expand
表 49.211. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 49.212. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 49.213. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 49.214. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 49.216. 位置参数
概述

<pool>

要修改的池(名称或 ID)。

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 49.218. 位置参数
概述

<provider_name>

供应商驱动程序的名称。

Expand
表 49.219. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 49.220. 输出格式器
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

Expand
表 49.221. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

Expand
表 49.222. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 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]
Copy to Clipboard Toggle word wrap

Expand
表 49.224. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 49.225. 输出格式器
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

Expand
表 49.226. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

Expand
表 49.227. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 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]
Copy to Clipboard Toggle word wrap

Expand
表 49.229. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 49.230. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 49.231. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 49.232. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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>]
Copy to Clipboard Toggle word wrap

Expand
表 49.234. 可选参数
概述

-h, --help

显示帮助信息并退出

--project <project-id>

项目的名称或 uuid。

Expand
表 49.235. 输出格式器
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

Expand
表 49.236. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

Expand
表 49.237. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 49.239. 位置参数
概述

<project>

重置配额的项目(名称或 ID)

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 49.241. 位置参数
概述

<project>

项目的名称或 uuid。

Expand
表 49.242. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 49.243. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 49.244. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 49.245. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 49.246. 表格式
概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 49.248. 位置参数
概述

<project>

项目的名称或 uuid。

Expand
表 49.249. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 49.250. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 49.251. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 49.252. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 49.254. 位置参数
概述

<project>

项目的名称或 uuid。

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 49.256. 位置参数
概述

<load_balancer>

要更新的负载均衡器的名称或 uuid。

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 49.258. 位置参数
概述

<load_balancer>

负载均衡器的名称或 uuid。

Expand
表 49.259. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 49.260. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 49.261. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 49.262. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 49.264. 位置参数
概述

<load_balancer>

负载均衡器的名称或 uuid。

Expand
表 49.265. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 49.266. 输出格式器
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 49.267. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 49.268. shell Formatter
概述

--prefix PREFIX

为所有变量名称添加前缀

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 49.270. 位置参数
概述

<load_balancer>

负载均衡器的名称或 uuid。

Expand
表 49.271. 可选参数
概述

-h, --help

显示帮助信息并退出

49.69. LoadBalancer 取消设置

清除负载均衡器设置

使用方法:

openstack loadbalancer unset [-h] [--name] [--description]
                                    [--vip-qos-policy-id]
                                    <load_balancer>
Copy to Clipboard Toggle word wrap

Expand
表 49.272. 位置参数
概述

<load_balancer>

要更新的负载均衡器的名称或 uuid。

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 50.1. 位置参数
概述

<name>

新映射名称(必须唯一)

Expand
表 50.2. 可选参数
概述

-h, --help

显示帮助信息并退出

--rules <filename>

包含一组映射规则的文件名(必需)

Expand
表 50.3. 输出格式
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 50.4. JSON 格式
概述

--noindent

是否禁用缩进 json

Expand
表 50.5. Shell 格式
概述

--prefix PREFIX

在所有变量名称中添加前缀

Expand
表 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> ...]
Copy to Clipboard Toggle word wrap

Expand
表 50.7. 位置参数
概述

<mapping>

要删除的映射

Expand
表 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]
Copy to Clipboard Toggle word wrap

Expand
表 50.9. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 50.10. 输出格式
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定要对数据排序的列(指定第一个列具有优先级,而非现有列将被忽略),可以重复

Expand
表 50.11. CSV 格式
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

Expand
表 50.12. JSON 格式
概述

--noindent

是否禁用缩进 json

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 50.14. 位置参数
概述

<name>

映射修改

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 50.16. 位置参数
概述

<mapping>

映射至显示

Expand
表 50.17. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 50.18. 输出格式
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 50.19. JSON 格式
概述

--noindent

是否禁用缩进 json

Expand
表 50.20. Shell 格式
概述

--prefix PREFIX

在所有变量名称中添加前缀

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 51.1. 位置参数
概述

<queue_name>

要声明的队列的名称

Expand
表 51.2. 可选参数
概述

-h, --help

显示帮助信息并退出

--ttl <ttl>

声明的时间(以秒为单位)

--grace <grace>

消息宽限期(以秒为单位)

--limit <limit>

声明一组信息,最多限制

Expand
表 51.3. 输出格式
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定要对数据排序的列(指定第一个列具有优先级,而非现有列将被忽略),可以重复

Expand
表 51.4. CSV 格式
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

Expand
表 51.5. JSON 格式
概述

--noindent

是否禁用缩进 json

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 51.7. 位置参数
概述

<queue_name>

声明队列的名称

<claim_id>

声明 ID

Expand
表 51.8. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 51.9. 输出格式
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定要对数据排序的列(指定第一个列具有优先级,而非现有列将被忽略),可以重复

Expand
表 51.10. CSV 格式
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

Expand
表 51.11. JSON 格式
概述

--noindent

是否禁用缩进 json

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 51.13. 位置参数
概述

<queue_name>

声明队列的名称

<claim_id>

要删除的声明 ID

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 51.15. 位置参数
概述

<queue_name>

声明队列的名称

<claim_id>

声明 ID

Expand
表 51.16. 可选参数
概述

-h, --help

显示帮助信息并退出

--ttl <ttl>

声明的时间(以秒为单位)

--grace <grace>

消息宽限期(以秒为单位)

Expand
表 51.17. 输出格式
概述

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定要对数据排序的列(指定第一个列具有优先级,而非现有列将被忽略),可以重复

Expand
表 51.18. CSV 格式
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为非数字

Expand
表 51.19. JSON 格式
概述

--noindent

是否禁用缩进 json

Expand
表 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>
Copy to Clipboard Toggle word wrap

Expand
表 51.21. 位置参数
概述

<flavor_name>

类别的名称

Expand
表 51.22. 可选参数
概述

-h, --help

显示帮助信息并退出

--pool_list <pool_list>

类别池列表

--capabilities <capabilities>

描述特定于类别的功能,此选项仅适用于 client api 版本 < 2。

Expand
表 51.23. 输出格式
概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 51.24. JSON 格式
概述

--noindent

是否禁用缩进 json

Expand
表 51.25. Shell 格式
概述

--prefix PREFIX

在所有变量名称中添加前缀

Expand
表 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. 消息传递类别删除