命令行界面参考

Red Hat OpenStack Platform 16.1

Red Hat OpenStack Platform 的命令行客户端

摘要

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

前言

使开源包含更多

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

对红帽文档提供反馈

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

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

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

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

第 1 章 OpenStack 客户端

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

OpenStack API 的命令行界面

使用方法:

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

表 1.1. 可选参数

概述

--version

显示程序的版本号并退出

-v, --verbose

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

-q, --quiet

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

--log-file LOG_FILE

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

-h, --help

显示帮助信息并退出。

--debug

显示错误的回溯信息。

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

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

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

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

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

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

--os-cert <certificate-file>

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

--os-key <key-file>

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

--verify

验证服务器证书(默认)

--insecure

禁用服务器证书验证

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

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

--os-interface <interface>

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

--os-service-provider <service_provider>

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

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

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

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

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

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

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

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

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

--timing

print api 调用时间信息

--os-beta-command

启用可能更改的 beta 命令

--os-profile hmac-key

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

--os-data-processing-url OS_DATA_PROCESSING_URL

Data processing api url,(env: OS_DATA_PROCESSING_API_URL)

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

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

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

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

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

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

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

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

--inspector-api-version INSPECTOR_API_VERSION

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

--inspector-url INSPECTOR_URL

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

--os-username <auth-username>

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

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

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

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

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

--os-password <auth-password>

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

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

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

--os-protocol <auth-protocol>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

--os-endpoint <auth-endpoint>

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

--os-token <auth-token>

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

--os-user <auth-user>

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

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

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

--os-passcode <auth-passcode>

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

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

v3applicationcredential: application credential auth secret (Env: OS_APPLICATION_CREDENTIAL_SECRET)

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

v3applicationcredential: application credential ID (Env: OS_APPLICATION_CREDENTIAL_ID)

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

v3applicationcredential: application credential name (Env: OS_APPLICATION_CREDENTIAL_NAME)

--os-roles <auth-roles>

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

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

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

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

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

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

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

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

With v3oauth1: oauth access key (env: os_access_key)

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

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

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

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

--os-code <auth-code>

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

--os-auth-methods <auth-auth-methods>

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

第 2 章 access

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

2.1. 访问令牌创建

创建访问令牌

使用方法:

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

表 2.1. 可选参数

概述

-h, --help

显示帮助信息并退出

--consumer-key <consumer-key>

consumer key (必需)

--consumer-secret <consumer-secret>

consumer secret (必需)

--request-key <request-key>

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

--request-secret <request-secret>

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

--verifier <verifier>

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

表 2.2. 输出格式器

概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

表 2.3. JSON Formatter

概述

--noindent

是否禁用缩进 json

表 2.4. shell Formatter

概述

--prefix PREFIX

为所有变量名称添加前缀

表 2.5. 表格式

概述

--max-width <integer>

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

--fit-width

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

--print-empty

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

第 3 章 acl

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

3.1. ACL 删除

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

使用方法:

openstack acl delete [-h] URI

表 3.1. 位置参数

概述

URI

secret 或容器的 uri 引用。

表 3.2. 可选参数

概述

-h, --help

显示帮助信息并退出

3.2. ACL 获得

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

使用方法:

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

表 3.3. 位置参数

概述

URI

secret 或容器的 uri 引用。

表 3.4. 可选参数

概述

-h, --help

显示帮助信息并退出

表 3.5. 输出格式器

概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

表 3.6. CSV Formatter

概述

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

当包含引号时,默认为 nonnumeric

表 3.7. JSON Formatter

概述

--noindent

是否禁用缩进 json

表 3.8. 表格式

概述

--max-width <integer>

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

--fit-width

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

--print-empty

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

3.3. ACL 提交

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

使用方法:

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

表 3.9. 位置参数

概述

URI

secret 或容器的 uri 引用。

表 3.10. 可选参数

概述

-h, --help

显示帮助信息并退出

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

acl 的 Keystone userid.

--project-access

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

--no-project-access

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

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

为设置 barbican 操作 acl 的类型

表 3.11. 输出格式器

概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

表 3.12. CSV Formatter

概述

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

当包含引号时,默认为 nonnumeric

表 3.13. JSON Formatter

概述

--noindent

是否禁用缩进 json

表 3.14. 表格式

概述

--max-width <integer>

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

--fit-width

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

--print-empty

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

3.4. ACL 用户添加

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

使用方法:

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

表 3.15. 位置参数

概述

URI

secret 或容器的 uri 引用。

表 3.16. 可选参数

概述

-h, --help

显示帮助信息并退出

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

acl 的 Keystone userid.

--project-access

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

--no-project-access

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

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

为设置 barbican 操作 acl 的类型

表 3.17. 输出格式器

概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

表 3.18. CSV Formatter

概述

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

当包含引号时,默认为 nonnumeric

表 3.19. JSON Formatter

概述

--noindent

是否禁用缩进 json

表 3.20. 表格式

概述

--max-width <integer>

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

--fit-width

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

--print-empty

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

3.5. ACL 用户删除

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

使用方法:

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

表 3.21. 位置参数

概述

URI

secret 或容器的 uri 引用。

表 3.22. 可选参数

概述

-h, --help

显示帮助信息并退出

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

acl 的 Keystone userid.

--project-access

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

--no-project-access

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

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

为设置 barbican 操作 acl 的类型

表 3.23. 输出格式器

概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

表 3.24. CSV Formatter

概述

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

当包含引号时,默认为 nonnumeric

表 3.25. JSON Formatter

概述

--noindent

是否禁用缩进 json

表 3.26. 表格式

概述

--max-width <integer>

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

--fit-width

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

--print-empty

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

第 4 章 action

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

4.1. 操作定义创建

创建新操作。

使用方法:

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

表 4.1. 位置参数

概述

定义

操作定义文件

表 4.2. 可选参数

概述

-h, --help

显示帮助信息并退出

--marker [MARKER]

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

--limit [LIMIT]

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

--sort_keys [SORT_KEYS]

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

--sort_dirs [SORT_DIRS]

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

--filter FILTERS

过滤器. 可以重复。

--public

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

表 4.3. 输出格式器

概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

表 4.4. CSV Formatter

概述

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

当包含引号时,默认为 nonnumeric

表 4.5. JSON Formatter

概述

--noindent

是否禁用缩进 json

表 4.6. 表格式

概述

--max-width <integer>

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

--fit-width

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

--print-empty

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

4.2. 操作定义显示

显示操作定义。

使用方法:

openstack action definition definition show [-h] name

表 4.7. 位置参数

概述

name

操作名称

表 4.8. 可选参数

概述

-h, --help

显示帮助信息并退出

4.3. 操作定义删除

删除操作.

使用方法:

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

表 4.9. 位置参数

概述

action

操作的名称或 id。

表 4.10. 可选参数

概述

-h, --help

显示帮助信息并退出

4.4. 操作定义列表

列出所有操作。

使用方法:

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

表 4.11. 可选参数

