命令行界面参考


Red Hat OpenStack Platform 13

Red Hat OpenStack Platform 的命令行客户端

摘要

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

前言

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

第 1 章 OpenStack 客户端

openstack 客户端是 OpenStack 命令行界面(CLI)。本章记录了 openstack 版本 3.14.3 的主要选项。:leveloffset: +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-network-api-version <network-api-version>]
                 [--os-image-api-version <image-api-version>]
                 [--os-volume-api-version <volume-api-version>]
                 [--os-identity-api-version <identity-api-version>]
                 [--os-object-api-version <object-api-version>]
                 [--os-queues-api-version <queues-api-version>]
                 [--os-tripleoclient-api-version <tripleoclient-api-version>]
                 [--os-key-manager-api-version <key-manager-api-version>]
                 [--os-loadbalancer-api-version <loadbalancer-api-version>]
                 [--os-metrics-api-version <metrics-api-version>]
                 [--os-workflow-api-version <workflow-api-version>]
                 [--os-baremetal-api-version <baremetal-api-version>]
                 [--os-dns-api-version <dns-api-version>]
                 [--os-alarming-api-version <alarming-api-version>]
                 [--os-orchestration-api-version <orchestration-api-version>]
                 [--os-data-processing-api-version <data-processing-api-version>]
                 [--os-data-processing-url OS_DATA_PROCESSING_URL]
                 [--os-container-infra-api-version <container-infra-api-version>]
                 [--inspector-api-version INSPECTOR_API_VERSION]
                 [--inspector-url INSPECTOR_URL]
                 [--os-database-api-version <database-api-version>]
                 [--os-auth-type <auth-type>]
                 [--os-project-domain-id <auth-project-domain-id>]
                 [--os-protocol <auth-protocol>]
                 [--os-project-name <auth-project-name>]
                 [--os-trust-id <auth-trust-id>]
                 [--os-consumer-key <auth-consumer-key>]
                 [--os-domain-name <auth-domain-name>]
                 [--os-access-secret <auth-access-secret>]
                 [--os-user-domain-id <auth-user-domain-id>]
                 [--os-access-token-type <auth-access-token-type>]
                 [--os-code <auth-code>]
                 [--os-application-credential-name <auth-application-credential-name>]
                 [--os-identity-provider-url <auth-identity-provider-url>]
                 [--os-aodh-endpoint <auth-aodh-endpoint>]
                 [--os-service-provider-endpoint <auth-service-provider-endpoint>]
                 [--os-access-token <auth-access-token>]
                 [--os-domain-id <auth-domain-id>]
                 [--os-user-domain-name <auth-user-domain-name>]
                 [--os-openid-scope <auth-openid-scope>]
                 [--os-user-id <auth-user-id>]
                 [--os-application-credential-secret <auth-application-credential-secret>]
                 [--os-identity-provider <auth-identity-provider>]
                 [--os-username <auth-username>]
                 [--os-auth-url <auth-auth-url>]
                 [--os-client-secret <auth-client-secret>]
                 [--os-access-token-endpoint <auth-access-token-endpoint>]
                 [--os-default-domain-id <auth-default-domain-id>]
                 [--os-discovery-endpoint <auth-discovery-endpoint>]
                 [--os-client-id <auth-client-id>]
                 [--os-default-domain-name <auth-default-domain-name>]
                 [--os-project-domain-name <auth-project-domain-name>]
                 [--os-service-provider-entity-id <auth-service-provider-entity-id>]
                 [--os-access-key <auth-access-key>]
                 [--os-password <auth-password>]
                 [--os-redirect-uri <auth-redirect-uri>]
                 [--os-endpoint <auth-endpoint>] [--os-roles <auth-roles>]
                 [--os-url <auth-url>]
                 [--os-consumer-secret <auth-consumer-secret>]
                 [--os-token <auth-token>]
                 [--os-application-credential-id <auth-application-credential-id>]
                 [--os-passcode <auth-passcode>]
                 [--os-system-scope <auth-system-scope>]
                 [--os-project-id <auth-project-id>] [--os-user <auth-user>]
Copy to Clipboard Toggle word wrap

Expand
表 1.1. 可选参数
概述

--inspector-url INSPECTOR_URL

inspector url,默认为 localhost (env: INSPECTOR_URL)。

--os-cacert <ca-bundle-file>

CA 证书捆绑包文件(env: os_cacert)

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

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

--inspector-api-version INSPECTOR_API_VERSION

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

--os-redirect-uri <auth-redirect-uri>

使用 v3oidcauthcode: openid connect redirect url (env: OS_REDIRECT_URI)

--os-cloud <cloud-config-name>

clouds.yaml 中的云名称(env: os_cloud)

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

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

--OS-alarming-api-version <alarming-api-version>

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

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

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

-h, --help

显示帮助信息并退出。

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

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

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

使用 v2token: trust id with v3adfspassword: trust id With v2password: Trust ID With v3token: Trust ID with v3oidcauthcode: Trust ID with v3samlpassword: Trust ID with v3totp: Trust ID with v3oidc clientcredentials: Trust ID with password: Trust ID with v3oidcaccesstoken: Trust ID with v3oidcpassword: Trust ID with token: Trust ID with v3applicationcredential: Trust ID (Env: os_TRUST_ID)

--os-identity-api-version <identity-api-version>

Identity api version, default=3 (env: OS_IDENTITY_API_VERSION)

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

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

--verify

验证服务器证书(默认)

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

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

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

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

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

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

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

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

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

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

--os-endpoint <auth-endpoint>

使用 admin_token:通过 gnocchi-basic: Gnocchi 端点带有 gnocchi-noauth: Gnocchi 端点的端点(Env: OS_ENDPOINT)的端点(Env: OS_ENDPOINT)

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

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

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

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

--os-roles <auth-roles>

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

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

v3applicationcredential: application credential name (Env: OS_APPLICATION_CREDENTIAL_NAME)

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

Dns api version, default=2 (env: os_dns_api_version)

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

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

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

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

--os-service-provider-entity-id <auth-service-provider-entity-id>

使用 v3adfspassword:服务提供商的 saml 实体 id (Env: OS_SERVICE_PROVIDER_ENTITY_ID)

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

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

--os-beta-command

启用可能更改的 beta 命令

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

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

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

使用 v3adfspassword:服务提供商的端点(env: OS_SERVICE_PROVIDER_ENDPOINT)

--timing

print api 调用时间信息

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

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

--os-loadbalancer-api-version <loadbalancer-api-version>

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

--os-protocol <auth-protocol>

使用 v3adfspassword:用于联合插件的协议与 v3oidcauthcode: Protocol for federated 插件使用 v3samlpassword: Protocol for federated 插件使用 v3oidcclientcredentials: Protocol for federated 插件使用 v3oidcaccesstoken: Protocol for federated 插件(Env: OS_PROTOCOL)

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

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

--os-user <auth-user>

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

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

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

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

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

--insecure

禁用服务器证书验证

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

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

--os-password <auth-password>

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

--os-cert <certificate-file>

客户端证书捆绑包文件(env: os_cert)

--os-code <auth-code>

使用 v3oidcauthcode: oauth 2.0 授权代码(Env: OS_CODE)

--os-consumer-secret <auth-consumer-secret>

使用 v3oauth1: oauth consumer secret (env: OS_CONSUMER_SECRET)

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

Compute api version, default=2.1 (env: OS_COMPUTE_API_VERSION)

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

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

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

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

--os-region-name <auth-region-name>

身份验证区域名称(env: os_region_name)

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

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

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

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

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

v3applicationcredential: application credential auth secret (Env: OS_APPLICATION_CREDENTIAL_SECRET)

--os-passcode <auth-passcode>

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

--os-profile hmac-key

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

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

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

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

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

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

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

-v, --verbose

增加输出的详细程度。可以重复。

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

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

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

v3applicationcredential: application credential ID (Env: OS_APPLICATION_CREDENTIAL_ID)

--os-data-processing-url OS_DATA_PROCESSING_URL

Data processing api url,(env: OS_DATA_PROCESSING_API_URL)

--os-service-provider <service_provider>

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

--os-image-api-version <image-api-version>

image api 版本, default=2 (env: OS_IMAGE_API_VERSION)

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

使用 v3password: user 的域名(带有 v3totp: User 的域名 with password: User 的域名 With v3applicationcredential: User 的域名(Env: OS_USER_DOMAIN_NAME)

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

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

--os-key <key-file>

客户端证书密钥文件(env: os_key)

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

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

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

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

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

默认域 ID, default=default. (env: OS_DEFAULT_DOMAIN)

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

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

--log-file LOG_FILE

指定要日志输出的文件。默认禁用。

--os-access-key <auth-access-key>

With v3oauth1: oauth access key (env: os_access_key)

--debug

显示错误的回溯信息。

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

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

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

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

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

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

-q, --quiet

抑制输出,但警告和错误除外。

--version

显示程序的版本号并退出

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

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

--os-interface <interface>

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

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

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

--os-token <auth-token>

v2token: 带有 admin_token 的令牌:将始终通过 v3token: Token 使用令牌与 token_endpoint: Authentication 令牌进行身份验证,以便与 token: Token 用于与(Env: OS_TOKEN)进行身份验证。

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

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

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

Database api version, default=1 (env: OS_DATABASE_API_VERSION)

--os-consumer-key <auth-consumer-key>

使用 v3oauth1: oauth consumer id/key (env: OS_CONSUMER_KEY)

--os-url <auth-url>

带有 token_endpoint:要使用的特定服务端点(Env: OS_URL)

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

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

--os-username <auth-username>

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

第 2 章 acl

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

2.1. ACL 删除

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

使用方法:

openstack acl delete [-h] URI
Copy to Clipboard Toggle word wrap

Expand
表 2.1. 位置参数
概述

URI

secret 或容器的 uri 引用。

Expand
表 2.2. 可选参数
概述

-h, --help

显示帮助信息并退出

2.2. ACL 获得

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

使用方法:

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

Expand
表 2.3. 表格式
概述

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表 2.4. 位置参数
概述

URI

secret 或容器的 uri 引用。

Expand
表 2.5. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 2.6. 输出格式器
概述

输出 formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 2.7. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 2.8. 可选参数
概述

-h, --help

显示帮助信息并退出

2.3. ACL 提交

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

使用方法:

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

Expand
表 2.9. 表格式
概述

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表 2.10. 位置参数
概述

URI

secret 或容器的 uri 引用。

Expand
表 2.11. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 2.12. 输出格式器
概述

输出 formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 2.13. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 2.14. 可选参数
概述

--project-access

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

-h, --help

显示帮助信息并退出

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

acl 的 Keystone userid.

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

为设置 barbican 操作 acl 的类型

--no-project-access

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

2.4. ACL 用户添加

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

使用方法:

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

Expand
表 2.15. 表格式
概述

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表 2.16. 位置参数
概述

URI

secret 或容器的 uri 引用。

Expand
表 2.17. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 2.18. 输出格式器
概述

输出 formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 2.19. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 2.20. 可选参数
概述

--project-access

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

-h, --help

显示帮助信息并退出

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

acl 的 Keystone userid.

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

为设置 barbican 操作 acl 的类型

--no-project-access

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

2.5. ACL 用户删除

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

使用方法:

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

Expand
表 2.21. 表格式
概述

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表 2.22. 位置参数
概述

URI

secret 或容器的 uri 引用。

Expand
表 2.23. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 2.24. 输出格式器
概述

输出 formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 2.25. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 2.26. 可选参数
概述

--project-access

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

-h, --help

显示帮助信息并退出

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

acl 的 Keystone userid.

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

为设置 barbican 操作 acl 的类型

--no-project-access

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

第 3 章 action

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

3.1. 操作定义创建

创建新操作。

使用方法:

openstack action definition create [-h]
                                          [-f {csv,json,table,value,yaml}]
                                          [-c COLUMN] [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          [--noindent]
                                          [--quote {all,minimal,none,nonnumeric}]
                                          [--sort-column SORT_COLUMN]
                                          [--public]
                                          definition
Copy to Clipboard Toggle word wrap

Expand
表 3.1. 表格式
概述

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表 3.2. 位置参数
概述

定义

操作定义文件

Expand
表 3.3. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 3.4. 输出格式器
概述

输出 formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 3.5. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 3.6. 可选参数
概述

-h, --help

显示帮助信息并退出

--public

使用此标志操作将被标记为 "public"。

3.2. 操作定义显示

显示操作定义。

使用方法:

openstack action definition definition show [-h] name
Copy to Clipboard Toggle word wrap

Expand
表 3.7. 位置参数
概述

name

操作名称

Expand
表 3.8. 可选参数
概述

-h, --help

显示帮助信息并退出

3.3. 操作定义删除

删除操作.

使用方法:

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

Expand
表 3.9. 位置参数
概述

action

操作的名称或 id。

Expand
表 3.10. 可选参数
概述

-h, --help

显示帮助信息并退出

3.4. 操作定义列表

列出所有操作。

使用方法:

openstack action definition list [-h] [-f {csv,json,table,value,yaml}]
                                        [-c COLUMN] [--max-width <integer>]
                                        [--fit-width] [--print-empty]
                                        [--noindent]
                                        [--quote {all,minimal,none,nonnumeric}]
                                        [--sort-column SORT_COLUMN]
                                        [--filter FILTERS]
Copy to Clipboard Toggle word wrap

Expand
表 3.11. 表格式
概述

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表 3.12. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 3.13. 输出格式器
概述

输出 formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 3.14. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 3.15. 可选参数
概述

--filter FILTERS

过滤器. 可以重复。

-h, --help

显示帮助信息并退出

3.5. 操作定义显示

显示特定操作。

使用方法:

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

Expand
表 3.16. 表格式
概述

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表 3.17. 位置参数
概述

action

操作(名称或 id)

Expand
表 3.18. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 3.19. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 3.20. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 3.21. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

3.6. 操作定义更新

更新操作。

使用方法:

openstack action definition update [-h]
                                          [-f {csv,json,table,value,yaml}]
                                          [-c COLUMN] [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          [--noindent]
                                          [--quote {all,minimal,none,nonnumeric}]
                                          [--sort-column SORT_COLUMN]
                                          [--id ID] [--public]
                                          definition
Copy to Clipboard Toggle word wrap

Expand
表 3.22. 表格式
概述

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表 3.23. 位置参数
概述

定义

操作定义文件

Expand
表 3.24. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 3.25. 输出格式器
概述

输出 formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 3.26. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 3.27. 可选参数
概述

-h, --help

显示帮助信息并退出

--id ID

操作 ID.

--public

使用此标志操作将被标记为 "public"。

3.7. 操作执行删除

删除操作执行。

使用方法:

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

Expand
表 3.28. 位置参数
概述

action_execution

操作执行标识符 ID。

Expand
表 3.29. 可选参数
概述

-h, --help

显示帮助信息并退出

3.8. 操作执行输入显示

显示操作执行输入数据。

使用方法:

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

Expand
表 3.30. 位置参数
概述

id

操作执行 ID.

Expand
表 3.31. 可选参数
概述

-h, --help

显示帮助信息并退出

3.9. 操作执行列表

列出所有操作执行。

使用方法:

openstack action execution list [-h] [-f {csv,json,table,value,yaml}]
                                       [-c COLUMN] [--max-width <integer>]
                                       [--fit-width] [--print-empty]
                                       [--noindent]
                                       [--quote {all,minimal,none,nonnumeric}]
                                       [--sort-column SORT_COLUMN]
                                       [--limit [LIMIT]]
                                       [task_execution_id]
Copy to Clipboard Toggle word wrap

Expand
表 3.32. 表格式
概述

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表 3.33. 位置参数
概述

task_execution_id

任务执行 ID。

Expand
表 3.34. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 3.35. 输出格式器
概述

输出 formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 3.36. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 3.37. 可选参数
概述

-h, --help

显示帮助信息并退出

--limit [LIMIT]

在单个结果中返回的最大操作数。默认情况下,限制设为 100。使用 --limit -1 获取完整结果集。

3.10. 操作执行输出显示

显示 Action 执行输出数据。

使用方法:

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

Expand
表 3.38. 位置参数
概述

id

操作执行 ID.

Expand
表 3.39. 可选参数
概述

-h, --help

显示帮助信息并退出

3.11. 操作执行运行

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

使用方法:

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

Expand
表 3.40. 表格式
概述

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表 3.41. 位置参数
概述

输入

操作输入.

name

要执行的操作名称。

Expand
表 3.42. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 3.43. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 3.44. 可选参数
概述

-s, --save-result

将结果保存到 db 中。

-t TARGET, --target TARGET

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

-h, --help

显示帮助信息并退出

--run-sync

同步运行操作。

Expand
表 3.45. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

3.12. 操作执行显示

显示具体操作执行。

使用方法:

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

Expand
表 3.46. 表格式
概述

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表 3.47. 位置参数
概述

action_execution

操作执行 ID.

Expand
表 3.48. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 3.49. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 3.50. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 3.51. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

3.13. 操作执行更新

更新特定的操作执行。

使用方法:

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

Expand
表 3.52. 表格式
概述

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表 3.53. 位置参数
概述

id

操作执行 ID.

Expand
表 3.54. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 3.55. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 3.56. 可选参数
概述

-h, --help

显示帮助信息并退出

--output OUTPUT

操作执行输出

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

操作执行状态

Expand
表 3.57. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

第 4 章 address

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

4.1. 地址范围创建

创建新地址范围

使用方法:

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

Expand
表 4.1. 表格式
概述

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表 4.2. 位置参数
概述

<name>

新地址范围名称

Expand
表 4.3. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 4.4. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 4.5. 可选参数
概述

--share

在项目间共享地址范围

--ip-version {4,6}

IP 版本(默认为 4)

--project-domain <project-domain>

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

--no-share

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

-h, --help

显示帮助信息并退出

--project <project>

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

Expand
表 4.6. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

4.2. 地址范围删除

删除地址范围

使用方法:

openstack address scope delete [-h]
                                      <address-scope> [<address-scope> ...]
Copy to Clipboard Toggle word wrap

Expand
表 4.7. 位置参数
概述

<address-scope>

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

Expand
表 4.8. 可选参数
概述

-h, --help

显示帮助信息并退出

4.3. 地址范围列表

列出地址范围

使用方法:

openstack address scope list [-h] [-f {csv,json,table,value,yaml}]
                                    [-c COLUMN] [--max-width <integer>]
                                    [--fit-width] [--print-empty] [--noindent]
                                    [--quote {all,minimal,none,nonnumeric}]
                                    [--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
表 4.9. 表格式
概述

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表 4.10. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 4.11. 输出格式器
概述

输出 formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 4.12. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 4.13. 可选参数
概述

--share

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

--ip-version <ip-version>

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

--name <name>

列出输出中给定名称的地址范围

--project <project>

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

--no-share

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

-h, --help

显示帮助信息并退出

--project-domain <project-domain>

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

4.4. 地址范围集

设置地址范围属性

使用方法:

openstack address scope set [-h] [--name <name>] [--share | --no-share]
                                   <address-scope>
Copy to Clipboard Toggle word wrap

Expand
表 4.14. 位置参数
概述

<address-scope>

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

Expand
表 4.15. 可选参数
概述

--share

在项目间共享地址范围

--name <name>

设置地址范围名称

-h, --help

显示帮助信息并退出

--no-share

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

4.5. 地址范围显示

显示地址范围详情

使用方法:

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

Expand
表 4.16. 表格式
概述

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表 4.17. 位置参数
概述

<address-scope>

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

Expand
表 4.18. 输出格式器
概述

output formatter options-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. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 4.21. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

第 5 章 aggregate

本章论述了 aggregate 命令中的命令。

5.1. 聚合添加主机

将主机添加到聚合

使用方法:

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

Expand
表 5.1. 表格式
概述

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表 5.2. 位置参数
概述

<aggregate>

聚合(名称或 ID)

<host>

要添加到 <aggregate> 的主机

Expand
表 5.3. 输出格式器
概述

output formatter options-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. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 5.6. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

5.2. 聚合创建

创建新聚合

使用方法:

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

Expand
表 5.7. 表格式
概述

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表 5.8. 位置参数
概述

<name>

新聚合名称

Expand
表 5.9. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 5.10. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 5.11. 可选参数
概述

-h, --help

显示帮助信息并退出

--zone <availability-zone>

可用区名称

--property <key=value>

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

Expand
表 5.12. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

5.3. 聚合删除

删除现有聚合

使用方法:

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

Expand
表 5.13. 位置参数
概述

<aggregate>

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

Expand
表 5.14. 可选参数
概述

-h, --help

显示帮助信息并退出

5.4. 聚合列表

列出所有聚合

使用方法:

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

Expand
表 5.15. 表格式
概述

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表 5.16. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 5.17. 输出格式器
概述

输出 formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 5.18. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 5.19. 可选参数
概述

-h, --help

显示帮助信息并退出

--long

列出输出中的其他字段

5.5. 聚合删除主机

从聚合中删除主机

使用方法:

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

Expand
表 5.20. 表格式
概述

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表 5.21. 位置参数
概述

<aggregate>

聚合(名称或 ID)

<host>

从 <aggregate> 中删除的主机

Expand
表 5.22. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 5.23. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 5.24. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 5.25. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

5.6. 聚合集

设置聚合属性

使用方法:

openstack aggregate set [-h] [--name <name>]
                               [--zone <availability-zone>]
                               [--property <key=value>] [--no-property]
                               <aggregate>
Copy to Clipboard Toggle word wrap

Expand
表 5.26. 位置参数
概述

<aggregate>

聚合以修改(名称或 ID)

Expand
表 5.27. 可选参数
概述

--name <name>

设置聚合名称

-h, --help

显示帮助信息并退出

--zone <availability-zone>

设置可用区域名称

--no-property

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

--property <key=value>

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

5.7. 聚合显示

显示聚合详情

使用方法:

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

Expand
表 5.28. 表格式
概述

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表 5.29. 位置参数
概述

<aggregate>

聚合显示(名称或 id)

Expand
表 5.30. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 5.31. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 5.32. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 5.33. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

5.8. aggregate unset

取消设置聚合属性

使用方法:

openstack aggregate unset [-h] [--property <key>] <aggregate>
Copy to Clipboard Toggle word wrap

Expand
表 5.34. 位置参数
概述

<aggregate>

聚合以修改(名称或 ID)

Expand
表 5.35. 可选参数
概述

--property <key>

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

-h, --help

显示帮助信息并退出

第 6 章 警报

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

6.1. 创建警报

创建警报

使用方法:

openstack alarm create [-h] [-f {json,shell,table,value,yaml}]
                              [-c COLUMN] [--max-width <integer>]
                              [--fit-width] [--print-empty] [--noindent]
                              [--prefix PREFIX] --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>] [--metric <METRIC>]
                              [--event-type <EVENT_TYPE>]
                              [--granularity <GRANULARITY>]
                              [--aggregation-method <AGGR_METHOD>]
                              [--resource-type <RESOURCE_TYPE>]
                              [--resource-id <RESOURCE_ID>]
                              [--metrics <METRICS>]
                              [--composite-rule <COMPOSITE_RULE>]
Copy to Clipboard Toggle word wrap

Expand
表 6.1. 表格式
概述

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表 6.2. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

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

--aggregation-method <AGGR_METHOD>

与阈值相比的 aggregation_method。

--granularity <GRANULARITY>

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

Expand
表 6.4. 事件警报
概述

--event-type <EVENT_TYPE>

要评估的事件类型

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

--resource-id <RESOURCE_ID>

资源的 ID。

--resource-type <RESOURCE_TYPE>

资源的类型。

Expand
表 6.6. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 6.7. 复合警报
概述

--composite-rule <COMPOSITE_RULE>

带有 json 格式的复合阈值规则,表单可以是嵌套的 diction,它按 "and", "or" 合并 gnocchi 规则。例如,格式为: {"or":[RULE1, RULE2, {"and": [RULE3, RULE4]}]}。

Expand
表 6.8. 可选参数
概述

--OK-action <Webhook URL>

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

--user-id <USER_ID>

与警报关联的用户(仅限管理员用户配置)

--name <NAME>

警报的名称

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

警报类型应当是: event、composite、gnocchi_resources_threshold、gnocchi_aggregation_by_metrics_threshold、gnocchi_aggregation_by_resources_threshold。

--repeat-actions {True

false}

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

--state <STATE>

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

--time-constraint <Time Constraint>

仅在此时间约束内评估评估时,才评估警报。约束的开始点通过 cron 表达式指定,而其持续时间(以秒为单位)。可以为多个时间限制指定多个次数,格式为: name=<CONSTRAINT_NAME>;start=< CRON>;duration=<SECONDS>;[description=<DESCRIPTION>;[t imezone=<IANA Timezone>]

--project-id <PROJECT_ID>

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

--insufficient-data-action <Webhook URL>

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

--severity <SEVERITY>

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

--alarm-action <Webhook URL>

要在状态转换为警报时调用的 URL。可以多次使用。

-h, --help

显示帮助信息并退出

--description <DESCRIPTION>

警报的免费文本描述

--enabled {True

false}

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

Expand
表 6.9. 常见警报规则
概述

--evaluation-periods <EVAL_PERIODS>

要评估的时间段数

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

--metric <METRIC>

要评估的指标。

--threshold <THRESHOLD>

要评估的阈值。

Expand
表 6.10. 基于指标警报的 Gnocchi 聚合
概述

--metrics <METRICS>

指标 ID 列表。

Expand
表 6.11. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

6.2. 删除警报

删除警报

使用方法:

openstack alarm delete [-h] [--name <NAME>] [<ALARM ID or NAME>]
Copy to Clipboard Toggle word wrap

Expand
表 6.12. 位置参数
概述

<ALARM ID 或 NAME>

警报的 ID 或名称。

Expand
表 6.13. 可选参数
概述

--name <NAME>

警报的名称

-h, --help

显示帮助信息并退出

6.4. alarm-history 显示

显示警报历史记录

使用方法:

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

Expand
表 6.19. 表格式
概述

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表 6.20. 位置参数
概述

alarm_id

警报 ID

Expand
表 6.21. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 6.22. 输出格式器
概述

输出 formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 6.23. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 6.24. 可选参数
概述

--sort <SORT_KEY:SORT_DIR>

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

--limit <LIMIT>

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

-h, --help

显示帮助信息并退出

--marker <MARKER>

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

6.5. 警报列表

列出警报

使用方法:

openstack alarm list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                            [--max-width <integer>] [--fit-width]
                            [--print-empty] [--noindent]
                            [--quote {all,minimal,none,nonnumeric}]
                            [--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
表 6.25. 表格式
概述

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表 6.26. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 6.27. 输出格式器
概述

输出 formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 6.28. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 6.29. 可选参数
概述

--sort <SORT_KEY:SORT_DIR>

资源属性排序,如 name:asc

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

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

--query QUERY

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

--marker <MARKER>

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

--limit <LIMIT>

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

-h, --help

显示帮助信息并退出

6.6. 警报显示

显示警报

使用方法:

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

Expand
表 6.30. 表格式
概述

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表 6.31. 位置参数
概述

<ALARM ID 或 NAME>

警报的 ID 或名称。

Expand
表 6.32. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 6.33. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 6.34. 可选参数
概述

--name <NAME>

警报的名称

-h, --help

显示帮助信息并退出

Expand
表 6.35. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

6.7. 警报状态获取

获取警报状态

使用方法:

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

Expand
表 6.36. 表格式
概述

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表 6.37. 位置参数
概述

<ALARM ID 或 NAME>

警报的 ID 或名称。

Expand
表 6.38. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 6.39. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 6.40. 可选参数
概述

--name <NAME>

警报的名称

-h, --help

显示帮助信息并退出

Expand
表 6.41. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

6.8. 设置警报状态

设置警报状态

使用方法:

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

Expand
表 6.42. 表格式
概述

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表 6.43. 位置参数
概述

<ALARM ID 或 NAME>

警报的 ID 或名称。

Expand
表 6.44. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 6.45. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 6.46. 可选参数
概述

--name <NAME>

警报的名称

-h, --help

显示帮助信息并退出

--state <STATE>

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

Expand
表 6.47. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

6.9. 警报更新

更新警报

使用方法:

openstack alarm update [-h] [-f {json,shell,table,value,yaml}]
                              [-c COLUMN] [--max-width <integer>]
                              [--fit-width] [--print-empty] [--noindent]
                              [--prefix PREFIX] [--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>] [--metric <METRIC>]
                              [--event-type <EVENT_TYPE>]
                              [--granularity <GRANULARITY>]
                              [--aggregation-method <AGGR_METHOD>]
                              [--resource-type <RESOURCE_TYPE>]
                              [--resource-id <RESOURCE_ID>]
                              [--metrics <METRICS>]
                              [--composite-rule <COMPOSITE_RULE>]
                              [<ALARM ID or NAME>]
Copy to Clipboard Toggle word wrap

Expand
表 6.48. 表格式
概述

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表 6.49. 位置参数
概述

<ALARM ID 或 NAME>

警报的 ID 或名称。

Expand
表 6.50. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

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

--aggregation-method <AGGR_METHOD>

与阈值相比的 aggregation_method。

--granularity <GRANULARITY>

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

Expand
表 6.52. 事件警报
概述

--event-type <EVENT_TYPE>

要评估的事件类型

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

--resource-id <RESOURCE_ID>

资源的 ID。

--resource-type <RESOURCE_TYPE>

资源的类型。

Expand
表 6.54. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 6.55. 复合警报
概述

--composite-rule <COMPOSITE_RULE>

带有 json 格式的复合阈值规则,表单可以是嵌套的 diction,它按 "and", "or" 合并 gnocchi 规则。例如,格式为: {"or":[RULE1, RULE2, {"and": [RULE3, RULE4]}]}。

Expand
表 6.56. 可选参数
概述

--OK-action <Webhook URL>

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

--user-id <USER_ID>

与警报关联的用户(仅限管理员用户配置)

--name <NAME>

警报的名称

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

警报类型应当是: event、composite、gnocchi_resources_threshold、gnocchi_aggregation_by_metrics_threshold、gnocchi_aggregation_by_resources_threshold。

--repeat-actions {True

false}

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

--state <STATE>

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

--time-constraint <Time Constraint>

仅在此时间约束内评估评估时,才评估警报。约束的开始点通过 cron 表达式指定,而其持续时间(以秒为单位)。可以为多个时间限制指定多个次数,格式为: name=<CONSTRAINT_NAME>;start=< CRON>;duration=<SECONDS>;[description=<DESCRIPTION>;[t imezone=<IANA Timezone>]

--project-id <PROJECT_ID>

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

--insufficient-data-action <Webhook URL>

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

--severity <SEVERITY>

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

--alarm-action <Webhook URL>

要在状态转换为警报时调用的 URL。可以多次使用。

-h, --help

显示帮助信息并退出

--description <DESCRIPTION>

警报的免费文本描述

--enabled {True

false}

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

Expand
表 6.57. 常见警报规则
概述

--evaluation-periods <EVAL_PERIODS>

要评估的时间段数

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

--metric <METRIC>

要评估的指标。

--threshold <THRESHOLD>

要评估的阈值。

Expand
表 6.58. 基于指标警报的 Gnocchi 聚合
概述

--metrics <METRICS>

指标 ID 列表。

Expand
表 6.59. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

第 7 章 警报

本章论述了警报命令下 的命令

7.1. 警报功能列表

列出警报服务的功能

使用方法:

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

Expand
表 7.1. 表格式
概述

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表 7.2. 输出格式器
概述

output formatter options-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. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 7.5. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

第 8 章 可用性

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

8.1. 可用区列表

列出可用区及其状态

使用方法:

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

Expand
表 8.1. 表格式
概述

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表 8.2. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 8.3. 输出格式器
概述

输出 formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 8.4. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 8.5. 可选参数
概述

--compute

列出计算可用区

--volume

列出卷可用区

-h, --help

显示帮助信息并退出

--network

列出网络可用区

--long

列出输出中的其他字段

第 9 章 baremetal

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

9.1. baremetal chassis create

创建新的 chassis。

使用方法:

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

Expand
表 9.1. 表格式
概述

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表 9.2. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 9.3. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 9.4. 可选参数
概述

--uuid <uuid>

chassis 的唯一 uuid

-h, --help

显示帮助信息并退出

--description <description>

chassis 描述

--extra <key=value>

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

Expand
表 9.5. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

9.2. baremetal chassis delete

删除 chassis。

使用方法:

openstack baremetal chassis delete [-h] <chassis> [<chassis> ...]
Copy to Clipboard Toggle word wrap

Expand
表 9.6. 位置参数
概述

<chassis>

要删除的机箱的 UUID

Expand
表 9.7. 可选参数
概述

-h, --help

显示帮助信息并退出

9.3. baremetal chassis 列表

列出 chassis。

使用方法:

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

Expand
表 9.8. 表格式
概述

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表 9.9. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 9.10. 输出格式器
概述

输出 formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 9.11. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 9.12. 可选参数
概述

--marker <chassis>

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

--long

显示有关 chassis 的详细信息

--limit <limit>

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

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

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

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

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

-h, --help

显示帮助信息并退出

9.4. baremetal chassis 集

设置 chassis 属性。

使用方法:

openstack baremetal chassis set [-h] [--description <description>]
                                       [--extra <key=value>]
                                       <chassis>
Copy to Clipboard Toggle word wrap

Expand
表 9.13. 位置参数
概述

<chassis>

chassis 的 UUID

Expand
表 9.14. 可选参数
概述

-h, --help

显示帮助信息并退出

--description <description>

设置 chassis 的描述

--extra <key=value>

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

9.5. baremetal chassis 显示

显示机箱详细信息。

使用方法:

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

Expand
表 9.15. 表格式
概述

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表 9.16. 位置参数
概述

<chassis>

chassis 的 UUID

Expand
表 9.17. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 9.18. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 9.19. 可选参数
概述

-h, --help

显示帮助信息并退出

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

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

Expand
表 9.20. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

9.6. baremetal chassis unset

取消设置机箱属性。

使用方法:

openstack baremetal chassis unset [-h] [--description] [--extra <key>]
                                         <chassis>
Copy to Clipboard Toggle word wrap

Expand
表 9.21. 位置参数
概述

<chassis>

chassis 的 UUID

Expand
表 9.22. 可选参数
概述

-h, --help

显示帮助信息并退出

--extra <key>

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

--description

清除 chassis 描述

9.7. baremetal create

从文件创建资源

使用方法:

openstack baremetal create [-h] <file> [<file> ...]
Copy to Clipboard Toggle word wrap

Expand
表 9.23. 位置参数
概述

<file>

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

Expand
表 9.24. 可选参数
概述

-h, --help

显示帮助信息并退出

9.8. baremetal 驱动程序列表

列出已启用的驱动程序。

使用方法:

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

Expand
表 9.25. 表格式
概述

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表 9.26. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 9.27. 输出格式器
概述

输出 formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 9.28. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 9.29. 可选参数
概述

--type <type>

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

-h, --help

显示帮助信息并退出

--long

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

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

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

使用方法:

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

Expand
表 9.30. 表格式
概述

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表 9.31. 位置参数
概述

<method>

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

<driver>

驱动程序的名称。

Expand
表 9.32. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 9.33. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 9.34. 可选参数
概述

-h, --help

显示帮助信息并退出

--http-method <http-method>

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

--arg <key=value>

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

Expand
表 9.35. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

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

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

使用方法:

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

Expand
表 9.36. 表格式
概述

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表 9.37. 位置参数
概述

<driver>

驱动程序的名称。

Expand
表 9.38. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 9.39. 输出格式器
概述

输出 formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 9.40. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 9.41. 可选参数
概述

-h, --help

显示帮助信息并退出

9.11. baremetal 驱动程序属性列表

列出驱动程序属性。

使用方法:

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

Expand
表 9.42. 表格式
概述

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表 9.43. 位置参数
概述

<driver>

驱动程序的名称。

Expand
表 9.44. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 9.45. 输出格式器
概述

输出 formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 9.46. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 9.47. 可选参数
概述

-h, --help

显示帮助信息并退出

9.12. baremetal driver raid 属性列表

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

使用方法:

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

Expand
表 9.48. 表格式
概述

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表 9.49. 位置参数
概述

<driver>

驱动程序的名称。

Expand
表 9.50. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 9.51. 输出格式器
概述

输出 formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 9.52. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 9.53. 可选参数
概述

-h, --help

显示帮助信息并退出

9.13. baremetal 驱动程序显示

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

使用方法:

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

Expand
表 9.54. 表格式
概述

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表 9.55. 位置参数
概述

<driver>

驱动程序的名称。

Expand
表 9.56. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 9.57. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 9.58. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 9.59. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

9.14. 裸机内省中止

中止运行节点的内省。

使用方法:

openstack baremetal introspection abort [-h] node
Copy to Clipboard Toggle word wrap

Expand
表 9.60. 位置参数
概述

node

裸机恢复节点 uuid 或名称

Expand
表 9.61. 可选参数
概述

-h, --help

显示帮助信息并退出

9.15. 裸机内省数据保存

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

使用方法:

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

Expand
表 9.62. 位置参数
概述

node

裸机恢复节点 uuid 或名称

Expand
表 9.63. 可选参数
概述

-h, --help

显示帮助信息并退出

--file <filename>

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

9.16. 裸机内省接口列表

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

使用方法:

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

Expand
表 9.64. 表格式
概述

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表 9.65. 位置参数
概述

node_ident

裸机恢复节点 uuid 或名称

Expand
表 9.66. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 9.67. 输出格式器
概述

输出 formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 9.68. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 9.69. 可选参数
概述

-h, --help

显示帮助信息并退出

--vlan VLAN

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

--long

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

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

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

9.17. 裸机内省接口显示

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

使用方法:

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

Expand
表 9.70. 表格式
概述

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表 9.71. 位置参数
概述

interface

接口名称

node_ident

裸机恢复节点 uuid 或名称

Expand
表 9.72. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 9.73. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 9.74. 可选参数
概述

-h, --help

显示帮助信息并退出

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

显示一个或多个字段。

Expand
表 9.75. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

9.18. 裸机内省列表

列出内省状态

使用方法:

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

Expand
表 9.76. 表格式
概述

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表 9.77. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 9.78. 输出格式器
概述

输出 formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 9.79. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 9.80. 可选参数
概述

-h, --help

显示帮助信息并退出

--limit LIMIT

要返回的项目数量

--marker MARKER

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

9.19. 裸机内省重新处理

重新处理存储内省数据

使用方法:

openstack baremetal introspection reprocess [-h] node
Copy to Clipboard Toggle word wrap

Expand
表 9.81. 位置参数
概述

node

裸机恢复节点 uuid 或名称

Expand
表 9.82. 可选参数
概述

-h, --help

显示帮助信息并退出

9.20. 裸机内省规则删除

删除内省规则。

使用方法:

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

Expand
表 9.83. 位置参数
概述

uuid

规则 uuid

Expand
表 9.84. 可选参数
概述

-h, --help

显示帮助信息并退出

9.21. 裸机内省规则导入

从 json 文件导入一个或多个内省规则。

使用方法:

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

Expand
表 9.85. 表格式
概述

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表 9.86. 位置参数
概述

file

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

Expand
表 9.87. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 9.88. 输出格式器
概述

输出 formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 9.89. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 9.90. 可选参数
概述

-h, --help

显示帮助信息并退出

9.22. 裸机内省规则列表

列出所有内省规则。

使用方法:

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

Expand
表 9.91. 表格式
概述

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表 9.92. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 9.93. 输出格式器
概述

输出 formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 9.94. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 9.95. 可选参数
概述

-h, --help

显示帮助信息并退出

9.23. 裸机内省规则清除

丢弃所有内省规则。

使用方法:

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

Expand
表 9.96. 可选参数
概述

-h, --help

显示帮助信息并退出

9.24. 裸机内省规则显示

显示内省规则。

使用方法:

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

Expand
表 9.97. 表格式
概述

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表 9.98. 位置参数
概述

uuid

规则 uuid

Expand
表 9.99. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 9.100. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 9.101. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 9.102. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

9.25. 裸机内省启动

启动内省。

使用方法:

openstack baremetal introspection start [-h]
                                               [-f {csv,json,table,value,yaml}]
                                               [-c COLUMN]
                                               [--max-width <integer>]
                                               [--fit-width] [--print-empty]
                                               [--noindent]
                                               [--quote {all,minimal,none,nonnumeric}]
                                               [--sort-column SORT_COLUMN]
                                               [--wait]
                                               node [node ...]
Copy to Clipboard Toggle word wrap

Expand
表 9.103. 表格式
概述

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表 9.104. 位置参数
概述

node

裸机恢复节点 uuid 或名称

Expand
表 9.105. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 9.106. 输出格式器
概述

输出 formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 9.107. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 9.108. 可选参数
概述

-h, --help

显示帮助信息并退出

--wait

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

9.26. 裸机内省状态

获取内省状态。

使用方法:

openstack baremetal introspection status [-h]
                                                [-f {json,shell,table,value,yaml}]
                                                [-c COLUMN]
                                                [--max-width <integer>]
                                                [--fit-width] [--print-empty]
                                                [--noindent] [--prefix PREFIX]
                                                node
Copy to Clipboard Toggle word wrap

Expand
表 9.109. 表格式
概述

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表 9.110. 位置参数
概述

node

裸机恢复节点 uuid 或名称

Expand
表 9.111. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 9.112. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 9.113. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 9.114. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

9.27. 裸机节点中止

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

使用方法:

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

Expand
表 9.115. 位置参数
概述

<node>

节点的名称或 uuid。

Expand
表 9.116. 可选参数
概述

-h, --help

显示帮助信息并退出

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

将特征添加到节点。

使用方法:

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

Expand
表 9.117. 位置参数
概述

<node>

节点的名称或 uuid

<trait>

要添加的特征

Expand
表 9.118. 可选参数
概述

-h, --help

显示帮助信息并退出

9.29. 裸机恢复节点采用

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

使用方法:

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

Expand
表 9.119. 位置参数
概述

<node>

节点的名称或 uuid。

Expand
表 9.120. 可选参数
概述

-h, --help

显示帮助信息并退出

--wait [<time-out>]

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

9.30. 裸机节点引导设备集

为节点设置引导设备

使用方法:

openstack baremetal node boot device set [-h] [--persistent]
                                                <node> <device>
Copy to Clipboard Toggle word wrap

Expand
表 9.121. 位置参数
概述

<node>

节点的名称或 uuid

<device>

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

Expand
表 9.122. 可选参数
概述

-h, --help

显示帮助信息并退出

--persistent

对将来的所有启动都保留更改

9.31. 裸机节点引导设备显示

显示节点的引导设备信息

使用方法:

openstack baremetal node boot device show [-h]
                                                 [-f {json,shell,table,value,yaml}]
                                                 [-c COLUMN]
                                                 [--max-width <integer>]
                                                 [--fit-width] [--print-empty]
                                                 [--noindent]
                                                 [--prefix PREFIX]
                                                 [--supported]
                                                 <node>
Copy to Clipboard Toggle word wrap

Expand
表 9.123. 表格式
概述

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表 9.124. 位置参数
概述

<node>

节点的名称或 uuid

Expand
表 9.125. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 9.126. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 9.127. 可选参数
概述

-h, --help

显示帮助信息并退出

--supported

显示支持的引导设备

Expand
表 9.128. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

9.32. 裸机节点清理

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

使用方法:

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

Expand
表 9.129. 位置参数
概述

<node>

节点的名称或 uuid。

Expand
表 9.130. 可选参数
概述

-h, --help

显示帮助信息并退出

--wait [<time-out>]

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

--clean-steps <clean-steps>

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

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

禁用节点的控制台访问

使用方法:

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

Expand
表 9.131. 位置参数
概述

<node>

节点的名称或 uuid

Expand
表 9.132. 可选参数
概述

-h, --help

显示帮助信息并退出

9.34. 裸机节点控制台启用

为节点启用控制台访问

使用方法:

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

Expand
表 9.133. 位置参数
概述

<node>

节点的名称或 uuid

Expand
表 9.134. 可选参数
概述

-h, --help

显示帮助信息并退出

9.35. 裸机恢复节点控制台显示

显示节点的控制台信息

使用方法:

openstack baremetal node console show [-h]
                                             [-f {json,shell,table,value,yaml}]
                                             [-c COLUMN]
                                             [--max-width <integer>]
                                             [--fit-width] [--print-empty]
                                             [--noindent] [--prefix PREFIX]
                                             <node>
Copy to Clipboard Toggle word wrap

Expand
表 9.135. 表格式
概述

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表 9.136. 位置参数
概述

<node>

节点的名称或 uuid

Expand
表 9.137. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 9.138. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 9.139. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 9.140. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

9.36. 裸机节点创建

使用 baremetal 服务注册新节点

使用方法:

openstack baremetal node create [-h] [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--max-width <integer>]
                                       [--fit-width] [--print-empty]
                                       [--noindent] [--prefix PREFIX]
                                       [--chassis-uuid <chassis>] --driver
                                       <driver> [--driver-info <key=value>]
                                       [--property <key=value>]
                                       [--extra <key=value>] [--uuid <uuid>]
                                       [--name <name>]
                                       [--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>]
                                       [--storage-interface <storage_interface>]
                                       [--vendor-interface <vendor_interface>]
                                       [--resource-class <resource_class>]
Copy to Clipboard Toggle word wrap

Expand
表 9.141. 表格式
概述

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表 9.142. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 9.143. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 9.144. 可选参数
概述

--inspect-interface <inspect_interface>

检查节点驱动程序使用的接口。这仅适用于指定 --driver 是一个硬件类型。

--boot-interface <boot_interface>

由节点驱动程序使用的引导接口。这仅适用于指定的 --driver 是一个硬件类型。

--management-interface <management_interface>

节点驱动程序使用的管理接口。这仅适用于指定的 --driver 是一个硬件类型。

--driver <driver>

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

--deploy-interface <deploy_interface>

部署由节点驱动程序使用的界面。这仅适用于指定的 --driver 是一个硬件类型。

--uuid <uuid>

节点的唯一 uuid。

--console-interface <console_interface>

由节点驱动程序使用的控制台接口。这仅适用于指定的 --driver 是一个硬件类型。

--chassis-uuid <chassis>

此节点所属的机箱的 UUID。

--network-interface <network_interface>

用于切换节点来清理/置备网络的网络接口。

--property <key=value>

描述节点物理特性的键/值对。这是导出到 Nova,由调度程序使用。可多次指定。

--vendor-interface <vendor_interface>

节点驱动程序使用的厂商界面。这仅适用于指定 --driver 是一个硬件类型。

--resource-class <resource_class>

将节点映射到 nova 类别的资源类

--raid-interface <raid_interface>

节点驱动程序使用的 RAID 接口。这只适用于指定 --driver 是一个硬件类型。

--storage-interface <storage_interface>

节点驱动程序使用的存储接口。

--power-interface <power_interface>

节点驱动程序使用的电源接口。这仅适用于指定的 --driver 是一个硬件类型。

--name <name>

节点的唯一名称。

--driver-info <key=value>

驱动程序使用的键/值对,如带外管理凭证。可多次指定。

--extra <key=value>

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

-h, --help

显示帮助信息并退出

Expand
表 9.145. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

9.37. 裸机节点删除

取消注册的裸机恢复节点

使用方法:

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

Expand
表 9.146. 位置参数
概述

<node>

要删除的节点(name 或 uuid)

Expand
表 9.147. 可选参数
概述

-h, --help

显示帮助信息并退出

9.38. 裸机节点部署

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

使用方法:

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

Expand
表 9.148. 位置参数
概述

<node>

节点的名称或 uuid。

Expand
表 9.149. 可选参数
概述

-h, --help

显示帮助信息并退出

--wait [<time-out>]

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

--config-drive <config-drive>

gzip 压缩的 base64 编码的配置驱动器字符串,或者配置驱动器文件的路径,或者包含配置驱动器文件的路径。如果是目录,则会从它生成一个配置驱动器。

9.39. 裸机恢复节点注入 nmi

将 NMI 注入到裸机恢复节点

使用方法:

openstack baremetal node inject nmi [-h] <node>
Copy to Clipboard Toggle word wrap

Expand
表 9.150. 位置参数
概述

<node>

节点的名称或 uuid。

Expand
表 9.151. 可选参数
概述

-h, --help

显示帮助信息并退出

9.40. 裸机节点检查

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

使用方法:

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

Expand
表 9.152. 位置参数
概述

<node>

节点的名称或 uuid。

Expand
表 9.153. 可选参数
概述

-h, --help

显示帮助信息并退出

--wait [<time-out>]

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

9.41. 裸机节点列表

列出裸机节点

使用方法:

openstack baremetal node list [-h] [-f {csv,json,table,value,yaml}]
                                     [-c COLUMN] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--noindent]
                                     [--quote {all,minimal,none,nonnumeric}]
                                     [--sort-column SORT_COLUMN]
                                     [--limit <limit>] [--marker <node>]
                                     [--sort <key>[:<direction>]]
                                     [--maintenance | --no-maintenance]
                                     [--associated | --unassociated]
                                     [--provision-state <provision state>]
                                     [--driver <driver>]
                                     [--resource-class <resource class>]
                                     [--chassis <chassis UUID>]
                                     [--long | --fields <field> [<field> ...]]
Copy to Clipboard Toggle word wrap

Expand
表 9.154. 表格式
概述

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表 9.155. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 9.156. 输出格式器
概述

输出 formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 9.157. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 9.158. 可选参数
概述

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

按指定节点字段和指示排序输出(asc 或 desc) (默认值: asc 表示)。可以用逗号分隔来指定多个字段和方向。

--chassis <chassis UUID>

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

--resource-class <resource class>

将列表限制为带有资源类 <resource class> 的节点

--marker <node>

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

--long

显示有关节点的详细信息。

--provision-state <provision state>

列出指定置备状态的节点。

--limit <limit>

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

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

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

--maintenance

以维护模式将列表限制为节点

--unassociated

仅列出不与实例关联的节点。

-h, --help

显示帮助信息并退出

--associated

仅列出与实例关联的节点。

--no-maintenance

将列表限制为不处于维护模式的节点

--driver <driver>

将列表限制为带有驱动程序 <driver> 的节点

9.42. 裸机节点维护集

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

使用方法:

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

Expand
表 9.159. 位置参数
概述

<node>

节点的名称或 uuid。

Expand
表 9.160. 可选参数
概述

-h, --help

显示帮助信息并退出

--reason <reason>

设置维护模式的原因。

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

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

使用方法:

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

Expand
表 9.161. 位置参数
概述

<node>

节点的名称或 uuid。

Expand
表 9.162. 可选参数
概述

-h, --help

显示帮助信息并退出

9.44. 裸机节点管理

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

使用方法:

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

Expand
表 9.163. 位置参数
概述

<node>

节点的名称或 uuid。

Expand
表 9.164. 可选参数
概述

-h, --help

显示帮助信息并退出

--wait [<time-out>]

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

9.45. 裸机节点通过thru 调用

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

使用方法:

openstack baremetal node passthru call [-h] [--arg <key=value>]
                                              [--http-method <http-method>]
                                              <node> <method>
Copy to Clipboard Toggle word wrap

Expand
表 9.165. 位置参数
概述

<node>

节点的名称或 uuid

<method>

执行供应商传递方法

Expand
表 9.166. 可选参数
概述

-h, --help

显示帮助信息并退出

--http-method <http-method>

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

--arg <key=value>

传递给 passthru 方法的参数(用于指定多个参数)

9.46. 裸机恢复节点传递列表

列出节点的厂商 passthru 方法

使用方法:

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

Expand
表 9.167. 表格式
概述

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表 9.168. 位置参数
概述

<node>

节点的名称或 uuid

Expand
表 9.169. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 9.170. 输出格式器
概述

输出 formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 9.171. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 9.172. 可选参数
概述

-h, --help

显示帮助信息并退出

9.47. 裸机节点关闭

关闭节点

使用方法:

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

Expand
表 9.173. 位置参数
概述

<node>

节点的名称或 uuid。

Expand
表 9.174. 可选参数
概述

--soft

请求正常关机.

-h, --help

显示帮助信息并退出

--power-timeout <power-timeout>

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

9.48. 裸机节点电源

打开节点

使用方法:

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

Expand
表 9.175. 位置参数
概述

<node>

节点的名称或 uuid。

Expand
表 9.176. 可选参数
概述

-h, --help

显示帮助信息并退出

--power-timeout <power-timeout>

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

9.49. 裸机恢复节点提供

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

使用方法:

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

Expand
表 9.177. 位置参数
概述

<node>

节点的名称或 uuid。

Expand
表 9.178. 可选参数
概述

-h, --help

显示帮助信息并退出

--wait [<time-out>]

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

9.50. 裸机节点重新引导

重新引导裸机节点

使用方法:

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

Expand
表 9.179. 位置参数
概述

<node>

节点的名称或 uuid。

Expand
表 9.180. 可选参数
概述

--soft

请求正常重启。

-h, --help

显示帮助信息并退出

--power-timeout <power-timeout>

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

9.51. 裸机节点重建

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

使用方法:

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

Expand
表 9.181. 位置参数
概述

<node>

节点的名称或 uuid。

Expand
表 9.182. 可选参数
概述

-h, --help

显示帮助信息并退出

--wait [<time-out>]

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

--config-drive <config-drive>

gzip 压缩的 base64 编码的配置驱动器字符串,或者配置驱动器文件的路径,或者包含配置驱动器文件的路径。如果是目录,则会从它生成一个配置驱动器。

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

从节点中删除特征。

使用方法:

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

Expand
表 9.183. 位置参数
概述

<node>

节点的名称或 uuid

<trait>

要删除的特征

Expand
表 9.184. 可选参数
概述

-h, --help

显示帮助信息并退出

--all

删除所有特征

9.53. 裸机恢复节点集

设置裸机属性

使用方法:

openstack baremetal node set [-h] [--instance-uuid <uuid>]
                                    [--name <name>]
                                    [--chassis-uuid <chassis UUID>]
                                    [--driver <driver>]
                                    [--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>]
                                    [--storage-interface <storage_interface>]
                                    [--vendor-interface <vendor_interface>]
                                    [--resource-class <resource_class>]
                                    [--target-raid-config <target_raid_config>]
                                    [--property <key=value>]
                                    [--extra <key=value>]
                                    [--driver-info <key=value>]
                                    [--instance-info <key=value>]
                                    <node>
Copy to Clipboard Toggle word wrap

Expand
表 9.185. 位置参数
概述

<node>

节点的名称或 uuid。

Expand
表 9.186. 可选参数
概述

--instance-uuid <uuid>

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

--inspect-interface <inspect_interface>

为节点设置检查接口

--boot-interface <boot_interface>

为节点设置引导接口

--management-interface <management_interface>

为节点设置管理界面

--driver <driver>

为节点设置驱动程序

--extra <key=value>

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

--deploy-interface <deploy_interface>

为节点设置部署接口

--name <name>

设置节点的名称

--console-interface <console_interface>

为节点设置控制台接口

--power-interface <power_interface>

为节点设置电源接口

--network-interface <network_interface>

为节点设置网络接口

--property <key=value>

在这个裸机节点上设置的属性(重复选项来设置多个属性)

--vendor-interface <vendor_interface>

为节点设置厂商接口

--resource-class <resource_class>

为节点设置资源类

--chassis-uuid <chassis UUID>

为节点设置 chassis

--raid-interface <raid_interface>

为节点设置 raid 接口

--storage-interface <storage_interface>

为节点设置存储接口

--instance-info <key=value>

在此裸机节点上设置的实例信息(重复选项来设置多个实例信息)

--driver-info <key=value>

在此裸机节点上设置的驱动程序信息(重复选项来设置多个驱动程序信息)

-h, --help

显示帮助信息并退出

--target-raid-config <target_raid_config>

为节点设置目标 raid 配置(json)。这可以是以下之一:1。一个包含 RAID 配置的 JSON 数据的文件;2. 用于从标准输入读取内容的 "-" 或 3。

9.54. 裸机恢复节点显示

显示裸机节点详情

使用方法:

openstack baremetal node show [-h] [-f {json,shell,table,value,yaml}]
                                     [-c COLUMN] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--noindent] [--prefix PREFIX]
                                     [--instance]
                                     [--fields <field> [<field> ...]]
                                     <node>
Copy to Clipboard Toggle word wrap

Expand
表 9.187. 表格式
概述

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表 9.188. 位置参数
概述

<node>

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

Expand
表 9.189. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 9.190. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 9.191. 可选参数
概述

--instance

<node> 是一个实例 uuid。

-h, --help

显示帮助信息并退出

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

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

Expand
表 9.192. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

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

列出节点的特征。

使用方法:

openstack baremetal node trait list [-h]
                                           [-f {csv,json,table,value,yaml}]
                                           [-c COLUMN] [--max-width <integer>]
                                           [--fit-width] [--print-empty]
                                           [--noindent]
                                           [--quote {all,minimal,none,nonnumeric}]
                                           [--sort-column SORT_COLUMN]
                                           <node>
Copy to Clipboard Toggle word wrap

Expand
表 9.193. 表格式
概述

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表 9.194. 位置参数
概述

<node>

节点的名称或 uuid

Expand
表 9.195. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 9.196. 输出格式器
概述

输出 formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 9.197. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 9.198. 可选参数
概述

-h, --help

显示帮助信息并退出

9.56. 裸机节点取消部署

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

使用方法:

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

Expand
表 9.199. 位置参数
概述

<node>

节点的名称或 uuid。

Expand
表 9.200. 可选参数
概述

-h, --help

显示帮助信息并退出

--wait [<time-out>]

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

9.57. 裸机恢复节点未设置

取消设置裸机属性

使用方法:

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]
                                      [--boot-interface] [--console-interface]
                                      [--deploy-interface]
                                      [--inspect-interface]
                                      [--management-interface]
                                      [--network-interface]
                                      [--power-interface] [--raid-interface]
                                      [--storage-interface]
                                      [--vendor-interface]
                                      <node>
Copy to Clipboard Toggle word wrap

Expand
表 9.201. 位置参数
概述

<node>

节点的名称或 uuid。

Expand
表 9.202. 可选参数
概述

--property <key>

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

--storage-interface

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

--instance-uuid

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

--deploy-interface

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

--vendor-interface

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

--network-interface

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

--instance-info <key>

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

--driver-info <key>

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

--extra <key>

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

--resource-class

取消设置节点的资源类

--management-interface

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

--boot-interface

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

--raid-interface

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

--console-interface

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

--target-raid-config

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

--name

取消设置节点的名称

-h, --help

显示帮助信息并退出

--inspect-interface

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

--chassis-uuid

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

--power-interface

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

9.58. 裸机节点验证

验证节点的驱动程序接口

使用方法:

openstack baremetal node validate [-h] [-f {csv,json,table,value,yaml}]
                                         [-c COLUMN] [--max-width <integer>]
                                         [--fit-width] [--print-empty]
                                         [--noindent]
                                         [--quote {all,minimal,none,nonnumeric}]
                                         [--sort-column SORT_COLUMN]
                                         <node>
Copy to Clipboard Toggle word wrap

Expand
表 9.203. 表格式
概述

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表 9.204. 位置参数
概述

<node>

节点的名称或 uuid

Expand
表 9.205. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 9.206. 输出格式器
概述

输出 formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 9.207. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 9.208. 可选参数
概述

-h, --help

显示帮助信息并退出

9.59. 裸机恢复节点 vif attach

将 VIF 附加到指定节点

使用方法:

openstack baremetal node vif attach [-h] [--vif-info <key=value>]
                                           <node> <vif-id>
Copy to Clipboard Toggle word wrap

Expand
表 9.209. 位置参数
概述

<node>

节点的名称或 uuid

<vif-id>

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

Expand
表 9.210. 可选参数
概述

-h, --help

显示帮助信息并退出

--vif-info <key=value>

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

9.60. 裸机节点 vif detach

从给定节点分离 VIF

使用方法:

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

Expand
表 9.211. 位置参数
概述

<node>

节点的名称或 uuid

<vif-id>

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

Expand
表 9.212. 可选参数
概述

-h, --help

显示帮助信息并退出

9.61. 裸机节点 vif list

显示节点的附加 VIFs

使用方法:

openstack baremetal node vif list [-h] [-f {csv,json,table,value,yaml}]
                                         [-c COLUMN] [--max-width <integer>]
                                         [--fit-width] [--print-empty]
                                         [--noindent]
                                         [--quote {all,minimal,none,nonnumeric}]
                                         [--sort-column SORT_COLUMN]
                                         <node>
Copy to Clipboard Toggle word wrap

Expand
表 9.213. 表格式
概述

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表 9.214. 位置参数
概述

<node>

节点的名称或 uuid

Expand
表 9.215. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 9.216. 输出格式器
概述

输出 formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 9.217. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 9.218. 可选参数
概述

-h, --help

显示帮助信息并退出

9.62. 裸机端口创建

创建新端口

使用方法:

openstack baremetal port create [-h] [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--max-width <integer>]
                                       [--fit-width] [--print-empty]
                                       [--noindent] [--prefix PREFIX] --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>]
                                       <address>
Copy to Clipboard Toggle word wrap

Expand
表 9.219. 表格式
概述

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表 9.220. 位置参数
概述

<address>

此端口的 MAC 地址。

Expand
表 9.221. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 9.222. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 9.223. 可选参数
概述

--extra <key=value>

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

--physical-network <physical network>

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

--uuid <uuid>

端口的 UUID。

--port-group <uuid>

此端口所属端口的 UUID。

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

描述本地链路连接信息的键/值元数据。有效密钥是 switch_infoswitch_idport_id。keys switch_idport_id 是必需的。可多次指定。

--pxe-enabled <boolean>

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

-l <key=value>

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

-h, --help

显示帮助信息并退出

--node <uuid>

此端口所属节点的 UUID。

Expand
表 9.224. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

9.63. 裸机端口删除

删除端口。

使用方法:

openstack baremetal port delete [-h] <port> [<port> ...]
Copy to Clipboard Toggle word wrap

Expand
表 9.225. 位置参数
概述

<port>

要删除的端口的 UUID。

Expand
表 9.226. 可选参数
概述

-h, --help

显示帮助信息并退出

9.64. 裸机端口组创建

创建新的裸机端口组。

使用方法:

openstack baremetal port group create [-h]
                                             [-f {json,shell,table,value,yaml}]
                                             [-c COLUMN]
                                             [--max-width <integer>]
                                             [--fit-width] [--print-empty]
                                             [--noindent] [--prefix PREFIX]
                                             --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
表 9.227. 表格式
概述

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表 9.228. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 9.229. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 9.230. 可选参数
概述

--support-standalone-ports

属于此端口组的成员的端口可以用作独立端口。(默认)

--extra <key=value>

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

--address <mac-address>

该端口组的 MAC 地址。

--unsupport-standalone-ports

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

--property <key=value>

与此端口组配置相关的 key/value 属性。可多次指定。

--mode MODE

端口组的模式。有关可能的值,请参阅 https://www.kernel.org/doc/Documentation/networking/bo nding.txt。

--name NAME

端口组名称。

-h, --help

显示帮助信息并退出

--uuid UUID

端口组的 UUID。

--node <uuid>

此端口组所属的节点的 UUID。

Expand
表 9.231. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

9.65. 裸机端口组删除

取消注册裸机端口组。

使用方法:

openstack baremetal port group delete [-h]
                                             <port group> [<port group> ...]
Copy to Clipboard Toggle word wrap

Expand
表 9.232. 位置参数
概述

<port group>

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

Expand
表 9.233. 可选参数
概述

-h, --help

显示帮助信息并退出

9.66. 裸机端口组列表

列出裸机端口组。

使用方法:

openstack baremetal port group list [-h]
                                           [-f {csv,json,table,value,yaml}]
                                           [-c COLUMN] [--max-width <integer>]
                                           [--fit-width] [--print-empty]
                                           [--noindent]
                                           [--quote {all,minimal,none,nonnumeric}]
                                           [--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
表 9.234. 表格式
概述

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表 9.235. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 9.236. 输出格式器
概述

输出 formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 9.237. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 9.238. 可选参数
概述

--node <node>

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

--address <mac-address>

仅显示具有此 mac 地址的端口组的信息。

--long

显示有关端口组的详细信息。

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

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

--limit <limit>

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

--marker <port group>

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

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

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

-h, --help

显示帮助信息并退出

9.67. 裸机端口组集

设置裸机端口组属性。

使用方法:

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

<port group>

端口组的名称或 uuid。

Expand
表 9.240. 可选参数
概述

--support-standalone-ports

属于此端口组成员的端口可以用作独立端口。

--extra <key=value>

在这个 baremetal 端口组中设置额外的额外的选项(重复选项来设置多个额外的选项)。

--address <mac-address>

该端口组的 MAC 地址。

--unsupport-standalone-ports

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

--property <key=value>

与此端口组配置相关的键/值属性(重复选项来设置多个属性)。

--mode MODE

端口组的模式。有关可能的值,请参阅 https://www.kernel.org/doc/Documentation/networking/bo nding.txt。

--name <name>

端口组名称。

-h, --help

显示帮助信息并退出

--node <uuid>

更新此端口组所属的节点的 uuid。

9.68. 裸机端口组显示

显示裸机端口组详细信息。

使用方法:

openstack baremetal port group show [-h]
                                           [-f {json,shell,table,value,yaml}]
                                           [-c COLUMN] [--max-width <integer>]
                                           [--fit-width] [--print-empty]
                                           [--noindent] [--prefix PREFIX]
                                           [--address]
                                           [--fields <field> [<field> ...]]
                                           <id>
Copy to Clipboard Toggle word wrap

Expand
表 9.241. 表格式
概述

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表 9.242. 位置参数
概述

<id>

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

Expand
表 9.243. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 9.244. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 9.245. 可选参数
概述

-h, --help

显示帮助信息并退出

--address

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

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

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

Expand
表 9.246. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

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

<port group>

端口组的名称或 uuid。

Expand
表 9.248. 可选参数
概述

--property <key>

在这个 baremetal 端口组中取消设置的属性(重复选项以取消设置多个属性)。

--name

取消设置端口组的名称。

-h, --help

显示帮助信息并退出

--address

取消设置端口组的地址。

--extra <key>

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

9.70. 裸机端口列表

列出裸机端口。

使用方法:

openstack baremetal port list [-h] [-f {csv,json,table,value,yaml}]
                                     [-c COLUMN] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--noindent]
                                     [--quote {all,minimal,none,nonnumeric}]
                                     [--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
表 9.249. 表格式
概述

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表 9.250. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 9.251. 输出格式器
概述

输出 formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 9.252. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 9.253. 可选参数
概述

--node <node>

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

--address <mac-address>

仅显示具有此 mac 地址的端口的信息。

--marker <port>

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

--long

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

--port-group <port group>

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

--limit <limit>

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

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

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

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

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

-h, --help

显示帮助信息并退出

9.71. 裸机端口集

设置裸机端口属性。

使用方法:

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

Expand
表 9.254. 位置参数
概述

<port>

端口的 UUID

Expand
表 9.255. 可选参数
概述

--pxe-enabled

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

--extra <key=value>

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

--pxe-disabled

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

--port-group <uuid>

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

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

描述本地链路连接信息的键/值元数据。有效密钥是 switch_infoswitch_idport_id。keys switch_idport_id 是必需的。可多次指定。

--physical-network <physical network>

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

-h, --help

显示帮助信息并退出

--node <uuid>

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

--address <address>

为这个端口设置 mac 地址

9.72. 裸机端口显示

显示裸机端口详细信息。

使用方法:

openstack baremetal port show [-h] [-f {json,shell,table,value,yaml}]
                                     [-c COLUMN] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--noindent] [--prefix PREFIX]
                                     [--address]
                                     [--fields <field> [<field> ...]]
                                     <id>
Copy to Clipboard Toggle word wrap

Expand
表 9.256. 表格式
概述

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表 9.257. 位置参数
概述

<id>

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

Expand
表 9.258. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 9.259. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 9.260. 可选参数
概述

-h, --help

显示帮助信息并退出

--address

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

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

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

Expand
表 9.261. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

9.73. baremetal 端口未设置

取消设置裸机端口属性。

使用方法:

openstack baremetal port unset [-h] [--extra <key>] [--port-group]
                                      [--physical-network]
                                      <port>
Copy to Clipboard Toggle word wrap

Expand
表 9.262. 位置参数
概述

<port>

端口的 UUID。

Expand
表 9.263. 可选参数
概述

--port-group

从端口组中删除端口

-h, --help

显示帮助信息并退出

--extra <key>

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

--physical-network

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

9.74. 裸机卷连接器创建

创建新的裸机卷连接器。

使用方法:

openstack baremetal volume connector create [-h]
                                                   [-f {json,shell,table,value,yaml}]
                                                   [-c COLUMN]
                                                   [--max-width <integer>]
                                                   [--fit-width]
                                                   [--print-empty]
                                                   [--noindent]
                                                   [--prefix PREFIX] --node
                                                   <uuid> --type <type>
                                                   --connector-id <connector
                                                   id> [--uuid <uuid>]
                                                   [--extra <key=value>]
Copy to Clipboard Toggle word wrap

Expand
表 9.264. 表格式
概述

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表 9.265. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 9.266. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 9.267. 可选参数
概述

--node <uuid>

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

--uuid <uuid>

卷连接器的 UUID。

--type <type>

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

--extra <key=value>

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

-h, --help

显示帮助信息并退出

--connector-id <connector id>

指定类型中的卷连接器 ID。例如,如果类型为 iqn,则节点的 iSCSI 启动器 IQN。

Expand
表 9.268. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

9.75. 裸机卷连接器删除

取消注册裸机卷连接器。

使用方法:

openstack baremetal volume connector delete [-h]
                                                   <volume connector>
                                                   [<volume connector> ...]
Copy to Clipboard Toggle word wrap

Expand
表 9.269. 位置参数
概述

<volume connector>

要删除的卷连接器的 UUID。

Expand
表 9.270. 可选参数
概述

-h, --help

显示帮助信息并退出

9.76. 裸机卷连接器列表

列出裸机卷连接器。

使用方法:

openstack baremetal volume connector list [-h]
                                                 [-f {csv,json,table,value,yaml}]
                                                 [-c COLUMN]
                                                 [--max-width <integer>]
                                                 [--fit-width] [--print-empty]
                                                 [--noindent]
                                                 [--quote {all,minimal,none,nonnumeric}]
                                                 [--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
表 9.271. 表格式
概述

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表 9.272. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 9.273. 输出格式器
概述

输出 formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 9.274. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 9.275. 可选参数
概述

--node <node>

仅列出该节点的卷连接器(名称或 UUID)。

--long

显示有关卷连接器的详细信息。

--limit <limit>

每个请求返回的最大卷连接器数 0,无限制。默认为 Baremetal API 服务使用的最大值。

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

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

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

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

-h, --help

显示帮助信息并退出

--marker <volume connector>

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

9.77. 裸机卷连接器集

设置裸机卷连接器属性。

使用方法:

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

<volume connector>

卷连接器的 UUID。

Expand
表 9.277. 可选参数
概述

--extra <key=value>

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

--type <type>

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

-h, --help

显示帮助信息并退出

--node <uuid>

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

--connector-id <connector id>

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

9.78. 裸机卷连接器显示

显示裸机卷连接器详情。

使用方法:

openstack baremetal volume connector show [-h]
                                                 [-f {json,shell,table,value,yaml}]
                                                 [-c COLUMN]
                                                 [--max-width <integer>]
                                                 [--fit-width] [--print-empty]
                                                 [--noindent]
                                                 [--prefix PREFIX]
                                                 [--fields <field> [<field> ...]]
                                                 <id>
Copy to Clipboard Toggle word wrap

Expand
表 9.278. 表格式
概述

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表 9.279. 位置参数
概述

<id>

卷连接器的 UUID。

Expand
表 9.280. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 9.281. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 9.282. 可选参数
概述

-h, --help

显示帮助信息并退出

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

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

Expand
表 9.283. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

9.79. 裸机卷连接器未设置

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

使用方法:

openstack baremetal volume connector unset [-h] [--extra <key>]
                                                  <volume connector>
Copy to Clipboard Toggle word wrap

Expand
表 9.284. 位置参数
概述

<volume connector>

卷连接器的 UUID。

Expand
表 9.285. 可选参数
概述

-h, --help

显示帮助信息并退出

--extra <key>

extra to unset (repeat option to unset multiple extras)

9.80. baremetal 卷目标创建

创建新的 baremetal 卷目标。

使用方法:

openstack baremetal volume target create [-h]
                                                [-f {json,shell,table,value,yaml}]
                                                [-c COLUMN]
                                                [--max-width <integer>]
                                                [--fit-width] [--print-empty]
                                                [--noindent] [--prefix PREFIX]
                                                --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
表 9.286. 表格式
概述

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表 9.287. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 9.288. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 9.289. 可选参数
概述

--extra <key=value>

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

--uuid <uuid>

卷目标的 UUID。

--property <key=value>

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

--boot-index <boot index>

卷目标引导索引。

--type <volume type>

卷目标的类型,例如 iscsifibre_channel

-h, --help

显示帮助信息并退出

--volume-id <volume id>

与此目标关联的卷的 ID。

--node <uuid>

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

Expand
表 9.290. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

9.81. baremetal 卷目标删除

取消注册裸机卷目标。

使用方法:

openstack baremetal volume target delete [-h]
                                                <volume target>
                                                [<volume target> ...]
Copy to Clipboard Toggle word wrap

Expand
表 9.291. 位置参数
概述

<volume target>

要删除的卷目标的 UUID。

Expand
表 9.292. 可选参数
概述

-h, --help

显示帮助信息并退出

9.82. baremetal 卷目标列表

列出裸机卷目标。

使用方法:

openstack baremetal volume target list [-h]
                                              [-f {csv,json,table,value,yaml}]
                                              [-c COLUMN]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty]
                                              [--noindent]
                                              [--quote {all,minimal,none,nonnumeric}]
                                              [--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
表 9.293. 表格式
概述

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表 9.294. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 9.295. 输出格式器
概述

输出 formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 9.296. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 9.297. 可选参数
概述

--node <node>

仅列出此节点的卷目标(名称或 uuid)。

--marker <volume target>

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

--long

显示有关卷目标的详细信息。

--limit <limit>

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

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

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

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

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

-h, --help

显示帮助信息并退出

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

<volume target>

卷目标的 UUID。

Expand
表 9.299. 可选参数
概述

--extra <key=value>

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

--property <key=value>

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

--boot-index <boot index>

卷目标引导索引。

--type <volume type>

卷目标的类型,例如 iscsifibre_channel

-h, --help

显示帮助信息并退出

--volume-id <volume id>

与此目标关联的卷的 ID。

--node <uuid>

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

9.84. baremetal 卷目标显示

显示 baremetal 卷目标详细信息。

使用方法:

openstack baremetal volume target show [-h]
                                              [-f {json,shell,table,value,yaml}]
                                              [-c COLUMN]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty]
                                              [--noindent] [--prefix PREFIX]
                                              [--fields <field> [<field> ...]]
                                              <id>
Copy to Clipboard Toggle word wrap

Expand
表 9.300. 表格式
概述

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表 9.301. 位置参数
概述

<id>

卷目标的 UUID。

Expand
表 9.302. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 9.303. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 9.304. 可选参数
概述

-h, --help

显示帮助信息并退出

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

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

Expand
表 9.305. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

9.85. baremetal 卷目标未设置

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

使用方法:

openstack baremetal volume target unset [-h] [--extra <key>]
                                               [--property <key>]
                                               <volume target>
Copy to Clipboard Toggle word wrap

Expand
表 9.306. 位置参数
概述

<volume target>

卷目标的 UUID。

Expand
表 9.307. 可选参数
概述

--property <key>

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

-h, --help

显示帮助信息并退出

--extra <key>

extra to unset (repeat option to unset multiple extras)

第 10 章 BGP

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

10.1. BGP dragent add speaker

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

使用方法:

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

Expand
表 10.1. 位置参数
概述

<agent-id>

动态路由代理的 ID

<bgp-speaker>

bgp speaker 的 ID 或名称

Expand
表 10.2. 可选参数
概述

-h, --help

显示帮助信息并退出

10.2. BGP dragent remove speaker

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

使用方法:

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

Expand
表 10.3. 位置参数
概述

<agent-id>

动态路由代理的 ID

<bgp-speaker>

bgp speaker 的 ID 或名称

Expand
表 10.4. 可选参数
概述

-h, --help

显示帮助信息并退出

10.3. BGP peer create

创建 BGP peer

使用方法:

openstack bgp peer create [-h] [-f {json,shell,table,value,yaml}]
                                 [-c COLUMN] [--max-width <integer>]
                                 [--fit-width] [--print-empty] [--noindent]
                                 [--prefix PREFIX] --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
表 10.5. 表格式
概述

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表 10.6. 位置参数
概述

<name>

要创建的 bgp peer 的名称

Expand
表 10.7. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 10.8. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 10.9. 可选参数
概述

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

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

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

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

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

peer ip 地址

--project-domain <project-domain>

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

--password <auth-password>

身份验证密码

-h, --help

显示帮助信息并退出

--project <project>

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

Expand
表 10.10. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

10.4. BGP peer delete

删除 BGP peer

使用方法:

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

Expand
表 10.11. 位置参数
概述

<bgp-peer>

BGP peer to delete (名称或 ID)

Expand
表 10.12. 可选参数
概述

-h, --help

显示帮助信息并退出

10.5. BGP peer list

列出 BGP 对等对象

使用方法:

openstack bgp peer list [-h] [-f {csv,json,table,value,yaml}]
                               [-c COLUMN] [--max-width <integer>]
                               [--fit-width] [--print-empty] [--noindent]
                               [--quote {all,minimal,none,nonnumeric}]
                               [--sort-column SORT_COLUMN]
Copy to Clipboard Toggle word wrap

Expand
表 10.13. 表格式
概述

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表 10.14. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 10.15. 输出格式器
概述

输出 formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 10.16. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 10.17. 可选参数
概述

-h, --help

显示帮助信息并退出

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

<bgp-peer>

BGP peer 以更新(名称或 ID)

Expand
表 10.19. 可选参数
概述

--password <auth-password>

更新了身份验证密码

-h, --help

显示帮助信息并退出

--name NAME

更新了 bgp peer 的名称

10.7. BGP peer 显示

显示 BGP peer (BGP peer)的信息

使用方法:

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

Expand
表 10.20. 表格式
概述

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表 10.21. 位置参数
概述

<bgp-peer>

BGP peer to display (名称或 ID)

Expand
表 10.22. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 10.23. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 10.24. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 10.25. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

10.8. BGP speaker add 网络

将网络添加到 BGP speaker

使用方法:

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

Expand
表 10.26. 位置参数
概述

<bgp-speaker>

BGP 发言人(名称或 ID)

<network>

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

Expand
表 10.27. 可选参数
概述

-h, --help

显示帮助信息并退出

10.9. BGP speaker add peer

为 BGP 发言人添加对等点

使用方法:

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

Expand
表 10.28. 位置参数
概述

<bgp-peer>

BGP peer to add (名称或 ID)

<bgp-speaker>

BGP 发言人(名称或 ID)

Expand
表 10.29. 可选参数
概述

-h, --help

显示帮助信息并退出

10.10. BGP speaker create

创建 BGP 发言人

使用方法:

openstack bgp speaker create [-h] [-f {json,shell,table,value,yaml}]
                                    [-c COLUMN] [--max-width <integer>]
                                    [--fit-width] [--print-empty] [--noindent]
                                    [--prefix PREFIX] --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
表 10.30. 表格式
概述

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表 10.31. 位置参数
概述

<name>

要创建的 bgp 发言人的名称

Expand
表 10.32. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

Expand
表 10.33. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 10.34. 可选参数
概述

--no-advertise-floating-ip-host-routes

禁用 BGP speaker 公告浮动 IP 主机路由。

--project-domain <project-domain>

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

--no-advertise-tenant-networks

禁用 BGP 发言人的租户网络路由的公告。

--ip-version {4,6}

bgp speaker 的 IP 版本(默认为 4)

--advertise-floating-ip-host-routes

通过 BGP speaker. (默认)启用浮动 ip 主机路由的公告。(默认)

--local-as <local-as>

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

--advertise-tenant-networks

启用 BGP speaker 的租户网络路由的公告(默认)

-h, --help

显示帮助信息并退出

--project <project>

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

Expand
表 10.35. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

10.11. BGP speaker delete

删除 BGP 发言人

使用方法:

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

Expand
表 10.36. 位置参数
概述

<bgp-speaker>

BGP speaker to delete (名称或 ID)

Expand
表 10.37. 可选参数
概述

-h, --help

显示帮助信息并退出

10.12. BGP 发言人列表公告的路由

列出公告的路由

使用方法:

openstack bgp speaker list advertised routes [-h]
                                                    [-f {csv,json,table,value,yaml}]
                                                    [-c COLUMN]
                                                    [--max-width <integer>]
                                                    [--fit-width]
                                                    [--print-empty]
                                                    [--noindent]
                                                    [--quote {all,minimal,none,nonnumeric}]
                                                    [--sort-column SORT_COLUMN]
                                                    <bgp-speaker>
Copy to Clipboard Toggle word wrap

Expand
表 10.38. 表格式
概述

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表 10.39. 位置参数
概述

<bgp-speaker>

BGP 发言人(名称或 ID)

Expand
表 10.40. CSV Formatter
概述

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

当包含引号时,默认为 nonnumeric

Expand
表 10.41. 输出格式器
概述

输出 formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
表 10.42. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 10.43. 可选参数
概述

-h, --help

显示帮助信息并退出

10.13. BGP speaker list

列出 BGP 发言人

使用方法:

openstack bgp speaker list [-h] [-f {csv,json,table,value,yaml}]
                                  [-c COLUMN] [--max-width <integer>]
                                  [--fit-width] [--print-empty] [--noindent]
                                  [--quote {all,minimal,none,nonnumeric}]
                                  [--sort-column SORT_COLUMN]
                                  [--agent <agent-id>]
Copy to Clipboard Toggle word wrap

Expand
表 10.44. 表格式
概述

--print-empty

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

--max-width <integer>

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

--fit-width

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

Expand
表 10.45. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

Expand
表 10.46. 输出格式器
概述

输出 formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

Expand
表 10.47. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 10.48. 可选参数
概述

-h, --help

显示帮助信息并退出

--agent <agent-id>

列出由代理托管的 bgp 发言人(仅限 ID)

10.14. BGP speaker 删除网络

从 BGP speaker 中删除网络

使用方法:

openstack bgp speaker remove network [-h] <bgp-speaker> <network>
Copy to Clipboard Toggle word wrap

Expand
表 10.49. 位置参数
概述

<bgp-speaker>

BGP 发言人(名称或 ID)

<network>

要删除的网络(名称或 id)

Expand
表 10.50. 可选参数
概述

-h, --help

显示帮助信息并退出

10.15. BGP speaker remove peer

从 BGP speaker 中删除对等点

使用方法:

openstack bgp speaker remove peer [-h] <bgp-speaker> <bgp-peer>
Copy to Clipboard Toggle word wrap

Expand
表 10.51. 位置参数
概述

<bgp-peer>

BGP peer to remove (名称或 ID)

<bgp-speaker>

BGP 发言人(名称或 ID)

Expand
表 10.52. 可选参数
概述

-h, --help

显示帮助信息并退出

10.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
表 10.53. 位置参数
概述

<bgp-speaker>

BGP speaker to update (名称或 ID)

Expand
表 10.54. 可选参数
概述

--no-advertise-floating-ip-host-routes

禁用 BGP speaker 公告浮动 IP 主机路由。

--no-advertise-tenant-networks

禁用 BGP 发言人的租户网络路由的公告。

--advertise-floating-ip-host-routes

通过 BGP speaker. (默认)启用浮动 ip 主机路由的公告。(默认)

--name NAME

要更新的 bgp 发言人的名称

--advertise-tenant-networks

启用 BGP speaker 的租户网络路由的公告(默认)

-h, --help

显示帮助信息并退出

10.17. BGP speaker show dragents

列出托管 BGP 发言人的动态路由代理

使用方法:

openstack bgp speaker show dragents [-h]
                                           [-f {csv,json,table,value,yaml}]
                                           [-c COLUMN] [--max-width <integer>]
                                           [--fit-width] [--print-empty]
                                           [--noindent]
                                           [--quote {all,minimal,none,nonnumeric}]
                                           [--sort-column SORT_COLUMN]
                                           <bgp-speaker>
Copy to Clipboard Toggle word wrap

Expand
表 10.55. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 10.56. 位置参数
概述

<bgp-speaker>

bgp speaker 的 ID 或名称

Expand
表 10.57. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

Expand
表 10.58. 输出格式器
概述

输出 formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

Expand
表 10.59. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 10.60. 可选参数
概述

-h, --help

显示帮助信息并退出

10.18. BGP speaker show

显示 BGP 发言人

使用方法:

openstack bgp speaker show [-h] [-f {json,shell,table,value,yaml}]
                                  [-c COLUMN] [--max-width <integer>]
                                  [--fit-width] [--print-empty] [--noindent]
                                  [--prefix PREFIX]
                                  <bgp-speaker>
Copy to Clipboard Toggle word wrap

Expand
表 10.61. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 10.62. 位置参数
概述

<bgp-speaker>

要显示的 BGP 发言人(名称或 ID)

Expand
表 10.63. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 10.64. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 10.65. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 10.66. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

第 11 章 bgpvpn

本章论述了 bgpvpn 命令下的命令。

11.1. bgpvpn create

创建 BGP VPN 资源

使用方法:

openstack bgpvpn create [-h] [-f {json,shell,table,value,yaml}]
                               [-c COLUMN] [--max-width <integer>]
                               [--fit-width] [--print-empty] [--noindent]
                               [--prefix PREFIX] [--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] [--type {l2,l3}]
Copy to Clipboard Toggle word wrap

Expand
表 11.1. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 11.2. 输出格式器
概述

output formatter options-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. 可选参数
概述

--name <name>

bgp vpn 的名称

--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)

--project-domain <project-domain>

项目所属的域(名称或 id)。这可在项目名称之间有冲突时使用。

--vni VNI

使用 VXLAN 封装时要用于此 bgpvpn 的 VXLAN 网络标识符

--import-target <import-target>

添加路由目标以导入列表(多个路由目标的重复选项)

--route-target <route-target>

添加路由目标以导入/导出列表(多个路由目标的重复选项)

--type {l2,l3}

BGP vpn 类型选择 ip vpn (l3)和以太网 VPN (l2) (默认:l3)

-h, --help

显示帮助信息并退出

--export-target <export-target>

添加路由目标以导出列表(多个路由目标的重复选项)

--project <project>

所有者的项目(名称或 id)

Expand
表 11.5. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

11.2. bgpvpn delete

删除 BGP VPN 资源

使用方法:

openstack bgpvpn delete [-h] <bgpvpn> [<bgpvpn> ...]
Copy to Clipboard Toggle word wrap

Expand
表 11.6. 位置参数
概述

<bgpvpn>

BGP vpn (s)以删除(名称或 ID)

Expand
表 11.7. 可选参数
概述

-h, --help

显示帮助信息并退出

11.3. bgpvpn list

列出 BGP VPN 资源

使用方法:

openstack bgpvpn list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                             [--max-width <integer>] [--fit-width]
                             [--print-empty] [--noindent]
                             [--quote {all,minimal,none,nonnumeric}]
                             [--sort-column SORT_COLUMN] [--project <project>]
                             [--project-domain <project-domain>] [--long]
                             [--property <key=value>]
Copy to Clipboard Toggle word wrap

Expand
表 11.8. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 11.9. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

Expand
表 11.10. 输出格式器
概述

输出 formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

Expand
表 11.11. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 11.12. 可选参数
概述

--property <key=value>

要应用到返回的 bgp vpns 的过滤器属性(重复用于过滤多个属性)

-h, --help

显示帮助信息并退出

--project <project>

所有者的项目(名称或 id)

--long

列出输出中的其他字段

--project-domain <project-domain>

项目所属的域(名称或 id)。这可在项目名称之间有冲突时使用。

11.4. bgpvpn 网络关联创建

创建 BGP VPN 网络关联

使用方法:

openstack bgpvpn network association create [-h]
                                                   [-f {json,shell,table,value,yaml}]
                                                   [-c COLUMN]
                                                   [--max-width <integer>]
                                                   [--fit-width]
                                                   [--print-empty]
                                                   [--noindent]
                                                   [--prefix PREFIX]
                                                   [--project <project>]
                                                   [--project-domain <project-domain>]
                                                   <bgpvpn> <network>
Copy to Clipboard Toggle word wrap

Expand
表 11.13. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 11.14. 位置参数
概述

<bgpvpn>

BGP vpn 以应用网络关联(名称或 ID)

<network>

要关联 bgp vpn (name 或 id)的网络。

Expand
表 11.15. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 11.16. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 11.17. 可选参数
概述

-h, --help

显示帮助信息并退出

--project <project>

所有者的项目(名称或 id)

--project-domain <project-domain>

项目所属的域(名称或 id)。这可在项目名称之间有冲突时使用。

Expand
表 11.18. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

11.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
表 11.19. 位置参数
概述

<network 关联 ID>

要删除的网络关联 ID

<bgpvpn>

BGP vpn 网络关联属于 (名称或 ID)

Expand
表 11.20. 可选参数
概述

-h, --help

显示帮助信息并退出

11.6. bgpvpn 网络关联列表

列出给定 BGP VPN 的网络关联

使用方法:

openstack bgpvpn network association list [-h]
                                                 [-f {csv,json,table,value,yaml}]
                                                 [-c COLUMN]
                                                 [--max-width <integer>]
                                                 [--fit-width] [--print-empty]
                                                 [--noindent]
                                                 [--quote {all,minimal,none,nonnumeric}]
                                                 [--sort-column SORT_COLUMN]
                                                 [--long]
                                                 [--property <key=value>]
                                                 <bgpvpn>
Copy to Clipboard Toggle word wrap

Expand
表 11.21. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 11.22. 位置参数
概述

<bgpvpn>

BGP vpn 列出的关联属于 (名称或 ID)

Expand
表 11.23. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

Expand
表 11.24. 输出格式器
概述

输出 formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

Expand
表 11.25. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 11.26. 可选参数
概述

-h, --help

显示帮助信息并退出

--property <key=value>

要应用到返回的 bgp vpns 的过滤器属性(重复用于过滤多个属性)

--long

列出输出中的其他字段

11.7. bgpvpn 网络关联显示

显示给定 BGP VPN 网络关联信息

使用方法:

openstack bgpvpn network association show [-h]
                                                 [-f {json,shell,table,value,yaml}]
                                                 [-c COLUMN]
                                                 [--max-width <integer>]
                                                 [--fit-width] [--print-empty]
                                                 [--noindent]
                                                 [--prefix PREFIX]
                                                 <network association ID>
                                                 <bgpvpn>
Copy to Clipboard Toggle word wrap

Expand
表 11.27. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 11.28. 位置参数
概述

<network 关联 ID>

要查找的网络关联 ID

<bgpvpn>

BGP vpn 关联属于(名称或 ID)

Expand
表 11.29. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 11.30. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 11.31. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 11.32. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

11.8. bgpvpn 端口关联创建

创建 BGP VPN 端口关联

使用方法:

openstack bgpvpn port association create [-h]
                                                [-f {json,shell,table,value,yaml}]
                                                [-c COLUMN]
                                                [--max-width <integer>]
                                                [--fit-width] [--print-empty]
                                                [--noindent] [--prefix PREFIX]
                                                [--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
表 11.33. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 11.34. 位置参数
概述

<bgpvpn>

BGP vpn 以应用端口关联(名称或 ID)

<port>

要关联 bgp vpn (名称或 id)的端口

Expand
表 11.35. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 11.36. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 11.37. 可选参数
概述

--bgpvpn-route bgpvpn=<BGP VPN ID or name>[,local_pref=<integer>]

为路由泄漏添加 bgp vpn 路由。可选(可选)控制 BGP LOCAL_PREF 中要公告的路由的值(多个 BGP VPN 路由的重复选项)

--no-advertise-fixed-ips

修复了端口的 ips 不会公告到 BGP VPN

--prefix-route prefix=<cidr>[,local_pref=<integer>]

在 cidr 表示法中添加前缀路由。(可选)可控制 BGP LOCAL_PREF 中要公告的路由的值(用于多个前缀路由的重复选项)

--project-domain <project-domain>

项目所属的域(名称或 id)。这可在项目名称之间有冲突时使用。

--advertise-fixed-ips

修复了端口的 ips 将公告为 bgp VPN (默认)

-h, --help

显示帮助信息并退出

--project <project>

所有者的项目(名称或 id)

Expand
表 11.38. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

11.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
表 11.39. 位置参数
概述

<bgpvpn>

BGP vpn 端口关联属于 (名称或 ID)

<port 关联 ID>

要删除的端口关联 ID

Expand
表 11.40. 可选参数
概述

-h, --help

显示帮助信息并退出

11.10. bgpvpn 端口关联列表

列出给定 BGP VPN 端口关联

使用方法:

openstack bgpvpn port association list [-h]
                                              [-f {csv,json,table,value,yaml}]
                                              [-c COLUMN]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty]
                                              [--noindent]
                                              [--quote {all,minimal,none,nonnumeric}]
                                              [--sort-column SORT_COLUMN]
                                              [--long]
                                              [--property <key=value>]
                                              <bgpvpn>
Copy to Clipboard Toggle word wrap

Expand
表 11.41. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 11.42. 位置参数
概述

<bgpvpn>

BGP vpn 列出的关联属于 (名称或 ID)

Expand
表 11.43. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

Expand
表 11.44. 输出格式器
概述

输出 formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

Expand
表 11.45. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 11.46. 可选参数
概述

-h, --help

显示帮助信息并退出

--property <key=value>

要应用到返回的 bgp vpns 的过滤器属性(重复用于过滤多个属性)

--long

列出输出中的其他字段

11.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
表 11.47. 位置参数
概述

<bgpvpn>

BGP vpn 端口关联属于 (名称或 ID)

<port 关联 ID>

要更新的端口关联 ID

Expand
表 11.48. 可选参数
概述

--bgpvpn-route bgpvpn=<BGP VPN ID or name>[,local_pref=<integer>]

为路由泄漏添加 bgp vpn 路由。可选(可选)控制 BGP LOCAL_PREF 中要公告的路由的值(多个 BGP VPN 路由的重复选项)

--no-advertise-fixed-ips

修复了端口的 ips 不会公告到 BGP VPN

--prefix-route prefix=<cidr>[,local_pref=<integer>]

在 cidr 表示法中添加前缀路由。(可选)可控制 BGP LOCAL_PREF 中要公告的路由的值(用于多个前缀路由的重复选项)

--no-bgpvpn-route

空 bgp vpn 路由列表

--no-prefix-route

空前缀路由列表

--advertise-fixed-ips

修复了端口的 ips 将公告给 bgp VPN

-h, --help

显示帮助信息并退出

11.12. bgpvpn 端口关联显示

显示给定 BGP VPN 端口关联信息

使用方法:

openstack bgpvpn port association show [-h]
                                              [-f {json,shell,table,value,yaml}]
                                              [-c COLUMN]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty]
                                              [--noindent] [--prefix PREFIX]
                                              <port association ID> <bgpvpn>
Copy to Clipboard Toggle word wrap

Expand
表 11.49. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 11.50. 位置参数
概述

<bgpvpn>

BGP vpn 关联属于(名称或 ID)

<port 关联 ID>

要查找的端口关联 id

Expand
表 11.51. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 11.52. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 11.53. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 11.54. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

11.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
表 11.55. 位置参数
概述

<bgpvpn>

BGP vpn 端口关联属于 (名称或 ID)

<port 关联 ID>

要更新的端口关联 ID

Expand
表 11.56. 可选参数
概述

--all-prefix-routes

空前缀路由列表

--no-advertise-fixed-ips

修复了端口的 ips 将公告给 bgp VPN

--prefix-route <cidr>

在 cidr 标记中移除前缀路由(用于多个前缀路由的peat 选项)

--all-bgpvpn-routes

空 bgp vpn 路由列表

--advertise-fixed-ips

修复了端口的 ips 不会公告到 BGP VPN

-h, --help

显示帮助信息并退出

--bgpvpn-route <BGP VPN ID 或 name>

删除 bgp vpn route (多个 bgp VPN 路由的重复选项)

11.14. bgpvpn 路由器关联创建

创建 BGP VPN 路由器关联

使用方法:

openstack bgpvpn router association create [-h]
                                                  [-f {json,shell,table,value,yaml}]
                                                  [-c COLUMN]
                                                  [--max-width <integer>]
                                                  [--fit-width]
                                                  [--print-empty] [--noindent]
                                                  [--prefix PREFIX]
                                                  [--project <project>]
                                                  [--project-domain <project-domain>]
                                                  <bgpvpn> <router>
Copy to Clipboard Toggle word wrap

Expand
表 11.57. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 11.58. 位置参数
概述

<bgpvpn>

BGP vpn 以应用路由器关联(名称或 ID)

<router>

要关联 bgp vpn (名称或 id)的路由器.

Expand
表 11.59. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 11.60. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 11.61. 可选参数
概述

-h, --help

显示帮助信息并退出

--project <project>

所有者的项目(名称或 id)

--project-domain <project-domain>

项目所属的域(名称或 id)。这可在项目名称之间有冲突时使用。

Expand
表 11.62. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

11.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
表 11.63. 位置参数
概述

<bgpvpn>

BGP vpn 路由器关联属于 (名称或 ID)

<router 关联 ID>

要删除的路由器关联 ID

Expand
表 11.64. 可选参数
概述

-h, --help

显示帮助信息并退出

11.16. bgpvpn 路由器关联列表

列出给定 BGP VPN 路由器关联

使用方法:

openstack bgpvpn router association list [-h]
                                                [-f {csv,json,table,value,yaml}]
                                                [-c COLUMN]
                                                [--max-width <integer>]
                                                [--fit-width] [--print-empty]
                                                [--noindent]
                                                [--quote {all,minimal,none,nonnumeric}]
                                                [--sort-column SORT_COLUMN]
                                                [--long]
                                                [--property <key=value>]
                                                <bgpvpn>
Copy to Clipboard Toggle word wrap

Expand
表 11.65. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 11.66. 位置参数
概述

<bgpvpn>

BGP vpn 列出的关联属于 (名称或 ID)

Expand
表 11.67. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

Expand
表 11.68. 输出格式器
概述

输出 formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

Expand
表 11.69. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 11.70. 可选参数
概述

-h, --help

显示帮助信息并退出

--property <key=value>

要应用到返回的 bgp vpns 的过滤器属性(重复用于过滤多个属性)

--long

列出输出中的其他字段

11.17. bgpvpn 路由器关联显示

显示给定 BGP VPN 路由器关联信息

使用方法:

openstack bgpvpn router association show [-h]
                                                [-f {json,shell,table,value,yaml}]
                                                [-c COLUMN]
                                                [--max-width <integer>]
                                                [--fit-width] [--print-empty]
                                                [--noindent] [--prefix PREFIX]
                                                <router association ID>
                                                <bgpvpn>
Copy to Clipboard Toggle word wrap

Expand
表 11.71. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 11.72. 位置参数
概述

<bgpvpn>

BGP vpn 关联属于(名称或 ID)

<router 关联 ID>

要查找的路由器关联 id

Expand
表 11.73. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 11.74. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 11.75. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 11.76. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

11.18. 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]
                            <bgpvpn>
Copy to Clipboard Toggle word wrap

Expand
表 11.77. 位置参数
概述

<bgpvpn>

BGP vpn 更新(名称或 ID)

Expand
表 11.78. 可选参数
概述

--no-route-target

空路由目标列表

--name <name>

bgp vpn 的名称

--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

空路由可识别器列表

--no-export-target

空导出路由目标列表

--no-import-target

空导入路由目标列表

--vni VNI

使用 VXLAN 封装时要用于此 bgpvpn 的 VXLAN 网络标识符

--import-target <import-target>

添加路由目标以导入列表(多个路由目标的重复选项)

--route-target <route-target>

添加路由目标以导入/导出列表(多个路由目标的重复选项)

-h, --help

显示帮助信息并退出

--export-target <export-target>

添加路由目标以导出列表(多个路由目标的重复选项)

11.19. bgpvpn show

显示给定 BGP VPN 的信息

使用方法:

openstack bgpvpn show [-h] [-f {json,shell,table,value,yaml}]
                             [-c COLUMN] [--max-width <integer>] [--fit-width]
                             [--print-empty] [--noindent] [--prefix PREFIX]
                             <bgpvpn>
Copy to Clipboard Toggle word wrap

Expand
表 11.79. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 11.80. 位置参数
概述

<bgpvpn>

BGP vpn 以显示(名称或 ID)

Expand
表 11.81. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 11.82. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 11.83. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 11.84. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

11.20. 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]
                              <bgpvpn>
Copy to Clipboard Toggle word wrap

Expand
表 11.85. 位置参数
概述

<bgpvpn>

BGP vpn 更新(名称或 ID)

Expand
表 11.86. 可选参数
概述

--all-route-target

空路由目标列表

--route-target <route-target>

从导入/导出列表中删除路由目标(在多个 Route 目标的重复选项)

--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-export-target

空导出路由目标列表

--all-import-target

空导入路由目标列表

--vni VNI

使用 VXLAN 封装时要用于此 bgpvpn 的 VXLAN 网络标识符

--import-target <import-target>

从导入列表中删除路由目标(多个路由目标的重复选项)

-h, --help

显示帮助信息并退出

--export-target <export-target>

从导出列表中删除路由目标(多个路由目标的重复选项)

--all-route-distinguisher

空路由可识别器列表

第 12 章 ca

本章论述了 ca 命令下的命令。

12.1. CA get

通过提供 URI 来检索 CA。

使用方法:

openstack ca get [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN]
                        [--max-width <integer>] [--fit-width] [--print-empty]
                        [--noindent] [--prefix PREFIX]
                        URI
Copy to Clipboard Toggle word wrap

Expand
表 12.1. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 12.2. 位置参数
概述

URI

ca 的 uri 引用。

Expand
表 12.3. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 12.4. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 12.5. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 12.6. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

12.2. CA 列表

列出 CA。

使用方法:

openstack ca list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                         [--max-width <integer>] [--fit-width] [--print-empty]
                         [--noindent] [--quote {all,minimal,none,nonnumeric}]
                         [--sort-column SORT_COLUMN] [--limit LIMIT]
                         [--offset OFFSET] [--name NAME]
Copy to Clipboard Toggle word wrap

Expand
表 12.7. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 12.8. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

Expand
表 12.9. 输出格式器
概述

输出 formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

Expand
表 12.10. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 12.11. 可选参数
概述

-h, --help

显示帮助信息并退出

--limit LIMIT, -l LIMIT

指定每个页面列表的项目列表数量(默认为 10;最大:100)

--name NAME, -n NAME

指定 ca 名称(默认:none)

--offset OFFSET,-o OFFSET

指定页面偏移(默认值 0)

第 13 章 catalog

本章描述了 catalog 命令下的命令。

13.1. 目录列表

列出服务目录中的服务

使用方法:

openstack catalog list [-h] [-f {csv,json,table,value,yaml}]
                              [-c COLUMN] [--max-width <integer>]
                              [--fit-width] [--print-empty] [--noindent]
                              [--quote {all,minimal,none,nonnumeric}]
                              [--sort-column SORT_COLUMN]
Copy to Clipboard Toggle word wrap

Expand
表 13.1. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 13.2. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

Expand
表 13.3. 输出格式器
概述

输出 formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

Expand
表 13.4. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 13.5. 可选参数
概述

-h, --help

显示帮助信息并退出

13.2. 目录显示

显示服务目录详情

使用方法:

openstack catalog show [-h] [-f {json,shell,table,value,yaml}]
                              [-c COLUMN] [--max-width <integer>]
                              [--fit-width] [--print-empty] [--noindent]
                              [--prefix PREFIX]
                              <service>
Copy to Clipboard Toggle word wrap

Expand
表 13.6. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 13.7. 位置参数
概述

<service>

要显示的服务(类型或名称)

Expand
表 13.8. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 13.9. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 13.10. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 13.11. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

第 14 章 Coe

本章论述了 coe 命令下的命令。

14.1. Coe ca 轮转

轮转集群的 CA 证书以撤销访问。

使用方法:

openstack coe ca rotate [-h] <cluster>
Copy to Clipboard Toggle word wrap

Expand
表 14.1. 位置参数
概述

<cluster>

集群的 ID 或名称

Expand
表 14.2. 可选参数
概述

-h, --help

显示帮助信息并退出

14.2. Coe ca show

显示集群的 CA 证书详情。

使用方法:

openstack coe ca show [-h] <cluster>
Copy to Clipboard Toggle word wrap

Expand
表 14.3. 位置参数
概述

<cluster>

集群的 ID 或名称

Expand
表 14.4. 可选参数
概述

-h, --help

显示帮助信息并退出

14.3. Coe ca sign

为集群生成 CA 证书。

使用方法:

openstack coe ca sign [-h] <cluster> <csr>
Copy to Clipboard Toggle word wrap

Expand
表 14.5. 位置参数
概述

<cluster>

集群的 ID 或名称

<csr>

发送到 magnum 的 csr 文件的路径来签名。

Expand
表 14.6. 可选参数
概述

-h, --help

显示帮助信息并退出

14.4. Coe 集群配置

获取集群的配置

使用方法:

openstack coe cluster config [-h] [--dir <dir>] [--force] <cluster>
Copy to Clipboard Toggle word wrap

Expand
表 14.7. 位置参数
概述

<cluster>

要更新的集群的名称或 uuid

Expand
表 14.8. 可选参数
概述

--force

如果不存在,则覆盖文件。

-h, --help

显示帮助信息并退出

--dir <dir>

保存证书和配置文件的目录。

14.5. Coe 集群创建

创建集群

使用方法:

openstack coe cluster create [-h] --cluster-template <cluster-template>
                                    [--discovery-url <discovery-url>]
                                    [--docker-volume-size <docker-volume-size>]
                                    [--labels <KEY1=VALUE1,KEY2=VALUE2;KEY3=VALUE3...>]
                                    [--keypair <keypair>]
                                    [--master-count <master-count>]
                                    [--node-count <node-count>]
                                    [--timeout <timeout>]
                                    [--master-flavor <master-flavor>]
                                    [--flavor <flavor>]
                                    <name>
Copy to Clipboard Toggle word wrap

Expand
表 14.9. 位置参数
概述

<name>

要创建的集群的名称。

Expand
表 14.10. 可选参数
概述

--labels <KEY1=VALUE1,KEY2=VALUE2;KEY3=VALUE3…​>

以 key=valuepairs 的形式的任意标签与集群模板关联。可以多次使用。

--discovery-url <discovery-url>

为节点发现指定自定义 delivery url。

--cluster-template <cluster-template>

集群模板的 ID 或名称。

--master-flavor <master-flavor>

启动集群的主节点时要使用的 nova 类别名称或 uuid。

--timeout <timeout>

集群创建时间的超时时间。默认值为 60 分钟。

--flavor <flavor>

启动集群时要使用的 nova 类别名称或 uuid。

--master-count <master-count>

集群的 master 节点数量。

--keypair <keypair>

要使用的密钥对的 UUID 或名称。

-h, --help

显示帮助信息并退出

--docker-volume-size <docker-volume-size>

要使用的 docker 卷的大小,以 gb 为单位。

--node-count <node-count>

集群节点数。

14.6. Coe cluster delete

删除集群

使用方法:

openstack coe cluster delete [-h] <cluster> [<cluster> ...]
Copy to Clipboard Toggle word wrap

Expand
表 14.11. 位置参数
概述

<cluster>

要删除的集群的 ID 或名称。

Expand
表 14.12. 可选参数
概述

-h, --help

显示帮助信息并退出

14.7. Coe 集群列表

列出集群

使用方法:

openstack coe cluster list [-h] [-f {csv,json,table,value,yaml}]
                                  [-c COLUMN] [--max-width <integer>]
                                  [--fit-width] [--print-empty] [--noindent]
                                  [--quote {all,minimal,none,nonnumeric}]
                                  [--sort-column SORT_COLUMN]
                                  [--limit <limit>] [--sort-key <sort-key>]
                                  [--sort-dir <sort-dir>]
Copy to Clipboard Toggle word wrap

Expand
表 14.13. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 14.14. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

Expand
表 14.15. 输出格式器
概述

输出 formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

Expand
表 14.16. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 14.17. 可选参数
概述

--limit <limit>

要返回的最大集群数量

-h, --help

显示帮助信息并退出

--sort-key <sort-key>

列以按以下方式排序结果

--sort-dir <sort-dir>

划分的方向。"asc"或"desc"。

14.8. Coe cluster show

显示集群

使用方法:

openstack coe cluster show [-h] [-f {json,shell,table,value,yaml}]
                                  [-c COLUMN] [--max-width <integer>]
                                  [--fit-width] [--print-empty] [--noindent]
                                  [--prefix PREFIX]
                                  <cluster>
Copy to Clipboard Toggle word wrap

Expand
表 14.18. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 14.19. 位置参数
概述

<cluster>

要显示的集群的 ID 或名称。

Expand
表 14.20. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 14.21. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 14.22. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 14.23. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

14.9. Coe 集群模板创建

创建集群模板。

使用方法:

openstack coe cluster template create [-h]
                                             [-f {json,shell,table,value,yaml}]
                                             [-c COLUMN]
                                             [--max-width <integer>]
                                             [--fit-width] [--print-empty]
                                             [--noindent] [--prefix PREFIX]
                                             --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]
                                             <name>
Copy to Clipboard Toggle word wrap

Expand
表 14.24. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 14.25. 位置参数
概述

<name>

要创建的集群模板的名称。

Expand
表 14.26. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 14.27. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 14.28. 可选参数
概述

--master-lb-enabled

指明创建的集群是否应该具有 master 节点的负载均衡器。

--fixed-subnet <fixed-subnet>

要连接到集群的私有 neutron 子网名称。

--fixed-network <fixed-network>

要连接到此集群模型的专用 neutron 网络名称。

--https-proxy <https-proxy>

用于集群中的节点的 https_proxy 地址。

--registry-enabled

在集群中启用 Docker registry

--volume-driver <volume-driver>

用于实例化容器卷的卷驱动程序名称。

--labels <KEY1=VALUE1,KEY2=VALUE2;KEY3=VALUE3…​>

以 key=value 对的形式使用任意标签,以便与集群模板关联。可以多次使用。

--network-driver <network-driver>

用于实例化容器网络的网络驱动程序名称。

--tls-disabled

在集群中禁用 tls。

--master-flavor <master-flavor>

启动集群的主节点时要使用的 nova 类别名称或 uuid。

--floating-ip-enabled

指明创建的集群是否应该有一个浮动 ip。

-h, --help

显示帮助信息并退出

--flavor <flavor>

启动集群时要使用的 nova 类别名称或 uuid。

--image <image>

要为集群自定义的基础镜像的名称或 uuid。

--external-network <external-network>

要连接到此集群模板的外部 neutron 网络名称或 uuid。

--coe <coe>

指定要使用的容器编排引擎。

--docker-storage-driver <docker-storage-driver>

选择 docker 存储驱动程序。支持的:设备映射器、overlay。默认:设备映射器

--keypair <keypair>

要加载到集群节点的 ssh 密钥对的名称或 uuid。

--public

使集群模板变为公共模板。

--server-type <server-type>

指定要用于示例 vm. 的服务器类型,作为此发行版本的默认服务器类型将为 vm。

--http-proxy <http-proxy>

用于集群中的节点的 http_proxy 地址。

--no-proxy <no-proxy>

用于集群中的节点的 no_proxy 地址。

--docker-volume-size <docker-volume-size>

指定要使用的 docker 卷的大小(gb)。

--dns-nameserver <dns-nameserver>

用于此集群模板的 dns 名称服务器。

--floating-ip-disabled

在新集群中禁用浮动 ip create

Expand
表 14.29. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

14.10. Coe 集群模板删除

删除集群模板。

使用方法:

openstack coe cluster template delete [-h]
                                             <cluster-templates>
                                             [<cluster-templates> ...]
Copy to Clipboard Toggle word wrap

Expand
表 14.30. 位置参数
概述

<cluster-templates>

要删除的(集群模板)的 ID 或名称。

Expand
表 14.31. 可选参数
概述

-h, --help

显示帮助信息并退出

14.11. Coe 集群模板列表

列出集群模板。

使用方法:

openstack coe cluster template list [-h]
                                           [-f {csv,json,table,value,yaml}]
                                           [-c COLUMN] [--max-width <integer>]
                                           [--fit-width] [--print-empty]
                                           [--noindent]
                                           [--quote {all,minimal,none,nonnumeric}]
                                           [--sort-column SORT_COLUMN]
                                           [--limit <limit>]
                                           [--sort-key <sort-key>]
                                           [--sort-dir <sort-dir>]
                                           [--fields <fields>]
Copy to Clipboard Toggle word wrap

Expand
表 14.32. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 14.33. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

Expand
表 14.34. 输出格式器
概述

输出 formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

Expand
表 14.35. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 14.36. 可选参数
概述

--fields <fields>

要显示的字段用列表。可用字段:uuid、name、coe、image_id、public、link、apiserver_port、server_type、tls_disabled、registry_enabled

--limit <limit>

要返回的集群模板的最大数量

-h, --help

显示帮助信息并退出

--sort-key <sort-key>

列以按以下方式排序结果

--sort-dir <sort-dir>

划分的方向。"asc"或"desc"。

14.12. Coe 集群模板显示

显示集群模板。

使用方法:

openstack coe cluster template show [-h]
                                           [-f {json,shell,table,value,yaml}]
                                           [-c COLUMN] [--max-width <integer>]
                                           [--fit-width] [--print-empty]
                                           [--noindent] [--prefix PREFIX]
                                           <cluster-template>
Copy to Clipboard Toggle word wrap

Expand
表 14.37. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 14.38. 位置参数
概述

<cluster-template>

要显示的集群模板的 ID 或名称。

Expand
表 14.39. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 14.40. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 14.41. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 14.42. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

14.13. Coe 集群模板更新

更新集群模板。

使用方法:

openstack coe cluster template update [-h]
                                             [-f {json,shell,table,value,yaml}]
                                             [-c COLUMN]
                                             [--max-width <integer>]
                                             [--fit-width] [--print-empty]
                                             [--noindent] [--prefix PREFIX]
                                             <cluster-template> <op>
                                             <path=value> [<path=value> ...]
Copy to Clipboard Toggle word wrap

Expand
表 14.43. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 14.44. 位置参数
概述

<op>

操作:其中一项 添加替换或删除

<cluster-template>

要更新的集群模板的名称或 uuid

<path=value>

添加/替换或删除的属性(在删除时只需要路径)

Expand
表 14.45. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 14.46. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 14.47. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 14.48. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

14.14. Coe 集群更新

更新集群

使用方法:

openstack coe cluster update [-h] [--rollback]
                                    <cluster> <op> <path=value>
                                    [<path=value> ...]
Copy to Clipboard Toggle word wrap

Expand
表 14.49. 位置参数
概述

<cluster>

要更新的集群的名称或 uuid

<path=value>

添加/替换或删除的属性(在删除时只需要路径)

<op>

操作:其中一项 添加替换或删除

Expand
表 14.50. 可选参数
概述

--rollback

在更新失败时回滚集群。

-h, --help

显示帮助信息并退出

14.15. Coe 配额创建

创建配额。

使用方法:

openstack coe quotas create [-h] --project-id <project-id> --resource
                                   <resource> [--hard-limit <hard-limit>]
Copy to Clipboard Toggle word wrap

Expand
表 14.51. 可选参数
概述

--project-id <project-id>

项目 ID

-h, --help

显示帮助信息并退出

--hard-limit <hard-limit>

max 资源限制(默认: hard-limit=1)

--resource <resource>

资源名称。

14.16. Coe 配额删除

删除指定的资源配额。

使用方法:

openstack coe quotas delete [-h] --project-id <project-id> --resource
                                   <resource>
Copy to Clipboard Toggle word wrap

Expand
表 14.52. 可选参数
概述

--project-id <project-id>

项目 ID

-h, --help

显示帮助信息并退出

--resource <resource>

资源名称。

14.17. 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
表 14.53. 可选参数
概述

--sort-key <sort-key>

列以按.

--sort-dir <sort-dir>

划分的方向。"asc"或"desc"。

--all-tenants

用于表示列出所有租户配额的标记。

--limit <limit>

要返回的最大配额数。

-h, --help

显示帮助信息并退出

--marker <marker>

上一页面的最后一个配额 uuid;在"标记"后显示配额列表。

14.18. Coe 配额显示

显示给定项目配额的详细信息。

使用方法:

openstack coe quotas show [-h] --project-id <project-id> --resource
                                 <resource>
Copy to Clipboard Toggle word wrap

Expand
表 14.54. 可选参数
概述

--project-id <project-id>

项目 ID

-h, --help

显示帮助信息并退出

--resource <resource>

资源名称。

14.19. Coe 配额更新

更新所给项目配额的信息。

使用方法:

openstack coe quotas update [-h] --project-id <project-id> --resource
                                   <resource> [--hard-limit <hard-limit>]
Copy to Clipboard Toggle word wrap

Expand
表 14.55. 可选参数
概述

--project-id <project-id>

项目 ID

-h, --help

显示帮助信息并退出

--hard-limit <hard-limit>

max 资源限制(默认: hard-limit=1)

--resource <resource>

资源名称。

14.20. Coe 服务列表

打印 Magnum 服务列表。

使用方法:

openstack coe service list [-h] [-f {csv,json,table,value,yaml}]
                                  [-c COLUMN] [--max-width <integer>]
                                  [--fit-width] [--print-empty] [--noindent]
                                  [--quote {all,minimal,none,nonnumeric}]
                                  [--sort-column SORT_COLUMN]
Copy to Clipboard Toggle word wrap

Expand
表 14.56. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 14.57. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

Expand
表 14.58. 输出格式器
概述

输出 formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

Expand
表 14.59. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 14.60. 可选参数
概述

-h, --help

显示帮助信息并退出

14.21. Coe stats list

显示给定 project_id 的 stats

使用方法:

openstack coe stats list [-h] <project>
Copy to Clipboard Toggle word wrap

Expand
表 14.61. 位置参数
概述

<project>

项目 ID

Expand
表 14.62. 可选参数
概述

-h, --help

显示帮助信息并退出

第 15 章 命令

本章论述了命令 命令

15.1. 命令列表

按组列出可识别的命令

使用方法:

openstack command list [-h] [-f {csv,json,table,value,yaml}]
                              [-c COLUMN] [--max-width <integer>]
                              [--fit-width] [--print-empty] [--noindent]
                              [--quote {all,minimal,none,nonnumeric}]
                              [--sort-column SORT_COLUMN]
                              [--group <group-keyword>]
Copy to Clipboard Toggle word wrap

Expand
表 15.1. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 15.2. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

Expand
表 15.3. 输出格式器
概述

输出 formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

Expand
表 15.4. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 15.5. 可选参数
概述

-h, --help

显示帮助信息并退出

--group <group-keyword>

显示命令组过滤的命令,例如:身份、卷、计算、镜像、网络和其他关键字

第 16 章 complete.adoc

本章论述了 complete.adoc 命令下的命令。

16.1. complete

打印 bash completion 命令

使用方法:

openstack complete [-h] [--name <command_name>] [--shell <shell>]
Copy to Clipboard Toggle word wrap

Expand
表 16.1. 可选参数
概述

-h, --help

显示帮助信息并退出

--name <command_name>

使用命令完成支持的命令名称

--shell <shell>

使用 shell。仅将 none 用于数据(默认:bash)

第 17 章 Compute

本章论述了 compute 命令下的命令。

17.1. 计算代理创建

创建计算代理

使用方法:

openstack compute agent create [-h] [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--max-width <integer>]
                                      [--fit-width] [--print-empty]
                                      [--noindent] [--prefix PREFIX]
                                      <os> <architecture> <version> <url>
                                      <md5hash> <hypervisor>
Copy to Clipboard Toggle word wrap

Expand
表 17.1. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 17.2. 位置参数
概述

<url>

URL

<architecture>

架构的类型

<version>

版本

<hypervisor>

hypervisor 类型

<OS>

os 的类型

<md5hash>

Md5 hash

Expand
表 17.3. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 17.4. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 17.5. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 17.6. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

17.2. 计算代理删除

删除计算代理

使用方法:

openstack compute agent delete [-h] <id> [<id> ...]
Copy to Clipboard Toggle word wrap

Expand
表 17.7. 位置参数
概述

<id>

要删除的代理 ID

Expand
表 17.8. 可选参数
概述

-h, --help

显示帮助信息并退出

17.3. 计算代理列表

列出计算代理

使用方法:

openstack compute agent list [-h] [-f {csv,json,table,value,yaml}]
                                    [-c COLUMN] [--max-width <integer>]
                                    [--fit-width] [--print-empty] [--noindent]
                                    [--quote {all,minimal,none,nonnumeric}]
                                    [--sort-column SORT_COLUMN]
                                    [--hypervisor <hypervisor>]
Copy to Clipboard Toggle word wrap

Expand
表 17.9. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 17.10. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

Expand
表 17.11. 输出格式器
概述

输出 formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

Expand
表 17.12. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 17.13. 可选参数
概述

-h, --help

显示帮助信息并退出

--hypervisor <hypervisor>

hypervisor 类型

17.4. 计算代理集

设置计算代理属性

使用方法:

openstack compute agent set [-h] [--agent-version <version>]
                                   [--url <url>] [--md5hash <md5hash>]
                                   <id>
Copy to Clipboard Toggle word wrap

Expand
表 17.14. 位置参数
概述

<id>

代理 ID

Expand
表 17.15. 可选参数
概述

--agent-version <version>

代理的版本

-h, --help

显示帮助信息并退出

--md5hash <md5hash>

代理的 Md5 哈希

--url <url>

代理的 URL

17.5. 计算服务删除

删除计算服务

使用方法:

openstack compute service delete [-h] <service> [<service> ...]
Copy to Clipboard Toggle word wrap

Expand
表 17.16. 位置参数
概述

<service>

要删除的计算服务(仅限 ID)

Expand
表 17.17. 可选参数
概述

-h, --help

显示帮助信息并退出

17.6. 计算服务列表

列出计算服务

使用方法:

openstack compute service list [-h] [-f {csv,json,table,value,yaml}]
                                      [-c COLUMN] [--max-width <integer>]
                                      [--fit-width] [--print-empty]
                                      [--noindent]
                                      [--quote {all,minimal,none,nonnumeric}]
                                      [--sort-column SORT_COLUMN]
                                      [--host <host>] [--service <service>]
                                      [--long]
Copy to Clipboard Toggle word wrap

Expand
表 17.18. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 17.19. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

Expand
表 17.20. 输出格式器
概述

输出 formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

Expand
表 17.21. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 17.22. 可选参数
概述

-h, --help

显示帮助信息并退出

--host <host>

列出指定主机上的服务(仅限名称)

--long

列出输出中的其他字段

--service <service>

仅列出指定的服务(仅限名称)

17.7. 计算服务集

设置计算服务属性

使用方法:

openstack compute service set [-h] [--enable | --disable]
                                     [--disable-reason <reason>]
                                     [--up | --down]
                                     <host> <service>
Copy to Clipboard Toggle word wrap

Expand
表 17.23. 位置参数
概述

<service>

服务的名称(二进制名称)

<host>

主机的名称

Expand
表 17.24. 可选参数
概述

--enable

启用服务

--disable-reason <reason>

禁用服务的原因(在引号中)。应该与 --disable 选项一起使用。

--down

强制关闭服务

--up

强制服务

-h, --help

显示帮助信息并退出

--disable

禁用服务

第 18 章 配置

本章论述了 配置 命令下的命令。

18.1. 配置显示

显示配置详情

使用方法:

openstack configuration show [-h] [-f {json,shell,table,value,yaml}]
                                    [-c COLUMN] [--max-width <integer>]
                                    [--fit-width] [--print-empty] [--noindent]
                                    [--prefix PREFIX] [--mask | --unmask]
Copy to Clipboard Toggle word wrap

Expand
表 18.1. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 18.2. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 18.3. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 18.4. 可选参数
概述

-h, --help

显示帮助信息并退出

--unmask

以明文显示密码

--mask

尝试屏蔽密码(默认)

Expand
表 18.5. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

第 19 章 一致性

本章论述了 consistency 命令下的命令。

19.1. 致性组添加卷

添加卷以一致性组

使用方法:

openstack consistency group add volume [-h]
                                              <consistency-group> <volume>
                                              [<volume> ...]
Copy to Clipboard Toggle word wrap

Expand
表 19.1. 位置参数
概述

<volume>

要添加到 <consistency-group> (名称或 id)的卷(重复选项来添加多个卷)

<consistency-group>

包含 <volume> (名称或 ID)的一致性组

Expand
表 19.2. 可选参数
概述

-h, --help

显示帮助信息并退出

19.2. 一致性组创建

创建新的一致性组。

使用方法:

openstack consistency group create [-h]
                                          [-f {json,shell,table,value,yaml}]
                                          [-c COLUMN] [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          [--noindent] [--prefix PREFIX]
                                          (--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
表 19.3. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 19.4. 位置参数
概述

<name>

新一致性组名称(默认为 none)

Expand
表 19.5. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 19.6. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 19.7. 可选参数
概述

--availability-zone <availability-zone>

此一致性组的可用性区域(如果从源创建一致性组时)

--consistency-group-snapshot <consistency-group-snapshot>

现有一致性组快照(名称或 id)

--consistency-group-source <consistency-group>

现有一致性组(名称或 id)

-h, --help

显示帮助信息并退出

--description <description>

此一致性组的描述

--volume-type <volume-type>

此一致性组的卷类型(name 或 id)

Expand
表 19.8. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

19.3. 致性组删除

删除一致性组。

使用方法:

openstack consistency group delete [-h] [--force]
                                          <consistency-group>
                                          [<consistency-group> ...]
Copy to Clipboard Toggle word wrap

Expand
表 19.9. 位置参数
概述

<consistency-group>

删除的一致性组(名称或 ID)

Expand
表 19.10. 可选参数
概述

--force

允许以错误或可用状态以外的状态删除

-h, --help

显示帮助信息并退出

19.4. 一致性组列表

列出一致性组。

使用方法:

openstack consistency group list [-h] [-f {csv,json,table,value,yaml}]
                                        [-c COLUMN] [--max-width <integer>]
                                        [--fit-width] [--print-empty]
                                        [--noindent]
                                        [--quote {all,minimal,none,nonnumeric}]
                                        [--sort-column SORT_COLUMN]
                                        [--all-projects] [--long]
Copy to Clipboard Toggle word wrap

Expand
表 19.11. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 19.12. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

Expand
表 19.13. 输出格式器
概述

输出 formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

Expand
表 19.14. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 19.15. 可选参数
概述

--all-projects

显示所有项目的详细信息。仅 admin。(默认为 False)

-h, --help

显示帮助信息并退出

--long

列出输出中的其他字段

19.5. 致性组删除卷

从一致性组中删除卷

使用方法:

openstack consistency group remove volume [-h]
                                                 <consistency-group> <volume>
                                                 [<volume> ...]
Copy to Clipboard Toggle word wrap

Expand
表 19.16. 位置参数
概述

<volume>

从 <consistency-group> (名称或 ID)中删除的卷(用于移除多个卷)

<consistency-group>

包含 <volume> (名称或 ID)的一致性组

Expand
表 19.17. 可选参数
概述

-h, --help

显示帮助信息并退出

19.6. 致性组集

设置一致性组属性

使用方法:

openstack consistency group set [-h] [--name <name>]
                                       [--description <description>]
                                       <consistency-group>
Copy to Clipboard Toggle word wrap

Expand
表 19.18. 位置参数
概述

<consistency-group>

致性组进行修改(名称或 ID)

Expand
表 19.19. 可选参数
概述

--name <name>

新的一致性组名称

-h, --help

显示帮助信息并退出

--description <description>

新的一致性组描述

19.7. 致性组显示

显示一致性组详细信息。

使用方法:

openstack consistency group show [-h]
                                        [-f {json,shell,table,value,yaml}]
                                        [-c COLUMN] [--max-width <integer>]
                                        [--fit-width] [--print-empty]
                                        [--noindent] [--prefix PREFIX]
                                        <consistency-group>
Copy to Clipboard Toggle word wrap

Expand
表 19.20. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 19.21. 位置参数
概述

<consistency-group>

要显示的一致性组(名称或 id)

Expand
表 19.22. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 19.23. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 19.24. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 19.25. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

19.8. 一致性组快照创建

创建新的一致性组快照。

使用方法:

openstack consistency group snapshot create [-h]
                                                   [-f {json,shell,table,value,yaml}]
                                                   [-c COLUMN]
                                                   [--max-width <integer>]
                                                   [--fit-width]
                                                   [--print-empty]
                                                   [--noindent]
                                                   [--prefix PREFIX]
                                                   [--consistency-group <consistency-group>]
                                                   [--description <description>]
                                                   [<snapshot-name>]
Copy to Clipboard Toggle word wrap

Expand
表 19.26. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 19.27. 位置参数
概述

<snapshot-name>

新一致性组快照的名称(默认为 None)

Expand
表 19.28. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 19.29. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 19.30. 可选参数
概述

-h, --help

显示帮助信息并退出

--consistency-group <consistency-group>

一致性到快照(名称或 id)的组(默认为与 <snapshot-name> 相同)

--description <description>

此一致性组快照的描述

Expand
表 19.31. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

19.9. 致组快照删除

<consistency-group-snapshot>
[<consistency-group-snapshot> ...]
Copy to Clipboard Toggle word wrap

删除一致性组快照。

使用方法:

openstack consistency group snapshot delete [-h]
Copy to Clipboard Toggle word wrap

Expand
表 19.32. 位置参数
概述

<consistency-group-snapshot>

删除的一致性组快照(名称或 ID)

Expand
表 19.33. 可选参数
概述

-h, --help

显示帮助信息并退出

19.10. 一致性组快照列表

列出一致性组快照。

使用方法:

openstack consistency group snapshot list [-h]
                                                 [-f {csv,json,table,value,yaml}]
                                                 [-c COLUMN]
                                                 [--max-width <integer>]
                                                 [--fit-width] [--print-empty]
                                                 [--noindent]
                                                 [--quote {all,minimal,none,nonnumeric}]
                                                 [--sort-column SORT_COLUMN]
                                                 [--all-projects] [--long]
                                                 [--status <status>]
                                                 [--consistency-group <consistency-group>]
Copy to Clipboard Toggle word wrap

Expand
表 19.34. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 19.35. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

Expand
表 19.36. 输出格式器
概述

输出 formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

Expand
表 19.37. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 19.38. 可选参数
概述

--all-projects

显示所有项目(仅管理员)的详细信息(默认为 False)

--status <status>

按状态("可用"、"error"、"reating"、"deleting"或 "error_deleting" 来过滤结果。

-h, --help

显示帮助信息并退出

--consistency-group <consistency-group>

按一致性组(名称或 ID)过滤结果

--long

列出输出中的其他字段

19.11. 一致性组快照显示

显示一致性组快照详情

使用方法:

openstack consistency group snapshot show [-h]
                                                 [-f {json,shell,table,value,yaml}]
                                                 [-c COLUMN]
                                                 [--max-width <integer>]
                                                 [--fit-width] [--print-empty]
                                                 [--noindent]
                                                 [--prefix PREFIX]
                                                 <consistency-group-snapshot>
Copy to Clipboard Toggle word wrap

Expand
表 19.39. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 19.40. 位置参数
概述

<consistency-group-snapshot>

以显示一致性组快照(名称或 ID)

Expand
表 19.41. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 19.42. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 19.43. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 19.44. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

第 20 章 控制台

本章论述了 console 命令下的命令。

20.1. 控制台日志显示

显示服务器的控制台输出

使用方法:

openstack console log show [-h] [--lines <num-lines>] <server>
Copy to Clipboard Toggle word wrap

Expand
表 20.1. 位置参数
概述

<server>

服务器以显示控制台日志(名称或 id)

Expand
表 20.2. 可选参数
概述

--lines <num-lines>

日志末尾显示的行数(默认=all)

-h, --help

显示帮助信息并退出

20.2. 控制台 url 显示

显示服务器的远程控制台 URL

使用方法:

openstack console url show [-h] [-f {json,shell,table,value,yaml}]
                                  [-c COLUMN] [--max-width <integer>]
                                  [--fit-width] [--print-empty] [--noindent]
                                  [--prefix PREFIX]
                                  [--novnc | --xvpvnc | --spice | --rdp | --serial | --mks]
                                  <server>
Copy to Clipboard Toggle word wrap

Expand
表 20.3. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 20.4. 位置参数
概述

<server>

服务器显示 url (名称或 id)

Expand
表 20.5. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 20.6. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 20.7. 可选参数
概述

--mks

显示 webmks 控制台 url

--novnc

显示 novnc 控制台 url (默认)

--xvpvnc

显示 xvpvnc 控制台 url

--rdp

显示 rdp 控制台 url

--spice

显示 spice 控制台 url

-h, --help

显示帮助信息并退出

--serial

显示串行控制台 url

Expand
表 20.8. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

第 21 章 container

本章论述了容器命令下的命令。

21.1. 容器创建

创建新容器

使用方法:

openstack container create [-h] [-f {csv,json,table,value,yaml}]
                                  [-c COLUMN] [--max-width <integer>]
                                  [--fit-width] [--print-empty] [--noindent]
                                  [--quote {all,minimal,none,nonnumeric}]
                                  [--sort-column SORT_COLUMN]
                                  <container-name> [<container-name> ...]
Copy to Clipboard Toggle word wrap

Expand
表 21.1. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 21.2. 位置参数
概述

<container-name>

新容器名称

Expand
表 21.3. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

Expand
表 21.4. 输出格式器
概述

输出 formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

Expand
表 21.5. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 21.6. 可选参数
概述

-h, --help

显示帮助信息并退出

21.2. 容器删除

删除容器

使用方法:

openstack container delete [-h] [--recursive]
                                  <container> [<container> ...]
Copy to Clipboard Toggle word wrap

Expand
表 21.7. 位置参数
概述

<Container>

要删除的容器

Expand
表 21.8. 可选参数
概述

-h, --help

显示帮助信息并退出

--recursive, -r

递归删除对象和容器

21.3. 容器列表

列出容器

使用方法:

openstack container list [-h] [-f {csv,json,table,value,yaml}]
                                [-c COLUMN] [--max-width <integer>]
                                [--fit-width] [--print-empty] [--noindent]
                                [--quote {all,minimal,none,nonnumeric}]
                                [--sort-column SORT_COLUMN]
                                [--prefix <prefix>] [--marker <marker>]
                                [--end-marker <end-marker>]
                                [--limit <num-containers>] [--long] [--all]
Copy to Clipboard Toggle word wrap

Expand
表 21.9. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 21.10. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

Expand
表 21.11. 输出格式器
概述

输出 formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

Expand
表 21.12. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 21.13. 可选参数
概述

--limit <num-containers>

限制返回的容器数量

--marker <marker>

用于分页的定位符

--long

列出输出中的其他字段

--end-marker <end-marker>

结束用于分页的定位符

-h, --help

显示帮助信息并退出

--prefix <prefix>

使用 <prefix> 过滤列表

--all

列出所有容器(默认为 10000)

21.4. 容器保存

本地保存容器内容

使用方法:

openstack container save [-h] <container>
Copy to Clipboard Toggle word wrap

Expand
表 21.14. 位置参数
概述

<Container>

要保存的容器

Expand
表 21.15. 可选参数
概述

-h, --help

显示帮助信息并退出

21.5. 容器集

设置容器属性

使用方法:

openstack container set [-h] --property <key=value> <container>
Copy to Clipboard Toggle word wrap

Expand
表 21.16. 位置参数
概述

<Container>

修改容器

Expand
表 21.17. 可选参数
概述

-h, --help

显示帮助信息并退出

--property <key=value>

在此容器上设置属性(重复选项以设置多个属性)

21.6. 容器显示

显示容器详情

使用方法:

openstack container show [-h] [-f {json,shell,table,value,yaml}]
                                [-c COLUMN] [--max-width <integer>]
                                [--fit-width] [--print-empty] [--noindent]
                                [--prefix PREFIX]
                                <container>
Copy to Clipboard Toggle word wrap

Expand
表 21.18. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 21.19. 位置参数
概述

<Container>

显示的容器

Expand
表 21.20. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 21.21. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 21.22. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 21.23. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

21.7. Container unset

取消设置容器属性

使用方法:

openstack container unset [-h] --property <key> <container>
Copy to Clipboard Toggle word wrap

Expand
表 21.24. 位置参数
概述

<Container>

修改容器

Expand
表 21.25. 可选参数
概述

--property <key>

从容器中删除属性(重复选项以删除多个属性)

-h, --help

显示帮助信息并退出

第 22 章 cron

本章论述了 cron 命令下的命令。

22.1. Cron trigger create

创建新触发器。

使用方法:

openstack cron trigger create [-h] [-f {json,shell,table,value,yaml}]
                                     [-c COLUMN] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--noindent] [--prefix PREFIX]
                                     [--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
表 22.1. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 22.2. 位置参数
概述

workflow_input

工作流输入

workflow_identifier

工作流名称或 id

name

Cron trigger name

Expand
表 22.3. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 22.4. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 22.5. 可选参数
概述

--count <integer>

想要执行的数量

--first-time <YYYY-MM-DD HH:MM>

首次执行的日期和时间。除非也指定了 --utc,否则时间被视为本地时间

--params PARAMS

工作流参数

--utc

指定的所有时间都应视为 utc

-h, --help

显示帮助信息并退出

--pattern <* * * * *>

cron 触发器模式

Expand
表 22.6. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

22.2. Cron trigger delete

删除触发器。

使用方法:

openstack cron trigger delete [-h] cron_trigger [cron_trigger ...]
Copy to Clipboard Toggle word wrap

Expand
表 22.7. 位置参数
概述

cron_trigger

cron trigger 的名称。

Expand
表 22.8. 可选参数
概述

-h, --help

显示帮助信息并退出

22.3. Cron trigger list

列出所有 cron 触发器。

使用方法:

openstack cron trigger list [-h] [-f {csv,json,table,value,yaml}]
                                   [-c COLUMN] [--max-width <integer>]
                                   [--fit-width] [--print-empty] [--noindent]
                                   [--quote {all,minimal,none,nonnumeric}]
                                   [--sort-column SORT_COLUMN]
Copy to Clipboard Toggle word wrap

Expand
表 22.9. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 22.10. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

Expand
表 22.11. 输出格式器
概述

输出 formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

Expand
表 22.12. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 22.13. 可选参数
概述

-h, --help

显示帮助信息并退出

22.4. Cron trigger show

显示特定的 cron 触发器。

使用方法:

openstack cron trigger show [-h] [-f {json,shell,table,value,yaml}]
                                   [-c COLUMN] [--max-width <integer>]
                                   [--fit-width] [--print-empty] [--noindent]
                                   [--prefix PREFIX]
                                   cron_trigger
Copy to Clipboard Toggle word wrap

Expand
表 22.14. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 22.15. 位置参数
概述

cron_trigger

Cron trigger name

Expand
表 22.16. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 22.17. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 22.18. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 22.19. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

第 23 章 datastore

本章论述了 数据存储 命令中的命令。

23.1. 数据存储列表

列出可用的数据存储

使用方法:

openstack datastore list [-h] [-f {csv,json,table,value,yaml}]
                                [-c COLUMN] [--max-width <integer>]
                                [--fit-width] [--print-empty] [--noindent]
                                [--quote {all,minimal,none,nonnumeric}]
                                [--sort-column SORT_COLUMN]
Copy to Clipboard Toggle word wrap

Expand
表 23.1. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 23.2. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

Expand
表 23.3. 输出格式器
概述

输出 formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

Expand
表 23.4. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 23.5. 可选参数
概述

-h, --help

显示帮助信息并退出

23.2. 数据存储显示

显示数据存储详情

使用方法:

openstack datastore show [-h] [-f {json,shell,table,value,yaml}]
                                [-c COLUMN] [--max-width <integer>]
                                [--fit-width] [--print-empty] [--noindent]
                                [--prefix PREFIX]
                                <datastore>
Copy to Clipboard Toggle word wrap

Expand
表 23.6. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 23.7. 位置参数
概述

<datastore>

数据存储的 ID

Expand
表 23.8. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 23.9. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 23.10. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 23.11. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

23.3. Datastore 版本列表

列出数据存储的可用版本

使用方法:

openstack datastore version list [-h] [-f {csv,json,table,value,yaml}]
                                        [-c COLUMN] [--max-width <integer>]
                                        [--fit-width] [--print-empty]
                                        [--noindent]
                                        [--quote {all,minimal,none,nonnumeric}]
                                        [--sort-column SORT_COLUMN]
                                        <datastore>
Copy to Clipboard Toggle word wrap

Expand
表 23.12. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 23.13. 位置参数
概述

<datastore>

数据存储的 ID 或名称

Expand
表 23.14. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

Expand
表 23.15. 输出格式器
概述

输出 formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

Expand
表 23.16. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 23.17. 可选参数
概述

-h, --help

显示帮助信息并退出

23.4. Datastore 版本显示

显示数据存储版本的详细信息。

使用方法:

openstack datastore version show [-h]
                                        [-f {json,shell,table,value,yaml}]
                                        [-c COLUMN] [--max-width <integer>]
                                        [--fit-width] [--print-empty]
                                        [--noindent] [--prefix PREFIX]
                                        [--datastore <datastore>]
                                        <datastore_version>
Copy to Clipboard Toggle word wrap

Expand
表 23.18. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 23.19. 位置参数
概述

<datastore_version>

数据存储版本的 ID 或名称。

Expand
表 23.20. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 23.21. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 23.22. 可选参数
概述

-h, --help

显示帮助信息并退出

--datastore <datastore>

数据存储的 ID 或名称。如果提供了 datastore_version 的 id,则可选。

Expand
表 23.23. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

第 24 章 dns

本章论述了 dns 命令下的命令。

24.1. DNS 配额列表

列出配额

使用方法:

openstack dns quota list [-h] [-f {json,shell,table,value,yaml}]
                                [-c COLUMN] [--max-width <integer>]
                                [--fit-width] [--print-empty] [--noindent]
                                [--prefix PREFIX] [--all-projects]
                                [--edit-managed]
                                [--sudo-project-id SUDO_PROJECT_ID]
                                [--project-id PROJECT_ID]
Copy to Clipboard Toggle word wrap

Expand
表 24.1. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 24.2. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 24.3. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 24.4. 可选参数
概述

--all-projects

显示所有项目的结果。default: false

--project-id PROJECT_ID

项目 ID default:当前项目

-h, --help

显示帮助信息并退出

--edit-managed

编辑标记为 managed. default: false的资源

--sudo-project-id SUDO_PROJECT_ID

这个命令的模拟项目 ID。default: None

Expand
表 24.5. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

24.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
表 24.6. 可选参数
概述

--all-projects

显示所有项目的结果。default: false

--project-id PROJECT_ID

项目 ID

-h, --help

显示帮助信息并退出

--edit-managed

编辑标记为 managed. default: false的资源

--sudo-project-id SUDO_PROJECT_ID

这个命令的模拟项目 ID。default: None

24.3. DNS 配额集

设置黑名单属性

使用方法:

openstack dns quota set [-h] [-f {json,shell,table,value,yaml}]
                               [-c COLUMN] [--max-width <integer>]
                               [--fit-width] [--print-empty] [--noindent]
                               [--prefix PREFIX] [--all-projects]
                               [--edit-managed]
                               [--sudo-project-id SUDO_PROJECT_ID]
                               [--project-id PROJECT_ID]
                               [--api-export-size <api-export-size>]
                               [--zones <zones>]
                               [--recordset-records <recordset-records>]
                               [--zone-records <zone-records>]
                               [--zone-recordsets <zone-recordsets>]
Copy to Clipboard Toggle word wrap

Expand
表 24.7. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 24.8. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 24.9. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 24.10. 可选参数
概述

--project-id PROJECT_ID

项目 ID

--edit-managed

编辑标记为 managed. default: false的资源

--api-export-size <api-export-size>

api-export-size 配额的新值

--sudo-project-id SUDO_PROJECT_ID

这个命令的模拟项目 ID。default: None

--all-projects

显示所有项目的结果。default: false

--zone-recordsets <zone-recordsets>

zone-recordsets 配额的新值

--zone-records <zone-records>

zone-records 配额的新值

-h, --help

显示帮助信息并退出

--recordset-records <recordset-records>

recordset-records 配额的新值

--zones <zones>

zone 配额的新值

Expand
表 24.11. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

24.4. DNS 服务列表

列出服务状态

使用方法:

openstack dns service list [-h] [-f {csv,json,table,value,yaml}]
                                  [-c COLUMN] [--max-width <integer>]
                                  [--fit-width] [--print-empty] [--noindent]
                                  [--quote {all,minimal,none,nonnumeric}]
                                  [--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
表 24.12. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 24.13. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

Expand
表 24.14. 输出格式器
概述

输出 formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

Expand
表 24.15. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 24.16. 可选参数
概述

--edit-managed

编辑标记为 managed. default: false的资源

--sudo-project-id SUDO_PROJECT_ID

这个命令的模拟项目 ID。default: None

--all-projects

显示所有项目的结果。default: false

--service_name SERVICE_NAME

服务名称

--hostname HOSTNAME

Hostname

--status STATUS

状态

-h, --help

显示帮助信息并退出

24.5. DNS 服务显示

显示服务状态详情

使用方法:

openstack dns service show [-h] [-f {json,shell,table,value,yaml}]
                                  [-c COLUMN] [--max-width <integer>]
                                  [--fit-width] [--print-empty] [--noindent]
                                  [--prefix PREFIX] [--all-projects]
                                  [--edit-managed]
                                  [--sudo-project-id SUDO_PROJECT_ID]
                                  id
Copy to Clipboard Toggle word wrap

Expand
表 24.17. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 24.18. 位置参数
概述

id

服务状态 ID

Expand
表 24.19. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 24.20. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 24.21. 可选参数
概述

--all-projects

显示所有项目的结果。default: false

-h, --help

显示帮助信息并退出

--edit-managed

编辑标记为 managed. default: false的资源

--sudo-project-id SUDO_PROJECT_ID

这个命令的模拟项目 ID。default: None

Expand
表 24.22. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

第 25 章 ec2

本章论述了 ec2 命令下的命令。

25.1. ec2 凭证创建

创建 EC2 凭证

使用方法:

openstack ec2 credentials create [-h]
                                        [-f {json,shell,table,value,yaml}]
                                        [-c COLUMN] [--max-width <integer>]
                                        [--fit-width] [--print-empty]
                                        [--noindent] [--prefix PREFIX]
                                        [--project <project>] [--user <user>]
Copy to Clipboard Toggle word wrap

Expand
表 25.1. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 25.2. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 25.3. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 25.4. 可选参数
概述

--user <user>

为用户创建凭证(name 或 id;默认:当前经过身份验证的用户)

-h, --help

显示帮助信息并退出

--project <project>

在项目中创建凭证(名称或 id;默认:当前经过身份验证的用户项目)

Expand
表 25.5. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

25.2. ec2 凭证删除

删除 EC2 凭证

使用方法:

openstack ec2 credentials delete [-h] [--user <user>]
                                        <access-key> [<access-key> ...]
Copy to Clipboard Toggle word wrap

Expand
表 25.6. 位置参数
概述

<access-key>

凭证访问密钥

Expand
表 25.7. 可选参数
概述

--user <user>

删除用户的凭证(名称或 id)

-h, --help

显示帮助信息并退出

25.3. ec2 凭证列表

列出 EC2 凭证

使用方法:

openstack ec2 credentials list [-h] [-f {csv,json,table,value,yaml}]
                                      [-c COLUMN] [--max-width <integer>]
                                      [--fit-width] [--print-empty]
                                      [--noindent]
                                      [--quote {all,minimal,none,nonnumeric}]
                                      [--sort-column SORT_COLUMN]
                                      [--user <user>]
Copy to Clipboard Toggle word wrap

Expand
表 25.8. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 25.9. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

Expand
表 25.10. 输出格式器
概述

输出 formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

Expand
表 25.11. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 25.12. 可选参数
概述

--user <user>

按用户(名称或 ID)过滤列表

-h, --help

显示帮助信息并退出

25.4. ec2 凭证显示

显示 EC2 凭证详情

使用方法:

openstack ec2 credentials show [-h] [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--max-width <integer>]
                                      [--fit-width] [--print-empty]
                                      [--noindent] [--prefix PREFIX]
                                      [--user <user>]
                                      <access-key>
Copy to Clipboard Toggle word wrap

Expand
表 25.13. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 25.14. 位置参数
概述

<access-key>

凭证访问密钥

Expand
表 25.15. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 25.16. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 25.17. 可选参数
概述

--user <user>

显示用户凭证(名称或 id)

-h, --help

显示帮助信息并退出

Expand
表 25.18. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

第 26 章 端点

本章论述了 endpoint 命令下的命令。

26.1. 端点创建

创建新端点

使用方法:

openstack endpoint create [-h] [-f {json,shell,table,value,yaml}]
                                 [-c COLUMN] [--max-width <integer>]
                                 [--fit-width] [--print-empty] [--noindent]
                                 [--prefix PREFIX] --publicurl <url>
                                 [--adminurl <url>] [--internalurl <url>]
                                 [--region <region-id>]
                                 <service>
Copy to Clipboard Toggle word wrap

Expand
表 26.1. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 26.2. 位置参数
概述

<service>

要与新端点关联的服务(名称或 ID)

Expand
表 26.3. 输出格式器
概述

output formatter options-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. 可选参数
概述

-h, --help

显示帮助信息并退出

--region <region-id>

新端点区域 ID

--internalurl <url>

新端点内部 url

--publicurl <url>

新端点公共 url (必需)

--adminurl <url>

新端点 admin url

Expand
表 26.6. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

26.2. 端点删除

删除端点

使用方法:

openstack endpoint delete [-h] <endpoint-id> [<endpoint-id> ...]
Copy to Clipboard Toggle word wrap

Expand
表 26.7. 位置参数
概述

<endpoint-id>

要删除的端点(仅限 ID)

Expand
表 26.8. 可选参数
概述

-h, --help

显示帮助信息并退出

26.3. 端点列表

列出端点

使用方法:

openstack endpoint list [-h] [-f {csv,json,table,value,yaml}]
                               [-c COLUMN] [--max-width <integer>]
                               [--fit-width] [--print-empty] [--noindent]
                               [--quote {all,minimal,none,nonnumeric}]
                               [--sort-column SORT_COLUMN] [--long]
Copy to Clipboard Toggle word wrap

Expand
表 26.9. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 26.10. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

Expand
表 26.11. 输出格式器
概述

输出 formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

Expand
表 26.12. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 26.13. 可选参数
概述

-h, --help

显示帮助信息并退出

--long

列出输出中的其他字段

26.4. 端点显示

显示端点详情

使用方法:

openstack endpoint show [-h] [-f {json,shell,table,value,yaml}]
                               [-c COLUMN] [--max-width <integer>]
                               [--fit-width] [--print-empty] [--noindent]
                               [--prefix PREFIX]
                               <endpoint>
Copy to Clipboard Toggle word wrap

Expand
表 26.14. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 26.15. 位置参数
概述

<endpoint>

要显示的端点(endpoint id、服务 id、服务名称、服务类型)

Expand
表 26.16. 输出格式器
概述

output formatter options-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. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 26.19. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

第 27 章 event

本章论述了 事件 命令下的命令。

27.1. 事件触发器创建

创建新触发器。

使用方法:

openstack event trigger create [-h] [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--max-width <integer>]
                                      [--fit-width] [--print-empty]
                                      [--noindent] [--prefix PREFIX]
                                      [--params PARAMS]
                                      name workflow_id exchange topic event
                                      [workflow_input]
Copy to Clipboard Toggle word wrap

Expand
表 27.1. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 27.2. 位置参数
概述

workflow_input

工作流输入

name

事件触发器名称

Exchange

事件触发器交换

topic

事件触发器主题

workflow_id

工作流 ID

event

事件触发器事件名称

Expand
表 27.3. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 27.4. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 27.5. 可选参数
概述

--params PARAMS

工作流参数

-h, --help

显示帮助信息并退出

Expand
表 27.6. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

27.2. event trigger delete

删除触发器。

使用方法:

openstack event trigger delete [-h]
                                      event_trigger_id [event_trigger_id ...]
Copy to Clipboard Toggle word wrap

Expand
表 27.7. 位置参数
概述

event_trigger_id

事件触发器的 ID。

Expand
表 27.8. 可选参数
概述

-h, --help

显示帮助信息并退出

27.3. 事件触发器列表

列出所有事件触发器。

使用方法:

openstack event trigger list [-h] [-f {csv,json,table,value,yaml}]
                                    [-c COLUMN] [--max-width <integer>]
                                    [--fit-width] [--print-empty] [--noindent]
                                    [--quote {all,minimal,none,nonnumeric}]
                                    [--sort-column SORT_COLUMN]
Copy to Clipboard Toggle word wrap

Expand
表 27.9. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 27.10. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

Expand
表 27.11. 输出格式器
概述

输出 formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

Expand
表 27.12. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 27.13. 可选参数
概述

-h, --help

显示帮助信息并退出

27.4. 事件触发器显示

显示特定事件触发器。

使用方法:

openstack event trigger show [-h] [-f {json,shell,table,value,yaml}]
                                    [-c COLUMN] [--max-width <integer>]
                                    [--fit-width] [--print-empty] [--noindent]
                                    [--prefix PREFIX]
                                    event_trigger
Copy to Clipboard Toggle word wrap

Expand
表 27.14. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 27.15. 位置参数
概述

event_trigger

事件触发器 ID

Expand
表 27.16. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 27.17. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 27.18. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 27.19. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

第 28 章 扩展

本章论述了 扩展 命令下的命令。

28.1. 扩展列表

列出 API 扩展

使用方法:

openstack extension list [-h] [-f {csv,json,table,value,yaml}]
                                [-c COLUMN] [--max-width <integer>]
                                [--fit-width] [--print-empty] [--noindent]
                                [--quote {all,minimal,none,nonnumeric}]
                                [--sort-column SORT_COLUMN] [--compute]
                                [--identity] [--network] [--volume] [--long]
Copy to Clipboard Toggle word wrap

Expand
表 28.1. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 28.2. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

Expand
表 28.3. 输出格式器
概述

输出 formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

Expand
表 28.4. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 28.5. 可选参数
概述

--compute

列出 compute api 的扩展

--long

列出输出中的其他字段

--volume

列出块存储 api 的扩展

-h, --help

显示帮助信息并退出

--network

列出网络 api 的扩展

--identity

列出身份 api 的扩展

28.2. 扩展显示

显示 API 扩展

使用方法:

openstack extension show [-h] [-f {json,shell,table,value,yaml}]
                                [-c COLUMN] [--max-width <integer>]
                                [--fit-width] [--print-empty] [--noindent]
                                [--prefix PREFIX]
                                <extension>
Copy to Clipboard Toggle word wrap

Expand
表 28.6. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 28.7. 位置参数
概述

<bx id="1" />

可以扩展到当前显示,当前只支持网络扩展。(名称或别名)

Expand
表 28.8. 输出格式器
概述

output formatter options-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. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 28.11. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

第 29 章 firewall

本章论述了 firewall 命令下的命令。

29.1. firewall group create

创建新的防火墙组

使用方法:

openstack firewall group create [-h] [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--max-width <integer>]
                                       [--fit-width] [--print-empty]
                                       [--noindent] [--prefix PREFIX]
                                       [--name NAME]
                                       [--description <description>]
                                       [--ingress-firewall-policy <ingress-firewall-policy> | --no-ingress-firewall-policy]
                                       [--egress-firewall-policy <egress-firewall-policy> | --no-egress-firewall-policy]
                                       [--public | --private | --share | --no-share]
                                       [--enable | --disable]
                                       [--project <project>]
                                       [--project-domain <project-domain>]
                                       [--port <port> | --no-port]
Copy to Clipboard Toggle word wrap

Expand
表 29.1. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 29.2. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 29.3. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 29.4. 可选参数
概述

--share

共享要在所有项目中使用的防火墙组(默认情况下,限制当前项目使用)。

--no-port

从防火墙组分离所有端口

--disable

禁用防火墙组

--public

使防火墙组 public,允许它在所有项目中使用(而不是默认值),这是限制其对当前项目的使用。这个选项已弃用,并将在以后的发行版本中删除。

--no-egress-firewall-policy

从防火墙组分离出口防火墙策略

--enable

启用防火墙组

--project-domain <project-domain>

项目所属的域(名称或 id)。这可在项目名称之间有冲突时使用。

--egress-firewall-policy <egress-firewall-policy>

出口防火墙策略(名称或 id)

--project <project>

所有者的项目(名称或 id)

--no-share

将防火墙组的使用限制为当前项目

--no-ingress-firewall-policy

从防火墙组分离入口防火墙策略

--private

将防火墙组的使用限制为当前项目。这个选项已弃用,并将在以后的发行版本中删除。

--port <port>

要应用防火墙组的端口(名称或 id)。可以重复此选项

--name NAME

防火墙组的名称

-h, --help

显示帮助信息并退出

--description <description>

firewall 组的描述

--ingress-firewall-policy <ingress-firewall-policy>

Ingress 防火墙策略(名称或 id)

Expand
表 29.5. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

29.2. firewall group delete

删除防火墙组

使用方法:

openstack firewall group delete [-h]
                                       <firewall-group> [<firewall-group> ...]
Copy to Clipboard Toggle word wrap

Expand
表 29.6. 位置参数
概述

<firewall-group>

要删除的防火墙组(名称或 ID)

Expand
表 29.7. 可选参数
概述

-h, --help

显示帮助信息并退出

29.3. 防火墙组列表

列出防火墙组

使用方法:

openstack firewall group list [-h] [-f {csv,json,table,value,yaml}]
                                     [-c COLUMN] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--noindent]
                                     [--quote {all,minimal,none,nonnumeric}]
                                     [--sort-column SORT_COLUMN] [--long]
Copy to Clipboard Toggle word wrap

Expand
表 29.8. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 29.9. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

Expand
表 29.10. 输出格式器
概述

输出 formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

Expand
表 29.11. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 29.12. 可选参数
概述

-h, --help

显示帮助信息并退出

--long

列出输出中的其他字段

29.4. 防火墙组策略添加规则

在给定的防火墙策略中插入规则

使用方法:

openstack firewall group policy add rule [-h]
                                                [--insert-before <firewall-rule>]
                                                [--insert-after <firewall-rule>]
                                                <firewall-policy>
                                                <firewall-rule>
Copy to Clipboard Toggle word wrap

Expand
表 29.13. 位置参数
概述

<firewall-policy>

用于插入规则的防火墙规则(名称或 ID)

<firewall-rule>

要插入的防火墙规则(名称或 id)

Expand
表 29.14. 可选参数
概述

--insert-after <firewall-rule>

在此现有规则后插入新规则(名称或 ID)

-h, --help

显示帮助信息并退出

--insert-before <firewall-rule>

在此现有规则前插入新规则(名称或 ID)

29.5. 防火墙组策略创建

创建新的防火墙策略

使用方法:

openstack firewall group policy create [-h]
                                              [-f {json,shell,table,value,yaml}]
                                              [-c COLUMN]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty]
                                              [--noindent] [--prefix PREFIX]
                                              [--description DESCRIPTION]
                                              [--audited | --no-audited]
                                              [--share | --public | --private | --no-share]
                                              [--project <project>]
                                              [--project-domain <project-domain>]
                                              [--firewall-rule <firewall-rule> | --no-firewall-rule]
                                              <name>
Copy to Clipboard Toggle word wrap

Expand
表 29.15. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 29.16. 位置参数
概述

<name>

防火墙策略的名称

Expand
表 29.17. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 29.18. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 29.19. 可选参数
概述

--share

共享要在所有项目中使用的防火墙策略(默认情况下,限制当前项目使用)。

--public

将防火墙策略设为公共,允许它在所有项目中使用(而不是默认值),这是限制其对当前项目的使用。) 这个选项已弃用,并将在以后的发行版本中删除。

--no-audited

为策略禁用审计

--no-firewall-rule

从防火墙策略取消设置所有防火墙规则

--audited

为策略启用审计

--project-domain <project-domain>

项目所属的域(名称或 id)。这可在项目名称之间有冲突时使用。

--no-share

限制对当前项目的防火墙策略的使用

--firewall-rule <firewall-rule>

要应用的防火墙规则(名称或 id)

--private

限制将防火墙策略用于当前项目。此选项已弃用,并将在 R 发行版本中删除。

--description DESCRIPTION

防火墙策略描述

-h, --help

显示帮助信息并退出

--project <project>

所有者的项目(名称或 id)

Expand
表 29.20. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

29.6. 防火墙组策略删除

删除防火墙策略

使用方法:

openstack firewall group policy delete [-h]
                                              <firewall-policy>
                                              [<firewall-policy> ...]
Copy to Clipboard Toggle word wrap

Expand
表 29.21. 位置参数
概述

<firewall-policy>

要删除的防火墙策略(名称或 ID)

Expand
表 29.22. 可选参数
概述

-h, --help

显示帮助信息并退出

29.7. 防火墙组策略列表

列出防火墙策略

使用方法:

openstack firewall group policy list [-h]
                                            [-f {csv,json,table,value,yaml}]
                                            [-c COLUMN]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            [--noindent]
                                            [--quote {all,minimal,none,nonnumeric}]
                                            [--sort-column SORT_COLUMN]
                                            [--long]
Copy to Clipboard Toggle word wrap

Expand
表 29.23. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 29.24. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

Expand
表 29.25. 输出格式器
概述

输出 formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

Expand
表 29.26. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 29.27. 可选参数
概述

-h, --help

显示帮助信息并退出

--long

列出输出中的其他字段

29.8. 防火墙组策略删除规则

从给定的防火墙策略中删除规则

使用方法:

openstack firewall group policy remove rule [-h]
                                                   <firewall-policy>
                                                   <firewall-rule>
Copy to Clipboard Toggle word wrap

Expand
表 29.28. 位置参数
概述

<firewall-policy>

删除规则的防火墙规则(名称或 id)

<firewall-rule>

从策略中删除的防火墙规则(名称或 id)

Expand
表 29.29. 可选参数
概述

-h, --help

显示帮助信息并退出

29.9. 防火墙组策略集

设置防火墙策略属性

使用方法:

openstack firewall group policy set [-h] [--description DESCRIPTION]
                                           [--audited | --no-audited]
                                           [--share | --public | --private | --no-share]
                                           [--name <name>]
                                           [--firewall-rule <firewall-rule>]
                                           [--no-firewall-rule]
                                           <firewall-policy>
Copy to Clipboard Toggle word wrap

Expand
表 29.30. 位置参数
概述

<firewall-policy>

更新的防火墙策略(名称或 id)

Expand
表 29.31. 可选参数
概述

--share

共享要在所有项目中使用的防火墙策略(默认情况下,限制当前项目使用)。

--public

将防火墙策略设为公共,允许它在所有项目中使用(而不是默认值),这是限制其对当前项目的使用。) 这个选项已弃用,并将在以后的发行版本中删除。

--no-audited

为策略禁用审计

--no-firewall-rule

从防火墙策略删除所有防火墙规则

--audited

为策略启用审计

--no-share

限制对当前项目的防火墙策略的使用

--firewall-rule <firewall-rule>

要应用的防火墙规则(名称或 id)

--private

限制将防火墙策略用于当前项目。此选项已弃用,并将在 R 发行版本中删除。

--description DESCRIPTION

防火墙策略描述

-h, --help

显示帮助信息并退出

--name <name>

防火墙策略的名称

29.10. 防火墙组策略显示

显示防火墙策略详情

使用方法:

openstack firewall group policy show [-h]
                                            [-f {json,shell,table,value,yaml}]
                                            [-c COLUMN]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            [--noindent] [--prefix PREFIX]
                                            <firewall-policy>
Copy to Clipboard Toggle word wrap

Expand
表 29.32. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 29.33. 位置参数
概述

<firewall-policy>

显示的防火墙策略(名称或 id)

Expand
表 29.34. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 29.35. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 29.36. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 29.37. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

29.11. 防火墙组策略未设置

设置防火墙策略属性

使用方法:

openstack firewall group policy unset [-h]
                                             [--firewall-rule <firewall-rule> | --all-firewall-rule]
                                             [--audited] [--share] [--public]
                                             <firewall-policy>
Copy to Clipboard Toggle word wrap

Expand
表 29.38. 位置参数
概述

<firewall-policy>

要取消设置的防火墙策略(name 或 id)

Expand
表 29.39. 可选参数
概述

--share

限制对当前项目的防火墙策略的使用

--public

将防火墙策略的使用限制为当前项目。这个选项已弃用,并将在以后的发行版本中删除。

--audited

为策略禁用审计

--all-firewall-rule

从防火墙策略中删除所有防火墙规则

--firewall-rule <firewall-rule>

从防火墙策略(名称或 ID)中删除防火墙规则

-h, --help

显示帮助信息并退出

29.12. 防火墙规则创建

创建新的防火墙规则

使用方法:

openstack firewall group rule create [-h]
                                            [-f {json,shell,table,value,yaml}]
                                            [-c COLUMN]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            [--noindent] [--prefix PREFIX]
                                            [--name <name>]
                                            [--description <description>]
                                            [--protocol {tcp,udp,icmp,any}]
                                            [--action {allow,deny,reject}]
                                            [--ip-version <ip-version>]
                                            [--source-ip-address <source-ip-address> | --no-source-ip-address]
                                            [--destination-ip-address <destination-ip-address> | --no-destination-ip-address]
                                            [--source-port <source-port> | --no-source-port]
                                            [--destination-port <destination-port> | --no-destination-port]
                                            [--public | --private | --share | --no-share]
                                            [--enable-rule | --disable-rule]
                                            [--project <project>]
                                            [--project-domain <project-domain>]
Copy to Clipboard Toggle word wrap

Expand
表 29.40. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 29.41. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 29.42. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 29.43. 可选参数
概述

--destination-port <destination-port>

目标端口号或范围(整数为 [1, 65535] 或范围,如 123:456)

--no-destination-ip-address

分离目的地 IP 地址

--source-ip-address <source-ip-address>

源 IP 地址或子网

--share

共享要在所有项目中使用的防火墙规则(默认情况下,限制当前项目使用)。

--no-source-ip-address

分离源 IP 地址

--private

限制将防火墙规则限制到当前项目。此选项已弃用,并将在 R 发行版本中删除。

--enable-rule

启用此规则(默认启用)

--name <name>

防火墙规则的名称

--no-source-port

分离源端口号或范围

--destination-ip-address <destination-ip-address>

目标 IP 地址或子网

-h, --help

显示帮助信息并退出

--description <description>

防火墙规则的描述

--project-domain <project-domain>

项目所属的域(名称或 id)。这可在项目名称之间有冲突时使用。

--action {allow,deny,reject}

防火墙规则的操作

--ip-version <ip-version>

设置 ip 版本 4 或 6 (默认为 4)

--source-port <source-port>

源端口号或范围(整数为 [1, 65535] 或范围,如 123:456)

--no-share

限制对当前项目的防火墙规则的使用

--no-destination-port

分离目标端口号或范围

--project <project>

所有者的项目(名称或 id)

--disable-rule

禁用这个规则

--public

将防火墙策略设为公共,允许它在所有项目中使用(而不是默认值),这是限制其对当前项目的使用。这个选项已弃用,并将在 R Release 中删除

--protocol {tcp,udp,icmp,any}

防火墙规则的协议

Expand
表 29.44. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

29.13. 防火墙规则删除

删除防火墙规则

使用方法:

openstack firewall group rule delete [-h]
                                            <firewall-rule>
                                            [<firewall-rule> ...]
Copy to Clipboard Toggle word wrap

Expand
表 29.45. 位置参数
概述

<firewall-rule>

要删除的防火墙规则(名称或 ID)

Expand
表 29.46. 可选参数
概述

-h, --help

显示帮助信息并退出

29.14. 防火墙规则列表

列出属于给定租户的防火墙规则

使用方法:

openstack firewall group rule list [-h]
                                          [-f {csv,json,table,value,yaml}]
                                          [-c COLUMN] [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          [--noindent]
                                          [--quote {all,minimal,none,nonnumeric}]
                                          [--sort-column SORT_COLUMN] [--long]
Copy to Clipboard Toggle word wrap

Expand
表 29.47. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 29.48. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

Expand
表 29.49. 输出格式器
概述

输出 formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

Expand
表 29.50. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 29.51. 可选参数
概述

-h, --help

显示帮助信息并退出

--long

列出输出中的其他字段

29.15. 防火墙组规则集

设置防火墙规则属性

使用方法:

openstack firewall group rule set [-h] [--name <name>]
                                         [--description <description>]
                                         [--protocol {tcp,udp,icmp,any}]
                                         [--action {allow,deny,reject}]
                                         [--ip-version <ip-version>]
                                         [--source-ip-address <source-ip-address> | --no-source-ip-address]
                                         [--destination-ip-address <destination-ip-address> | --no-destination-ip-address]
                                         [--source-port <source-port> | --no-source-port]
                                         [--destination-port <destination-port> | --no-destination-port]
                                         [--public | --private | --share | --no-share]
                                         [--enable-rule | --disable-rule]
                                         <firewall-rule>
Copy to Clipboard Toggle word wrap

Expand
表 29.52. 位置参数
概述

<firewall-rule>

设定的防火墙规则(名称或 id)

Expand
表 29.53. 可选参数
概述

--share

共享要在所有项目中使用的防火墙规则(默认情况下,限制当前项目使用)。

--no-source-ip-address

分离源 IP 地址

--source-ip-address <source-ip-address>

源 IP 地址或子网

--ip-version <ip-version>

设置 ip 版本 4 或 6 (默认为 4)

--private

限制将防火墙规则限制到当前项目。此选项已弃用,并将在 R 发行版本中删除。

--no-source-port

分离源端口号或范围

--name <name>

防火墙规则的名称

--enable-rule

启用此规则(默认启用)

--destination-port <destination-port>

目标端口号或范围(整数为 [1, 65535] 或范围,如 123:456)

--source-port <source-port>

源端口号或范围(整数为 [1, 65535] 或范围,如 123:456)

--disable-rule

禁用这个规则

--no-share

限制对当前项目的防火墙规则的使用

--no-destination-port

分离目标端口号或范围

--no-destination-ip-address

分离目的地 IP 地址

--destination-ip-address <destination-ip-address>

目标 IP 地址或子网

-h, --help

显示帮助信息并退出

--description <description>

防火墙规则的描述

--protocol {tcp,udp,icmp,any}

防火墙规则的协议

--action {allow,deny,reject}

防火墙规则的操作

--public

将防火墙策略设为公共,允许它在所有项目中使用(而不是默认值),这是限制其对当前项目的使用。这个选项已弃用,并将在 R Release 中删除

29.16. 防火墙规则显示

显示防火墙规则详情

使用方法:

openstack firewall group rule show [-h]
                                          [-f {json,shell,table,value,yaml}]
                                          [-c COLUMN] [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          [--noindent] [--prefix PREFIX]
                                          <firewall-rule>
Copy to Clipboard Toggle word wrap

Expand
表 29.54. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 29.55. 位置参数
概述

<firewall-rule>

要显示的防火墙规则(名称或 id)

Expand
表 29.56. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 29.57. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 29.58. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 29.59. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

29.17. 防火墙规则取消设置

取消设置防火墙规则属性

使用方法:

openstack firewall group rule unset [-h] [--source-ip-address]
                                           [--destination-ip-address]
                                           [--source-port]
                                           [--destination-port] [--share]
                                           [--public] [--enable-rule]
                                           <firewall-rule>
Copy to Clipboard Toggle word wrap

Expand
表 29.60. 位置参数
概述

<firewall-rule>

取消设置的防火墙规则(名称或 id)

Expand
表 29.61. 可选参数
概述

--share

限制对当前项目的防火墙规则的使用

--public

限制对当前项目的防火墙规则的使用。这个选项已弃用,并将在 R Release 中删除。

--enable-rule

禁用这个规则

--destination-port

目标端口号或范围(整数为 [1, 65535] 或范围,如 123:456)

--source-ip-address

源 IP 地址或子网

-h, --help

显示帮助信息并退出

--destination-ip-address

目标 IP 地址或子网

--source-port

源端口号或范围(整数为 [1, 65535] 或范围,如 123:456)

29.18. 防火墙组集

设置防火墙组属性

使用方法:

openstack firewall group set [-h] [--name NAME]
                                    [--description <description>]
                                    [--ingress-firewall-policy <ingress-firewall-policy> | --no-ingress-firewall-policy]
                                    [--egress-firewall-policy <egress-firewall-policy> | --no-egress-firewall-policy]
                                    [--public | --private | --share | --no-share]
                                    [--enable | --disable] [--port <port>]
                                    [--no-port]
                                    <firewall-group>
Copy to Clipboard Toggle word wrap

Expand
表 29.62. 位置参数
概述

<firewall-group>

要更新的防火墙组(名称或 id)

Expand
表 29.63. 可选参数
概述

--share

共享要在所有项目中使用的防火墙组(默认情况下,限制当前项目使用)。

--no-port

从防火墙组分离所有端口

--disable

禁用防火墙组

--public

使防火墙组 public,允许它在所有项目中使用(而不是默认值),这是限制其对当前项目的使用。这个选项已弃用,并将在以后的发行版本中删除。

--no-egress-firewall-policy

从防火墙组分离出口防火墙策略

--enable

启用防火墙组

--egress-firewall-policy <egress-firewall-policy>

出口防火墙策略(名称或 id)

--no-share

将防火墙组的使用限制为当前项目

--no-ingress-firewall-policy

从防火墙组分离入口防火墙策略

--private

将防火墙组的使用限制为当前项目。这个选项已弃用,并将在以后的发行版本中删除。

--port <port>

要应用防火墙组的端口(名称或 id)。可以重复此选项

--name NAME

防火墙组的名称

-h, --help

显示帮助信息并退出

--description <description>

firewall 组的描述

--ingress-firewall-policy <ingress-firewall-policy>

Ingress 防火墙策略(名称或 id)

29.19. firewall group show

显示防火墙组详情

使用方法:

openstack firewall group show [-h] [-f {json,shell,table,value,yaml}]
                                     [-c COLUMN] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--noindent] [--prefix PREFIX]
                                     <firewall-group>
Copy to Clipboard Toggle word wrap

Expand
表 29.64. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 29.65. 位置参数
概述

<firewall-group>

要显示的防火墙组(名称或 id)

Expand
表 29.66. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 29.67. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 29.68. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 29.69. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

29.20. firewall group unset

取消设置防火墙组属性

使用方法:

openstack firewall group unset [-h] [--port <port> | --all-port]
                                      [--ingress-firewall-policy]
                                      [--egress-firewall-policy]
                                      [--public | --share] [--enable]
                                      <firewall-group>
Copy to Clipboard Toggle word wrap

Expand
表 29.70. 位置参数
概述

<firewall-group>

要取消设置的防火墙组(name 或 id)

Expand
表 29.71. 可选参数
概述

--share

将防火墙组的使用限制为当前项目

--all-port

删除此防火墙组的所有端口

--public

使防火墙组 public,允许它在所有项目中使用(而不是默认值),这是限制其对当前项目的使用。这个选项已弃用,并将在以后的发行版本中删除。

--enable

禁用防火墙组

--ingress-firewall-policy

要删除的 Ingress 防火墙策略(名称或 id)

--egress-firewall-policy

要删除的出口防火墙策略(名称或 id)

--port <port>

要应用防火墙组的端口(名称或 id)。可以重复此选项

-h, --help

显示帮助信息并退出

第 30 章 Flavor

本章论述了 flavor 命令下的命令。

30.1. Flavor create

创建新类别

使用方法:

openstack flavor create [-h] [-f {json,shell,table,value,yaml}]
                               [-c COLUMN] [--max-width <integer>]
                               [--fit-width] [--print-empty] [--noindent]
                               [--prefix PREFIX] [--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>]
                               [--project-domain <project-domain>]
                               <flavor-name>
Copy to Clipboard Toggle word wrap

Expand
表 30.1. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 30.2. 位置参数
概述

<flavor-name>

新类别名称

Expand
表 30.3. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 30.4. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 30.5. 可选参数
概述

--disk <size-gb>

磁盘大小(默认为 0g)

--ram <size-mb>

大小为 mb (默认 256m)

--id <id>

唯一类别 ID;自动创建 uuid (默认值: auto

--private

flavor 不适用于其他项目

--project-domain <project-domain>

项目所属的域(名称或 id)。这可在项目名称之间有冲突时使用。

--ephemeral <size-gb>

gb 中的临时磁盘大小(默认为 0g)

--property <key=value>

可添加此类别的属性(重复选项以设置多个属性)

--vcpus <vcpus>

vcpus 的数量(默认为 1)

--swap <size-mb>

以 mb 为单位的额外交换空间大小(默认值为 0m)

--rxtx-factor <factor>

RX/tx 因子(默认 1.0)

-h, --help

显示帮助信息并退出

--project <project>

允许 <project> 访问私有类别(名称或 ID)(Must with --private 选项)

--public

类别可用于其他项目(默认)

Expand
表 30.6. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

30.2. 类别删除

删除类别

使用方法:

openstack flavor delete [-h] <flavor> [<flavor> ...]
Copy to Clipboard Toggle word wrap

Expand
表 30.7. 位置参数
概述

<flavor>

要删除的类别(名称或 ID)

Expand
表 30.8. 可选参数
概述

-h, --help

显示帮助信息并退出

30.3. 类别列表

列出类别

使用方法:

openstack flavor list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                             [--max-width <integer>] [--fit-width]
                             [--print-empty] [--noindent]
                             [--quote {all,minimal,none,nonnumeric}]
                             [--sort-column SORT_COLUMN]
                             [--public | --private | --all] [--long]
                             [--marker <flavor-id>] [--limit <num-flavors>]
Copy to Clipboard Toggle word wrap

Expand
表 30.9. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 30.10. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

Expand
表 30.11. 输出格式器
概述

输出 formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

Expand
表 30.12. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 30.13. 可选参数
概述

--public

仅列出公共类别(默认)

--private

仅列出私有类别

--long

列出输出中的其他字段

--limit <num-flavors>

可显示的最大类别数

-h, --help

显示帮助信息并退出

--marker <flavor-id>

上一个页面的最后一个类别 ID

--all

列出所有类别,无论是公共还是私有

30.4. 类别集

设置类别属性

使用方法:

openstack flavor set [-h] [--no-property] [--property <key=value>]
                            [--project <project>]
                            [--project-domain <project-domain>]
                            <flavor>
Copy to Clipboard Toggle word wrap

Expand
表 30.14. 位置参数
概述

<flavor>

修改(名称或 ID)的类别.

Expand
表 30.15. 可选参数
概述

-h, --help

显示帮助信息并退出

--project-domain <project-domain>

项目所属的域(名称或 id)。这可在项目名称之间有冲突时使用。

--property <key=value>

用于为这个类别添加或修改的属性(重复选项以设置多个属性)

--no-property

从此类别中删除所有属性(指定 --no-property 和 --property),以在设置新属性前移除当前属性。)

--project <project>

将类别访问权限设置为项目(名称或 ID)(仅限 admin)

30.5. 类别显示

显示类别详情

使用方法:

openstack flavor show [-h] [-f {json,shell,table,value,yaml}]
                             [-c COLUMN] [--max-width <integer>] [--fit-width]
                             [--print-empty] [--noindent] [--prefix PREFIX]
                             <flavor>
Copy to Clipboard Toggle word wrap

Expand
表 30.16. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 30.17. 位置参数
概述

<flavor>

显示的类别(名称或 ID)

Expand
表 30.18. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 30.19. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 30.20. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 30.21. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

30.6. 类别未设置

取消设置类别属性

使用方法:

openstack flavor unset [-h] [--property <key>] [--project <project>]
                              [--project-domain <project-domain>]
                              <flavor>
Copy to Clipboard Toggle word wrap

Expand
表 30.22. 位置参数
概述

<flavor>

修改(名称或 ID)的类别.

Expand
表 30.23. 可选参数
概述

--property <key>

从类别中删除属性(重复选项以取消设置多个属性)

-h, --help

显示帮助信息并退出

--project <project>

从项目(名称或 ID)中删除类别访问权限(仅限 admin)

--project-domain <project-domain>

项目所属的域(名称或 id)。这可在项目名称之间有冲突时使用。

第 31 章 floating

本章论述了 浮动 命令下的命令。

31.1. floating ip create

创建浮动 IP

使用方法:

openstack floating ip create [-h] [-f {json,shell,table,value,yaml}]
                                    [-c COLUMN] [--max-width <integer>]
                                    [--fit-width] [--print-empty] [--noindent]
                                    [--prefix PREFIX] [--subnet <subnet>]
                                    [--port <port>]
                                    [--floating-ip-address <ip-address>]
                                    [--fixed-ip-address <ip-address>]
                                    [--qos-policy <qos-policy>]
                                    [--description <description>]
                                    [--project <project>]
                                    [--project-domain <project-domain>]
                                    <network>
Copy to Clipboard Toggle word wrap

Expand
表 31.1. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 31.2. 位置参数
概述

<network>

从中分配浮动 ip 的网络(名称或 ID)

Expand
表 31.3. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 31.4. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 31.5. 可选参数
概述

--fixed-ip-address <ip-address>

修复了映射到浮动 IP 的 ip 地址

--description <description>

设置浮动 IP 描述

--project-domain <project-domain>

项目所属的域(名称或 id)。这可在项目名称之间有冲突时使用。

--project <project>

所有者的项目(名称或 id)

--port <port>

要与浮动 IP 关联的端口(名称或 ID)

--qos-policy <qos-policy>

将 qos 策略附加到浮动 ip (名称或 id)

-h, --help

显示帮助信息并退出

--floating-ip-address <ip-address>

浮动 IP 地址

--subnet <subnet>

要创建浮动 IP (名称或 ID)的子网

Expand
表 31.6. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

31.2. floating ip delete

删除浮动 IP

使用方法:

openstack floating ip delete [-h] <floating-ip> [<floating-ip> ...]
Copy to Clipboard Toggle word wrap

Expand
表 31.7. 位置参数
概述

<floating-ip>

要删除的浮动 ip (s) (IP 地址或 id)

Expand
表 31.8. 可选参数
概述

-h, --help

显示帮助信息并退出

31.3. floating ip list

列出浮动 IP

使用方法:

openstack floating ip list [-h] [-f {csv,json,table,value,yaml}]
                                  [-c COLUMN] [--max-width <integer>]
                                  [--fit-width] [--print-empty] [--noindent]
                                  [--quote {all,minimal,none,nonnumeric}]
                                  [--sort-column SORT_COLUMN]
                                  [--network <network>] [--port <port>]
                                  [--fixed-ip-address <ip-address>] [--long]
                                  [--status <status>] [--project <project>]
                                  [--project-domain <project-domain>]
                                  [--router <router>]
Copy to Clipboard Toggle word wrap

Expand
表 31.9. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 31.10. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

Expand
表 31.11. 输出格式器
概述

输出 formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

Expand
表 31.12. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 31.13. 可选参数
概述

--fixed-ip-address <ip-address>

根据给定的固定 IP 地址列出浮动 ip (s)

--router <router>

根据给定路由器(名称或 ID)列出浮动 ip (s)

--long

列出输出中的其他字段

--project-domain <project-domain>

项目所属的域(名称或 id)。这可在项目名称之间有冲突时使用。

--status <status>

根据给定状态列出浮动 ip (s) (ACTIVEDOWN)

--network <network>

根据给定网络(名称或 ID)列出浮动 ip (s)

--port <port>

根据给定端口(名称或 ID)列出浮动 ip (s)

-h, --help

显示帮助信息并退出

--project <project>

根据给定项目(名称或 ID)列出浮动 ip (s)

31.4. floating ip pool list

列出浮动 IP 地址池

使用方法:

openstack floating ip pool list [-h] [-f {csv,json,table,value,yaml}]
                                       [-c COLUMN] [--max-width <integer>]
                                       [--fit-width] [--print-empty]
                                       [--noindent]
                                       [--quote {all,minimal,none,nonnumeric}]
                                       [--sort-column SORT_COLUMN]
Copy to Clipboard Toggle word wrap

Expand
表 31.14. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 31.15. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

Expand
表 31.16. 输出格式器
概述

输出 formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

Expand
表 31.17. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 31.18. 可选参数
概述

-h, --help

显示帮助信息并退出

31.5. floating ip set

设置浮动 IP 属性

使用方法:

openstack floating ip set [-h] [--port <port>]
                                 [--fixed-ip-address <ip-address>]
                                 [--qos-policy <qos-policy> | --no-qos-policy]
                                 <floating-ip>
Copy to Clipboard Toggle word wrap

Expand
表 31.19. 位置参数
概述

<floating-ip>

要修改的浮动 IP (IP 地址或 id)

Expand
表 31.20. 可选参数
概述

--qos-policy <qos-policy>

将 qos 策略附加到浮动 ip (名称或 id)

-h, --help

显示帮助信息并退出

--no-qos-policy

移除附加到浮动 ip 的 qos 策略

--port <port>

将浮动 ip 与端口(名称或 ID)关联

--fixed-ip-address <ip-address>

修复了端口的 ip (仅在端口有多个 IP 时必需)

31.6. floating ip show

显示浮动 IP 详情

使用方法:

openstack floating ip show [-h] [-f {json,shell,table,value,yaml}]
                                  [-c COLUMN] [--max-width <integer>]
                                  [--fit-width] [--print-empty] [--noindent]
                                  [--prefix PREFIX]
                                  <floating-ip>
Copy to Clipboard Toggle word wrap

Expand
表 31.21. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 31.22. 位置参数
概述

<floating-ip>

显示浮动 IP (IP 地址或 id)

Expand
表 31.23. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 31.24. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 31.25. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 31.26. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

31.7. floating ip unset

取消设置浮动 IP 属性

使用方法:

openstack floating ip unset [-h] [--port] [--qos-policy] <floating-ip>
Copy to Clipboard Toggle word wrap

Expand
表 31.27. 位置参数
概述

<floating-ip>

浮动 IP 用于解除关联(IP 地址或 id)

Expand
表 31.28. 可选参数
概述

-h, --help

显示帮助信息并退出

--qos-policy

移除附加到浮动 ip 的 qos 策略

--port

解除与浮动 ip 关联的任何端口

第 32 章 help.adoc

本章论述了 help.adoc 命令下的命令。

32.1. 帮助

打印另一个命令的详细帮助

使用方法:

openstack help [-h] [cmd [cmd ...]]
Copy to Clipboard Toggle word wrap

Expand
表 32.1. 位置参数
概述

cmd

命令的名称

Expand
表 32.2. 可选参数
概述

-h, --help

显示帮助信息并退出

第 33 章 主机

本章论述了 host 命令下的命令。

33.1. 主机列表

列出主机

使用方法:

openstack host list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                           [--max-width <integer>] [--fit-width]
                           [--print-empty] [--noindent]
                           [--quote {all,minimal,none,nonnumeric}]
                           [--sort-column SORT_COLUMN] [--zone <zone>]
Copy to Clipboard Toggle word wrap

Expand
表 33.1. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 33.2. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

Expand
表 33.3. 输出格式器
概述

输出 formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

Expand
表 33.4. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 33.5. 可选参数
概述

--zone <zone>

仅返回可用性区域中的主机

-h, --help

显示帮助信息并退出

33.2. 主机集合

设置主机属性

使用方法:

openstack host set [-h] [--enable | --disable]
                          [--enable-maintenance | --disable-maintenance]
                          <host>
Copy to Clipboard Toggle word wrap

Expand
表 33.6. 位置参数
概述

<host>

要修改的主机(仅限名称)

Expand
表 33.7. 可选参数
概述

--enable-maintenance

为主机启用维护模式

-h, --help

显示帮助信息并退出

--disable

禁用主机

--disable-maintenance

禁用主机的维护模式

--enable

启用主机

33.3. 主机显示

显示主机详情

使用方法:

openstack host show [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                           [--max-width <integer>] [--fit-width]
                           [--print-empty] [--noindent]
                           [--quote {all,minimal,none,nonnumeric}]
                           [--sort-column SORT_COLUMN]
                           <host>
Copy to Clipboard Toggle word wrap

Expand
表 33.8. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 33.9. 位置参数
概述

<host>

主机的名称

Expand
表 33.10. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

Expand
表 33.11. 输出格式器
概述

输出 formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

Expand
表 33.12. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 33.13. 可选参数
概述

-h, --help

显示帮助信息并退出

第 34 章 hypervisor

本章论述了 虚拟机监控程序 命令下的命令。

34.1. 虚拟机监控程序列表

列出虚拟机监控程序

使用方法:

openstack hypervisor list [-h] [-f {csv,json,table,value,yaml}]
                                 [-c COLUMN] [--max-width <integer>]
                                 [--fit-width] [--print-empty] [--noindent]
                                 [--quote {all,minimal,none,nonnumeric}]
                                 [--sort-column SORT_COLUMN]
                                 [--matching <hostname>] [--long]
Copy to Clipboard Toggle word wrap

Expand
表 34.1. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 34.2. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

Expand
表 34.3. 输出格式器
概述

输出 formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

Expand
表 34.4. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 34.5. 可选参数
概述

-h, --help

显示帮助信息并退出

--long

列出输出中的其他字段

--matching <hostname>

使用 <hostname> substring 过滤虚拟机监控程序

34.2. 管理程序显示

显示虚拟机监控程序详情

使用方法:

openstack hypervisor show [-h] [-f {json,shell,table,value,yaml}]
                                 [-c COLUMN] [--max-width <integer>]
                                 [--fit-width] [--print-empty] [--noindent]
                                 [--prefix PREFIX]
                                 <hypervisor>
Copy to Clipboard Toggle word wrap

Expand
表 34.6. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 34.7. 位置参数
概述

<hypervisor>

要显示的虚拟机监控程序(名称或 id)

Expand
表 34.8. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 34.9. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 34.10. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 34.11. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

34.3. 管理程序统计显示

显示虚拟机监控程序统计详情

使用方法:

openstack hypervisor stats show [-h] [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--max-width <integer>]
                                       [--fit-width] [--print-empty]
                                       [--noindent] [--prefix PREFIX]
Copy to Clipboard Toggle word wrap

Expand
表 34.12. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 34.13. 输出格式器
概述

output formatter options-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. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 34.16. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

第 35 章 image

本章论述了 image 命令下的命令。

35.1. 镜像添加项目

将项目与镜像关联

使用方法:

openstack image add project [-h] [-f {json,shell,table,value,yaml}]
                                   [-c COLUMN] [--max-width <integer>]
                                   [--fit-width] [--print-empty] [--noindent]
                                   [--prefix PREFIX]
                                   [--project-domain <project-domain>]
                                   <image> <project>
Copy to Clipboard Toggle word wrap

Expand
表 35.1. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 35.2. 位置参数
概述

<image>

要共享的镜像(名称或 id)

<project>

与镜像关联的项目(名称或 id)

Expand
表 35.3. 输出格式器
概述

output formatter options-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. 可选参数
概述

-h, --help

显示帮助信息并退出

--project-domain <project-domain>

项目所属的域(名称或 id)。这可在项目名称之间有冲突时使用。

Expand
表 35.6. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

35.2. 镜像创建

创建/上传镜像

使用方法:

openstack image create [-h] [-f {json,shell,table,value,yaml}]
                              [-c COLUMN] [--max-width <integer>]
                              [--fit-width] [--print-empty] [--noindent]
                              [--prefix PREFIX] [--id <id>]
                              [--container-format <container-format>]
                              [--disk-format <disk-format>]
                              [--min-disk <disk-gb>] [--min-ram <ram-mb>]
                              [--file <file> | --volume <volume>] [--force]
                              [--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
表 35.7. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 35.8. 位置参数
概述

<image-name>

新镜像名称

Expand
表 35.9. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 35.10. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 35.11. 可选参数
概述

--volume <volume>

从卷创建镜像

--force

如果卷正在使用,则强制进行镜像创建(仅对 --volume 有有意义的名称)

--community

镜像可以被社区访问

--id <id>

要保留的镜像 ID

--private

镜像不能被公众访问(默认)

--disk-format <disk-format>

镜像磁盘格式。支持的选项有: ami、ari、aki、vhd、vmdk、raw、qcow2、vhdx、vdi、iso、ploop。默认格式为: raw

--unprotected

允许删除镜像(默认)

--project-domain <project-domain>

项目所属的域(名称或 id)。这可在项目名称之间有冲突时使用。

--property <key=value>

在该镜像上设置属性(重复选项以设置多个属性)

--min-disk <disk-gb>

引导镜像所需的最小磁盘大小,以 GB 为单位

--min-ram <ram-mb>

引导镜像所需的最小 RAM 大小(以 MB 为单位)

--shared

镜像可以被共享

--file <file>

从本地文件上传镜像

--container-format <container-format>

镜像容器格式。支持的选项有: ami、ari、aki、bare、docker、ova、ovf。默认格式为: bare

-h, --help

显示帮助信息并退出

--tag <tag>

在此镜像上设置标签(重复选项以设置多个标签)

--public

镜像可以被公共访问

--project <project>

在此镜像上设置备用项目(名称或 ID)

--protected

防止镜像被删除

Expand
表 35.12. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

35.3. image delete

删除镜像

使用方法:

openstack image delete [-h] <image> [<image> ...]
Copy to Clipboard Toggle word wrap

Expand
表 35.13. 位置参数
概述

<image>

要删除的镜像(名称或 ID)

Expand
表 35.14. 可选参数
概述

-h, --help

显示帮助信息并退出

35.4. 镜像列表

列出可用的镜像

使用方法:

openstack image list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                            [--max-width <integer>] [--fit-width]
                            [--print-empty] [--noindent]
                            [--quote {all,minimal,none,nonnumeric}]
                            [--sort-column SORT_COLUMN]
                            [--public | --private | --shared]
                            [--property <key=value>] [--name <name>]
                            [--status <status>] [--long]
                            [--sort <key>[:<direction>]]
                            [--limit <num-images>] [--marker <image>]
Copy to Clipboard Toggle word wrap

Expand
表 35.15. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 35.16. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

Expand
表 35.17. 输出格式器
概述

输出 formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

Expand
表 35.18. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 35.19. 可选参数
概述

--public

仅列出公共镜像

--private

仅列出私有镜像

--name <name>

根据名称过滤镜像。

--property <key=value>

根据属性过滤输出

--status <status>

根据状态过滤镜像。

--limit <num-images>

要显示的最大镜像数。

--marker <image>

上一页面的最后一个镜像。在标记后显示镜像列表。如果没有指定,则显示所有镜像。(名称或 ID)

--long

列出输出中的其他字段

--sort <key>[:<direction>]

通过所选键和方向(默认:name: name:asc),可以使用逗号分隔的多个键和方向对输出进行排序

--shared

仅列出共享镜像

-h, --help

显示帮助信息并退出

35.5. 镜像移除项目

使用镜像解除关联项目

使用方法:

openstack image remove project [-h] [--project-domain <project-domain>]
                                      <image> <project>
Copy to Clipboard Toggle word wrap

Expand
表 35.20. 位置参数
概述

<image>

镜像到未共享(名称或 id)

<project>

要与镜像解除的项目(名称或 id)

Expand
表 35.21. 可选参数
概述

-h, --help

显示帮助信息并退出

--project-domain <project-domain>

项目所属的域(名称或 id)。这可在项目名称之间有冲突时使用。

35.6. 镜像保存

本地保存镜像

使用方法:

openstack image save [-h] [--file <filename>] <image>
Copy to Clipboard Toggle word wrap

Expand
表 35.22. 位置参数
概述

<image>

要保存的镜像(名称或 id)

Expand
表 35.23. 可选参数
概述

-h, --help

显示帮助信息并退出

--file <filename>

下载的镜像保存文件名(默认:stdout)

35.7. 镜像集

设置镜像属性

使用方法:

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
表 35.24. 位置参数
概述

<image>

要修改的镜像(名称或 id)

Expand
表 35.25. 可选参数
概述

--instance-id <instance-id>

用于创建此镜像的服务器实例 ID

--unprotected

允许删除镜像(默认)

--activate

激活镜像

--accept

接受镜像成员资格

--community

镜像可以被社区访问

--os-version <os-version>

操作系统分发版本

--private

镜像不能被公众访问(默认)

--name <name>

新镜像名称

--project <project>

在此镜像上设置备用项目(名称或 ID)

--min-ram <ram-mb>

引导镜像所需的最小 RAM 大小(以 MB 为单位)

--deactivate

取消激活镜像

-h, --help

显示帮助信息并退出

--project-domain <project-domain>

项目所属的域(名称或 id)。这可在项目名称之间有冲突时使用。

--protected

防止镜像被删除

--pending

将镜像成员资格重置为 待处理

--os-distro <os-distro>

操作系统分发名称

--architecture <architecture>

操作系统架构

--property <key=value>

在该镜像上设置属性(重复选项以设置多个属性)

--reject

拒绝镜像成员资格

--shared

镜像可以被共享

--min-disk <disk-gb>

引导镜像所需的最小磁盘大小,以 GB 为单位

--ramdisk-id <ramdisk-id>

用于引导此磁盘镜像的 ramdisk 镜像的 ID

--tag <tag>

在此镜像上设置标签(重复选项以设置多个标签)

--public

镜像可以被公共访问

--kernel-id <kernel-id>

用于引导此磁盘镜像的内核镜像的 ID

--disk-format <disk-format>

镜像磁盘格式。支持的选项有: ami、ari、aki、vhd、vmdk、raw、qcow2、vhdx、vdi、iso、ploop

--container-format <container-format>

镜像容器格式。支持的选项有: ami、ari、aki、bare、docker、ova、ovf

35.8. image show

显示镜像详情

使用方法:

openstack image show [-h] [-f {json,shell,table,value,yaml}]
                            [-c COLUMN] [--max-width <integer>] [--fit-width]
                            [--print-empty] [--noindent] [--prefix PREFIX]
                            [--human-readable]
                            <image>
Copy to Clipboard Toggle word wrap

Expand
表 35.26. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 35.27. 位置参数
概述

<image>

要显示的镜像(名称或 id)

Expand
表 35.28. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 35.29. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 35.30. 可选参数
概述

-h, --help

显示帮助信息并退出

--human-readable

以人类友好格式显示镜像大小。

Expand
表 35.31. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

35.9. 镜像取消设置

取消设置镜像标签和属性

使用方法:

openstack image unset [-h] [--tag <tag>] [--property <property-key>]
                             <image>
Copy to Clipboard Toggle word wrap

Expand
表 35.32. 位置参数
概述

<image>

要修改的镜像(名称或 id)

Expand
表 35.33. 可选参数
概述

-h, --help

显示帮助信息并退出

--property <property-key>

取消设置此镜像上的属性(重复选项以取消设置多个属性)

--tag <tag>

取消在此镜像上取消设置标签(重复选项以取消设置多个标签)

第 36 章 ip

本章论述了 ip 命令下的命令。

36.1. IP 可用性列表

列出网络的 IP 可用性

使用方法:

openstack ip availability list [-h] [-f {csv,json,table,value,yaml}]
                                      [-c COLUMN] [--max-width <integer>]
                                      [--fit-width] [--print-empty]
                                      [--noindent]
                                      [--quote {all,minimal,none,nonnumeric}]
                                      [--sort-column SORT_COLUMN]
                                      [--ip-version <ip-version>]
                                      [--project <project>]
                                      [--project-domain <project-domain>]
Copy to Clipboard Toggle word wrap

Expand
表 36.1. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 36.2. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

Expand
表 36.3. 输出格式器
概述

输出 formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

Expand
表 36.4. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 36.5. 可选参数
概述

-h, --help

显示帮助信息并退出

--project-domain <project-domain>

项目所属的域(名称或 id)。这可在项目名称之间有冲突时使用。

--ip-version <ip-version>

列出给定 ip version 网络的 ip availability (默认为 4)

--project <project>

列出给定项目的 ip availability (名称或 ID)

36.2. IP 可用性显示

显示网络 IP 可用性详情

使用方法:

openstack ip availability show [-h] [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--max-width <integer>]
                                      [--fit-width] [--print-empty]
                                      [--noindent] [--prefix PREFIX]
                                      <network>
Copy to Clipboard Toggle word wrap

Expand
表 36.6. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 36.7. 位置参数
概述

<network>

显示特定网络的 ip 可用性(名称或 ID)

Expand
表 36.8. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 36.9. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 36.10. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 36.11. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

第 37 章 密钥对

本章论述了 keypair 命令下的命令。

37.1. 密钥对创建

为服务器 ssh 访问创建新公钥或私钥

使用方法:

openstack keypair create [-h] [-f {json,shell,table,value,yaml}]
                                [-c COLUMN] [--max-width <integer>]
                                [--fit-width] [--print-empty] [--noindent]
                                [--prefix PREFIX]
                                [--public-key <file> | --private-key <file>]
                                <name>
Copy to Clipboard Toggle word wrap

Expand
表 37.1. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 37.2. 位置参数
概述

<name>

新公钥或私钥名称

Expand
表 37.3. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 37.4. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 37.5. 可选参数
概述

-h, --help

显示帮助信息并退出

--public-key <file>

要添加的公钥的文件名。如果没有使用,请创建一个私钥。

--private-key <file>

要保存的私钥的文件名。如果没有使用,请在控制台中打印私钥。

Expand
表 37.6. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

37.2. 密钥对删除

删除公钥或私钥.

使用方法:

openstack keypair delete [-h] <key> [<key> ...]
Copy to Clipboard Toggle word wrap

Expand
表 37.7. 位置参数
概述

<key>

要删除的密钥名称(仅限名称)

Expand
表 37.8. 可选参数
概述

-h, --help

显示帮助信息并退出

37.3. 密钥对列表

列出密钥指纹

使用方法:

openstack keypair list [-h] [-f {csv,json,table,value,yaml}]
                              [-c COLUMN] [--max-width <integer>]
                              [--fit-width] [--print-empty] [--noindent]
                              [--quote {all,minimal,none,nonnumeric}]
                              [--sort-column SORT_COLUMN]
Copy to Clipboard Toggle word wrap

Expand
表 37.9. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 37.10. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

Expand
表 37.11. 输出格式器
概述

输出 formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

Expand
表 37.12. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 37.13. 可选参数
概述

-h, --help

显示帮助信息并退出

37.4. 密钥对显示

显示密钥详情

使用方法:

openstack keypair show [-h] [-f {json,shell,table,value,yaml}]
                              [-c COLUMN] [--max-width <integer>]
                              [--fit-width] [--print-empty] [--noindent]
                              [--prefix PREFIX] [--public-key]
                              <key>
Copy to Clipboard Toggle word wrap

Expand
表 37.14. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 37.15. 位置参数
概述

<key>

要显示的公钥或私钥(仅限名称)

Expand
表 37.16. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 37.17. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 37.18. 可选参数
概述

-h, --help

显示帮助信息并退出

--public-key

仅显示使用生成的密钥对裸机公钥

Expand
表 37.19. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

第 38 章 limits

本章论述了 limits 命令下的命令。

38.1. limits show

显示计算和块存储限制

使用方法:

openstack limits show [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                             [--max-width <integer>] [--fit-width]
                             [--print-empty] [--noindent]
                             [--quote {all,minimal,none,nonnumeric}]
                             [--sort-column SORT_COLUMN] (--absolute | --rate)
                             [--reserved] [--project <project>]
                             [--domain <domain>]
Copy to Clipboard Toggle word wrap

Expand
表 38.1. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 38.2. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

Expand
表 38.3. 输出格式器
概述

输出 formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

Expand
表 38.4. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 38.5. 可选参数
概述

--reserved

包括保留数 [只能通过 --absolute]

--project <project>

显示特定项目的限值(名称或 id)[只有效使用 --absolute]

--rate

显示速率限值

-h, --help

显示帮助信息并退出

--absolute

显示绝对限制

--domain <domain>

项目所属的域(名称或 id)[仅对 --absolute]有效.

第 39 章 LoadBalancer

本章论述了 loadbalancer 命令下的命令。

39.1. LoadBalancer amphora 列表

list amphorae

使用方法:

openstack loadbalancer amphora list [-h]
                                           [-f {csv,json,table,value,yaml}]
                                           [-c COLUMN] [--max-width <integer>]
                                           [--fit-width] [--print-empty]
                                           [--noindent]
                                           [--quote {all,minimal,none,nonnumeric}]
                                           [--sort-column SORT_COLUMN]
                                           [--loadbalancer <loadbalancer>]
                                           [--compute-id <compute-id>]
                                           [--role {MASTER,BACKUP,STANDALONE}]
                                           [--status {PENDING_DELETE,DELETED,ERROR,PENDING_CREATE,BOOTING,READY,ALLOCATED}]
Copy to Clipboard Toggle word wrap

Expand
表 39.1. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 39.2. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

Expand
表 39.3. 输出格式器
概述

输出 formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

Expand
表 39.4. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 39.5. 可选参数
概述

--role {MASTER,BACKUP,STANDALONE}

按角色过滤。

--LoadBalancer <loadbalancer>

按负载均衡器(名称或 id)过滤。

-h, --help

显示帮助信息并退出

--status {PENDING_DELETE,DELETED,ERROR,PENDING_CREATE,BOOTING,READY,ALLOCATED}, --provisioning-status {PENDING_DELETED,DELETED,ERROR,PENDING_CREATE,BOOTING,READY,ALLOCATED}

通过 amphora provisioning 状态过滤。

--compute-id <compute-id>

按计算 ID 过滤。

39.2. LoadBalancer amphora 显示

显示单个 amphora 的详细信息

使用方法:

openstack loadbalancer amphora show [-h]
                                           [-f {json,shell,table,value,yaml}]
                                           [-c COLUMN] [--max-width <integer>]
                                           [--fit-width] [--print-empty]
                                           [--noindent] [--prefix PREFIX]
                                           <amphora-id>
Copy to Clipboard Toggle word wrap

Expand
表 39.6. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 39.7. 位置参数
概述

<amphora-id>

amphora 的 UUID。

Expand
表 39.8. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 39.9. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 39.10. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 39.11. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

39.3. LoadBalancer 创建

创建负载均衡器

使用方法:

openstack loadbalancer create [-h] [-f {json,shell,table,value,yaml}]
                                     [-c COLUMN] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--noindent] [--prefix PREFIX]
                                     [--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>]
                                     [--enable | --disable]
Copy to Clipboard Toggle word wrap

Expand
表 39.12. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 39.13. VIP 网络
概述

--vip-network-id <vip_network_id>

为负载均衡器(名称或 ID)设置网络。

--vip-subnet-id <vip_subnet_id>

为负载均衡器(名称或 ID)设置子网。

至少需要以下参数之一。---vip-port-id <vip_port_id>

为负载均衡器(名称或 ID)设置端口。

Expand
表 39.14. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 39.15. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 39.16. 可选参数
概述

--disable

禁用负载均衡器。

--vip-qos-policy-id <vip_qos_policy_id>

为 vip 端口设置 qos 策略 ID。未设置任何。

--enable

启用负载均衡器(默认)。

--name <name>

新的负载均衡器名称。

--vip-address <vip_address>

设置 vip ip 地址。

-h, --help

显示帮助信息并退出

--description <description>

设置负载均衡器描述。

--project <project>

负载均衡器的项目(名称或 ID)。

Expand
表 39.17. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

39.4. LoadBalancer delete

删除负载均衡器

使用方法:

openstack loadbalancer delete [-h] [--cascade] <load_balancer>
Copy to Clipboard Toggle word wrap

Expand
表 39.18. 位置参数
概述

<load_balancer>

要删除的负载均衡器(名称或 id)

Expand
表 39.19. 可选参数
概述

--cascade

将删除操作传递给负载均衡器的所有子元素。

-h, --help

显示帮助信息并退出

39.5. LoadBalancer 故障转移

触发负载均衡器故障切换

使用方法:

openstack loadbalancer failover [-h] <load_balancer>
Copy to Clipboard Toggle word wrap

Expand
表 39.20. 位置参数
概述

<load_balancer>

负载均衡器的名称或 uuid。

Expand
表 39.21. 可选参数
概述

-h, --help

显示帮助信息并退出

39.6. LoadBalancer healthmonitor create

创建运行状况监控器

使用方法:

openstack loadbalancer healthmonitor create [-h]
                                                   [-f {json,shell,table,value,yaml}]
                                                   [-c COLUMN]
                                                   [--max-width <integer>]
                                                   [--fit-width]
                                                   [--print-empty]
                                                   [--noindent]
                                                   [--prefix PREFIX]
                                                   [--name <name>] --delay
                                                   <delay>
                                                   [--expected-codes <codes>]
                                                   [--http-method {GET,POST,DELETE,PUT,HEAD,OPTIONS,PATCH,CONNECT,TRACE}]
                                                   --timeout <timeout>
                                                   --max-retries <max_retries>
                                                   [--url-path <url_path>]
                                                   --type
                                                   {PING,HTTP,TCP,HTTPS,TLS-HELLO}
                                                   [--max-retries-down <max_retries_down>]
                                                   [--enable | --disable]
                                                   <pool>
Copy to Clipboard Toggle word wrap

Expand
表 39.22. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 39.23. 位置参数
概述

<pool>

为运行状况监控器(名称或 ID)设置池。

Expand
表 39.24. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 39.25. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 39.26. 可选参数
概述

--disable

禁用运行状况监视器。

--timeout <timeout>

设置监视器在超时前等待连接的最长时间,以秒为单位。这个值必须小于延迟值。

--enable

启用运行状况监视器(默认)。

--name <name>

设置运行状况 monitor 名称。

--max-retries <max_retries>

在将成员的操作状态更改为 ONLINE 前成功检查数量。

--http-method {GET,POST,DELETE,PUT,HEAD,OPTIONS,PATCH,CONNECT,TRACE}

设置运行状况监视器用于请求的 http 方法。

--expected-codes <codes>

设置来自成员所预期的 http 状态代码列表,以声明它健康。

--type {PING,HTTP,TCP,HTTPS,TLS-HELLO}

设置运行状况监视器类型。

--delay <delay>

设置向成员发送探测之间的时间(以秒为单位)。

--max-retries-down <max_retries_down>

在将成员的操作状态更改为 ERROR 之前,设置允许检查失败的数量。

-h, --help

显示帮助信息并退出

--url-path <url_path>

设置监控器发送的请求的 http url 路径,以测试后端成员的健康状况。

Expand
表 39.27. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

39.7. LoadBalancer healthmonitor delete

删除健康监控器

使用方法:

openstack loadbalancer healthmonitor delete [-h] <health_monitor>
Copy to Clipboard Toggle word wrap

Expand
表 39.28. 位置参数
概述

<health_monitor>

要删除的运行状况监视器(名称或 id)。

Expand
表 39.29. 可选参数
概述

-h, --help

显示帮助信息并退出

39.8. LoadBalancer healthmonitor 列表

列出运行状况监视器

使用方法:

openstack loadbalancer healthmonitor list [-h]
                                                 [-f {csv,json,table,value,yaml}]
                                                 [-c COLUMN]
                                                 [--max-width <integer>]
                                                 [--fit-width] [--print-empty]
                                                 [--noindent]
                                                 [--quote {all,minimal,none,nonnumeric}]
                                                 [--sort-column SORT_COLUMN]
Copy to Clipboard Toggle word wrap

Expand
表 39.30. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 39.31. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

Expand
表 39.32. 输出格式器
概述

输出 formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

Expand
表 39.33. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 39.34. 可选参数
概述

-h, --help

显示帮助信息并退出

39.9. LoadBalancer healthmonitor 设置

更新健康监控器

使用方法:

openstack loadbalancer healthmonitor set [-h] [--name <name>]
                                                [--delay <delay>]
                                                [--expected-codes <codes>]
                                                [--http-method {GET,POST,DELETE,PUT,HEAD,OPTIONS,PATCH,CONNECT,TRACE}]
                                                [--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
表 39.35. 位置参数
概述

<health_monitor>

运行状况监视器更新(名称或 id)。

Expand
表 39.36. 可选参数
概述

--disable

禁用运行状况监视器。

--timeout <timeout>

设置监视器在超时前等待连接的最长时间,以秒为单位。这个值必须小于延迟值。

--enable

启用运行状况监视器。

--name <name>

设置运行状况监视器名称。

--max-retries <max_retries>

在将成员的操作状态更改为 ONLINE 前设置成功检查的数量。

--http-method {GET,POST,DELETE,PUT,HEAD,OPTIONS,PATCH,CONNECT,TRACE}

设置运行状况监视器用于请求的 http 方法。

--expected-codes <codes>

设置来自成员所预期的 http 状态代码列表,以声明它健康。

--delay <delay>

设置向成员发送探测之间的时间(以秒为单位)。

--max-retries-down <max_retries_down>

在将成员的操作状态更改为 ERROR 之前,设置允许检查失败的数量。

-h, --help

显示帮助信息并退出

--url-path <url_path>

设置监控器发送的请求的 http url 路径,以测试后端成员的健康状况。

39.10. LoadBalancer healthmonitor 显示

显示单个健康监控器的详细信息

使用方法:

openstack loadbalancer healthmonitor show [-h]
                                                 [-f {json,shell,table,value,yaml}]
                                                 [-c COLUMN]
                                                 [--max-width <integer>]
                                                 [--fit-width] [--print-empty]
                                                 [--noindent]
                                                 [--prefix PREFIX]
                                                 <health_monitor>
Copy to Clipboard Toggle word wrap

Expand
表 39.37. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 39.38. 位置参数
概述

<health_monitor>

健康监控器的名称或 uuid。

Expand
表 39.39. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 39.40. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 39.41. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 39.42. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

39.11. LoadBalancer l7policy create

创建 l7policy

使用方法:

openstack loadbalancer l7policy create [-h]
                                              [-f {json,shell,table,value,yaml}]
                                              [-c COLUMN]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty]
                                              [--noindent] [--prefix PREFIX]
                                              [--name <name>]
                                              [--description <description>]
                                              --action
                                              {REDIRECT_TO_URL,REDIRECT_TO_POOL,REJECT}
                                              [--redirect-pool <pool> | --redirect-url <url>]
                                              [--position <position>]
                                              [--enable | --disable]
                                              <listener>
Copy to Clipboard Toggle word wrap

Expand
表 39.43. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 39.44. 位置参数
概述

<listener>

将 l7policy 添加至(名称或 ID)的监听程序。

Expand
表 39.45. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 39.46. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 39.47. 可选参数
概述

--position <position>

此 l7 政策的序列号。

--disable

禁用 l7policy。

--enable

启用 l7policy (默认)。

--name <name>

设置 l7policy 名称。

--redirect-pool <pool>

将池设置为重定向请求(名称或 ID)。

--action {REDIRECT_TO_URL,REDIRECT_TO_POOL,REJECT}

设置策略的操作。

--redirect-url <url>

设置要将请求重定向到的 url。

-h, --help

显示帮助信息并退出

--description <description>

设置 l7policy 描述。

Expand
表 39.48. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

39.12. LoadBalancer l7policy delete

删除 l7policy

使用方法:

openstack loadbalancer l7policy delete [-h] <policy>
Copy to Clipboard Toggle word wrap

Expand
表 39.49. 位置参数
概述

<policy>

要删除的 L7policy (名称或 ID)。

Expand
表 39.50. 可选参数
概述

-h, --help

显示帮助信息并退出

39.13. LoadBalancer l7policy 列表

列出 l7policies

使用方法:

openstack loadbalancer l7policy list [-h]
                                            [-f {csv,json,table,value,yaml}]
                                            [-c COLUMN]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            [--noindent]
                                            [--quote {all,minimal,none,nonnumeric}]
                                            [--sort-column SORT_COLUMN]
Copy to Clipboard Toggle word wrap

Expand
表 39.51. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 39.52. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

Expand
表 39.53. 输出格式器
概述

输出 formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

Expand
表 39.54. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 39.55. 可选参数
概述

-h, --help

显示帮助信息并退出

39.14. LoadBalancer l7policy 设置

更新 l7policy

使用方法:

openstack loadbalancer l7policy set [-h] [--name <name>]
                                           [--description <description>]
                                           [--action {REDIRECT_TO_URL,REDIRECT_TO_POOL,REJECT}]
                                           [--redirect-pool <pool> | --redirect-url <url>]
                                           [--position <position>]
                                           [--enable | --disable]
                                           <policy>
Copy to Clipboard Toggle word wrap

Expand
表 39.56. 位置参数
概述

<policy>

L7policy 以更新(名称或 ID)。

Expand
表 39.57. 可选参数
概述

--position <position>

设置此 l7 策略的序列号。

--disable

禁用 l7policy。

--enable

启用 l7policy。

--name <name>

设置 l7policy 名称。

--redirect-pool <pool>

将池设置为重定向请求(名称或 ID)。

--action {REDIRECT_TO_URL,REDIRECT_TO_POOL,REJECT}

设置策略的操作。

--redirect-url <url>

设置要将请求重定向到的 url。

-h, --help

显示帮助信息并退出

--description <description>

设置 l7policy 描述。

39.15. LoadBalancer l7policy 显示

显示单个 l7policy 的详细信息

使用方法:

openstack loadbalancer l7policy show [-h]
                                            [-f {json,shell,table,value,yaml}]
                                            [-c COLUMN]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            [--noindent] [--prefix PREFIX]
                                            <policy>
Copy to Clipboard Toggle word wrap

Expand
表 39.58. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 39.59. 位置参数
概述

<policy>

l7policy 的名称或 uuid。

Expand
表 39.60. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 39.61. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 39.62. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 39.63. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

39.16. LoadBalancer l7rule create

创建 l7rule

使用方法:

openstack loadbalancer l7rule create [-h]
                                            [-f {json,shell,table,value,yaml}]
                                            [-c COLUMN]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            [--noindent] [--prefix PREFIX]
                                            --compare-type
                                            {REGEX,EQUAL_TO,CONTAINS,ENDS_WITH,STARTS_WITH}
                                            [--invert] --value <value>
                                            [--key <key>] --type
                                            {FILE_TYPE,PATH,COOKIE,HOST_NAME,HEADER}
                                            [--enable | --disable]
                                            <l7policy>
Copy to Clipboard Toggle word wrap

Expand
表 39.64. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 39.65. 位置参数
概述

<l7policy>

L7policy 以将 l7rule 添加到 (名称或 ID)。

Expand
表 39.66. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 39.67. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 39.68. 可选参数
概述

--value <value>

将规则值设置为与 on 匹配。

--enable

启用 l7rule (默认)。

--invert

invert l7rule.

--type {FILE_TYPE,PATH,COOKIE,HOST_NAME,HEADER}

设置 l7rule 的类型。

--key <key>

将 l7rule 的值的键设置为 match。

-h, --help

显示帮助信息并退出

--disable

禁用 l7rule。

--compare-type {REGEX,EQUAL_TO,CONTAINS,ENDS_WITH,STARTS_WITH}

为 l7rule 设置比较类型。

Expand
表 39.69. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

39.17. LoadBalancer l7rule delete

删除 l7rule

使用方法:

openstack loadbalancer l7rule delete [-h] <l7policy> <rule_id>
Copy to Clipboard Toggle word wrap

Expand
表 39.70. 位置参数
概述

<l7policy>

从(名称或 ID)中删除规则的 L7policy。

<rule_id>

要删除的 L7rule。

Expand
表 39.71. 可选参数
概述

-h, --help

显示帮助信息并退出

39.18. LoadBalancer l7rule 列表

列出 l7policy 的 l7rules

使用方法:

openstack loadbalancer l7rule list [-h]
                                          [-f {csv,json,table,value,yaml}]
                                          [-c COLUMN] [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          [--noindent]
                                          [--quote {all,minimal,none,nonnumeric}]
                                          [--sort-column SORT_COLUMN]
                                          <l7policy>
Copy to Clipboard Toggle word wrap

Expand
表 39.72. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 39.73. 位置参数
概述

<l7policy>

L7policy 可列出 (名称或 ID)的规则。

Expand
表 39.74. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

Expand
表 39.75. 输出格式器
概述

输出 formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

Expand
表 39.76. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 39.77. 可选参数
概述

-h, --help

显示帮助信息并退出

39.19. 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}]
                                         [--enable | --disable]
                                         <l7policy> <l7rule_id>
Copy to Clipboard Toggle word wrap

Expand
表 39.78. 位置参数
概述

<l7policy>

L7policy 可在(名称或 ID)上更新 l7rule。

<l7rule_id>

要更新的 L7rule。

Expand
表 39.79. 可选参数
概述

--value <value>

将规则值设置为与 on 匹配。

--enable

启用 l7rule。

--invert

invert l7rule.

--type {FILE_TYPE,PATH,COOKIE,HOST_NAME,HEADER}

设置 l7rule 的类型。

--key <key>

将 l7rule 的值的键设置为 match。

-h, --help

显示帮助信息并退出

--disable

禁用 l7rule。

--compare-type {REGEX,EQUAL_TO,CONTAINS,ENDS_WITH,STARTS_WITH}

为 l7rule 设置比较类型。

39.20. LoadBalancer l7rule 显示

显示单个 l7rule 的详细信息

使用方法:

openstack loadbalancer l7rule show [-h]
                                          [-f {json,shell,table,value,yaml}]
                                          [-c COLUMN] [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          [--noindent] [--prefix PREFIX]
                                          <l7policy> <l7rule_id>
Copy to Clipboard Toggle word wrap

Expand
表 39.80. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 39.81. 位置参数
概述

<l7policy>

L7policy 以显示来自(名称或 ID)的规则。

<l7rule_id>

要显示的 L7rule。

Expand
表 39.82. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 39.83. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 39.84. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 39.85. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

39.21. LoadBalancer 列表

列出负载均衡器

使用方法:

openstack loadbalancer list [-h] [-f {csv,json,table,value,yaml}]
                                   [-c COLUMN] [--max-width <integer>]
                                   [--fit-width] [--print-empty] [--noindent]
                                   [--quote {all,minimal,none,nonnumeric}]
                                   [--sort-column SORT_COLUMN] [--name <name>]
                                   [--enable | --disable]
                                   [--project <project-id>]
Copy to Clipboard Toggle word wrap

Expand
表 39.86. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 39.87. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

Expand
表 39.88. 输出格式器
概述

输出 formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

Expand
表 39.89. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 39.90. 可选参数
概述

--name <name>

根据负载均衡器的名称列出负载均衡器。

-h, --help

显示帮助信息并退出

--disable

列出禁用的负载均衡器。

--project <project-id>

根据项目(名称或 ID)列出负载均衡器。

--enable

列出已启用的负载均衡器。

39.22. LoadBalancer 侦听器创建

创建监听程序

使用方法:

openstack loadbalancer listener create [-h]
                                              [-f {json,shell,table,value,yaml}]
                                              [-c COLUMN]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty]
                                              [--noindent] [--prefix PREFIX]
                                              [--name <name>]
                                              [--description <description>]
                                              --protocol
                                              {TCP,HTTP,HTTPS,TERMINATED_HTTPS}
                                              [--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>
                                              [--enable | --disable]
                                              <loadbalancer>
Copy to Clipboard Toggle word wrap

Expand
表 39.91. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 39.92. 位置参数
概述

<LoadBalancer>

侦听器的负载均衡器(名称或 ID)。

Expand
表 39.93. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 39.94. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 39.95. 可选参数
概述

--protocol-port <port>

为监听器设置协议端口号。

--disable

禁用监听程序。

--connection-limit <limit>

设置此侦听器允许的最大连接数。

--name <name>

设置侦听器名称。

--protocol {TCP,HTTP,HTTPS,TERMINATED_HTTPS}

侦听器的协议。

--enable

启用监听程序(默认)。

--sni-container-refs [<container_ref> [<container_ref> …​]]

使用 Server Name Indication 为密钥管理器服务 secret 容器(包含 TERMINATED_TLS)的 uris 列表。

--default-pool <pool>

如果没有 L7 策略匹配,设置监听使用的池的名称或 ID。

-h, --help

显示帮助信息并退出

--description <description>

设置此侦听器的描述。

--insert-headers <header=value,…​>

在向后端成员发送前插入请求的可选标头字典。

--default-tls-container-ref <container_ref>

uri 到关键管理器服务 secret 容器,包含 TERMINATED_TLS 侦听的证书和密钥。

Expand
表 39.96. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

39.23. LoadBalancer 侦听器删除

删除监听程序

使用方法:

openstack loadbalancer listener delete [-h] <listener>
Copy to Clipboard Toggle word wrap

Expand
表 39.97. 位置参数
概述

<listener>

要删除的监听程序(名称或 id)

Expand
表 39.98. 可选参数
概述

-h, --help

显示帮助信息并退出

39.24. LoadBalancer 侦听器列表

列出监听程序

使用方法:

openstack loadbalancer listener list [-h]
                                            [-f {csv,json,table,value,yaml}]
                                            [-c COLUMN]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            [--noindent]
                                            [--quote {all,minimal,none,nonnumeric}]
                                            [--sort-column SORT_COLUMN]
                                            [--name <name>]
                                            [--loadbalancer <loadbalancer>]
                                            [--enable | --disable]
                                            [--project <project>]
Copy to Clipboard Toggle word wrap

Expand
表 39.99. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 39.100. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

Expand
表 39.101. 输出格式器
概述

输出 formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

Expand
表 39.102. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 39.103. 可选参数
概述

--enable

列出已启用的监听程序。

--name <name>

按侦听器名称列出监听程序。

--LoadBalancer <loadbalancer>

按负载均衡器(名称或 id)过滤。

-h, --help

显示帮助信息并退出

--disable

列出禁用的监听程序。

--project <project>

按项目 ID 列出监听程序。

39.25. 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>]
                                           [--enable | --disable]
                                           <listener>
Copy to Clipboard Toggle word wrap

Expand
表 39.104. 位置参数
概述

<listener>

修改(名称或 ID)的监听程序。

Expand
表 39.105. 可选参数
概述

--disable

禁用监听程序。

--connection-limit <limit>

此侦听器允许的最大连接数。默认值为 -1,代表无限连接。

--default-pool <pool>

如果没有 l7 策略,则监听程序使用的池的 id。

--enable

启用监听程序。

--insert-headers <header=value>

在向后端成员发送前插入请求的可选标头字典。

--name <name>

设置侦听器名称。

-h, --help

显示帮助信息并退出

--description <description>

设置此侦听器的描述。

--default-tls-container-ref <container-ref>

uri 至密钥管理器服务 secret 容器,包含 TERMINATED_TLSlisteners 的证书和密钥。

--sni-container-refs [<container-ref> [<container-ref> …​]]

使用 Server Name Indication 为密钥管理器服务 secret 容器(包含 TERMINATED_TLS)的 uris 列表。

39.26. LoadBalancer 侦听器显示

显示单个监听程序的详细信息

使用方法:

openstack loadbalancer listener show [-h]
                                            [-f {json,shell,table,value,yaml}]
                                            [-c COLUMN]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            [--noindent] [--prefix PREFIX]
                                            <listener>
Copy to Clipboard Toggle word wrap

Expand
表 39.106. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 39.107. 位置参数
概述

<listener>

侦听器的名称或 uuid

Expand
表 39.108. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 39.109. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 39.110. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 39.111. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

39.27. LoadBalancer 监听程序统计显示

显示当前监听器的统计信息。

使用方法:

openstack loadbalancer listener stats show [-h]
                                                  [-f {json,shell,table,value,yaml}]
                                                  [-c COLUMN]
                                                  [--max-width <integer>]
                                                  [--fit-width]
                                                  [--print-empty] [--noindent]
                                                  [--prefix PREFIX]
                                                  <listener>
Copy to Clipboard Toggle word wrap

Expand
表 39.112. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 39.113. 位置参数
概述

<listener>

侦听器的名称或 uuid

Expand
表 39.114. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 39.115. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 39.116. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 39.117. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

39.28. LoadBalancer 成员创建

在池中创建成员

使用方法:

openstack loadbalancer member create [-h]
                                            [-f {json,shell,table,value,yaml}]
                                            [-c COLUMN]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            [--noindent] [--prefix PREFIX]
                                            [--name <name>]
                                            [--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
表 39.118. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 39.119. 位置参数
概述

<pool>

为创建成员的池的 ID 或名称。

Expand
表 39.120. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 39.121. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 39.122. 可选参数
概述

--protocol-port <protocol_port>

后端成员服务器正在侦听的协议端口号。

--enable

启用成员(默认)

--name <name>

成员的名称。

--monitor-port <monitor_port>

用于健康监控后端成员的备用协议端口。

--subnet-id <subnet_id>

成员服务可从中访问子网 ID。

--monitor-address <monitor_address>

用于健康监控后端成员的备用 IP 地址。

--address <ip_address>

后端成员服务器的 IP 地址

-h, --help

显示帮助信息并退出

--disable

禁用成员

--weight <weight>

成员的权重决定了与池的其他成员相比,请求或服务连接的一部分。

Expand
表 39.123. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

39.29. LoadBalancer 成员删除

从池中删除成员

使用方法:

openstack loadbalancer member delete [-h] <pool> <member>
Copy to Clipboard Toggle word wrap

Expand
表 39.124. 位置参数
概述

<member>

要删除的成员的名称或 id。

<pool>

用于删除成员的池名称或 ID。

Expand
表 39.125. 可选参数
概述

-h, --help

显示帮助信息并退出

39.30. LoadBalancer 成员列表

列出池中的成员

使用方法:

openstack loadbalancer member list [-h]
                                          [-f {csv,json,table,value,yaml}]
                                          [-c COLUMN] [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          [--noindent]
                                          [--quote {all,minimal,none,nonnumeric}]
                                          [--sort-column SORT_COLUMN]
                                          <pool>
Copy to Clipboard Toggle word wrap

Expand
表 39.126. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 39.127. 位置参数
概述

<pool>

用于列出以下条件的成员的池名称或 ID。

Expand
表 39.128. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

Expand
表 39.129. 输出格式器
概述

输出 formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

Expand
表 39.130. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 39.131. 可选参数
概述

-h, --help

显示帮助信息并退出

39.31. LoadBalancer 成员集

更新成员

使用方法:

openstack loadbalancer member set [-h] [--name <name>]
                                         [--weight <weight>]
                                         [--monitor-port <monitor_port>]
                                         [--monitor-address <monitor_address>]
                                         [--enable | --disable]
                                         <pool> <member>
Copy to Clipboard Toggle word wrap

Expand
表 39.132. 位置参数
概述

<member>

要更新的成员的名称或 id

<pool>

要更新的成员所属的池(名称或 ID)。

Expand
表 39.133. 可选参数
概述

--enable

将 admin_state_up 设置为 true

--name <name>

设置成员的名称

--monitor-port <monitor_port>

用于健康监控后端成员的备用协议端口

--monitor-address <monitor_address>

用于健康监控后端成员的备用 IP 地址。

-h, --help

显示帮助信息并退出

--disable

将 admin_state_up 设置为 false

--weight <weight>

设置池中成员的权重

39.32. LoadBalancer 成员显示

显示单个成员的详情

使用方法:

openstack loadbalancer member show [-h]
                                          [-f {json,shell,table,value,yaml}]
                                          [-c COLUMN] [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          [--noindent] [--prefix PREFIX]
                                          <pool> <member>
Copy to Clipboard Toggle word wrap

Expand
表 39.134. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 39.135. 位置参数
概述

<member>

要显示的成员的名称或 id。

<pool>

池名称或 id,以显示.

Expand
表 39.136. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 39.137. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 39.138. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 39.139. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

39.33. LoadBalancer 池创建

创建池

使用方法:

openstack loadbalancer pool create [-h]
                                          [-f {json,shell,table,value,yaml}]
                                          [-c COLUMN] [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          [--noindent] [--prefix PREFIX]
                                          [--name <name>]
                                          [--description <description>]
                                          --protocol
                                          {TCP,HTTP,HTTPS,TERMINATED_HTTPS,PROXY}
                                          (--listener <listener> | --loadbalancer <load_balancer>)
                                          [--session-persistence <session persistence>]
                                          --lb-algorithm
                                          {SOURCE_IP,ROUND_ROBIN,LEAST_CONNECTIONS}
                                          [--enable | --disable]
Copy to Clipboard Toggle word wrap

Expand
表 39.140. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 39.141. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 39.142. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 39.143. 可选参数
概述

--disable

禁用池。

--enable

启用池(默认)。

--name <name>

设置池名称。

--loadbalancer <load_balancer>

加载 balncer 以将池添加到 (名称或 ID)

--session-persistence <session persistence>

为监听器(key=value)设置会话持久性。

--protocol {TCP,HTTP,HTTPS,TERMINATED_HTTPS,PROXY}

设置池协议。

--lb-algorithm {SOURCE_IP,ROUND_ROBIN,LEAST_CONNECTIONS}

要使用的负载平衡算法。

--listener <listener>

将池添加到(名称或 ID)的监听程序。

-h, --help

显示帮助信息并退出

--description <description>

设置池描述。

Expand
表 39.144. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

39.34. LoadBalancer 池删除

删除池

使用方法:

openstack loadbalancer pool delete [-h] <pool>
Copy to Clipboard Toggle word wrap

Expand
表 39.145. 位置参数
概述

<pool>

要删除的池(名称或 id)。

Expand
表 39.146. 可选参数
概述

-h, --help

显示帮助信息并退出

39.35. LoadBalancer 池列表

列出池

使用方法:

openstack loadbalancer pool list [-h] [-f {csv,json,table,value,yaml}]
                                        [-c COLUMN] [--max-width <integer>]
                                        [--fit-width] [--print-empty]
                                        [--noindent]
                                        [--quote {all,minimal,none,nonnumeric}]
                                        [--sort-column SORT_COLUMN]
                                        [--loadbalancer <loadbalancer>]
Copy to Clipboard Toggle word wrap

Expand
表 39.147. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 39.148. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

Expand
表 39.149. 输出格式器
概述

输出 formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

Expand
表 39.150. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 39.151. 可选参数
概述

--LoadBalancer <loadbalancer>

按负载均衡器(名称或 id)过滤。

-h, --help

显示帮助信息并退出

39.36. LoadBalancer 池集

更新池

使用方法:

openstack loadbalancer pool set [-h] [--name <name>]
                                       [--description <description>]
                                       [--session-persistence <session_persistence>]
                                       [--lb-algorithm {SOURCE_IP,ROUND_ROBIN,LEAST_CONNECTIONS}]
                                       [--enable | --disable]
                                       <pool>
Copy to Clipboard Toggle word wrap

Expand
表 39.152. 位置参数
概述

<pool>

要更新的池(名称或 id)。

Expand
表 39.153. 可选参数
概述

--disable

禁用池。

--enable

启用池。

--name <name>

设置池的名称。

--session-persistence <session_persistence>

为监听器(key=value)设置会话持久性。

--lb-algorithm {SOURCE_IP,ROUND_ROBIN,LEAST_CONNECTIONS}

设置要使用的负载平衡算法。

-h, --help

显示帮助信息并退出

--description <description>

设置池的描述。

39.37. LoadBalancer 池显示

显示单个池的详细信息

使用方法:

openstack loadbalancer pool show [-h]
                                        [-f {json,shell,table,value,yaml}]
                                        [-c COLUMN] [--max-width <integer>]
                                        [--fit-width] [--print-empty]
                                        [--noindent] [--prefix PREFIX]
                                        <pool>
Copy to Clipboard Toggle word wrap

Expand
表 39.154. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 39.155. 位置参数
概述

<pool>

池的名称或 uuid。

Expand
表 39.156. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 39.157. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 39.158. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 39.159. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

39.38. LoadBalancer 配额默认设置显示

显示配额默认值

使用方法:

openstack loadbalancer quota defaults show [-h]
                                                  [-f {json,shell,table,value,yaml}]
                                                  [-c COLUMN]
                                                  [--max-width <integer>]
                                                  [--fit-width]
                                                  [--print-empty] [--noindent]
                                                  [--prefix PREFIX]
Copy to Clipboard Toggle word wrap

Expand
表 39.160. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 39.161. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 39.162. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 39.163. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 39.164. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

39.39. LoadBalancer 配额列表

列出配额

使用方法:

openstack loadbalancer quota list [-h] [-f {csv,json,table,value,yaml}]
                                         [-c COLUMN] [--max-width <integer>]
                                         [--fit-width] [--print-empty]
                                         [--noindent]
                                         [--quote {all,minimal,none,nonnumeric}]
                                         [--sort-column SORT_COLUMN]
                                         [--project <project-id>]
Copy to Clipboard Toggle word wrap

Expand
表 39.165. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 39.166. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

Expand
表 39.167. 输出格式器
概述

输出 formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

Expand
表 39.168. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 39.169. 可选参数
概述

-h, --help

显示帮助信息并退出

--project <project-id>

项目的名称或 uuid。

39.40. LoadBalancer 配额重置

将配额重置为默认配额

使用方法:

openstack loadbalancer quota reset [-h] <project>
Copy to Clipboard Toggle word wrap

Expand
表 39.170. 位置参数
概述

<project>

重置配额的项目(名称或 ID)

Expand
表 39.171. 可选参数
概述

-h, --help

显示帮助信息并退出

39.41. LoadBalancer 配额集

更新配额

使用方法:

openstack loadbalancer quota set [-h]
                                        [-f {json,shell,table,value,yaml}]
                                        [-c COLUMN] [--max-width <integer>]
                                        [--fit-width] [--print-empty]
                                        [--noindent] [--prefix PREFIX]
                                        [--healthmonitor <health_monitor>]
                                        [--listener <listener>]
                                        [--loadbalancer <load_balancer>]
                                        [--member <member>] [--pool <pool>]
                                        <project>
Copy to Clipboard Toggle word wrap

Expand
表 39.172. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 39.173. 位置参数
概述

<project>

项目的名称或 uuid。

Expand
表 39.174. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 39.175. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 39.176. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 39.177. 配额限制
概述

--member <member>

member 配额限制的新值。值 -1 表示无限。

至少需要以下参数之一。---healthmonitor <health_monitor>

健康监控配额的新值。值 -1 表示无限。

--loadbalancer <load_balancer>

负载均衡器配额限制的新值。值 -1 表示无限。

--pool <pool>

池配额限制的新值。值 -1 表示无限。

--listener <listener>

侦听器 quota. value -1 的新值表示无限。

Expand
表 39.178. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

39.42. LoadBalancer 配额显示

显示项目的配额详情

使用方法:

openstack loadbalancer quota show [-h]
                                         [-f {json,shell,table,value,yaml}]
                                         [-c COLUMN] [--max-width <integer>]
                                         [--fit-width] [--print-empty]
                                         [--noindent] [--prefix PREFIX]
                                         <project>
Copy to Clipboard Toggle word wrap

Expand
表 39.179. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 39.180. 位置参数
概述

<project>

项目的名称或 uuid。

Expand
表 39.181. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 39.182. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 39.183. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 39.184. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

39.43. 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
表 39.185. 位置参数
概述

<load_balancer>

要更新的负载均衡器的名称或 uuid。

Expand
表 39.186. 可选参数
概述

--description <description>

设置负载均衡器描述。

--vip-qos-policy-id <vip_qos_policy_id>

为 vip 端口设置 qos 策略 ID。未设置任何。

--enable

启用负载均衡器。

--name <name>

设置负载均衡器名称。

-h, --help

显示帮助信息并退出

--disable

禁用负载均衡器。

39.44. LoadBalancer 显示

显示单个负载均衡器的详情

使用方法:

openstack loadbalancer show [-h] [-f {json,shell,table,value,yaml}]
                                   [-c COLUMN] [--max-width <integer>]
                                   [--fit-width] [--print-empty] [--noindent]
                                   [--prefix PREFIX]
                                   <load_balancer>
Copy to Clipboard Toggle word wrap

Expand
表 39.187. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 39.188. 位置参数
概述

<load_balancer>

负载均衡器的名称或 uuid。

Expand
表 39.189. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 39.190. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 39.191. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 39.192. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

39.45. LoadBalancer stats 显示

显示负载均衡器的当前统计信息

使用方法:

openstack loadbalancer stats show [-h]
                                         [-f {json,shell,table,value,yaml}]
                                         [-c COLUMN] [--max-width <integer>]
                                         [--fit-width] [--print-empty]
                                         [--noindent] [--prefix PREFIX]
                                         <load_balancer>
Copy to Clipboard Toggle word wrap

Expand
表 39.193. 表格式
概述

--print-empty

--max-width <integer>

--fit-width

Expand
表 39.194. 
概述

<load_balancer>

Expand
表 39.195. 
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

-c COLUMN, --column COLUMN

Expand
表 39.196. 
概述

--noindent

Expand
表 39.197. 
概述

-h, --help

显示帮助信息并退出

Expand
表 39.198. 
概述

第 40 章 messaging

40.1. 

使用方法:

openstack messaging claim create [-h] [-f {csv,json,table,value,yaml}]
                                        [-c COLUMN] [--max-width <integer>]
                                        [--fit-width] [--print-empty]
                                        [--noindent]
                                        [--quote {all,minimal,none,nonnumeric}]
                                        [--sort-column SORT_COLUMN]
                                        [--ttl <ttl>] [--grace <grace>]
                                        [--limit <limit>]
                                        <queue_name>
Copy to Clipboard Toggle word wrap

Expand
表 40.1. 
概述

--print-empty

--max-width <integer>

--fit-width

Expand
表 40.2. 
概述

<queue_name>

Expand
表 40.3. 
概述

--quote {all,minimal,none,nonnumeric}

Expand
表 40.4. 
概述

-c COLUMN, --column COLUMN

--sort-column SORT_COLUMN

Expand
表 40.5. 
概述

--noindent

Expand
表 40.6. 
概述

--limit <limit>

-h, --help

显示帮助信息并退出

--ttl <ttl>

40.2. 

使用方法:

openstack messaging claim query [-h] [-f {csv,json,table,value,yaml}]
                                       [-c COLUMN] [--max-width <integer>]
                                       [--fit-width] [--print-empty]
                                       [--noindent]
                                       [--quote {all,minimal,none,nonnumeric}]
                                       [--sort-column SORT_COLUMN]
                                       <queue_name> <claim_id>
Copy to Clipboard Toggle word wrap

Expand
表 40.7. 
概述

--print-empty

--max-width <integer>

--fit-width

Expand
表 40.8. 
概述

<claim_id>

<queue_name>

Expand
表 40.9. 
概述

--quote {all,minimal,none,nonnumeric}

Expand
表 40.10. 
概述

-c COLUMN, --column COLUMN

--sort-column SORT_COLUMN

Expand
表 40.11. 
概述

--noindent

Expand
表 40.12. 
概述

-h, --help

显示帮助信息并退出

40.3. 

使用方法:

openstack messaging claim release [-h] <queue_name> <claim_id>
Copy to Clipboard Toggle word wrap

Expand
表 40.13. 
概述

<claim_id>

<queue_name>

Expand
表 40.14. 
概述

-h, --help

显示帮助信息并退出

40.4. 

使用方法:

openstack messaging claim renew [-h] [-f {csv,json,table,value,yaml}]
                                       [-c COLUMN] [--max-width <integer>]
                                       [--fit-width] [--print-empty]
                                       [--noindent]
                                       [--quote {all,minimal,none,nonnumeric}]
                                       [--sort-column SORT_COLUMN]
                                       [--ttl <ttl>] [--grace <grace>]
                                       <queue_name> <claim_id>
Copy to Clipboard Toggle word wrap

Expand
表 40.15. 
概述

--print-empty

--max-width <integer>

--fit-width

Expand
表 40.16. 
概述

<claim_id>

<queue_name>

Expand
表 40.17. 
概述

--quote {all,minimal,none,nonnumeric}

Expand
表 40.18. 
概述

-c COLUMN, --column COLUMN

--sort-column SORT_COLUMN

Expand
表 40.19. 
概述

--noindent

Expand
表 40.20. 
概述

-h, --help

显示帮助信息并退出

--ttl <ttl>

40.5. 

使用方法:

openstack messaging flavor create [-h]
                                         [-f {json,shell,table,value,yaml}]
                                         [-c COLUMN] [--max-width <integer>]
                                         [--fit-width] [--print-empty]
                                         [--noindent] [--prefix PREFIX]
                                         [--capabilities <capabilities>]
                                         <flavor_name> <pool_group>
Copy to Clipboard Toggle word wrap

Expand
表 40.21. 
概述

--print-empty

--max-width <integer>

--fit-width

Expand
表 40.22. 
概述

<pool_group>

<flavor_name>

Expand
表 40.23. 
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

-c COLUMN, --column COLUMN

Expand
表 40.24. 
概述

--noindent

Expand
表 40.25. 
概述

-h, --help

显示帮助信息并退出

Expand
表 40.26. 
概述

40.6. 

使用方法:

openstack messaging flavor delete [-h] <flavor_name>
Copy to Clipboard Toggle word wrap

Expand
表 40.27. 
概述

<flavor_name>

Expand
表 40.28. 
概述

-h, --help

显示帮助信息并退出

40.7. 

使用方法:

openstack messaging flavor list [-h] [-f {csv,json,table,value,yaml}]
                                       [-c COLUMN] [--max-width <integer>]
                                       [--fit-width] [--print-empty]
                                       [--noindent]
                                       [--quote {all,minimal,none,nonnumeric}]
                                       [--sort-column SORT_COLUMN]
                                       [--marker <flavor_name>]
                                       [--limit <limit>] [--detailed]
Copy to Clipboard Toggle word wrap

Expand
表 40.29. 
概述

--print-empty

--max-width <integer>

--fit-width

Expand
表 40.30. 
概述

--quote {all,minimal,none,nonnumeric}

Expand
表 40.31. 
概述

-c COLUMN, --column COLUMN

--sort-column SORT_COLUMN

Expand
表 40.32. 
概述

--noindent

Expand
表 40.33. 
概述

--detailed

--limit <limit>

-h, --help

显示帮助信息并退出

--marker <flavor_name>

40.8. 

使用方法:

openstack messaging flavor show [-h] [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--max-width <integer>]
                                       [--fit-width] [--print-empty]
                                       [--noindent] [--prefix PREFIX]
                                       <flavor_name>
Copy to Clipboard Toggle word wrap

Expand
表 40.34. 
概述

--print-empty

--max-width <integer>

--fit-width

Expand
表 40.35. 
概述

<flavor_name>

Expand
表 40.36. 
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

-c COLUMN, --column COLUMN

Expand
表 40.37. 
概述

--noindent

Expand
表 40.38. 
概述

-h, --help

显示帮助信息并退出

Expand
表 40.39. 
概述

40.9. 

使用方法:

openstack messaging flavor update [-h]
                                         [-f {json,shell,table,value,yaml}]
                                         [-c COLUMN] [--max-width <integer>]
                                         [--fit-width] [--print-empty]
                                         [--noindent] [--prefix PREFIX]
                                         [--pool_group <pool_group>]
                                         [--capabilities <capabilities>]
                                         <flavor_name>
Copy to Clipboard Toggle word wrap

Expand
表 40.40. 
概述

--print-empty

--max-width <integer>

--fit-width

Expand
表 40.41. 
概述

<flavor_name>

Expand
表 40.42. 
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

-c COLUMN, --column COLUMN

Expand
表 40.43. 
概述

--noindent

Expand
表 40.44. 
概述

--pool_group <pool_group>

-h, --help

显示帮助信息并退出

Expand
表 40.45. 
概述

40.10. 

使用方法:

openstack messaging health [-h]
Copy to Clipboard Toggle word wrap

Expand
表 40.46. 
概述

-h, --help

显示帮助信息并退出

40.11. 

使用方法:

openstack messaging homedoc [-h]
Copy to Clipboard Toggle word wrap

Expand
表 40.47. 
概述

-h, --help

显示帮助信息并退出

40.12. 

使用方法:

openstack messaging message list [-h] [-f {csv,json,table,value,yaml}]
                                        [-c COLUMN] [--max-width <integer>]
                                        [--fit-width] [--print-empty]
                                        [--noindent]
                                        [--quote {all,minimal,none,nonnumeric}]
                                        [--sort-column SORT_COLUMN]
                                        [--message-ids <message_ids>]
                                        [--limit <limit>] [--echo]
                                        [--include-claimed]
                                        [--include-delayed]
                                        [--client-id <client_id>]
                                        <queue_name>
Copy to Clipboard Toggle word wrap

Expand
表 40.48. 
概述

--print-empty

--max-width <integer>

--fit-width

Expand
表 40.49. 
概述

<queue_name>

Expand
表 40.50. 
概述

--quote {all,minimal,none,nonnumeric}

Expand
表 40.51. 
概述

-c COLUMN, --column COLUMN

--sort-column SORT_COLUMN

Expand
表 40.52. 
概述

--noindent

Expand
表 40.53. 
概述

--client-id <client_id>

--limit <limit>

--echo

--message-ids <message_ids>

-h, --help

显示帮助信息并退出

--include-delayed

--include-claimed

40.13. 

使用方法:

openstack messaging message post [-h] [--client-id <client_id>]
                                        <queue_name> <messages>
Copy to Clipboard Toggle word wrap

Expand
表 40.54. 
概述

<queue_name>

Expand
表 40.55. 
概述

-h, --help

显示帮助信息并退出

--client-id <client_id>

40.14. 

使用方法:

openstack messaging ping [-h] [-f {json,shell,table,value,yaml}]
                                [-c COLUMN] [--max-width <integer>]
                                [--fit-width] [--print-empty] [--noindent]
                                [--prefix PREFIX]
Copy to Clipboard Toggle word wrap

Expand
表 40.56. 
概述

--print-empty

--max-width <integer>

--fit-width

Expand
表 40.57. 
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

-c COLUMN, --column COLUMN

Expand
表 40.58. 
概述

--noindent

Expand
表 40.59. 
概述

-h, --help

显示帮助信息并退出

Expand
表 40.60. 
概述

40.15. 

使用方法:

openstack messaging pool create [-h] [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--max-width <integer>]
                                       [--fit-width] [--print-empty]
                                       [--noindent] [--prefix PREFIX]
                                       [--pool_group <pool_group>]
                                       [--pool_options <pool_options>]
                                       <pool_name> <pool_uri> <pool_weight>
Copy to Clipboard Toggle word wrap

Expand
表 40.61. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 40.62. 位置参数
概述

<pool_weight>

池的权重

<pool_name>

池的名称

<pool_uri>

存储引擎 uri

Expand
表 40.63. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 40.64. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 40.65. 可选参数
概述

--pool_group <pool_group>

池的组

-h, --help

显示帮助信息并退出

--pool_options <pool_options>

与存储特定选项相关的可选请求组件

Expand
表 40.66. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

40.16. messaging 池删除

删除池

使用方法:

openstack messaging pool delete [-h] <pool_name>
Copy to Clipboard Toggle word wrap

Expand
表 40.67. 位置参数
概述

<pool_name>

池的名称

Expand
表 40.68. 可选参数
概述

-h, --help

显示帮助信息并退出

40.17. 消息传递池列表

列出可用的池

使用方法:

openstack messaging pool list [-h] [-f {csv,json,table,value,yaml}]
                                     [-c COLUMN] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--noindent]
                                     [--quote {all,minimal,none,nonnumeric}]
                                     [--sort-column SORT_COLUMN]
                                     [--marker <pool_name>] [--limit <limit>]
                                     [--detailed]
Copy to Clipboard Toggle word wrap

Expand
表 40.69. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 40.70. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

Expand
表 40.71. 输出格式器
概述

输出 formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

Expand
表 40.72. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 40.73. 可选参数
概述

--detailed

详细输出

--limit <limit>

页面大小限制

-h, --help

显示帮助信息并退出

--marker <pool_name>

池的分页标记

40.18. 消息传递池显示

显示池详情

使用方法:

openstack messaging pool show [-h] [-f {json,shell,table,value,yaml}]
                                     [-c COLUMN] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--noindent] [--prefix PREFIX]
                                     <pool_name>
Copy to Clipboard Toggle word wrap

Expand
表 40.74. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 40.75. 位置参数
概述

<pool_name>

要显示的池(名称)

Expand
表 40.76. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 40.77. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 40.78. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 40.79. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

40.19. 消息传递池更新

更新池属性

使用方法:

openstack messaging pool update [-h] [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--max-width <integer>]
                                       [--fit-width] [--print-empty]
                                       [--noindent] [--prefix PREFIX]
                                       [--pool_uri <pool_uri>]
                                       [--pool_weight <pool_weight>]
                                       [--pool_group <pool_group>]
                                       [--pool_options <pool_options>]
                                       <pool_name>
Copy to Clipboard Toggle word wrap

Expand
表 40.80. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 40.81. 位置参数
概述

<pool_name>

池的名称

Expand
表 40.82. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 40.83. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 40.84. 可选参数
概述

--pool_group <pool_group>

池的组

-h, --help

显示帮助信息并退出

--pool_options <pool_options>

与存储特定选项相关的可选请求组件

--pool_uri <pool_uri>

存储引擎 uri

--pool_weight <pool_weight>

池的权重

Expand
表 40.85. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

40.20. 消息传递队列创建

创建队列

使用方法:

openstack messaging queue create [-h]
                                        [-f {json,shell,table,value,yaml}]
                                        [-c COLUMN] [--max-width <integer>]
                                        [--fit-width] [--print-empty]
                                        [--noindent] [--prefix PREFIX]
                                        <queue_name>
Copy to Clipboard Toggle word wrap

Expand
表 40.86. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 40.87. 位置参数
概述

<queue_name>

队列的名称

Expand
表 40.88. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 40.89. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 40.90. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 40.91. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

40.21. 消息传递队列删除

删除队列

使用方法:

openstack messaging queue delete [-h] <queue_name>
Copy to Clipboard Toggle word wrap

Expand
表 40.92. 位置参数
概述

<queue_name>

队列的名称

Expand
表 40.93. 可选参数
概述

-h, --help

显示帮助信息并退出

40.22. 消息传递队列获取元数据

获取队列元数据

使用方法:

openstack messaging queue get metadata [-h]
                                              [-f {json,shell,table,value,yaml}]
                                              [-c COLUMN]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty]
                                              [--noindent] [--prefix PREFIX]
                                              <queue_name>
Copy to Clipboard Toggle word wrap

Expand
表 40.94. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 40.95. 位置参数
概述

<queue_name>

队列的名称

Expand
表 40.96. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 40.97. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 40.98. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 40.99. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

40.23. 消息传递队列列表

列出可用的队列

使用方法:

openstack messaging queue list [-h] [-f {csv,json,table,value,yaml}]
                                      [-c COLUMN] [--max-width <integer>]
                                      [--fit-width] [--print-empty]
                                      [--noindent]
                                      [--quote {all,minimal,none,nonnumeric}]
                                      [--sort-column SORT_COLUMN]
                                      [--marker <queue_id>] [--limit <limit>]
                                      [--detailed]
Copy to Clipboard Toggle word wrap

Expand
表 40.100. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 40.101. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

Expand
表 40.102. 输出格式器
概述

输出 formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

Expand
表 40.103. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 40.104. 可选参数
概述

--marker <queue_id>

队列的分页标记

--limit <limit>

页面大小限制

-h, --help

显示帮助信息并退出

--detailed

如果显示队列的详细信息

40.24. 消息传递队列清除

清除队列

使用方法:

openstack messaging queue purge [-h]
                                       [--resource_types <resource_types>]
                                       <queue_name>
Copy to Clipboard Toggle word wrap

Expand
表 40.105. 位置参数
概述

<queue_name>

队列的名称

Expand
表 40.106. 可选参数
概述

-h, --help

显示帮助信息并退出

--resource_types <resource_types>

资源类型需要清除。

40.25. 消息传递队列设置元数据

设置队列元数据

使用方法:

openstack messaging queue set metadata [-h]
                                              <queue_name> <queue_metadata>
Copy to Clipboard Toggle word wrap

Expand
表 40.107. 位置参数
概述

<queue_name>

队列的名称

<queue_metadata>

队列元数据,队列的所有元数据都将被替换为 queue_metadata

Expand
表 40.108. 可选参数
概述

-h, --help

显示帮助信息并退出

40.26. 消息传递队列已签名 url

创建预签名的 url

使用方法:

openstack messaging queue signed url [-h]
                                            [-f {json,shell,table,value,yaml}]
                                            [-c COLUMN]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            [--noindent] [--prefix PREFIX]
                                            [--paths <paths>]
                                            [--ttl-seconds <ttl_seconds>]
                                            [--methods <methods>]
                                            <queue_name>
Copy to Clipboard Toggle word wrap

Expand
表 40.109. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 40.110. 位置参数
概述

<queue_name>

队列的名称

Expand
表 40.111. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 40.112. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 40.113. 可选参数
概述

--ttl-seconds <ttl_seconds>

签名过期前的时间长度(以秒为单位)

-h, --help

显示帮助信息并退出

--paths <paths>

以逗号分隔的列表中允许的路径。选项: 消息、订阅、声明

--methods <methods>

使用 作为逗号分隔列表的 HTTP 方法。选项:GET, HEAD, OPTIONS, POST, PUT, DELETE

Expand
表 40.114. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

40.27. 消息传递队列统计

获取队列统计

使用方法:

openstack messaging queue stats [-h] [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--max-width <integer>]
                                       [--fit-width] [--print-empty]
                                       [--noindent] [--prefix PREFIX]
                                       <queue_name>
Copy to Clipboard Toggle word wrap

Expand
表 40.115. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 40.116. 位置参数
概述

<queue_name>

队列的名称

Expand
表 40.117. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 40.118. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 40.119. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 40.120. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

40.28. 消息传递订阅创建

为队列创建订阅

使用方法:

openstack messaging subscription create [-h]
                                               [-f {json,shell,table,value,yaml}]
                                               [-c COLUMN]
                                               [--max-width <integer>]
                                               [--fit-width] [--print-empty]
                                               [--noindent] [--prefix PREFIX]
                                               [--options <options>]
                                               <queue_name> <subscriber> <ttl>
Copy to Clipboard Toggle word wrap

Expand
表 40.121. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 40.122. 位置参数
概述

<subscriber>

将通知的订阅者

<ttl>

订阅生存时间(以秒为单位)

<queue_name>

要订阅的队列名称

Expand
表 40.123. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 40.124. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 40.125. 可选参数
概述

-h, --help

显示帮助信息并退出

--options <options>

json 格式的订阅元数据

Expand
表 40.126. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

40.29. 消息传递订阅删除

创建一个订阅:

使用方法:

openstack messaging subscription delete [-h]
                                               <queue_name> <subscription_id>
Copy to Clipboard Toggle word wrap

Expand
表 40.127. 位置参数
概述

<subscription_id>

订阅的 ID

<queue_name>

订阅队列的名称

Expand
表 40.128. 可选参数
概述

-h, --help

显示帮助信息并退出

40.30. 消息传递订阅列表

列出可用的订阅

使用方法:

openstack messaging subscription list [-h]
                                             [-f {csv,json,table,value,yaml}]
                                             [-c COLUMN]
                                             [--max-width <integer>]
                                             [--fit-width] [--print-empty]
                                             [--noindent]
                                             [--quote {all,minimal,none,nonnumeric}]
                                             [--sort-column SORT_COLUMN]
                                             [--marker <subscription_id>]
                                             [--limit <limit>]
                                             <queue_name>
Copy to Clipboard Toggle word wrap

Expand
表 40.129. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 40.130. 位置参数
概述

<queue_name>

要订阅的队列名称

Expand
表 40.131. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

Expand
表 40.132. 输出格式器
概述

输出 formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

Expand
表 40.133. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 40.134. 可选参数
概述

--limit <limit>

页面大小限制,默认值为 20

-h, --help

显示帮助信息并退出

--marker <subscription_id>

订阅分页标记,前一页面的最后订阅 ID

40.31. 消息传递订阅显示

显示订阅详情

使用方法:

openstack messaging subscription show [-h]
                                             [-f {json,shell,table,value,yaml}]
                                             [-c COLUMN]
                                             [--max-width <integer>]
                                             [--fit-width] [--print-empty]
                                             [--noindent] [--prefix PREFIX]
                                             <queue_name> <subscription_id>
Copy to Clipboard Toggle word wrap

Expand
表 40.135. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 40.136. 位置参数
概述

<subscription_id>

订阅的 ID

<queue_name>

要订阅的队列名称

Expand
表 40.137. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 40.138. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 40.139. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 40.140. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

40.32. 消息传递订阅更新

更新订阅

使用方法:

openstack messaging subscription update [-h]
                                               [-f {json,shell,table,value,yaml}]
                                               [-c COLUMN]
                                               [--max-width <integer>]
                                               [--fit-width] [--print-empty]
                                               [--noindent] [--prefix PREFIX]
                                               [--subscriber <subscriber>]
                                               [--ttl <ttl>]
                                               [--options <options>]
                                               <queue_name> <subscription_id>
Copy to Clipboard Toggle word wrap

Expand
表 40.141. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 40.142. 位置参数
概述

<subscription_id>

订阅的 ID

<queue_name>

要订阅的队列名称

Expand
表 40.143. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 40.144. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 40.145. 可选参数
概述

-h, --help

显示帮助信息并退出

--options <options>

json 格式的订阅元数据

--subscriber <subscriber>

将通知的订阅者

--ttl <ttl>

订阅生存时间(以秒为单位)

Expand
表 40.146. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

第 41 章 metric

本章论述了 metric 命令下的命令。

41.1. 指标聚合

获取聚合指标的测量

使用方法:

openstack metric aggregates [-h] [-f {csv,json,table,value,yaml}]
                                   [-c COLUMN] [--max-width <integer>]
                                   [--fit-width] [--print-empty] [--noindent]
                                   [--quote {all,minimal,none,nonnumeric}]
                                   [--sort-column SORT_COLUMN]
                                   [--resource-type RESOURCE_TYPE]
                                   [--start START] [--stop STOP]
                                   [--granularity GRANULARITY]
                                   [--needed-overlap NEEDED_OVERLAP]
                                   [--groupby GROUPBY] [--fill FILL]
                                   operations [search]
Copy to Clipboard Toggle word wrap

Expand
表 41.1. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 41.2. 位置参数
概述

操作

应用到时间序列的操作

search

用于过滤资源的查询。语法是属性、operator 和值的组合。例如: id=90d58eea-70d7-4294-a49a-170dcdf44c3c 将过滤带有特定 ID 的资源。可以构建更复杂的查询,例如: not (flavor_id!="1" 和 memory>=24)。使用 "" 强制将数据解释为字符串。支持的运算符包括:not 和 记录, PlacementBinding, >=, tc, !=, >, <, =, ==, eq, ne, lt, gt, ge, le, in, le, like, PREROUTING, detector, Bearer, in.

Expand
表 41.3. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

Expand
表 41.4. 输出格式器
概述

输出 formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

Expand
表 41.5. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 41.6. 可选参数
概述

--groupby GROUPBY

用于对资源进行分组的属性

--fill FILL

值在序列中缺少值的回填时间戳时使用。值应该是浮点值或 空值

--start START

周期开始

--resource-type RESOURCE_TYPE

要查询的资源类型

--stop STOP

周期结束

--granularity GRANULARITY

要检索的粒度

-h, --help

显示帮助信息并退出

--needed-overlap NEEDED_OVERLAP

数据点间重叠的百分比

41.2. metric archive-policy create

创建归档策略

使用方法:

openstack metric archive-policy create [-h]
                                              [-f {json,shell,table,value,yaml}]
                                              [-c COLUMN]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty]
                                              [--noindent] [--prefix PREFIX]
                                              -d <DEFINITION> [-b BACK_WINDOW]
                                              [-m AGGREGATION_METHODS]
                                              name
Copy to Clipboard Toggle word wrap

Expand
表 41.7. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 41.8. 位置参数
概述

name

归档策略的名称

Expand
表 41.9. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 41.10. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 41.11. 可选参数
概述

-d <DEFINITION>, --definition <DEFINITION>

归档策略定义的两个属性(由 ),其名称和值均用 分隔

-m AGGREGATION_METHODS, --aggregation-method AGGREGATION_METHODS

归档策略的聚合方法

-h, --help

显示帮助信息并退出

-b BACK_WINDOW, --back-window BACK_WINDOW

归档策略的后窗口

Expand
表 41.12. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

41.3. metric archive-policy delete

删除归档策略

使用方法:

openstack metric archive-policy delete [-h] name
Copy to Clipboard Toggle word wrap

Expand
表 41.13. 位置参数
概述

name

归档策略的名称

Expand
表 41.14. 可选参数
概述

-h, --help

显示帮助信息并退出

41.4. metric archive-policy 列表

列出归档策略

使用方法:

openstack metric archive-policy list [-h]
                                            [-f {csv,json,table,value,yaml}]
                                            [-c COLUMN]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            [--noindent]
                                            [--quote {all,minimal,none,nonnumeric}]
                                            [--sort-column SORT_COLUMN]
Copy to Clipboard Toggle word wrap

Expand
表 41.15. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 41.16. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

Expand
表 41.17. 输出格式器
概述

输出 formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

Expand
表 41.18. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 41.19. 可选参数
概述

-h, --help

显示帮助信息并退出

41.5. metric archive-policy-rule create

创建归档策略规则

使用方法:

openstack metric archive-policy-rule create [-h]
                                                   [-f {json,shell,table,value,yaml}]
                                                   [-c COLUMN]
                                                   [--max-width <integer>]
                                                   [--fit-width]
                                                   [--print-empty]
                                                   [--noindent]
                                                   [--prefix PREFIX] -a
                                                   ARCHIVE_POLICY_NAME -m
                                                   METRIC_PATTERN
                                                   name
Copy to Clipboard Toggle word wrap

Expand
表 41.20. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 41.21. 位置参数
概述

name

规则名称

Expand
表 41.22. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 41.23. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 41.24. 可选参数
概述

-a ARCHIVE_POLICY_NAME, --archive-policy-name ARCHIVE_POLICY_NAME

归档策略名称

-h, --help

显示帮助信息并退出

-m METRIC_PATTERN, --metric-pattern METRIC_PATTERN

要匹配的指标名称通配符

Expand
表 41.25. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

41.6. metric archive-policy-rule delete

删除归档策略规则

使用方法:

openstack metric archive-policy-rule delete [-h] name
Copy to Clipboard Toggle word wrap

Expand
表 41.26. 位置参数
概述

name

归档策略规则的名称

Expand
表 41.27. 可选参数
概述

-h, --help

显示帮助信息并退出

41.7. metric archive-policy-rule 列表

列出归档策略规则

使用方法:

openstack metric archive-policy-rule list [-h]
                                                 [-f {csv,json,table,value,yaml}]
                                                 [-c COLUMN]
                                                 [--max-width <integer>]
                                                 [--fit-width] [--print-empty]
                                                 [--noindent]
                                                 [--quote {all,minimal,none,nonnumeric}]
                                                 [--sort-column SORT_COLUMN]
Copy to Clipboard Toggle word wrap

Expand
表 41.28. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 41.29. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

Expand
表 41.30. 输出格式器
概述

输出 formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

Expand
表 41.31. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 41.32. 可选参数
概述

-h, --help

显示帮助信息并退出

41.8. metric archive-policy-rule show

显示归档策略规则

使用方法:

openstack metric archive-policy-rule show [-h]
                                                 [-f {json,shell,table,value,yaml}]
                                                 [-c COLUMN]
                                                 [--max-width <integer>]
                                                 [--fit-width] [--print-empty]
                                                 [--noindent]
                                                 [--prefix PREFIX]
                                                 name
Copy to Clipboard Toggle word wrap

Expand
表 41.33. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 41.34. 位置参数
概述

name

归档策略规则的名称

Expand
表 41.35. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 41.36. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 41.37. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 41.38. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

41.9. metric archive-policy 显示

显示归档策略

使用方法:

openstack metric archive-policy show [-h]
                                            [-f {json,shell,table,value,yaml}]
                                            [-c COLUMN]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            [--noindent] [--prefix PREFIX]
                                            name
Copy to Clipboard Toggle word wrap

Expand
表 41.39. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 41.40. 位置参数
概述

name

归档策略的名称

Expand
表 41.41. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 41.42. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 41.43. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 41.44. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

41.10. metric archive-policy 更新

更新归档策略

使用方法:

openstack metric archive-policy update [-h]
                                              [-f {json,shell,table,value,yaml}]
                                              [-c COLUMN]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty]
                                              [--noindent] [--prefix PREFIX]
                                              -d <DEFINITION>
                                              name
Copy to Clipboard Toggle word wrap

Expand
表 41.45. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 41.46. 位置参数
概述

name

归档策略的名称

Expand
表 41.47. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 41.48. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 41.49. 可选参数
概述

-d <DEFINITION>, --definition <DEFINITION>

归档策略定义的两个属性(由 ),其名称和值均用 分隔

-h, --help

显示帮助信息并退出

Expand
表 41.50. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

41.11. 指标基准测量添加

执行添加测量的基准测试

使用方法:

openstack metric benchmark measures add [-h]
                                               [--resource-id RESOURCE_ID]
                                               [-f {json,shell,table,value,yaml}]
                                               [-c COLUMN]
                                               [--max-width <integer>]
                                               [--fit-width] [--print-empty]
                                               [--noindent] [--prefix PREFIX]
                                               [--workers WORKERS] --count
                                               COUNT [--batch BATCH]
                                               [--timestamp-start TIMESTAMP_START]
                                               [--timestamp-end TIMESTAMP_END]
                                               [--wait]
                                               metric
Copy to Clipboard Toggle word wrap

Expand
表 41.51. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 41.52. 位置参数
概述

metric

指标的 ID 或名称

Expand
表 41.53. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 41.54. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 41.55. 可选参数
概述

--wait

等待所有测量结果被处理

--count COUNT, -n COUNT

要发送的总测量结果数

--timestamp-start TIMESTAMP_START, -s TIMESTAMP_START

要使用的第一个时间戳

--workers WORKERS, -w WORKERS

要使用的 worker 数量

--resource-id RESOURCE_ID, -r RESOURCE_ID

资源 ID

--batch BATCH, -b BATCH

各个批处理中发送的测量结果数

-h, --help

显示帮助信息并退出

--timestamp-end TIMESTAMP_END, -e TIMESTAMP_END

要使用的最后时间戳

Expand
表 41.56. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

41.12. 指标基准测量显示

测量的基准测试显示

使用方法:

openstack metric benchmark measures show [-h]
                                                [-f {json,shell,table,value,yaml}]
                                                [-c COLUMN]
                                                [--max-width <integer>]
                                                [--fit-width] [--print-empty]
                                                [--noindent] [--prefix PREFIX]
                                                [--sort-column SORT_COLUMN]
                                                [--utc]
                                                [--resource-id RESOURCE_ID]
                                                [--aggregation AGGREGATION]
                                                [--start START] [--stop STOP]
                                                [--granularity GRANULARITY]
                                                [--refresh]
                                                [--resample RESAMPLE]
                                                [--workers WORKERS] --count
                                                COUNT
                                                metric
Copy to Clipboard Toggle word wrap

Expand
表 41.57. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 41.58. 位置参数
概述

metric

指标的 ID 或名称

Expand
表 41.59. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

Expand
表 41.60. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 41.61. 可选参数
概述

--start START

周期开始

--count COUNT, -n COUNT

要发送的总测量结果数

--aggregation AGGREGATION

用于检索的聚合

--refresh

强制聚合所有已知的测量结果

--workers WORKERS, -w WORKERS

要使用的 worker 数量

--resample RESAMPLE

粒度将 resample 时间序列重新为 (以秒为单位)

--resource-id RESOURCE_ID, -r RESOURCE_ID

资源 ID

--stop STOP

周期结束

--granularity GRANULARITY

要检索的粒度

--utc

将时间戳返回为 utc

-h, --help

显示帮助信息并退出

Expand
表 41.62. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

41.13. 指标基准指标创建

创建指标的基准测试

使用方法:

openstack metric benchmark metric create [-h]
                                                [--resource-id RESOURCE_ID]
                                                [-f {json,shell,table,value,yaml}]
                                                [-c COLUMN]
                                                [--max-width <integer>]
                                                [--fit-width] [--print-empty]
                                                [--noindent] [--prefix PREFIX]
                                                [--archive-policy-name ARCHIVE_POLICY_NAME]
                                                [--workers WORKERS] --count
                                                COUNT [--keep]
Copy to Clipboard Toggle word wrap

Expand
表 41.63. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 41.64. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 41.65. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 41.66. 可选参数
概述

--count COUNT, -n COUNT

要创建的指标数

--archive-policy-name ARCHIVE_POLICY_NAME, -a ARCHIVE_POLICY_NAME

归档策略的名称

--keep, -k

保留创建的指标

--workers WORKERS, -w WORKERS

要使用的 worker 数量

--resource-id RESOURCE_ID, -r RESOURCE_ID

资源 ID

-h, --help

显示帮助信息并退出

Expand
表 41.67. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

41.14. 指标基准指标显示

指标的基准测试显示

使用方法:

openstack metric benchmark metric show [-h] [--resource-id RESOURCE_ID]
                                              [-f {json,shell,table,value,yaml}]
                                              [-c COLUMN]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty]
                                              [--noindent] [--prefix PREFIX]
                                              [--workers WORKERS] --count
                                              COUNT
                                              metric [metric ...]
Copy to Clipboard Toggle word wrap

Expand
表 41.68. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 41.69. 位置参数
概述

metric

指标的 ID 或名称

Expand
表 41.70. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 41.71. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 41.72. 可选参数
概述

--count COUNT, -n COUNT

要获取的指标数

-h, --help

显示帮助信息并退出

--resource-id RESOURCE_ID, -r RESOURCE_ID

资源 ID

--workers WORKERS, -w WORKERS

要使用的 worker 数量

Expand
表 41.73. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

41.15. 指标功能列表

列出功能

使用方法:

openstack metric capabilities list [-h]
                                          [-f {json,shell,table,value,yaml}]
                                          [-c COLUMN] [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          [--noindent] [--prefix PREFIX]
Copy to Clipboard Toggle word wrap

Expand
表 41.74. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 41.75. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 41.76. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 41.77. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 41.78. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

41.16. 指标创建

创建指标

使用方法:

openstack metric create [-h] [--resource-id RESOURCE_ID]
                               [-f {json,shell,table,value,yaml}] [-c COLUMN]
                               [--max-width <integer>] [--fit-width]
                               [--print-empty] [--noindent] [--prefix PREFIX]
                               [--archive-policy-name ARCHIVE_POLICY_NAME]
                               [--unit UNIT]
                               [METRIC_NAME]
Copy to Clipboard Toggle word wrap

Expand
表 41.79. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 41.80. 位置参数
概述

METRIC_NAME

指标的名称

Expand
表 41.81. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 41.82. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 41.83. 可选参数
概述

-h, --help

显示帮助信息并退出

--resource-id RESOURCE_ID, -r RESOURCE_ID

资源 ID

--unit UNIT, -u UNIT

指标的单位

--archive-policy-name ARCHIVE_POLICY_NAME, -a ARCHIVE_POLICY_NAME

归档策略的名称

Expand
表 41.84. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

41.17. metric delete

删除指标

使用方法:

openstack metric delete [-h] [--resource-id RESOURCE_ID]
                               metric [metric ...]
Copy to Clipboard Toggle word wrap

Expand
表 41.85. 位置参数
概述

metric

指标的 ID 或名称

Expand
表 41.86. 可选参数
概述

-h, --help

显示帮助信息并退出

--resource-id RESOURCE_ID, -r RESOURCE_ID

资源 ID

41.18. 指标列表

列出指标

使用方法:

openstack metric list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                             [--max-width <integer>] [--fit-width]
                             [--print-empty] [--noindent]
                             [--quote {all,minimal,none,nonnumeric}]
                             [--sort-column SORT_COLUMN] [--limit <LIMIT>]
                             [--marker <MARKER>] [--sort <SORT>]
Copy to Clipboard Toggle word wrap

Expand
表 41.87. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 41.88. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

Expand
表 41.89. 输出格式器
概述

输出 formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

Expand
表 41.90. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 41.91. 可选参数
概述

--limit <LIMIT>

要返回的指标数(默认为 server default)

-h, --help

显示帮助信息并退出

--marker <MARKER>

上一个列表的最后一个项。在此值后返回下一个结果

--sort <SORT>

指标属性排序(示例:user_id:desc- nullslast

41.19. 指标测量结果添加

将测量添加到指标

使用方法:

openstack metric measures add [-h] [--resource-id RESOURCE_ID] -m
                                     MEASURE
                                     metric
Copy to Clipboard Toggle word wrap

Expand
表 41.92. 位置参数
概述

metric

指标的 ID 或名称

Expand
表 41.93. 可选参数
概述

-h, --help

显示帮助信息并退出

--resource-id RESOURCE_ID, -r RESOURCE_ID

资源 ID

-m MEASURE, --measure MEASURE

使用 @分隔的测量结果的时间戳和值

41.20. 指标测量结果聚合

获取聚合指标的测量

使用方法:

openstack metric measures aggregation [-h]
                                             [-f {csv,json,table,value,yaml}]
                                             [-c COLUMN]
                                             [--max-width <integer>]
                                             [--fit-width] [--print-empty]
                                             [--noindent]
                                             [--quote {all,minimal,none,nonnumeric}]
                                             [--sort-column SORT_COLUMN]
                                             [--utc] -m METRIC [METRIC ...]
                                             [--aggregation AGGREGATION]
                                             [--reaggregation REAGGREGATION]
                                             [--start START] [--stop STOP]
                                             [--granularity GRANULARITY]
                                             [--needed-overlap NEEDED_OVERLAP]
                                             [--query QUERY]
                                             [--resource-type RESOURCE_TYPE]
                                             [--groupby GROUPBY] [--refresh]
                                             [--resample RESAMPLE]
                                             [--fill FILL]
Copy to Clipboard Toggle word wrap

Expand
表 41.94. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 41.95. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

Expand
表 41.96. 输出格式器
概述

输出 formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

Expand
表 41.97. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 41.98. 可选参数
概述

--groupby GROUPBY

用于对资源进行分组的属性

--start START

周期开始

--query QUERY

用于过滤资源的查询。语法是属性、operator 和值的组合。例如: id=90d58eea-70d7-4294-a49a-170dcdf44c3c 将过滤带有特定 ID 的资源。可以构建更复杂的查询,例如: not (flavor_id!="1" 和 memory>=24)。使用 "" 强制将数据解释为字符串。支持的运算符包括:not 和 记录, PlacementBinding, >=, tc, !=, >, <, =, ==, eq, ne, lt, gt, ge, le, in, le, like, PREROUTING, detector, Bearer, in.

--fill FILL

值在序列中缺少值的回填时间戳时使用。值应该是浮点值或 空值

--aggregation AGGREGATION

用于检索的粒度聚合函数

-m METRIC [METRIC …​], --metric METRIC [METRIC …​]

指标 ID 或指标名称

--resource-type RESOURCE_TYPE

要查询的资源类型

--refresh

强制聚合所有已知的测量结果

--reaggregation REAGGREGATION

Groupby 聚合功能用于检索

--stop STOP

周期结束

--granularity GRANULARITY

要检索的粒度

--utc

将时间戳返回为 utc

-h, --help

显示帮助信息并退出

--resample RESAMPLE

粒度将 resample 时间序列重新为 (以秒为单位)

--needed-overlap NEEDED_OVERLAP

每个指标所需的数据点百分比

41.21. 指标测量结果批处理指标

使用方法:

openstack metric measures batch-metrics [-h] file
Copy to Clipboard Toggle word wrap

Expand
表 41.99. 位置参数
概述

file

包含针对 stdin 测量或 - 为 stdin 测量的文件(请参见 Gnocchi REST API 文档,了解格式)

Expand
表 41.100. 可选参数
概述

-h, --help

显示帮助信息并退出

41.22. 指标测量结果批处理-resources-metrics

使用方法:

openstack metric measures batch-resources-metrics [-h]
                                                         [--create-metrics]
                                                         file
Copy to Clipboard Toggle word wrap

Expand
表 41.101. 位置参数
概述

file

包含针对 stdin 测量或 - 为 stdin 测量的文件(请参见 Gnocchi REST API 文档,了解格式)

Expand
表 41.102. 可选参数
概述

-h, --help

显示帮助信息并退出

--create-metrics

创建未知指标

41.23. 指标测量结果显示

获取指标的测量

使用方法:

openstack metric measures show [-h] [-f {csv,json,table,value,yaml}]
                                      [-c COLUMN] [--max-width <integer>]
                                      [--fit-width] [--print-empty]
                                      [--noindent]
                                      [--quote {all,minimal,none,nonnumeric}]
                                      [--sort-column SORT_COLUMN] [--utc]
                                      [--resource-id RESOURCE_ID]
                                      [--aggregation AGGREGATION]
                                      [--start START] [--stop STOP]
                                      [--granularity GRANULARITY] [--refresh]
                                      [--resample RESAMPLE]
                                      metric
Copy to Clipboard Toggle word wrap

Expand
表 41.103. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 41.104. 位置参数
概述

metric

指标的 ID 或名称

Expand
表 41.105. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

Expand
表 41.106. 输出格式器
概述

输出 formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

Expand
表 41.107. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 41.108. 可选参数
概述

--start START

周期开始

--aggregation AGGREGATION

用于检索的聚合

--refresh

强制聚合所有已知的测量结果

--resample RESAMPLE

粒度将 resample 时间序列重新为 (以秒为单位)

--resource-id RESOURCE_ID, -r RESOURCE_ID

资源 ID

--stop STOP

周期结束

--granularity GRANULARITY

要检索的粒度

--utc

将时间戳返回为 utc

-h, --help

显示帮助信息并退出

41.24. 指标指标创建

弃用:创建指标

使用方法:

openstack metric metric create [-h] [--resource-id RESOURCE_ID]
                                      [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--max-width <integer>]
                                      [--fit-width] [--print-empty]
                                      [--noindent] [--prefix PREFIX]
                                      [--archive-policy-name ARCHIVE_POLICY_NAME]
                                      [--unit UNIT]
                                      [METRIC_NAME]
Copy to Clipboard Toggle word wrap

Expand
表 41.109. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 41.110. 位置参数
概述

METRIC_NAME

指标的名称

Expand
表 41.111. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 41.112. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 41.113. 可选参数
概述

-h, --help

显示帮助信息并退出

--resource-id RESOURCE_ID, -r RESOURCE_ID

资源 ID

--unit UNIT, -u UNIT

指标的单位

--archive-policy-name ARCHIVE_POLICY_NAME, -a ARCHIVE_POLICY_NAME

归档策略的名称

Expand
表 41.114. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

41.25. metric metric delete

deprecated:删除指标

使用方法:

openstack metric metric delete [-h] [--resource-id RESOURCE_ID]
                                      metric [metric ...]
Copy to Clipboard Toggle word wrap

Expand
表 41.115. 位置参数
概述

metric

指标的 ID 或名称

Expand
表 41.116. 可选参数
概述

-h, --help

显示帮助信息并退出

--resource-id RESOURCE_ID, -r RESOURCE_ID

资源 ID

41.26. 指标指标列表

已弃用: 列出指标

使用方法:

openstack metric metric list [-h] [-f {csv,json,table,value,yaml}]
                                    [-c COLUMN] [--max-width <integer>]
                                    [--fit-width] [--print-empty] [--noindent]
                                    [--quote {all,minimal,none,nonnumeric}]
                                    [--sort-column SORT_COLUMN]
                                    [--limit <LIMIT>] [--marker <MARKER>]
                                    [--sort <SORT>]
Copy to Clipboard Toggle word wrap

Expand
表 41.117. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 41.118. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

Expand
表 41.119. 输出格式器
概述

输出 formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

Expand
表 41.120. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 41.121. 可选参数
概述

--limit <LIMIT>

要返回的指标数(默认为 server default)

-h, --help

显示帮助信息并退出

--marker <MARKER>

上一个列表的最后一个项。在此值后返回下一个结果

--sort <SORT>

指标属性排序(示例:user_id:desc- nullslast

41.27. 指标指标显示

弃用:显示指标

使用方法:

openstack metric metric show [-h] [-f {json,shell,table,value,yaml}]
                                    [-c COLUMN] [--max-width <integer>]
                                    [--fit-width] [--print-empty] [--noindent]
                                    [--prefix PREFIX]
                                    [--resource-id RESOURCE_ID]
                                    metric
Copy to Clipboard Toggle word wrap

Expand
表 41.122. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 41.123. 位置参数
概述

metric

指标的 ID 或名称

Expand
表 41.124. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 41.125. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 41.126. 可选参数
概述

-h, --help

显示帮助信息并退出

--resource-id RESOURCE_ID, -r RESOURCE_ID

资源 ID

Expand
表 41.127. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

41.28. 指标资源批处理删除

根据属性值删除批处理资源

使用方法:

openstack metric resource batch delete [-h]
                                              [-f {json,shell,table,value,yaml}]
                                              [-c COLUMN]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty]
                                              [--noindent] [--prefix PREFIX]
                                              [--type RESOURCE_TYPE]
                                              query
Copy to Clipboard Toggle word wrap

Expand
表 41.128. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 41.129. 位置参数
概述

query

用于过滤资源的查询。语法是属性、operator 和值的组合。例如: id=90d58eea-70d7-4294-a49a-170dcdf44c3c 将过滤带有特定 ID 的资源。可以构建更复杂的查询,例如: not (flavor_id!="1" 和 memory>=24)。使用 "" 强制将数据解释为字符串。支持的运算符包括:not 和 记录, PlacementBinding, >=, tc, !=, >, <, =, ==, eq, ne, lt, gt, ge, le, in, le, like, PREROUTING, detector, Bearer, in.

Expand
表 41.130. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 41.131. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 41.132. 可选参数
概述

-h, --help

显示帮助信息并退出

--type RESOURCE_TYPE, -t RESOURCE_TYPE

资源类型

Expand
表 41.133. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

41.29. 指标资源创建

创建资源

使用方法:

openstack metric resource create [-h]
                                        [-f {json,shell,table,value,yaml}]
                                        [-c COLUMN] [--max-width <integer>]
                                        [--fit-width] [--print-empty]
                                        [--noindent] [--prefix PREFIX]
                                        [--type RESOURCE_TYPE] [-a ATTRIBUTE]
                                        [-m ADD_METRIC] [-n CREATE_METRIC]
                                        resource_id
Copy to Clipboard Toggle word wrap

Expand
表 41.134. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 41.135. 位置参数
概述

resource_id

资源 ID

Expand
表 41.136. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 41.137. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 41.138. 可选参数
概述

-n CREATE_METRIC, --create-metric CREATE_METRIC

name:archive_policy_name

-h, --help

显示帮助信息并退出

-a ATTRIBUTE, --attribute ATTRIBUTE

使用 分隔的属性的名称和值

-m ADD_METRIC, --add-metric ADD_METRIC

要添加的指标的 name:id

--type RESOURCE_TYPE, -t RESOURCE_TYPE

资源类型

Expand
表 41.139. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

41.30. 指标资源删除

删除资源

使用方法:

openstack metric resource delete [-h] resource_id
Copy to Clipboard Toggle word wrap

Expand
表 41.140. 位置参数
概述

resource_id

资源 ID

Expand
表 41.141. 可选参数
概述

-h, --help

显示帮助信息并退出

41.31. 指标资源历史记录

显示资源的历史记录

使用方法:

openstack metric resource history [-h] [-f {csv,json,table,value,yaml}]
                                         [-c COLUMN] [--max-width <integer>]
                                         [--fit-width] [--print-empty]
                                         [--noindent]
                                         [--quote {all,minimal,none,nonnumeric}]
                                         [--sort-column SORT_COLUMN]
                                         [--details] [--limit <LIMIT>]
                                         [--marker <MARKER>] [--sort <SORT>]
                                         [--type RESOURCE_TYPE]
                                         resource_id
Copy to Clipboard Toggle word wrap

Expand
表 41.142. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 41.143. 位置参数
概述

resource_id

资源的 ID

Expand
表 41.144. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

Expand
表 41.145. 输出格式器
概述

输出 formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

Expand
表 41.146. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 41.147. 可选参数
概述

--details

显示通用资源的所有属性

--limit <LIMIT>

要返回的资源数量(默认为 server default)

--sort <SORT>

资源属性排序(示例:user_id:desc- nullslast

--marker <MARKER>

上一个列表的最后一个项。在此值后返回下一个结果

-h, --help

显示帮助信息并退出

--type RESOURCE_TYPE, -t RESOURCE_TYPE

资源类型

41.32. 指标资源列表

列出资源

使用方法:

openstack metric resource list [-h] [-f {csv,json,table,value,yaml}]
                                      [-c COLUMN] [--max-width <integer>]
                                      [--fit-width] [--print-empty]
                                      [--noindent]
                                      [--quote {all,minimal,none,nonnumeric}]
                                      [--sort-column SORT_COLUMN] [--details]
                                      [--history] [--limit <LIMIT>]
                                      [--marker <MARKER>] [--sort <SORT>]
                                      [--type RESOURCE_TYPE]
Copy to Clipboard Toggle word wrap

Expand
表 41.148. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 41.149. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

Expand
表 41.150. 输出格式器
概述

输出 formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

Expand
表 41.151. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 41.152. 可选参数
概述

--details

显示通用资源的所有属性

--limit <LIMIT>

要返回的资源数量(默认为 server default)

--history

显示资源的历史记录

--sort <SORT>

资源属性排序(示例:user_id:desc- nullslast

-h, --help

显示帮助信息并退出

--type RESOURCE_TYPE, -t RESOURCE_TYPE

资源类型

--marker <MARKER>

上一个列表的最后一个项。在此值后返回下一个结果

41.34. 指标资源显示

显示资源

使用方法:

openstack metric resource show [-h] [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--max-width <integer>]
                                      [--fit-width] [--print-empty]
                                      [--noindent] [--prefix PREFIX]
                                      [--type RESOURCE_TYPE]
                                      resource_id
Copy to Clipboard Toggle word wrap

Expand
表 41.159. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 41.160. 位置参数
概述

resource_id

资源的 ID

Expand
表 41.161. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 41.162. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 41.163. 可选参数
概述

-h, --help

显示帮助信息并退出

--type RESOURCE_TYPE, -t RESOURCE_TYPE

资源类型

Expand
表 41.164. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

41.35. metric resource-type create

创建资源类型

使用方法:

openstack metric resource-type create [-h]
                                             [-f {json,shell,table,value,yaml}]
                                             [-c COLUMN]
                                             [--max-width <integer>]
                                             [--fit-width] [--print-empty]
                                             [--noindent] [--prefix PREFIX]
                                             [-a ATTRIBUTE]
                                             name
Copy to Clipboard Toggle word wrap

Expand
表 41.165. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 41.166. 位置参数
概述

name

资源类型的名称

Expand
表 41.167. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 41.168. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 41.169. 可选参数
概述

-h, --help

显示帮助信息并退出

-a ATTRIBUTE, --attribute ATTRIBUTE

attribute definition, attribute_name:attribute_type:at tribute_is_required:attribute_type_option_name=attribu te_type_option_value:…​ 例如:display_name:string:true:max_length=255

Expand
表 41.170. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

41.36. metric resource-type delete

删除资源类型

使用方法:

openstack metric resource-type delete [-h] name
Copy to Clipboard Toggle word wrap

Expand
表 41.171. 位置参数
概述

name

资源类型的名称

Expand
表 41.172. 可选参数
概述

-h, --help

显示帮助信息并退出

41.37. 指标 resource-type 列表

列出资源类型

使用方法:

openstack metric resource-type list [-h]
                                           [-f {csv,json,table,value,yaml}]
                                           [-c COLUMN] [--max-width <integer>]
                                           [--fit-width] [--print-empty]
                                           [--noindent]
                                           [--quote {all,minimal,none,nonnumeric}]
                                           [--sort-column SORT_COLUMN]
Copy to Clipboard Toggle word wrap

Expand
表 41.173. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 41.174. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

Expand
表 41.175. 输出格式器
概述

输出 formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

Expand
表 41.176. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 41.177. 可选参数
概述

-h, --help

显示帮助信息并退出

41.38. metric resource-type 显示

显示资源类型

使用方法:

openstack metric resource-type show [-h]
                                           [-f {json,shell,table,value,yaml}]
                                           [-c COLUMN] [--max-width <integer>]
                                           [--fit-width] [--print-empty]
                                           [--noindent] [--prefix PREFIX]
                                           name
Copy to Clipboard Toggle word wrap

Expand
表 41.178. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 41.179. 位置参数
概述

name

资源类型的名称

Expand
表 41.180. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 41.181. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 41.182. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 41.183. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

41.39. 指标 resource-type 更新

使用方法:

openstack metric resource-type update [-h]
                                             [-f {json,shell,table,value,yaml}]
                                             [-c COLUMN]
                                             [--max-width <integer>]
                                             [--fit-width] [--print-empty]
                                             [--noindent] [--prefix PREFIX]
                                             [-a ATTRIBUTE]
                                             [-r REMOVE_ATTRIBUTE]
                                             name
Copy to Clipboard Toggle word wrap

Expand
表 41.184. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 41.185. 位置参数
概述

name

资源类型的名称

Expand
表 41.186. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 41.187. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 41.188. 可选参数
概述

-r REMOVE_ATTRIBUTE, --remove-attribute REMOVE_ATTRIBUTE

属性名称

-h, --help

显示帮助信息并退出

-a ATTRIBUTE, --attribute ATTRIBUTE

attribute definition, attribute_name:attribute_type:at tribute_is_required:attribute_type_option_name=attribu te_type_option_value:…​ 例如:display_name:string:true:max_length=255

Expand
表 41.189. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

41.40. 指标资源更新

更新资源

使用方法:

openstack metric resource update [-h]
                                        [-f {json,shell,table,value,yaml}]
                                        [-c COLUMN] [--max-width <integer>]
                                        [--fit-width] [--print-empty]
                                        [--noindent] [--prefix PREFIX]
                                        [--type RESOURCE_TYPE] [-a ATTRIBUTE]
                                        [-m ADD_METRIC] [-n CREATE_METRIC]
                                        [-d DELETE_METRIC]
                                        resource_id
Copy to Clipboard Toggle word wrap

Expand
表 41.190. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 41.191. 位置参数
概述

resource_id

资源 ID

Expand
表 41.192. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 41.193. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 41.194. 可选参数
概述

-n CREATE_METRIC, --create-metric CREATE_METRIC

name:archive_policy_name

-m ADD_METRIC, --add-metric ADD_METRIC

要添加的指标的 name:id

-d DELETE_METRIC, --delete-metric DELETE_METRIC

要删除的指标的名称

-h, --help

显示帮助信息并退出

--type RESOURCE_TYPE, -t RESOURCE_TYPE

资源类型

-a ATTRIBUTE, --attribute ATTRIBUTE

使用 分隔的属性的名称和值

Expand
表 41.195. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

41.41. 指标服务器版本

显示 Gnocchi 服务器版本

使用方法:

openstack metric server version [-h] [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--max-width <integer>]
                                       [--fit-width] [--print-empty]
                                       [--noindent] [--prefix PREFIX]
Copy to Clipboard Toggle word wrap

Expand
表 41.196. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 41.197. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 41.198. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 41.199. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 41.200. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

41.42. 指标显示

显示指标

使用方法:

openstack metric show [-h] [-f {json,shell,table,value,yaml}]
                             [-c COLUMN] [--max-width <integer>] [--fit-width]
                             [--print-empty] [--noindent] [--prefix PREFIX]
                             [--resource-id RESOURCE_ID]
                             metric
Copy to Clipboard Toggle word wrap

Expand
表 41.201. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 41.202. 位置参数
概述

metric

指标的 ID 或名称

Expand
表 41.203. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 41.204. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 41.205. 可选参数
概述

-h, --help

显示帮助信息并退出

--resource-id RESOURCE_ID, -r RESOURCE_ID

资源 ID

Expand
表 41.206. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

41.43. 指标状态

显示测量处理的状态

使用方法:

openstack metric status [-h] [-f {json,shell,table,value,yaml}]
                               [-c COLUMN] [--max-width <integer>]
                               [--fit-width] [--print-empty] [--noindent]
                               [--prefix PREFIX]
Copy to Clipboard Toggle word wrap

Expand
表 41.207. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 41.208. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 41.209. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 41.210. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 41.211. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

第 42 章 module

本章论述了 模块 命令下的命令。

42.1. 模块列表

列出模块版本

使用方法:

openstack module list [-h] [-f {json,shell,table,value,yaml}]
                             [-c COLUMN] [--max-width <integer>] [--fit-width]
                             [--print-empty] [--noindent] [--prefix PREFIX]
                             [--all]
Copy to Clipboard Toggle word wrap

Expand
表 42.1. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 42.2. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 42.3. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 42.4. 可选参数
概述

-h, --help

显示帮助信息并退出

--all

显示有版本信息的所有模块

Expand
表 42.5. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

第 43 章 network

本章论述了 网络 命令下的命令。

43.1. 网络代理添加网络

将网络添加到代理

使用方法:

openstack network agent add network [-h] [--dhcp] <agent-id> <network>
Copy to Clipboard Toggle word wrap

Expand
表 43.1. 位置参数
概述

<agent-id>

添加网络的代理(仅协助)

<network>

要添加到代理的网络(名称或 ID)

Expand
表 43.2. 可选参数
概述

-h, --help

显示帮助信息并退出

--dhcp

将网络添加到 dhcp 代理

43.2. 网络代理添加路由器

向代理添加路由器

使用方法:

openstack network agent add router [-h] [--l3] <agent-id> <router>
Copy to Clipboard Toggle word wrap

Expand
表 43.3. 位置参数
概述

<agent-id>

添加路由器的代理(仅用于帮助)

<router>

要添加到代理的路由器(名称或 ID)

Expand
表 43.4. 可选参数
概述

--l3

将路由器添加到 l3 代理

-h, --help

显示帮助信息并退出

43.3. 网络代理删除

删除网络代理

使用方法:

openstack network agent delete [-h]
                                      <network-agent> [<network-agent> ...]
Copy to Clipboard Toggle word wrap

Expand
表 43.5. 位置参数
概述

<network-agent>

要删除的网络代理(仅限 ID)

Expand
表 43.6. 可选参数
概述

-h, --help

显示帮助信息并退出

43.4. 网络代理列表

列出网络代理

使用方法:

openstack network agent list [-h] [-f {csv,json,table,value,yaml}]
                                    [-c COLUMN] [--max-width <integer>]
                                    [--fit-width] [--print-empty] [--noindent]
                                    [--quote {all,minimal,none,nonnumeric}]
                                    [--sort-column SORT_COLUMN]
                                    [--agent-type <agent-type>]
                                    [--host <host>]
                                    [--network <network> | --router <router>]
                                    [--long]
Copy to Clipboard Toggle word wrap

Expand
表 43.7. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 43.8. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

Expand
表 43.9. 输出格式器
概述

输出 formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

Expand
表 43.10. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 43.11. 可选参数
概述

--router <router>

列出托管此路由器的代理(名称或 id)

--host <host>

仅列出在指定主机上运行的代理

--long

列出输出中的其他字段

--network <network>

列出托管网络的代理(名称或 id)

--agent-type <agent-type>

仅列出指定代理类型的代理。支持的代理类型为 bgp, dhcp, open-vswitch, linux-bridge, ofa, l3, loadbalancer, metering, metadata, macvtap, nic.

-h, --help

显示帮助信息并退出

43.5. 网络代理删除网络

从代理中删除网络。

使用方法:

openstack network agent remove network [-h] [--dhcp]
                                              <agent-id> <network>
Copy to Clipboard Toggle word wrap

Expand
表 43.12. 位置参数
概述

<agent-id>

移除网络的代理(仅限 ID)

<network>

要从代理中删除的网络(名称或 id)

Expand
表 43.13. 可选参数
概述

-h, --help

显示帮助信息并退出

--dhcp

从 dhcp 代理中删除网络

43.6. 网络代理删除路由器

从代理中删除路由器

使用方法:

openstack network agent remove router [-h] [--l3] <agent-id> <router>
Copy to Clipboard Toggle word wrap

Expand
表 43.14. 位置参数
概述

<agent-id>

从中删除路由器的代理(仅限 ID)

<router>

要从代理中删除的路由器(名称或 id)

Expand
表 43.15. 可选参数
概述

--l3

从 l3 代理中删除路由器

-h, --help

显示帮助信息并退出

43.7. 网络代理集

设置网络代理属性

使用方法:

openstack network agent set [-h] [--description <description>]
                                   [--enable | --disable]
                                   <network-agent>
Copy to Clipboard Toggle word wrap

Expand
表 43.16. 位置参数
概述

<network-agent>

要修改的网络代理(仅限 ID)

Expand
表 43.17. 可选参数
概述

--disable

禁用网络代理

-h, --help

显示帮助信息并退出

--description <description>

设置网络代理描述

--enable

启用网络代理

43.8. 网络代理显示

显示网络代理详情

使用方法:

openstack network agent show [-h] [-f {json,shell,table,value,yaml}]
                                    [-c COLUMN] [--max-width <integer>]
                                    [--fit-width] [--print-empty] [--noindent]
                                    [--prefix PREFIX]
                                    <network-agent>
Copy to Clipboard Toggle word wrap

Expand
表 43.18. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 43.19. 位置参数
概述

<network-agent>

要显示的网络代理(仅限 ID)

Expand
表 43.20. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 43.21. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 43.22. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 43.23. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

43.9. 网络自动分配拓扑创建

为项目创建自动分配的拓扑

使用方法:

openstack network auto allocated topology create [-h]
                                                        [-f {json,shell,table,value,yaml}]
                                                        [-c COLUMN]
                                                        [--max-width <integer>]
                                                        [--fit-width]
                                                        [--print-empty]
                                                        [--noindent]
                                                        [--prefix PREFIX]
                                                        [--project <project>]
                                                        [--project-domain <project-domain>]
                                                        [--check-resources]
                                                        [--or-show]
Copy to Clipboard Toggle word wrap

Expand
表 43.24. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 43.25. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 43.26. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 43.27. 可选参数
概述

-h, --help

显示帮助信息并退出

--check-resources

验证自动分配的拓扑要求。不返回拓扑。

--or-show

如果拓扑存在,则返回拓扑的信息(默认)

--project <project>

返回给定项目的自动分配拓扑。默认值是当前项目

--project-domain <project-domain>

项目所属的域(名称或 id)。这可在项目名称之间有冲突时使用。

Expand
表 43.28. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

43.10. 网络自动分配拓扑删除

删除项目的自动分配拓扑

使用方法:

openstack network auto allocated topology delete [-h]
                                                        [--project <project>]
                                                        [--project-domain <project-domain>]
Copy to Clipboard Toggle word wrap

Expand
表 43.29. 可选参数
概述

-h, --help

显示帮助信息并退出

--project <project>

删除给定项目的自动分配拓扑。Default 是当前项目

--project-domain <project-domain>

项目所属的域(名称或 id)。这可在项目名称之间有冲突时使用。

43.11. Network create

创建新网络

使用方法:

openstack network create [-h] [-f {json,shell,table,value,yaml}]
                                [-c COLUMN] [--max-width <integer>]
                                [--fit-width] [--print-empty] [--noindent]
                                [--prefix PREFIX] [--share | --no-share]
                                [--enable | --disable] [--project <project>]
                                [--description <description>] [--mtu <mtu>]
                                [--project-domain <project-domain>]
                                [--availability-zone-hint <availability-zone>]
                                [--enable-port-security | --disable-port-security]
                                [--external | --internal]
                                [--default | --no-default]
                                [--qos-policy <qos-policy>]
                                [--transparent-vlan | --no-transparent-vlan]
                                [--provider-network-type <provider-network-type>]
                                [--provider-physical-network <provider-physical-network>]
                                [--provider-segment <provider-segment>]
                                [--tag <tag> | --no-tag]
                                <name>
Copy to Clipboard Toggle word wrap

Expand
表 43.30. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 43.31. 位置参数
概述

<name>

新网络名称

Expand
表 43.32. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 43.33. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 43.34. 可选参数
概述

--availability-zone-hint <availability-zone>

创建此网络的可用区(需要额外域扩展,重复设置多个可用区)的选项。

--enable

启用网络(默认)

--internal

将此网络设置为内部网络(默认)

--disable-port-security

在此网络上创建的端口默认为禁用端口安全性

--transparent-vlan

使网络 vlan 透明

--share

在项目间共享网络

--enable-port-security

对于在此网络中创建的端口,默认启用端口安全性(默认)

--provider-segment <provider-segment>

用于 GENEVE/GRE/VXLAN 网络的 VLAN ID 或隧道 ID

--qos-policy <qos-policy>

附加到此网络的 QoS 策略(名称或 ID)

-h, --help

显示帮助信息并退出

--description <description>

设置网络描述

--project-domain <project-domain>

项目所属的域(名称或 id)。这可在项目名称之间有冲突时使用。

--mtu <mtu>

设置网络 mtu

--no-tag

没有与网络关联的标签

--no-transparent-vlan

不要使网络 vlan 透明

--no-share

不要在项目间共享网络

--external

将此网络设置为外部网络(需要外部网络)

--provider-physical-network <provider-physical-network>

虚拟网络所实施的物理网络的名称

--default

指定是否应该将此网络用作默认外部网络

--provider-network-type <provider-network-type>

虚拟网络实施的物理机制。例如: flat、geneve、gre、local、vlan 和 vxlan。

--project <project>

所有者的项目(名称或 id)

--tag <tag>

要添加到网络的标签(重复选项来设置多个标签)

--disable

禁用网络

--no-default

不要使用网络作为默认外部网络(默认)

Expand
表 43.35. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

43.12. Network delete

删除网络

使用方法:

openstack network delete [-h] <network> [<network> ...]
Copy to Clipboard Toggle word wrap

Expand
表 43.36. 位置参数
概述

<network>

要删除的网络(名称或 ID)

Expand
表 43.37. 可选参数
概述

-h, --help

显示帮助信息并退出

43.13. Network flavor add 配置集

将服务配置集添加到网络类型

使用方法:

openstack network flavor add profile [-h] <flavor> <service-profile>
Copy to Clipboard Toggle word wrap

Expand
表 43.38. 位置参数
概述

<service-profile>

服务配置文件(仅限id)

<flavor>

网络类别(名称或 ID)

Expand
表 43.39. 可选参数
概述

-h, --help

显示帮助信息并退出

43.14. 网络类别创建

创建新网络类型

使用方法:

openstack network flavor create [-h] [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--max-width <integer>]
                                       [--fit-width] [--print-empty]
                                       [--noindent] [--prefix PREFIX]
                                       --service-type <service-type>
                                       [--description DESCRIPTION]
                                       [--project <project>]
                                       [--project-domain <project-domain>]
                                       [--enable | --disable]
                                       <name>
Copy to Clipboard Toggle word wrap

Expand
表 43.40. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 43.41. 位置参数
概述

<name>

类别的名称

Expand
表 43.42. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 43.43. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 43.44. 可选参数
概述

--enable

启用类别(默认)

--project <project>

所有者的项目(名称或 id)

--service-type <service-type>

类别所应用到的服务类型:例如 vpn (用于加载示例的 openstack network service provider list)。

--description DESCRIPTION

类别描述

-h, --help

显示帮助信息并退出

--disable

禁用类别

--project-domain <project-domain>

项目所属的域(名称或 id)。这可在项目名称之间有冲突时使用。

Expand
表 43.45. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

43.15. Network flavor delete

删除网络类型

使用方法:

openstack network flavor delete [-h] <flavor> [<flavor> ...]
Copy to Clipboard Toggle word wrap

Expand
表 43.46. 位置参数
概述

<flavor>

要删除的类别(名称或 ID)

Expand
表 43.47. 可选参数
概述

-h, --help

显示帮助信息并退出

43.16. Network flavor list

列出网络类型

使用方法:

openstack network flavor list [-h] [-f {csv,json,table,value,yaml}]
                                     [-c COLUMN] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--noindent]
                                     [--quote {all,minimal,none,nonnumeric}]
                                     [--sort-column SORT_COLUMN]
Copy to Clipboard Toggle word wrap

Expand
表 43.48. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 43.49. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

Expand
表 43.50. 输出格式器
概述

输出 formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

Expand
表 43.51. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 43.52. 可选参数
概述

-h, --help

显示帮助信息并退出

43.17. Network flavor profile create

创建新网络类别配置集

使用方法:

openstack network flavor profile create [-h]
                                               [-f {json,shell,table,value,yaml}]
                                               [-c COLUMN]
                                               [--max-width <integer>]
                                               [--fit-width] [--print-empty]
                                               [--noindent] [--prefix PREFIX]
                                               [--project <project>]
                                               [--project-domain <project-domain>]
                                               [--description <description>]
                                               [--enable | --disable]
                                               [--driver DRIVER]
                                               [--metainfo METAINFO]
Copy to Clipboard Toggle word wrap

Expand
表 43.53. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 43.54. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 43.55. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 43.56. 可选参数
概述

--description <description>

类别配置集的描述

--driver DRIVER

到驱动程序的 Python 模块路径。如果缺少 --metainfo,这就会需要,反之亦然

--enable

启用 flavor 配置集

--project-domain <project-domain>

项目所属的域(名称或 id)。这可在项目名称之间有冲突时使用。

-h, --help

显示帮助信息并退出

--disable

禁用 flavor 配置集

--project <project>

所有者的项目(名称或 id)

--metainfo METAINFO

类别配置集的 metainfo。如果缺少 --driver 且反之亦然,则需要此参数

Expand
表 43.57. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

43.18. Network flavor profile delete

删除网络 flavor 配置集

使用方法:

openstack network flavor profile delete [-h]
                                               <flavor-profile>
                                               [<flavor-profile> ...]
Copy to Clipboard Toggle word wrap

Expand
表 43.58. 位置参数
概述

<flavor-profile>

要删除的 flavor 配置集(仅限id only)

Expand
表 43.59. 可选参数
概述

-h, --help

显示帮助信息并退出

43.19. Network flavor 配置集列表

列出网络类别配置集

使用方法:

openstack network flavor profile list [-h]
                                             [-f {csv,json,table,value,yaml}]
                                             [-c COLUMN]
                                             [--max-width <integer>]
                                             [--fit-width] [--print-empty]
                                             [--noindent]
                                             [--quote {all,minimal,none,nonnumeric}]
                                             [--sort-column SORT_COLUMN]
Copy to Clipboard Toggle word wrap

Expand
表 43.60. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 43.61. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

Expand
表 43.62. 输出格式器
概述

输出 formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

Expand
表 43.63. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 43.64. 可选参数
概述

-h, --help

显示帮助信息并退出

43.20. 网络 flavor 配置集集

设置网络类别配置集属性

使用方法:

openstack network flavor profile set [-h]
                                            [--project-domain <project-domain>]
                                            [--description <description>]
                                            [--enable | --disable]
                                            [--driver DRIVER]
                                            [--metainfo METAINFO]
                                            <flavor-profile>
Copy to Clipboard Toggle word wrap

Expand
表 43.65. 位置参数
概述

<flavor-profile>

要更新的类别配置集(仅id only)

Expand
表 43.66. 可选参数
概述

--description <description>

类别配置集的描述

--driver DRIVER

到驱动程序的 Python 模块路径。如果缺少 --metainfo,这就会需要,反之亦然

--enable

启用 flavor 配置集

-h, --help

显示帮助信息并退出

--disable

禁用 flavor 配置集

--project-domain <project-domain>

项目所属的域(名称或 id)。这可在项目名称之间有冲突时使用。

--metainfo METAINFO

类别配置集的 metainfo。如果缺少 --driver 且反之亦然,则需要此参数

43.21. Network flavor profile show

显示网络 flavor 配置集详情

使用方法:

openstack network flavor profile show [-h]
                                             [-f {json,shell,table,value,yaml}]
                                             [-c COLUMN]
                                             [--max-width <integer>]
                                             [--fit-width] [--print-empty]
                                             [--noindent] [--prefix PREFIX]
                                             <flavor-profile>
Copy to Clipboard Toggle word wrap

Expand
表 43.67. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 43.68. 位置参数
概述

<flavor-profile>

要显示的 flavor 配置集(仅id only)

Expand
表 43.69. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 43.70. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 43.71. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 43.72. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

43.22. Network flavor remove 配置集

从网络类型中删除服务配置集

使用方法:

openstack network flavor remove profile [-h] <flavor> <service-profile>
Copy to Clipboard Toggle word wrap

Expand
表 43.73. 位置参数
概述

<service-profile>

服务配置文件(仅限id)

<flavor>

网络类别(名称或 ID)

Expand
表 43.74. 可选参数
概述

-h, --help

显示帮助信息并退出

43.23. 网络类别集

设置网络类别属性

使用方法:

openstack network flavor set [-h] [--description DESCRIPTION]
                                    [--disable | --enable] [--name <name>]
                                    <flavor>
Copy to Clipboard Toggle word wrap

Expand
表 43.75. 位置参数
概述

<flavor>

要更新的类别(名称或 id)

Expand
表 43.76. 可选参数
概述

--enable

启用网络类型

--name <name>

设置类别名称

-h, --help

显示帮助信息并退出

--disable

禁用网络类型

--description DESCRIPTION

设置网络类别描述

43.24. 网络类别显示

显示网络类别详细信息

使用方法:

openstack network flavor show [-h] [-f {json,shell,table,value,yaml}]
                                     [-c COLUMN] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--noindent] [--prefix PREFIX]
                                     <flavor>
Copy to Clipboard Toggle word wrap

Expand
表 43.77. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 43.78. 位置参数
概述

<flavor>

显示的类别(名称或 ID)

Expand
表 43.79. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 43.80. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 43.81. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 43.82. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

43.25. 网络列表

列出网络

使用方法:

openstack network list [-h] [-f {csv,json,table,value,yaml}]
                              [-c COLUMN] [--max-width <integer>]
                              [--fit-width] [--print-empty] [--noindent]
                              [--quote {all,minimal,none,nonnumeric}]
                              [--sort-column SORT_COLUMN]
                              [--external | --internal] [--long]
                              [--name <name>] [--enable | --disable]
                              [--project <project>]
                              [--project-domain <project-domain>]
                              [--share | --no-share] [--status <status>]
                              [--provider-network-type <provider-network-type>]
                              [--provider-physical-network <provider-physical-network>]
                              [--provider-segment <provider-segment>]
                              [--agent <agent-id>] [--tags <tag>[,<tag>,...]]
                              [--any-tags <tag>[,<tag>,...]]
                              [--not-tags <tag>[,<tag>,...]]
                              [--not-any-tags <tag>[,<tag>,...]]
Copy to Clipboard Toggle word wrap

Expand
表 43.83. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 43.84. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

Expand
表 43.85. 输出格式器
概述

输出 formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

Expand
表 43.86. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 43.87. 可选参数
概述

--share

列出项目间共享的网络

--agent <agent-id>

列出代理托管的网络(仅限 ID)

--tags <tag>[,<tag>,…​]

列出具有所有给定标签(组合的标记列表)的网络。

--enable

列出已启用的网络

--not-any-tags <tag>[,<tag>,…​]

排除具有任何给定标签(组合标签列表)的网络。

--name <name>

根据名称列出网络

--internal

列出内部网络

--long

列出输出中的其他字段

--project-domain <project-domain>

项目所属的域(名称或 id)。这可在项目名称之间有冲突时使用。

--any-tags <tag>[,<tag>,…​]

列出具有任何给定标签(组合的标记列表)的网络。

--status <status>

根据其状态列出网络(活动BUILDDOWNERROR)

--provider-segment <provider-segment>

根据 GENEVE/GRE/VXLAN 网络的 vlan id 或 Tunnel ID 列出网络

--no-share

列出项目间不共享的网络

--external

列出外部网络

--provider-physical-network <provider-physical-network>

根据物理网络的名称列出网络

--provider-network-type <provider-network-type>

根据物理机制列出网络。支持的选项有: flat、geneve、gre、local、vlan 和 vxlan。

-h, --help

显示帮助信息并退出

--disable

列出禁用的网络

--not-tags <tag>[,<tag>,…​]

排除具有所有给定标签(s) (comma- separated tags 列表)的网络。

--project <project>

根据其项目列出网络(名称或 ID)

43.26. 网络日志创建

创建新网络日志

使用方法:

openstack network log create [-h] [-f {json,shell,table,value,yaml}]
                                    [-c COLUMN] [--max-width <integer>]
                                    [--fit-width] [--print-empty] [--noindent]
                                    [--prefix PREFIX]
                                    [--description <description>]
                                    [--enable | --disable]
                                    [--project <project>]
                                    [--project-domain <project-domain>]
                                    [--event <event>] --resource-type
                                    <resource-type> [--resource <resource>]
                                    [--target <target>]
                                    <name>
Copy to Clipboard Toggle word wrap

Expand
表 43.88. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 43.89. 位置参数
概述

<name>

网络日志的名称

Expand
表 43.90. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 43.91. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 43.92. 可选参数
概述

--description <description>

网络日志的描述

--enable

启用此日志(默认为禁用)

--resource <resource>

用于日志记录的安全组(名称或 id)。您可以控制日志记录目标与 --target 选项。

--project <project>

所有者的项目(名称或 id)

--resource-type <resource-type>

网络日志类型。您可以使用以下命令查看支持的类型: $ openstack network loggable resource list

--event <event>

使用日志存储的事件

--target <target>

用于日志记录的端口(名称或 id)。您可以控制日志记录目标与 --resource 选项的组合。

-h, --help

显示帮助信息并退出

--disable

禁用此日志

--project-domain <project-domain>

项目所属的域(名称或 id)。这可在项目名称之间有冲突时使用。

Expand
表 43.93. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

43.27. Network log delete

删除网络日志

使用方法:

openstack network log delete [-h] <network-log> [<network-log> ...]
Copy to Clipboard Toggle word wrap

Expand
表 43.94. 位置参数
概述

<network-log>

要删除的网络日志(名称或 ID)

Expand
表 43.95. 可选参数
概述

-h, --help

显示帮助信息并退出

43.28. 网络日志列表

列出网络日志

使用方法:

openstack network log list [-h] [-f {csv,json,table,value,yaml}]
                                  [-c COLUMN] [--max-width <integer>]
                                  [--fit-width] [--print-empty] [--noindent]
                                  [--quote {all,minimal,none,nonnumeric}]
                                  [--sort-column SORT_COLUMN] [--long]
Copy to Clipboard Toggle word wrap

Expand
表 43.96. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 43.97. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

Expand
表 43.98. 输出格式器
概述

输出 formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

Expand
表 43.99. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 43.100. 可选参数
概述

-h, --help

显示帮助信息并退出

--long

列出输出中的其他字段

43.29. 网络日志集

设置网络日志属性

使用方法:

openstack network log set [-h] [--description <description>]
                                 [--enable | --disable] [--name <name>]
                                 <network-log>
Copy to Clipboard Toggle word wrap

Expand
表 43.101. 位置参数
概述

<network-log>

要设置的网络日志(名称或 id)

Expand
表 43.102. 可选参数
概述

--disable

禁用此日志

-h, --help

显示帮助信息并退出

--description <description>

网络日志的描述

--name <name>

网络日志的名称

--enable

启用此日志(默认为禁用)

43.30. 网络日志显示

显示网络日志详情

使用方法:

openstack network log show [-h] [-f {json,shell,table,value,yaml}]
                                  [-c COLUMN] [--max-width <integer>]
                                  [--fit-width] [--print-empty] [--noindent]
                                  [--prefix PREFIX]
                                  <network-log>
Copy to Clipboard Toggle word wrap

Expand
表 43.103. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 43.104. 位置参数
概述

<network-log>

网络日志以显示(名称或 id)

Expand
表 43.105. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 43.106. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 43.107. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 43.108. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

43.31. 网络可日志的资源列表

列出支持的 loggable 资源

使用方法:

openstack network loggable resources list [-h]
                                                 [-f {csv,json,table,value,yaml}]
                                                 [-c COLUMN]
                                                 [--max-width <integer>]
                                                 [--fit-width] [--print-empty]
                                                 [--noindent]
                                                 [--quote {all,minimal,none,nonnumeric}]
                                                 [--sort-column SORT_COLUMN]
                                                 [--long]
Copy to Clipboard Toggle word wrap

Expand
表 43.109. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 43.110. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

Expand
表 43.111. 输出格式器
概述

输出 formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

Expand
表 43.112. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 43.113. 可选参数
概述

-h, --help

显示帮助信息并退出

--long

列出输出中的其他字段

43.32. 网络计量创建

创建网络计量

使用方法:

openstack network meter create [-h] [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--max-width <integer>]
                                      [--fit-width] [--print-empty]
                                      [--noindent] [--prefix PREFIX]
                                      [--description <description>]
                                      [--project <project>]
                                      [--project-domain <project-domain>]
                                      [--share | --no-share]
                                      <name>
Copy to Clipboard Toggle word wrap

Expand
表 43.114. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 43.115. 位置参数
概述

<name>

计量名称

Expand
表 43.116. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 43.117. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 43.118. 可选参数
概述

--share

在项目间共享计量

--project-domain <project-domain>

项目所属的域(名称或 id)。这可在项目名称之间有冲突时使用。

--no-share

不要在项目间共享计量

-h, --help

显示帮助信息并退出

--description <description>

为 meter 创建描述

--project <project>

所有者的项目(名称或 id)

Expand
表 43.119. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

43.33. 网络计量删除

删除网络计量

使用方法:

openstack network meter delete [-h] <meter> [<meter> ...]
Copy to Clipboard Toggle word wrap

Expand
表 43.120. 位置参数
概述

<meter>

要删除的计量(名称或 id)

Expand
表 43.121. 可选参数
概述

-h, --help

显示帮助信息并退出

43.34. 网络计量列表

列出网络计量

使用方法:

openstack network meter list [-h] [-f {csv,json,table,value,yaml}]
                                    [-c COLUMN] [--max-width <integer>]
                                    [--fit-width] [--print-empty] [--noindent]
                                    [--quote {all,minimal,none,nonnumeric}]
                                    [--sort-column SORT_COLUMN]
Copy to Clipboard Toggle word wrap

Expand
表 43.122. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 43.123. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

Expand
表 43.124. 输出格式器
概述

输出 formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

Expand
表 43.125. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 43.126. 可选参数
概述

-h, --help

显示帮助信息并退出

43.35. 网络计量规则创建

创建新的计量规则

使用方法:

openstack network meter rule create [-h]
                                           [-f {json,shell,table,value,yaml}]
                                           [-c COLUMN] [--max-width <integer>]
                                           [--fit-width] [--print-empty]
                                           [--noindent] [--prefix PREFIX]
                                           [--project <project>]
                                           [--project-domain <project-domain>]
                                           [--exclude | --include]
                                           [--ingress | --egress]
                                           --remote-ip-prefix
                                           <remote-ip-prefix>
                                           <meter>
Copy to Clipboard Toggle word wrap

Expand
表 43.127. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 43.128. 位置参数
概述

<meter>

与此 metering 规则关联的标签(名称或 ID)

Expand
表 43.129. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 43.130. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 43.131. 可选参数
概述

--exclude

从流量数中排除远程 ip 前缀

--include

包括来自流量数的远程 ip 前缀(默认)

--remote-ip-prefix <remote-ip-prefix>

与这个规则关联的远程 ip 前缀

--ingress

将规则应用到传入流量(默认)

--project-domain <project-domain>

项目所属的域(名称或 id)。这可在项目名称之间有冲突时使用。

-h, --help

显示帮助信息并退出

--project <project>

所有者的项目(名称或 id)

--egress

将规则应用到传出流量

Expand
表 43.132. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

43.36. 网络计量规则删除

删除计量规则

使用方法:

openstack network meter rule delete [-h]
                                           <meter-rule-id>
                                           [<meter-rule-id> ...]
Copy to Clipboard Toggle word wrap

Expand
表 43.133. 位置参数
概述

<meter-rule-id>

要删除的计量规则(仅限 ID)

Expand
表 43.134. 可选参数
概述

-h, --help

显示帮助信息并退出

43.37. 网络计量规则列表

列出计量规则

使用方法:

openstack network meter rule list [-h] [-f {csv,json,table,value,yaml}]
                                         [-c COLUMN] [--max-width <integer>]
                                         [--fit-width] [--print-empty]
                                         [--noindent]
                                         [--quote {all,minimal,none,nonnumeric}]
                                         [--sort-column SORT_COLUMN]
Copy to Clipboard Toggle word wrap

Expand
表 43.135. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 43.136. CSV Formatter
概述

--quote {all,minimal,none,nonnumeric}

当包含引号时,默认为 nonnumeric

Expand
表 43.137. 输出格式器
概述

输出 formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

--sort-column SORT_COLUMN

指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复

Expand
表 43.138. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 43.139. 可选参数
概述

-h, --help

显示帮助信息并退出

43.38. 网络计量规则显示

显示计量规则详情

使用方法:

openstack network meter rule show [-h]
                                         [-f {json,shell,table,value,yaml}]
                                         [-c COLUMN] [--max-width <integer>]
                                         [--fit-width] [--print-empty]
                                         [--noindent] [--prefix PREFIX]
                                         <meter-rule-id>
Copy to Clipboard Toggle word wrap

Expand
表 43.140. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 43.141. 位置参数
概述

<meter-rule-id>

计量规则(仅限 ID)

Expand
表 43.142. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 43.143. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 43.144. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 43.145. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

43.39. 网络计量显示

显示网络计量

使用方法:

openstack network meter show [-h] [-f {json,shell,table,value,yaml}]
                                    [-c COLUMN] [--max-width <integer>]
                                    [--fit-width] [--print-empty] [--noindent]
                                    [--prefix PREFIX]
                                    <meter>
Copy to Clipboard Toggle word wrap

Expand
表 43.146. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 43.147. 位置参数
概述

<meter>

要显示的计量(名称或 id)

Expand
表 43.148. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 43.149. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 43.150. 可选参数
概述

-h, --help

显示帮助信息并退出

Expand
表 43.151. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

43.40. 网络 qos 策略创建

创建 QoS 策略

使用方法:

openstack network qos policy create [-h]
                                           [-f {json,shell,table,value,yaml}]
                                           [-c COLUMN] [--max-width <integer>]
                                           [--fit-width] [--print-empty]
                                           [--noindent] [--prefix PREFIX]
                                           [--description <description>]
                                           [--share | --no-share]
                                           [--project <project>]
                                           [--project-domain <project-domain>]
                                           [--default | --no-default]
                                           <name>
Copy to Clipboard Toggle word wrap

Expand
表 43.152. 表格式
概述

--print-empty

如果没有要显示数据,则打印空表。

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

Expand
表 43.153. 位置参数
概述

<name>

要创建的 qos 策略的名称

Expand
表 43.154. 输出格式器
概述

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

Expand
表 43.155. JSON Formatter
概述

--noindent

是否禁用缩进 json

Expand
表 43.156. 可选参数
概述

--share

使 qos 策略可供其他项目访问

--project-domain <project-domain>

项目所属的域(名称或 id)。这可在项目名称之间有冲突时使用。

--no-share

使 qos 策略不能被其他项目访问(默认)

--no-default

将它设置为非默认网络 qos 策略

--default

将它设置为默认网络 qos 策略

-h, --help

显示帮助信息并退出

--description <description>

qos 策略的描述

--project <project>

所有者的项目(名称或 id)

Expand
表 43.157. shell Formatter
概述

格式化 UNIX shell 可以解析(variable="value")--prefix PREFIX

为所有变量名称添加前缀

43.41. Network qos policy delete

删除 Qos 策略

使用方法:

openstack network qos policy delete [-h]
                                           <qos-policy> [<qos-policy> ...]
Copy to Clipboard Toggle word wrap

Expand
表 43.158. 位置参数
概述

<qos-policy>

要删除的 QoS 策略(名称或 ID)

Expand
表 43.159. 可选参数
概述

-h, --help

显示帮助信息并退出

43.42. 网络 qos 策略列表

列出 QoS 策略

使用方法:

openstack network qos policy list [-h] [-f {csv,json,table,value,yaml}]
                                         [-c COLUMN] [--max-width <integer>]
                                         [--fit-width] [--print-empty]
                                         [--noindent]
                                         [--quote {all,minimal,none,nonnumeric}]
                                         [--sort-column SORT_COLUMN]
                                         [--project <project>]
                                         [--project-domain <project-domain>]
                                         [--share | --no-share]
Copy to Clipboard Toggle word wrap