概述

-h, --help

显示帮助信息并退出

--marker [MARKER]

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

--limit [LIMIT]

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

--sort_keys [SORT_KEYS]

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

--sort_dirs [SORT_DIRS]

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

--filter FILTERS

过滤器. 可以重复。

表 4.12. 输出格式器

概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

表 4.13. CSV Formatter

概述

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

当包含引号时,默认为 nonnumeric

表 4.14. JSON Formatter

概述

--noindent

是否禁用缩进 json

表 4.15. 表格式

概述

--max-width <integer>

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

--fit-width

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

--print-empty

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

4.5. 操作定义显示

显示特定操作。

使用方法:

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

表 4.16. 位置参数

概述

action

操作(名称或 id)

表 4.17. 可选参数

概述

-h, --help

显示帮助信息并退出

表 4.18. 输出格式器

概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

表 4.19. JSON Formatter

概述

--noindent

是否禁用缩进 json

表 4.20. shell Formatter

概述

--prefix PREFIX

为所有变量名称添加前缀

表 4.21. 表格式

概述

--max-width <integer>

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

--fit-width

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

--print-empty

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

4.6. 操作定义更新

更新操作。

使用方法:

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

表 4.22. 位置参数

概述

定义

操作定义文件

表 4.23. 可选参数

概述

-h, --help

显示帮助信息并退出

--marker [MARKER]

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

--limit [LIMIT]

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

--sort_keys [SORT_KEYS]

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

--sort_dirs [SORT_DIRS]

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

--filter FILTERS

过滤器. 可以重复。

--id ID

操作 ID.

--public

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

表 4.24. 输出格式器

概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

表 4.25. CSV Formatter

概述

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

当包含引号时,默认为 nonnumeric

表 4.26. JSON Formatter

概述

--noindent

是否禁用缩进 json

表 4.27. 表格式

概述

--max-width <integer>

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

--fit-width

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

--print-empty

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

4.7. 操作执行删除

删除操作执行。

使用方法:

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

表 4.28. 位置参数

概述

action_execution

操作执行标识符 ID。

表 4.29. 可选参数

概述

-h, --help

显示帮助信息并退出

4.8. 操作执行输入显示

显示操作执行输入数据。

使用方法:

openstack action execution input show [-h] id

表 4.30. 位置参数

概述

id

操作执行 ID.

表 4.31. 可选参数

概述

-h, --help

显示帮助信息并退出

4.9. 操作执行列表

列出所有操作执行。

使用方法:

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

表 4.32. 位置参数

概述

task_execution_id

任务执行 ID。

表 4.33. 可选参数

概述

-h, --help

显示帮助信息并退出

--marker [MARKER]

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

--limit [LIMIT]

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

--sort_keys [SORT_KEYS]

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

--sort_dirs [SORT_DIRS]

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

--filter FILTERS

过滤器. 可以重复。

--oldest

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

表 4.34. 输出格式器

概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

表 4.35. CSV Formatter

概述

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

当包含引号时,默认为 nonnumeric

表 4.36. JSON Formatter

概述

--noindent

是否禁用缩进 json

表 4.37. 表格式

概述

--max-width <integer>

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

--fit-width

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

--print-empty

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

4.10. 操作执行输出显示

显示 Action 执行输出数据。

使用方法:

openstack action execution output show [-h] id

表 4.38. 位置参数

概述

id

操作执行 ID.

表 4.39. 可选参数

概述

-h, --help

显示帮助信息并退出

4.11. 操作执行运行

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

使用方法:

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

表 4.40. 位置参数

概述

name

要执行的操作名称。

输入

操作输入.

表 4.41. 可选参数

概述

-h, --help

显示帮助信息并退出

-s, --save-result

将结果保存到 db 中。

--run-sync

同步运行操作。

-t TARGET, --target TARGET

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

表 4.42. 输出格式器

概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

表 4.43. JSON Formatter

概述

--noindent

是否禁用缩进 json

表 4.44. shell Formatter

概述

--prefix PREFIX

为所有变量名称添加前缀

表 4.45. 表格式

概述

--max-width <integer>

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

--fit-width

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

--print-empty

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

4.12. 操作执行显示

显示具体操作执行。

使用方法:

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

表 4.46. 位置参数

概述

action_execution

操作执行 ID.

表 4.47. 可选参数

概述

-h, --help

显示帮助信息并退出

表 4.48. 输出格式器

概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

表 4.49. JSON Formatter

概述

--noindent

是否禁用缩进 json

表 4.50. shell Formatter

概述

--prefix PREFIX

为所有变量名称添加前缀

表 4.51. 表格式

概述

--max-width <integer>

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

--fit-width

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

--print-empty

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

4.13. 操作执行更新

更新特定的操作执行。

使用方法:

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

表 4.52. 位置参数

概述

id

操作执行 ID.

表 4.53. 可选参数

概述

-h, --help

显示帮助信息并退出

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

操作执行状态

--output OUTPUT

操作执行输出

表 4.54. 输出格式器

概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

表 4.55. JSON Formatter

概述

--noindent

是否禁用缩进 json

表 4.56. shell Formatter

概述

--prefix PREFIX

为所有变量名称添加前缀

表 4.57. 表格式

概述

--max-width <integer>

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

--fit-width

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

--print-empty

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

第 5 章 address

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

5.1. 地址范围创建

创建新地址范围

使用方法:

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

表 5.1. 位置参数

概述

<name>

新地址范围名称

表 5.2. 可选参数

概述

-h, --help

显示帮助信息并退出

--ip-version {4,6}

IP 版本(默认为 4)

--project <project>

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

--project-domain <project-domain>

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

--share

在项目间共享地址范围

--no-share

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

表 5.3. 输出格式器

概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

表 5.4. JSON Formatter

概述

--noindent

是否禁用缩进 json

表 5.5. shell Formatter

概述

--prefix PREFIX

为所有变量名称添加前缀

表 5.6. 表格式

概述

--max-width <integer>

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

--fit-width

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

--print-empty

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

5.2. 地址范围删除

删除地址范围

使用方法:

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

表 5.7. 位置参数

概述

<address-scope>

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

表 5.8. 可选参数

概述

-h, --help

显示帮助信息并退出

5.3. 地址范围列表

列出地址范围

使用方法:

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

表 5.9. 可选参数

概述

-h, --help

显示帮助信息并退出

--name <name>

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

--ip-version <ip-version>

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

--project <project>

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

--project-domain <project-domain>

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

--share

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

--no-share

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

表 5.10. 输出格式器

概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

表 5.11. CSV Formatter

概述

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

当包含引号时,默认为 nonnumeric

表 5.12. JSON Formatter

概述

--noindent

是否禁用缩进 json

表 5.13. 表格式

概述

--max-width <integer>

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

--fit-width

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

--print-empty

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

5.4. 地址范围集

设置地址范围属性

使用方法:

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

表 5.14. 位置参数

概述

<address-scope>

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

表 5.15. 可选参数

概述

-h, --help

显示帮助信息并退出

--name <name>

设置地址范围名称

--share

在项目间共享地址范围

--no-share

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

5.5. 地址范围显示

显示地址范围详情

使用方法:

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

表 5.16. 位置参数

概述

<address-scope>

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

表 5.17. 可选参数

概述

-h, --help

显示帮助信息并退出

表 5.18. 输出格式器

概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

表 5.19. JSON Formatter

概述

--noindent

是否禁用缩进 json

表 5.20. shell Formatter

概述

--prefix PREFIX

为所有变量名称添加前缀

表 5.21. 表格式

概述

--max-width <integer>

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

--fit-width

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

--print-empty

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

第 6 章 aggregate

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

6.1. 聚合添加主机

将主机添加到聚合

使用方法:

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

表 6.1. 位置参数

概述

<aggregate>

聚合(名称或 ID)

<host>

要添加到 <aggregate> 的主机

表 6.2. 可选参数

概述

-h, --help

显示帮助信息并退出

表 6.3. 输出格式器

概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

表 6.4. JSON Formatter

概述

--noindent

是否禁用缩进 json

表 6.5. shell Formatter

概述

--prefix PREFIX

为所有变量名称添加前缀

表 6.6. 表格式

概述

--max-width <integer>

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

--fit-width

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

--print-empty

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

6.2. 聚合创建

创建新聚合

使用方法:

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

表 6.7. 位置参数

概述

<name>

新聚合名称

表 6.8. 可选参数

概述

-h, --help

显示帮助信息并退出

--zone <availability-zone>

可用区名称

--property <key=value>

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

表 6.9. 输出格式器

概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

表 6.10. JSON Formatter

概述

--noindent

是否禁用缩进 json

表 6.11. shell Formatter

概述

--prefix PREFIX

为所有变量名称添加前缀

表 6.12. 表格式

概述

--max-width <integer>

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

--fit-width

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

--print-empty

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

6.3. 聚合删除

删除现有聚合

使用方法:

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

表 6.13. 位置参数

概述

<aggregate>

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

表 6.14. 可选参数

概述

-h, --help

显示帮助信息并退出

6.4. 聚合列表

列出所有聚合

使用方法:

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

表 6.15. 可选参数

概述

-h, --help

显示帮助信息并退出

--long

列出输出中的其他字段

表 6.16. 输出格式器

概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

表 6.17. CSV Formatter

概述

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

当包含引号时,默认为 nonnumeric

表 6.18. JSON Formatter

概述

--noindent

是否禁用缩进 json

表 6.19. 表格式

概述

--max-width <integer>

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

--fit-width

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

--print-empty

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

6.5. 聚合删除主机

从聚合中删除主机

使用方法:

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

表 6.20. 位置参数

概述

<aggregate>

聚合(名称或 ID)

<host>

从 <aggregate> 中删除的主机

表 6.21. 可选参数

概述

-h, --help

显示帮助信息并退出

表 6.22. 输出格式器

概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

表 6.23. JSON Formatter

概述

--noindent

是否禁用缩进 json

表 6.24. shell Formatter

概述

--prefix PREFIX

为所有变量名称添加前缀

表 6.25. 表格式

概述

--max-width <integer>

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

--fit-width

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

--print-empty

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

6.6. 聚合集

设置聚合属性

使用方法:

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

表 6.26. 位置参数

概述

<aggregate>

聚合以修改(名称或 ID)

表 6.27. 可选参数

概述

-h, --help

显示帮助信息并退出

--name <name>

设置聚合名称

--zone <availability-zone>

设置可用区域名称

--property <key=value>

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

--no-property

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

6.7. 聚合显示

显示聚合详情

使用方法:

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

表 6.28. 位置参数

概述

<aggregate>

聚合显示(名称或 id)

表 6.29. 可选参数

概述

-h, --help

显示帮助信息并退出

表 6.30. 输出格式器

概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

表 6.31. JSON Formatter

概述

--noindent

是否禁用缩进 json

表 6.32. shell Formatter

概述

--prefix PREFIX

为所有变量名称添加前缀

表 6.33. 表格式

概述

--max-width <integer>

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

--fit-width

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

--print-empty

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

6.8. aggregate unset

取消设置聚合属性

使用方法:

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

表 6.34. 位置参数

概述

<aggregate>

聚合以修改(名称或 ID)

表 6.35. 可选参数

概述

-h, --help

显示帮助信息并退出

--property <key>

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

第 7 章 警报

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

7.1. 创建警报

创建警报

使用方法:

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

表 7.1. 可选参数

概述

-h, --help

显示帮助信息并退出

--name <NAME>

警报的名称

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

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

--project-id <PROJECT_ID>

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

--user-id <USER_ID>

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

--description <DESCRIPTION>

警报的免费文本描述

--state <STATE>

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

--severity <SEVERITY>

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

--enabled {True|False}

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

--alarm-action <Webhook URL>

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

--OK-action <Webhook URL>

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

--insufficient-data-action <Webhook URL>

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

--time-constraint <Time Constraint>

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

--repeat-actions {True|False}

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

表 7.2. 输出格式器

概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

表 7.3. JSON Formatter

概述

--noindent

是否禁用缩进 json

表 7.4. shell Formatter

概述

--prefix PREFIX

为所有变量名称添加前缀

表 7.5. 表格式

概述

--max-width <integer>

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

--fit-width

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

--print-empty

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

表 7.6. 常见警报规则

概述

--query <QUERY>

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

--comparison-operator <OPERATOR>

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

--evaluation-periods <EVAL_PERIODS>

要评估的时间段数

--threshold <THRESHOLD>

要评估的阈值。

表 7.7. 事件警报

概述

--event-type <EVENT_TYPE>

要评估的事件类型

表 7.8. 常见 gnocchi 警报规则

概述

--granularity <GRANULARITY>

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

--aggregation-method <AGGR_METHOD>

与阈值相比的 aggregation_method。

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

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

表 7.9. Gnocchi 资源阈值警报

概述

--resource-type <RESOURCE_TYPE>

资源的类型。

--resource-id <RESOURCE_ID>

资源的 ID。

表 7.10. 复合警报

概述

--composite-rule <COMPOSITE_RULE>

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

7.2. 删除警报

删除警报

使用方法:

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

表 7.11. 位置参数

概述

<ALARM ID 或 NAME>

警报的 ID 或名称。

表 7.12. 可选参数

概述

-h, --help

显示帮助信息并退出

--name <NAME>

警报的名称

7.4. alarm-history 显示

显示警报历史记录

使用方法:

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

表 7.18. 位置参数

概述

<alarm-id>

警报 ID

表 7.19. 可选参数

概述

-h, --help

显示帮助信息并退出

--limit <LIMIT>

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

--marker <MARKER>

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

--sort <SORT_KEY:SORT_DIR>

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

表 7.20. 输出格式器

概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

表 7.21. CSV Formatter

概述

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

当包含引号时,默认为 nonnumeric

表 7.22. JSON Formatter

概述

--noindent

是否禁用缩进 json

表 7.23. 表格式

概述

--max-width <integer>

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

--fit-width

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

--print-empty

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

7.5. 警报列表

列出警报

使用方法:

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

表 7.24. 可选参数

概述

-h, --help

显示帮助信息并退出

--query QUERY

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

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

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

--limit <LIMIT>

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

--marker <MARKER>

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

--sort <SORT_KEY:SORT_DIR>

资源属性排序,如 name:asc

表 7.25. 输出格式器

概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

表 7.26. CSV Formatter

概述

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

当包含引号时,默认为 nonnumeric

表 7.27. JSON Formatter

概述

--noindent

是否禁用缩进 json

表 7.28. 表格式

概述

--max-width <integer>

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

--fit-width

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

--print-empty

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

7.6. 警报显示

显示警报

使用方法:

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

表 7.29. 位置参数

概述

<ALARM ID 或 NAME>

警报的 ID 或名称。

表 7.30. 可选参数

概述

-h, --help

显示帮助信息并退出

--name <NAME>

警报的名称

表 7.31. 输出格式器

概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

表 7.32. JSON Formatter

概述

--noindent

是否禁用缩进 json

表 7.33. shell Formatter

概述

--prefix PREFIX

为所有变量名称添加前缀

表 7.34. 表格式

概述

--max-width <integer>

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

--fit-width

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

--print-empty

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

7.7. 警报状态获取

获取警报状态

使用方法:

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

表 7.35. 位置参数

概述

<ALARM ID 或 NAME>

警报的 ID 或名称。

表 7.36. 可选参数

概述

-h, --help

显示帮助信息并退出

--name <NAME>

警报的名称

表 7.37. 输出格式器

概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

表 7.38. JSON Formatter

概述

--noindent

是否禁用缩进 json

表 7.39. shell Formatter

概述

--prefix PREFIX

为所有变量名称添加前缀

表 7.40. 表格式

概述

--max-width <integer>

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

--fit-width

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

--print-empty

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

7.8. 设置警报状态

设置警报状态

使用方法:

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

表 7.41. 位置参数

概述

<ALARM ID 或 NAME>

警报的 ID 或名称。

表 7.42. 可选参数

概述

-h, --help

显示帮助信息并退出

--name <NAME>

警报的名称

--state <STATE>

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

表 7.43. 输出格式器

概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

表 7.44. JSON Formatter

概述

--noindent

是否禁用缩进 json

表 7.45. shell Formatter

概述

--prefix PREFIX

为所有变量名称添加前缀

表 7.46. 表格式

概述

--max-width <integer>

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

--fit-width

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

--print-empty

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

7.9. 警报更新

更新警报

使用方法:

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

表 7.47. 位置参数

概述

<ALARM ID 或 NAME>

警报的 ID 或名称。

表 7.48. 可选参数

概述

-h, --help

显示帮助信息并退出

--name <NAME>

警报的名称

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

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

--project-id <PROJECT_ID>

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

--user-id <USER_ID>

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

--description <DESCRIPTION>

警报的免费文本描述

--state <STATE>

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

--severity <SEVERITY>

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

--enabled {True|False}

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

--alarm-action <Webhook URL>

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

--OK-action <Webhook URL>

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

--insufficient-data-action <Webhook URL>

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

--time-constraint <Time Constraint>

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

--repeat-actions {True|False}

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

表 7.49. 输出格式器

概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

表 7.50. JSON Formatter

概述

--noindent

是否禁用缩进 json

表 7.51. shell Formatter

概述

--prefix PREFIX

为所有变量名称添加前缀

表 7.52. 表格式

概述

--max-width <integer>

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

--fit-width

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

--print-empty

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

表 7.53. 常见警报规则

概述

--query <QUERY>

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

--comparison-operator <OPERATOR>

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

--evaluation-periods <EVAL_PERIODS>

要评估的时间段数

--threshold <THRESHOLD>

要评估的阈值。

表 7.54. 事件警报

概述

--event-type <EVENT_TYPE>

要评估的事件类型

表 7.55. 常见 gnocchi 警报规则

概述

--granularity <GRANULARITY>

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

--aggregation-method <AGGR_METHOD>

与阈值相比的 aggregation_method。

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

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

表 7.56. Gnocchi 资源阈值警报

概述

--resource-type <RESOURCE_TYPE>

资源的类型。

--resource-id <RESOURCE_ID>

资源的 ID。

表 7.57. 复合警报

概述

--composite-rule <COMPOSITE_RULE>

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

第 8 章 警报

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

8.1. 警报功能列表

列出警报服务的功能

使用方法:

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

表 8.1. 可选参数

概述

-h, --help

显示帮助信息并退出

表 8.2. 输出格式器

概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

表 8.3. JSON Formatter

概述

--noindent

是否禁用缩进 json

表 8.4. shell Formatter

概述

--prefix PREFIX

为所有变量名称添加前缀

表 8.5. 表格式

概述

--max-width <integer>

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

--fit-width

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

--print-empty

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

第 9 章 application

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

9.1. 应用程序凭证创建

创建新应用程序凭证

使用方法:

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

表 9.1. 位置参数

概述

<name>

应用程序凭证的名称

表 9.2. 可选参数

概述

-h, --help

显示帮助信息并退出

--secret <secret>

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

--role <role>

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

--expiration <expiration>

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

--description <description>

应用程序凭证描述

--unrestricted

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

--restricted

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

表 9.3. 输出格式器

概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

表 9.4. JSON Formatter

概述

--noindent

是否禁用缩进 json

表 9.5. shell Formatter

概述

--prefix PREFIX

为所有变量名称添加前缀

表 9.6. 表格式

概述

--max-width <integer>

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

--fit-width

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

--print-empty

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

9.2. 应用程序凭证删除

删除应用程序凭证

使用方法:

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

表 9.7. 位置参数

概述

<application-credential>

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

表 9.8. 可选参数

概述

-h, --help

显示帮助信息并退出

9.3. 应用程序凭证列表

列出应用程序凭证

使用方法:

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

表 9.9. 可选参数

概述

-h, --help

显示帮助信息并退出

--user <user>

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

--user-domain <user-domain>

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

表 9.10. 输出格式器

概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

表 9.11. CSV Formatter

概述

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

当包含引号时,默认为 nonnumeric

表 9.12. JSON Formatter

概述

--noindent

是否禁用缩进 json

表 9.13. 表格式

概述

--max-width <integer>

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

--fit-width

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

--print-empty

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

9.4. 应用程序凭证显示

显示应用程序凭证详情

使用方法:

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

表 9.14. 位置参数

概述

<application-credential>

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

表 9.15. 可选参数

概述

-h, --help

显示帮助信息并退出

表 9.16. 输出格式器

概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

表 9.17. JSON Formatter

概述

--noindent

是否禁用缩进 json

表 9.18. shell Formatter

概述

--prefix PREFIX

为所有变量名称添加前缀

表 9.19. 表格式

概述

--max-width <integer>

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

--fit-width

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

--print-empty

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

第 10 章 可用性

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

10.1. 可用区列表

列出可用区及其状态

使用方法:

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

表 10.1. 可选参数

概述

-h, --help

显示帮助信息并退出

--compute

列出计算可用区

--network

列出网络可用区

--volume

列出卷可用区

--long

列出输出中的其他字段

表 10.2. 输出格式器

概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

表 10.3. CSV Formatter

概述

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

当包含引号时,默认为 nonnumeric

表 10.4. JSON Formatter

概述

--noindent

是否禁用缩进 json

表 10.5. 表格式

概述

--max-width <integer>

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

--fit-width

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

--print-empty

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

第 11 章 baremetal

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

11.1. 裸机分配创建

创建新的 baremetal 分配。

使用方法:

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

表 11.1. 可选参数

概述

-h, --help

显示帮助信息并退出

--resource-class RESOURCE_CLASS

要请求的资源类。

--trait TRAITS

请求特征。可以多次指定。

--candidate-node CANDIDATE_NODES

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

--name NAME

分配的唯一名称。

--uuid UUID

分配的 UUID。

--extra <key=value>

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

--wait [<time-out>]

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

--node NODE

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

表 11.2. 输出格式器

概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

表 11.3. JSON Formatter

概述

--noindent

是否禁用缩进 json

表 11.4. shell Formatter

概述

--prefix PREFIX

为所有变量名称添加前缀

表 11.5. 表格式

概述

--max-width <integer>

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

--fit-width

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

--print-empty

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

11.2. 裸机分配删除

取消注册的裸机分配。

使用方法:

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

表 11.6. 位置参数

概述

<allocation>

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

表 11.7. 可选参数

概述

-h, --help

显示帮助信息并退出

11.3. 裸机分配列表

列出裸机分配。

使用方法:

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

表 11.8. 可选参数

概述

-h, --help

显示帮助信息并退出

--limit <limit>

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

--marker <allocation>

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

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

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

--node <node>

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

--resource-class <resource_class>

只使用这个资源类列出分配。

--state <state>

仅列出处于这个状态的分配。

--long

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

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

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

表 11.9. 输出格式器

概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

表 11.10. CSV Formatter

概述

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

当包含引号时,默认为 nonnumeric

表 11.11. JSON Formatter

概述

--noindent

是否禁用缩进 json

表 11.12. 表格式

概述

--max-width <integer>

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

--fit-width

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

--print-empty

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

11.4. 裸机分配集

设置 baremetal 分配属性。

使用方法:

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

表 11.13. 位置参数

概述

<allocation>

分配的名称或 uuid

表 11.14. 可选参数

概述

-h, --help

显示帮助信息并退出

--name <name>

设置分配的名称

--extra <key=value>

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

11.5. 裸机分配显示

显示裸机分配详细信息。

使用方法:

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

表 11.15. 位置参数

概述

<id>

分配的 UUID 或名称

表 11.16. 可选参数

概述

-h, --help

显示帮助信息并退出

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

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

表 11.17. 输出格式器

概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

表 11.18. JSON Formatter

概述

--noindent

是否禁用缩进 json

表 11.19. shell Formatter

概述

--prefix PREFIX

为所有变量名称添加前缀

表 11.20. 表格式

概述

--max-width <integer>

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

--fit-width

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

--print-empty

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

11.6. baremetal allocation unset

取消设置裸机分配属性。

使用方法:

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

表 11.21. 位置参数

概述

<allocation>

分配的名称或 uuid

表 11.22. 可选参数

概述

-h, --help

显示帮助信息并退出

--name

取消设置分配的名称

--extra <key>

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

11.7. baremetal chassis create

创建新的 chassis。

使用方法:

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

表 11.23. 可选参数

概述

-h, --help

显示帮助信息并退出

--description <description>

chassis 描述

--extra <key=value>

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

--uuid <uuid>

chassis 的唯一 uuid

表 11.24. 输出格式器

概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

表 11.25. JSON Formatter

概述

--noindent

是否禁用缩进 json

表 11.26. shell Formatter

概述

--prefix PREFIX

为所有变量名称添加前缀

表 11.27. 表格式

概述

--max-width <integer>

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

--fit-width

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

--print-empty

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

11.8. baremetal chassis delete

删除 chassis。

使用方法:

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

表 11.28. 位置参数

概述

<chassis>

要删除的机箱的 UUID

表 11.29. 可选参数

概述

-h, --help

显示帮助信息并退出

11.9. baremetal chassis 列表

列出 chassis。

使用方法:

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

表 11.30. 可选参数

概述

-h, --help

显示帮助信息并退出

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

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

--limit <limit>

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

--long

显示有关 chassis 的详细信息

--marker <chassis>

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

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

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

表 11.31. 输出格式器

概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

表 11.32. CSV Formatter

概述

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

当包含引号时,默认为 nonnumeric

表 11.33. JSON Formatter

概述

--noindent

是否禁用缩进 json

表 11.34. 表格式

概述

--max-width <integer>

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

--fit-width

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

--print-empty

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

11.10. baremetal chassis 集

设置 chassis 属性。

使用方法:

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

表 11.35. 位置参数

概述

<chassis>

chassis 的 UUID

表 11.36. 可选参数

概述

-h, --help

显示帮助信息并退出

--description <description>

设置 chassis 的描述

--extra <key=value>

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

11.11. baremetal chassis 显示

显示机箱详细信息。

使用方法:

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

表 11.37. 位置参数

概述

<chassis>

chassis 的 UUID

表 11.38. 可选参数

概述

-h, --help

显示帮助信息并退出

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

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

表 11.39. 输出格式器

概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

表 11.40. JSON Formatter

概述

--noindent

是否禁用缩进 json

表 11.41. shell Formatter

概述

--prefix PREFIX

为所有变量名称添加前缀

表 11.42. 表格式

概述

--max-width <integer>

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

--fit-width

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

--print-empty

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

11.12. baremetal chassis unset

取消设置机箱属性。

使用方法:

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

表 11.43. 位置参数

概述

<chassis>

chassis 的 UUID

表 11.44. 可选参数

概述

-h, --help

显示帮助信息并退出

--description

清除 chassis 描述

--extra <key>

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

11.13. 裸机编排器列表

列出裸机编排器

使用方法:

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

表 11.45. 可选参数

概述

-h, --help

显示帮助信息并退出

--limit <limit>

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

--marker <conductor>

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

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

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

--long

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

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

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

表 11.46. 输出格式器

概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

表 11.47. CSV Formatter

概述

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

当包含引号时,默认为 nonnumeric

表 11.48. JSON Formatter

概述

--noindent

是否禁用缩进 json

表 11.49. 表格式

概述

--max-width <integer>

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

--fit-width

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

--print-empty

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

11.14. 裸机编排器显示

显示裸机编排器详情

使用方法:

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

表 11.50. 位置参数

概述

<conductor>

编排器的主机名

表 11.51. 可选参数

概述

-h, --help

显示帮助信息并退出

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

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

表 11.52. 输出格式器

概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

表 11.53. JSON Formatter

概述

--noindent

是否禁用缩进 json

表 11.54. shell Formatter

概述

--prefix PREFIX

为所有变量名称添加前缀

表 11.55. 表格式

概述

--max-width <integer>

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

--fit-width

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

--print-empty

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

11.15. baremetal create

从文件创建资源

使用方法:

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

表 11.56. 位置参数

概述

<file>

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

表 11.57. 可选参数

概述

-h, --help

显示帮助信息并退出

11.16. 裸机部署模板创建

创建新部署模板

使用方法:

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

表 11.58. 位置参数

概述

<name>

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

表 11.59. 可选参数

概述

-h, --help

显示帮助信息并退出

--uuid <uuid>

deploy 模板的 UUID。

--extra <key=value>

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

--steps <steps>

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

表 11.60. 输出格式器

概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

表 11.61. JSON Formatter

概述

--noindent

是否禁用缩进 json

表 11.62. shell Formatter

概述

--prefix PREFIX

为所有变量名称添加前缀

表 11.63. 表格式

概述

--max-width <integer>

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

--fit-width

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

--print-empty

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

11.17. 裸机部署模板删除

删除部署模板。

使用方法:

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

表 11.64. 位置参数

概述

<template>

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

表 11.65. 可选参数

概述

-h, --help

显示帮助信息并退出

11.18. 裸机部署模板列表

列出裸机部署模板。

使用方法:

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

表 11.66. 可选参数

概述

-h, --help

显示帮助信息并退出

--limit <limit>

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

--marker <template>

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

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

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

--long

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

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

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

表 11.67. 输出格式器

概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

表 11.68. CSV Formatter

概述

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

当包含引号时,默认为 nonnumeric

表 11.69. JSON Formatter

概述

--noindent

是否禁用缩进 json

表 11.70. 表格式

概述

--max-width <integer>

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

--fit-width

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

--print-empty

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

11.19. 裸机部署模板集

设置 baremetal 部署模板属性。

使用方法:

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

表 11.71. 位置参数

概述

<template>

部署模板的名称或 uuid

表 11.72. 可选参数

概述

-h, --help

显示帮助信息并退出

--name <name>

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

--steps <steps>

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

--extra <key=value>

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

11.20. 裸机部署模板显示

显示裸机部署模板详细信息。

使用方法:

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

表 11.73. 位置参数

概述

<template>

部署模板的名称或 uuid。

表 11.74. 可选参数

概述

-h, --help

显示帮助信息并退出

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

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

表 11.75. 输出格式器

概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

表 11.76. JSON Formatter

概述

--noindent

是否禁用缩进 json

表 11.77. shell Formatter

概述

--prefix PREFIX

为所有变量名称添加前缀

表 11.78. 表格式

概述

--max-width <integer>

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

--fit-width

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

--print-empty

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

11.21. baremetal deploy template unset

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

使用方法:

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

表 11.79. 位置参数

概述

<template>

部署模板的名称或 uuid

表 11.80. 可选参数

概述

-h, --help

显示帮助信息并退出

--extra <key>

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

11.22. baremetal 驱动程序列表

列出已启用的驱动程序。

使用方法:

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

表 11.81. 可选参数

概述

-h, --help

显示帮助信息并退出

--type <type>

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

--long

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

表 11.82. 输出格式器

概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

表 11.83. CSV Formatter

概述

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

当包含引号时,默认为 nonnumeric

表 11.84. JSON Formatter

概述

--noindent

是否禁用缩进 json

表 11.85. 表格式

概述

--max-width <integer>

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

--fit-width

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

--print-empty

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

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

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

使用方法:

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

表 11.86. 位置参数

概述

<driver>

驱动程序的名称。

<method>

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

表 11.87. 可选参数

概述

-h, --help

显示帮助信息并退出

--arg <key=value>

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

--http-method <http-method>

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

表 11.88. 输出格式器

概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

表 11.89. JSON Formatter

概述

--noindent

是否禁用缩进 json

表 11.90. shell Formatter

概述

--prefix PREFIX

为所有变量名称添加前缀

表 11.91. 表格式

概述

--max-width <integer>

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

--fit-width

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

--print-empty

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

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

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

使用方法:

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

表 11.92. 位置参数

概述

<driver>

驱动程序的名称。

表 11.93. 可选参数

概述

-h, --help

显示帮助信息并退出

表 11.94. 输出格式器

概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

表 11.95. CSV Formatter

概述

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

当包含引号时,默认为 nonnumeric

表 11.96. JSON Formatter

概述

--noindent

是否禁用缩进 json

表 11.97. 表格式

概述

--max-width <integer>

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

--fit-width

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

--print-empty

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

11.25. baremetal 驱动程序属性列表

列出驱动程序属性。

使用方法:

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

表 11.98. 位置参数

概述

<driver>

驱动程序的名称。

表 11.99. 可选参数

概述

-h, --help

显示帮助信息并退出

表 11.100. 输出格式器

概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

表 11.101. CSV Formatter

概述

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

当包含引号时,默认为 nonnumeric

表 11.102. JSON Formatter

概述

--noindent

是否禁用缩进 json

表 11.103. 表格式

概述

--max-width <integer>

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

--fit-width

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

--print-empty

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

11.26. baremetal driver raid 属性列表

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

使用方法:

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

表 11.104. 位置参数

概述

<driver>

驱动程序的名称。

表 11.105. 可选参数

概述

-h, --help

显示帮助信息并退出

表 11.106. 输出格式器

概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

表 11.107. CSV Formatter

概述

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

当包含引号时,默认为 nonnumeric

表 11.108. JSON Formatter

概述

--noindent

是否禁用缩进 json

表 11.109. 表格式

概述

--max-width <integer>

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

--fit-width

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

--print-empty

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

11.27. baremetal 驱动程序显示

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

使用方法:

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

表 11.110. 位置参数

概述

<driver>

驱动程序的名称。

表 11.111. 可选参数

概述

-h, --help

显示帮助信息并退出

表 11.112. 输出格式器

概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

表 11.113. JSON Formatter

概述

--noindent

是否禁用缩进 json

表 11.114. shell Formatter

概述

--prefix PREFIX

为所有变量名称添加前缀

表 11.115. 表格式

概述

--max-width <integer>

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

--fit-width

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

--print-empty

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

11.28. 裸机内省中止

中止运行节点的内省。

使用方法:

openstack baremetal introspection abort [-h] node

表 11.116. 位置参数

概述

node

裸机恢复节点 uuid 或名称

表 11.117. 可选参数

概述

-h, --help

显示帮助信息并退出

11.29. 裸机内省数据保存

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

使用方法:

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

表 11.118. 位置参数

概述

node

裸机恢复节点 uuid 或名称

表 11.119. 可选参数

概述

-h, --help

显示帮助信息并退出

--file <filename>

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

11.30. 裸机内省接口列表

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

使用方法:

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

表 11.120. 位置参数

概述

node_ident

裸机恢复节点 uuid 或名称

表 11.121. 可选参数

概述

-h, --help

显示帮助信息并退出

--vlan VLAN

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

--long

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

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

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

表 11.122. 输出格式器

概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

表 11.123. CSV Formatter

概述

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

当包含引号时,默认为 nonnumeric

表 11.124. JSON Formatter

概述

--noindent

是否禁用缩进 json

表 11.125. 表格式

概述

--max-width <integer>

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

--fit-width

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

--print-empty

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

11.31. 裸机内省接口显示

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

使用方法:

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

表 11.126. 位置参数

概述

node_ident

裸机恢复节点 uuid 或名称

interface

接口名称

表 11.127. 可选参数

概述

-h, --help

显示帮助信息并退出

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

显示一个或多个字段。

表 11.128. 输出格式器

概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

表 11.129. JSON Formatter

概述

--noindent

是否禁用缩进 json

表 11.130. shell Formatter

概述

--prefix PREFIX

为所有变量名称添加前缀

表 11.131. 表格式

概述

--max-width <integer>

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

--fit-width

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

--print-empty

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

11.32. 裸机内省列表

列出内省状态

使用方法:

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

表 11.132. 可选参数

概述

-h, --help

显示帮助信息并退出

--marker MARKER

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

--limit LIMIT

要返回的项目数量

表 11.133. 输出格式器

概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

表 11.134. CSV Formatter

概述

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

当包含引号时,默认为 nonnumeric

表 11.135. JSON Formatter

概述

--noindent

是否禁用缩进 json

表 11.136. 表格式

概述

--max-width <integer>

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

--fit-width

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

--print-empty

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

11.33. 裸机内省重新处理

重新处理存储内省数据

使用方法:

openstack baremetal introspection reprocess [-h] node

表 11.137. 位置参数

概述

node

裸机恢复节点 uuid 或名称

表 11.138. 可选参数

概述

-h, --help

显示帮助信息并退出

11.34. 裸机内省规则删除

删除内省规则。

使用方法:

openstack baremetal introspection rule delete [-h] uuid

表 11.139. 位置参数

概述

uuid

规则 uuid

表 11.140. 可选参数

概述

-h, --help

显示帮助信息并退出

11.35. 裸机内省规则导入

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

使用方法:

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

表 11.141. 位置参数

概述

file

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

表 11.142. 可选参数

概述

-h, --help

显示帮助信息并退出

表 11.143. 输出格式器

概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

表 11.144. CSV Formatter

概述

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

当包含引号时,默认为 nonnumeric

表 11.145. JSON Formatter

概述

--noindent

是否禁用缩进 json

表 11.146. 表格式

概述

--max-width <integer>

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

--fit-width

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

--print-empty

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

11.36. 裸机内省规则列表

列出所有内省规则。

使用方法:

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

表 11.147. 可选参数

概述

-h, --help

显示帮助信息并退出

表 11.148. 输出格式器

概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

表 11.149. CSV Formatter

概述

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

当包含引号时,默认为 nonnumeric

表 11.150. JSON Formatter

概述

--noindent

是否禁用缩进 json

表 11.151. 表格式

概述

--max-width <integer>

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

--fit-width

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

--print-empty

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

11.37. 裸机内省规则清除

丢弃所有内省规则。

使用方法:

openstack baremetal introspection rule purge [-h]

表 11.152. 可选参数

概述

-h, --help

显示帮助信息并退出

11.38. 裸机内省规则显示

显示内省规则。

使用方法:

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

表 11.153. 位置参数

概述

uuid

规则 uuid

表 11.154. 可选参数

概述

-h, --help

显示帮助信息并退出

表 11.155. 输出格式器

概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

表 11.156. JSON Formatter

概述

--noindent

是否禁用缩进 json

表 11.157. shell Formatter

概述

--prefix PREFIX

为所有变量名称添加前缀

表 11.158. 表格式

概述

--max-width <integer>

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

--fit-width

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

--print-empty

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

11.39. 裸机内省启动

启动内省。

使用方法:

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

表 11.159. 位置参数

概述

node

裸机恢复节点 uuid 或名称

表 11.160. 可选参数

概述

-h, --help

显示帮助信息并退出

--wait

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

--check-errors

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

表 11.161. 输出格式器

概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

表 11.162. CSV Formatter

概述

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

当包含引号时,默认为 nonnumeric

表 11.163. JSON Formatter

概述

--noindent

是否禁用缩进 json

表 11.164. 表格式

概述

--max-width <integer>

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

--fit-width

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

--print-empty

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

11.40. 裸机内省状态

获取内省状态。

使用方法:

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

表 11.165. 位置参数

概述

node

裸机恢复节点 uuid 或名称

表 11.166. 可选参数

概述

-h, --help

显示帮助信息并退出

表 11.167. 输出格式器

概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

表 11.168. JSON Formatter

概述

--noindent

是否禁用缩进 json

表 11.169. shell Formatter

概述

--prefix PREFIX

为所有变量名称添加前缀

表 11.170. 表格式

概述

--max-width <integer>

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

--fit-width

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

--print-empty

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

11.41. 裸机节点中止

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

使用方法:

openstack baremetal node abort [-h] <node>

表 11.171. 位置参数

概述

<node>

节点的名称或 uuid。

表 11.172. 可选参数

概述

-h, --help

显示帮助信息并退出

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

将特征添加到节点。

使用方法:

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

表 11.173. 位置参数

概述

<node>

节点的名称或 uuid

<trait>

要添加的特征

表 11.174. 可选参数

概述

-h, --help

显示帮助信息并退出

11.43. 裸机恢复节点采用

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

使用方法:

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

表 11.175. 位置参数

概述

<node>

节点的名称或 uuid。

表 11.176. 可选参数

概述

-h, --help

显示帮助信息并退出

--wait [<time-out>]

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

11.44. 裸机节点 bios 设置列表

列出节点的 BIOS 设置。

使用方法:

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

表 11.177. 位置参数

概述

<node>

节点的名称或 uuid

表 11.178. 可选参数

概述

-h, --help

显示帮助信息并退出

表 11.179. 输出格式器

概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

表 11.180. CSV Formatter

概述

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

当包含引号时,默认为 nonnumeric

表 11.181. JSON Formatter

概述

--noindent

是否禁用缩进 json

表 11.182. 表格式

概述

--max-width <integer>

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

--fit-width

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

--print-empty

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

11.45. 裸机节点 bios 设置显示

显示节点的特定 BIOS 设置。

使用方法:

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

表 11.183. 位置参数

概述

<node>

节点的名称或 uuid

<setting name>

将名称设置为 show

表 11.184. 可选参数

概述

-h, --help

显示帮助信息并退出

表 11.185. 输出格式器

概述

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

输出格式,默认为 table

-c COLUMN, --column COLUMN

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

表 11.186. JSON Formatter

概述

--noindent

是否禁用缩进 json

表 11.187. shell Formatter

概述

--prefix PREFIX

为所有变量名称添加前缀

表 11.188. 表格式

概述

--max-width <integer>

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

--fit-width

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

--print-empty

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

11.46. 裸机节点引导设备集

为节点设置引导设备

使用方法:

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

表 11.189. 位置参数

概述

<node>

节点的名称或 uuid

<device>

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

表 11.190. 可选参数

概述

-h, --help

显示帮助信息并退出

--persistent

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

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

显示节点的引导设备信息

使用方法:

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

表 11.191. 位置参数

概述

<node>

节点的名称或 uuid

表 11.192. 可选参数

概述

-h, --help

显示帮助信息并退出

--supported

显示支持的引导设备

表 11.193. 输出格式器

概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 11.194. JSON Formatter

概述

--noindent

是否禁用缩进 json

表 11.195. shell Formatter

概述

--prefix PREFIX

为所有变量名称添加前缀

表 11.196. 表格式

概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

11.48. 裸机节点清理

将裸机节点的置备状态设置为 clean

使用方法:

openstack baremetal node clean [-h] [--wait [<time-out>]] --clean-steps
                                      <clean-steps>
                                      <node>

表 11.197. 位置参数

概述

<node>

节点的名称或 uuid。

表 11.198. 可选参数

概述

-h, --help

显示帮助信息并退出

--wait [<time-out>]

等待节点到达所需状态可管理。(可选)取超时值(以秒为单位)。默认值为 0,表示它将无限期等待。

--clean-steps <clean-steps>

json 格式的清理步骤。可以是包含清理步骤的文件的路径;或 -,包含从标准输入读取的清洁步骤;或字符串。该值应该是清理步骤字典的列表;每个字典中均应具有键 interfacestep,以及可选的键 arg

11.49. 裸机恢复节点控制台禁用

禁用节点的控制台访问

使用方法:

openstack baremetal node console disable [-h] <node>

表 11.199. 位置参数

概述

<node>

节点的名称或 uuid

表 11.200. 可选参数

概述

-h, --help

显示帮助信息并退出

11.50. 裸机节点控制台启用

为节点启用控制台访问

使用方法:

openstack baremetal node console enable [-h] <node>

表 11.201. 位置参数

概述

<node>

节点的名称或 uuid

表 11.202. 可选参数

概述

-h, --help

显示帮助信息并退出

11.51. 裸机恢复节点控制台显示

显示节点的控制台信息

使用方法:

openstack baremetal node console show [-h]
                                             [-f {json,shell,table,value,yaml}]
                                             [-c COLUMN] [--noindent]
                                             [--prefix PREFIX]
                                             [--max-width <integer>]
                                             [--fit-width] [--print-empty]
                                             <node>

表 11.203. 位置参数

概述

<node>

节点的名称或 uuid

表 11.204. 可选参数

概述

-h, --help

显示帮助信息并退出

表 11.205. 输出格式器

概述

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

输出格式,默认为 table

-c COLUMN, --column COLUMN

指定要包含的列,可以重复

表 11.206. JSON Formatter

概述

--noindent

是否禁用缩进 json

表 11.207. shell Formatter

概述

--prefix PREFIX

为所有变量名称添加前缀

表 11.208. 表格式

概述

--max-width <integer>

最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。

--fit-width

适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用

--print-empty

如果没有要显示数据,则打印空表。

11.52. 裸机节点创建

使用 baremetal 服务注册新节点

使用方法:

openstack baremetal node create [-h] [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--noindent]
                                       [--prefix PREFIX]
                                       [--max-width <integer>] [--fit-width]
                                       [--print-empty]
                                       [--chassis-uuid <chassis>] --driver
                                       <driver> [--driver-info <key=value>]
                                       [--property <key=value>]
                                       [--extra <key=value>] [--uuid <uuid>]
                                       [--name <name>]
                                       [--bios-interface <bios_interface>]
                                       [--boot-interface <boot_interface>]
                                       [--console-interface <console_interface>]
                                       [--deploy-interface <deploy_interface>]
                                       [--inspect-interface <inspect_interface>]
                                       [--management-interface <management_interface>]
                                       [--network-interface <network_interface>]
                                       [--power-interface <power_interface>]
                                       [--raid-interface <raid_interface>]
                                       [--rescue-interface <rescue_interface>]
                                       [--storage-interface <storage_interface>]
                                       [--vendor-interface <vendor_interface>]
                                       [--resource-class <resource_class>]
                                       [--conductor-group <conductor_group>]
                                       [--automated-clean] [--owner <owner>]
                                       [--description <description>]

表 11.209. 可选参数

概述

-h, --help

显示帮助信息并退出

--chassis-uuid <chassis>

此节点所属的机箱的 UUID。

--driver <driver>

用于控制节点 [required] 的驱动程序。

--driver-info <key=value>

驱动程序使用的键/值对,如带外管理凭证。可多次指定。

--property <key=value>

描述节点物理特性的键/值对。这是导出到 Nova,由调度程序使用。可多次指定。

--extra <key=value>

记录任意键/值元数据。可以多次指定。

--uuid <uuid>

节点的唯一 uuid。

--name <name>

节点的唯一名称。

--bios-interface <bios_interface>

由节点驱动程序使用的 BIOS 接口。这仅适用于指定 --driver 是硬件类型。

--boot-interface <boot_interface>

由节点驱动程序使用的引导接口。这仅适用于指定的 --driver 是一个硬件类型。

--console-interface <console_interface>

由节点驱动程序使用的控制台接口。这仅适用于指定的 --driver 是一个硬件类型。

--deploy-interface <deploy_interface>

部署由节点驱动程序使用的界面。这仅适用于指定的 --driver 是一个硬件类型。

--inspect-interface <inspect_interface>

检查节点驱动程序使用的接口。这仅适用于指定 --driver 是一个硬件类型。

--management-interface <management_interface>

节点驱动程序使用的管理接口。这仅适用于指定的 --driver 是一个硬件类型。

--network-interface <network_interface>

用于切换节点来清理/置备网络的网络接口。

--power-interface <power_interface>

节点驱动程序使用的电源接口。这仅适用于指定的 --driver 是一个硬件类型。

--raid-interface <raid_interface>

节点驱动程序使用的 RAID 接口。这只适用于指定 --driver 是一个硬件类型。

--rescue-interface <rescue_interface>

节点驱动程序使用的救援接口。这仅适用于指定的 --driver 是一个硬件类型。

--storage-interface <storage_interface>

节点驱动程序使用的存储接口。

--vendor-interface <vendor_interface>

节点驱动程序使用的厂商界面。这仅适用于指定 --driver 是一个硬件类型。

--resource-class <resource_class>

将节点映射到 nova 类别的资源类

--conductor-group <conductor_group>

节点将属于的编排器

--automated-clean

为节点启用自动清理

--owner <owner>

节点的所有者。

--description <description>