命令行界面参考
Red Hat OpenStack Platform 的命令行客户端
摘要
前言
使开源包含更多
红帽致力于替换我们的代码、文档和 Web 属性中存在问题的语言。我们从这四个术语开始:master、slave、黑名单和白名单。由于此项工作十分艰巨,这些更改将在即将推出的几个发行版本中逐步实施。详情请查看 CTO Chris Wright 的信息。
对红帽文档提供反馈
我们感谢您对文档提供反馈信息。与我们分享您的成功秘诀。
使用直接文档反馈(DDF)功能
使用 添加反馈 DDF 功能,用于特定句子、段落或代码块上的直接注释。
- 以 Multi-page HTML 格式查看文档。
- 请确定您看到文档右上角的 反馈 按钮。
- 用鼠标指针高亮显示您想评论的文本部分。
- 点 添加反馈。
- 在添加反馈项中输入您的意见。
- 可选:添加您的电子邮件地址,以便文档团队可以联系您以讨论您的问题。
- 点 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>]
值 | 概述 |
---|---|
--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>
值 | 概述 |
---|---|
-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> 关联的验证器(必需) |
值 | 概述 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 输出格式,默认为 table |
-c COLUMN, --column COLUMN | 指定要包含的列,可以重复 |
值 | 概述 |
---|---|
--noindent | 是否禁用缩进 json |
值 | 概述 |
---|---|
--prefix PREFIX | 为所有变量名称添加前缀 |
值 | 概述 |
---|---|
--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
值 | 概述 |
---|---|
URI | secret 或容器的 uri 引用。 |
值 | 概述 |
---|---|
-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
值 | 概述 |
---|---|
URI | secret 或容器的 uri 引用。 |
值 | 概述 |
---|---|
-h, --help | 显示帮助信息并退出 |
值 | 概述 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 输出格式,默认为 table |
-c COLUMN, --column COLUMN | 指定要包含的列,可以重复 |
--sort-column SORT_COLUMN | 指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复 |
值 | 概述 |
---|---|
--quote {all,minimal,none,nonnumeric} | 当包含引号时,默认为 nonnumeric |
值 | 概述 |
---|---|
--noindent | 是否禁用缩进 json |
值 | 概述 |
---|---|
--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
值 | 概述 |
---|---|
URI | secret 或容器的 uri 引用。 |
值 | 概述 |
---|---|
-h, --help | 显示帮助信息并退出 |
--user [USERS], -u [USERS] | acl 的 Keystone userid. |
--project-access | 启用项目访问行为的标志。 |
--no-project-access | 禁用项目访问行为的标志。 |
--operation-type {read}, -o {read} | 为设置 barbican 操作 acl 的类型 |
值 | 概述 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 输出格式,默认为 table |
-c COLUMN, --column COLUMN | 指定要包含的列,可以重复 |
--sort-column SORT_COLUMN | 指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复 |
值 | 概述 |
---|---|
--quote {all,minimal,none,nonnumeric} | 当包含引号时,默认为 nonnumeric |
值 | 概述 |
---|---|
--noindent | 是否禁用缩进 json |
值 | 概述 |
---|---|
--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
值 | 概述 |
---|---|
URI | secret 或容器的 uri 引用。 |
值 | 概述 |
---|---|
-h, --help | 显示帮助信息并退出 |
--user [USERS], -u [USERS] | acl 的 Keystone userid. |
--project-access | 启用项目访问行为的标志。 |
--no-project-access | 禁用项目访问行为的标志。 |
--operation-type {read}, -o {read} | 为设置 barbican 操作 acl 的类型 |
值 | 概述 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 输出格式,默认为 table |
-c COLUMN, --column COLUMN | 指定要包含的列,可以重复 |
--sort-column SORT_COLUMN | 指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复 |
值 | 概述 |
---|---|
--quote {all,minimal,none,nonnumeric} | 当包含引号时,默认为 nonnumeric |
值 | 概述 |
---|---|
--noindent | 是否禁用缩进 json |
值 | 概述 |
---|---|
--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
值 | 概述 |
---|---|
URI | secret 或容器的 uri 引用。 |
值 | 概述 |
---|---|
-h, --help | 显示帮助信息并退出 |
--user [USERS], -u [USERS] | acl 的 Keystone userid. |
--project-access | 启用项目访问行为的标志。 |
--no-project-access | 禁用项目访问行为的标志。 |
--operation-type {read}, -o {read} | 为设置 barbican 操作 acl 的类型 |
值 | 概述 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 输出格式,默认为 table |
-c COLUMN, --column COLUMN | 指定要包含的列,可以重复 |
--sort-column SORT_COLUMN | 指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复 |
值 | 概述 |
---|---|
--quote {all,minimal,none,nonnumeric} | 当包含引号时,默认为 nonnumeric |
值 | 概述 |
---|---|
--noindent | 是否禁用缩进 json |
值 | 概述 |
---|---|
--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
值 | 概述 |
---|---|
定义 | 操作定义文件 |
值 | 概述 |
---|---|
-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"。 |
值 | 概述 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 输出格式,默认为 table |
-c COLUMN, --column COLUMN | 指定要包含的列,可以重复 |
--sort-column SORT_COLUMN | 指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复 |
值 | 概述 |
---|---|
--quote {all,minimal,none,nonnumeric} | 当包含引号时,默认为 nonnumeric |
值 | 概述 |
---|---|
--noindent | 是否禁用缩进 json |
值 | 概述 |
---|---|
--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
值 | 概述 |
---|---|
name | 操作名称 |
值 | 概述 |
---|---|
-h, --help | 显示帮助信息并退出 |
4.3. 操作定义删除
删除操作.
使用方法:
openstack action definition delete [-h] action [action ...]
值 | 概述 |
---|---|
action | 操作的名称或 id。 |
值 | 概述 |
---|---|
-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]
值 | 概述 |
---|---|
-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 | 过滤器. 可以重复。 |
值 | 概述 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 输出格式,默认为 table |
-c COLUMN, --column COLUMN | 指定要包含的列,可以重复 |
--sort-column SORT_COLUMN | 指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复 |
值 | 概述 |
---|---|
--quote {all,minimal,none,nonnumeric} | 当包含引号时,默认为 nonnumeric |
值 | 概述 |
---|---|
--noindent | 是否禁用缩进 json |
值 | 概述 |
---|---|
--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
值 | 概述 |
---|---|
action | 操作(名称或 id) |
值 | 概述 |
---|---|
-h, --help | 显示帮助信息并退出 |
值 | 概述 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 输出格式,默认为 table |
-c COLUMN, --column COLUMN | 指定要包含的列,可以重复 |
值 | 概述 |
---|---|
--noindent | 是否禁用缩进 json |
值 | 概述 |
---|---|
--prefix PREFIX | 为所有变量名称添加前缀 |
值 | 概述 |
---|---|
--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
值 | 概述 |
---|---|
定义 | 操作定义文件 |
值 | 概述 |
---|---|
-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"。 |
值 | 概述 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 输出格式,默认为 table |
-c COLUMN, --column COLUMN | 指定要包含的列,可以重复 |
--sort-column SORT_COLUMN | 指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复 |
值 | 概述 |
---|---|
--quote {all,minimal,none,nonnumeric} | 当包含引号时,默认为 nonnumeric |
值 | 概述 |
---|---|
--noindent | 是否禁用缩进 json |
值 | 概述 |
---|---|
--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 ...]
值 | 概述 |
---|---|
action_execution | 操作执行标识符 ID。 |
值 | 概述 |
---|---|
-h, --help | 显示帮助信息并退出 |
4.8. 操作执行输入显示
显示操作执行输入数据。
使用方法:
openstack action execution input show [-h] id
值 | 概述 |
---|---|
id | 操作执行 ID. |
值 | 概述 |
---|---|
-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]
值 | 概述 |
---|---|
task_execution_id | 任务执行 ID。 |
值 | 概述 |
---|---|
-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 | 显示从最旧的条目开始的执行,而不是从最新的条目开始 |
值 | 概述 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 输出格式,默认为 table |
-c COLUMN, --column COLUMN | 指定要包含的列,可以重复 |
--sort-column SORT_COLUMN | 指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复 |
值 | 概述 |
---|---|
--quote {all,minimal,none,nonnumeric} | 当包含引号时,默认为 nonnumeric |
值 | 概述 |
---|---|
--noindent | 是否禁用缩进 json |
值 | 概述 |
---|---|
--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
值 | 概述 |
---|---|
id | 操作执行 ID. |
值 | 概述 |
---|---|
-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]
值 | 概述 |
---|---|
name | 要执行的操作名称。 |
输入 | 操作输入. |
值 | 概述 |
---|---|
-h, --help | 显示帮助信息并退出 |
-s, --save-result | 将结果保存到 db 中。 |
--run-sync | 同步运行操作。 |
-t TARGET, --target TARGET | 操作将针对 <target> executor 执行。 |
值 | 概述 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 输出格式,默认为 table |
-c COLUMN, --column COLUMN | 指定要包含的列,可以重复 |
值 | 概述 |
---|---|
--noindent | 是否禁用缩进 json |
值 | 概述 |
---|---|
--prefix PREFIX | 为所有变量名称添加前缀 |
值 | 概述 |
---|---|
--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
值 | 概述 |
---|---|
action_execution | 操作执行 ID. |
值 | 概述 |
---|---|
-h, --help | 显示帮助信息并退出 |
值 | 概述 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 输出格式,默认为 table |
-c COLUMN, --column COLUMN | 指定要包含的列,可以重复 |
值 | 概述 |
---|---|
--noindent | 是否禁用缩进 json |
值 | 概述 |
---|---|
--prefix PREFIX | 为所有变量名称添加前缀 |
值 | 概述 |
---|---|
--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
值 | 概述 |
---|---|
id | 操作执行 ID. |
值 | 概述 |
---|---|
-h, --help | 显示帮助信息并退出 |
--state {PAUSED,RUNNING,SUCCESS,ERROR,CANCELLED} | 操作执行状态 |
--output OUTPUT | 操作执行输出 |
值 | 概述 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 输出格式,默认为 table |
-c COLUMN, --column COLUMN | 指定要包含的列,可以重复 |
值 | 概述 |
---|---|
--noindent | 是否禁用缩进 json |
值 | 概述 |
---|---|
--prefix PREFIX | 为所有变量名称添加前缀 |
值 | 概述 |
---|---|
--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>
值 | 概述 |
---|---|
<name> | 新地址范围名称 |
值 | 概述 |
---|---|
-h, --help | 显示帮助信息并退出 |
--ip-version {4,6} | IP 版本(默认为 4) |
--project <project> | 所有者的项目(名称或 id) |
--project-domain <project-domain> | 项目所属的域(名称或 id)。这可在项目名称之间有冲突时使用。 |
--share | 在项目间共享地址范围 |
--no-share | 不要在项目间共享地址范围(默认) |
值 | 概述 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 输出格式,默认为 table |
-c COLUMN, --column COLUMN | 指定要包含的列,可以重复 |
值 | 概述 |
---|---|
--noindent | 是否禁用缩进 json |
值 | 概述 |
---|---|
--prefix PREFIX | 为所有变量名称添加前缀 |
值 | 概述 |
---|---|
--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> ...]
值 | 概述 |
---|---|
<address-scope> | 要删除的地址范围(名称或 ID) |
值 | 概述 |
---|---|
-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]
值 | 概述 |
---|---|
-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 | 列出项目间不共享的地址范围 |
值 | 概述 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 输出格式,默认为 table |
-c COLUMN, --column COLUMN | 指定要包含的列,可以重复 |
--sort-column SORT_COLUMN | 指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复 |
值 | 概述 |
---|---|
--quote {all,minimal,none,nonnumeric} | 当包含引号时,默认为 nonnumeric |
值 | 概述 |
---|---|
--noindent | 是否禁用缩进 json |
值 | 概述 |
---|---|
--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>
值 | 概述 |
---|---|
<address-scope> | 要修改的地址范围(名称或 id) |
值 | 概述 |
---|---|
-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>
值 | 概述 |
---|---|
<address-scope> | 要显示的地址范围(名称或 id) |
值 | 概述 |
---|---|
-h, --help | 显示帮助信息并退出 |
值 | 概述 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 输出格式,默认为 table |
-c COLUMN, --column COLUMN | 指定要包含的列,可以重复 |
值 | 概述 |
---|---|
--noindent | 是否禁用缩进 json |
值 | 概述 |
---|---|
--prefix PREFIX | 为所有变量名称添加前缀 |
值 | 概述 |
---|---|
--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>
值 | 概述 |
---|---|
<aggregate> | 聚合(名称或 ID) |
<host> | 要添加到 <aggregate> 的主机 |
值 | 概述 |
---|---|
-h, --help | 显示帮助信息并退出 |
值 | 概述 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 输出格式,默认为 table |
-c COLUMN, --column COLUMN | 指定要包含的列,可以重复 |
值 | 概述 |
---|---|
--noindent | 是否禁用缩进 json |
值 | 概述 |
---|---|
--prefix PREFIX | 为所有变量名称添加前缀 |
值 | 概述 |
---|---|
--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>
值 | 概述 |
---|---|
<name> | 新聚合名称 |
值 | 概述 |
---|---|
-h, --help | 显示帮助信息并退出 |
--zone <availability-zone> | 可用区名称 |
--property <key=value> | 要添加到此聚合的属性(重复选项来设置多个属性) |
值 | 概述 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 输出格式,默认为 table |
-c COLUMN, --column COLUMN | 指定要包含的列,可以重复 |
值 | 概述 |
---|---|
--noindent | 是否禁用缩进 json |
值 | 概述 |
---|---|
--prefix PREFIX | 为所有变量名称添加前缀 |
值 | 概述 |
---|---|
--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> ...]
值 | 概述 |
---|---|
<aggregate> | 要删除的聚合(名称或 ID) |
值 | 概述 |
---|---|
-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]
值 | 概述 |
---|---|
-h, --help | 显示帮助信息并退出 |
--long | 列出输出中的其他字段 |
值 | 概述 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 输出格式,默认为 table |
-c COLUMN, --column COLUMN | 指定要包含的列,可以重复 |
--sort-column SORT_COLUMN | 指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复 |
值 | 概述 |
---|---|
--quote {all,minimal,none,nonnumeric} | 当包含引号时,默认为 nonnumeric |
值 | 概述 |
---|---|
--noindent | 是否禁用缩进 json |
值 | 概述 |
---|---|
--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>
值 | 概述 |
---|---|
<aggregate> | 聚合(名称或 ID) |
<host> | 从 <aggregate> 中删除的主机 |
值 | 概述 |
---|---|
-h, --help | 显示帮助信息并退出 |
值 | 概述 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 输出格式,默认为 table |
-c COLUMN, --column COLUMN | 指定要包含的列,可以重复 |
值 | 概述 |
---|---|
--noindent | 是否禁用缩进 json |
值 | 概述 |
---|---|
--prefix PREFIX | 为所有变量名称添加前缀 |
值 | 概述 |
---|---|
--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>
值 | 概述 |
---|---|
<aggregate> | 聚合以修改(名称或 ID) |
值 | 概述 |
---|---|
-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>
值 | 概述 |
---|---|
<aggregate> | 聚合显示(名称或 id) |
值 | 概述 |
---|---|
-h, --help | 显示帮助信息并退出 |
值 | 概述 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 输出格式,默认为 table |
-c COLUMN, --column COLUMN | 指定要包含的列,可以重复 |
值 | 概述 |
---|---|
--noindent | 是否禁用缩进 json |
值 | 概述 |
---|---|
--prefix PREFIX | 为所有变量名称添加前缀 |
值 | 概述 |
---|---|
--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>
值 | 概述 |
---|---|
<aggregate> | 聚合以修改(名称或 ID) |
值 | 概述 |
---|---|
-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>]
值 | 概述 |
---|---|
-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} | 真(如果应该重复通知操作,则警报会一直处于目标状态) |
值 | 概述 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 输出格式,默认为 table |
-c COLUMN, --column COLUMN | 指定要包含的列,可以重复 |
值 | 概述 |
---|---|
--noindent | 是否禁用缩进 json |
值 | 概述 |
---|---|
--prefix PREFIX | 为所有变量名称添加前缀 |
值 | 概述 |
---|---|
--max-width <integer> | 最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。 |
--fit-width | 适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用 |
--print-empty | 如果没有要显示数据,则打印空表。 |
值 | 概述 |
---|---|
--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> | 与之比较的运算符,其中之一:[lt、le、eq、ne、ge、gt] |
--evaluation-periods <EVAL_PERIODS> | 要评估的时间段数 |
--threshold <THRESHOLD> | 要评估的阈值。 |
值 | 概述 |
---|---|
--event-type <EVENT_TYPE> | 要评估的事件类型 |
值 | 概述 |
---|---|
--granularity <GRANULARITY> | 查询的时间范围(以秒为单位)。 |
--aggregation-method <AGGR_METHOD> | 与阈值相比的 aggregation_method。 |
--metric <METRIC>, --metrics <METRIC> | 根据警报类型的指标 ID 或名称 |
值 | 概述 |
---|---|
--resource-type <RESOURCE_TYPE> | 资源的类型。 |
--resource-id <RESOURCE_ID> | 资源的 ID。 |
值 | 概述 |
---|---|
--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>]
值 | 概述 |
---|---|
<ALARM ID 或 NAME> | 警报的 ID 或名称。 |
值 | 概述 |
---|---|
-h, --help | 显示帮助信息并退出 |
--name <NAME> | 警报的名称 |
7.3. alarm-history 搜索
根据查询显示所有警报的历史记录
使用方法:
openstack alarm-history search [-h] [-f {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]
值 | 概述 |
---|---|
-h, --help | 显示帮助信息并退出 |
--query QUERY | Rich query supported by aodh, e.g. project_id!=my-id user_id=foo or user_id=bar |
值 | 概述 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 输出格式,默认为 table |
-c COLUMN, --column COLUMN | 指定要包含的列,可以重复 |
--sort-column SORT_COLUMN | 指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复 |
值 | 概述 |
---|---|
--quote {all,minimal,none,nonnumeric} | 当包含引号时,默认为 nonnumeric |
值 | 概述 |
---|---|
--noindent | 是否禁用缩进 json |
值 | 概述 |
---|---|
--max-width <integer> | 最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。 |
--fit-width | 适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用 |
--print-empty | 如果没有要显示数据,则打印空表。 |
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>
值 | 概述 |
---|---|
<alarm-id> | 警报 ID |
值 | 概述 |
---|---|
-h, --help | 显示帮助信息并退出 |
--limit <LIMIT> | 要返回的资源数量(默认为 server default) |
--marker <MARKER> | 以上列表的最后一个项。返回这个值后的下一个结果,支持的标记是 event_id。 |
--sort <SORT_KEY:SORT_DIR> | 资源属性的排序。例如 timestamp:desc |
值 | 概述 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 输出格式,默认为 table |
-c COLUMN, --column COLUMN | 指定要包含的列,可以重复 |
--sort-column SORT_COLUMN | 指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复 |
值 | 概述 |
---|---|
--quote {all,minimal,none,nonnumeric} | 当包含引号时,默认为 nonnumeric |
值 | 概述 |
---|---|
--noindent | 是否禁用缩进 json |
值 | 概述 |
---|---|
--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>]
值 | 概述 |
---|---|
-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 |
值 | 概述 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 输出格式,默认为 table |
-c COLUMN, --column COLUMN | 指定要包含的列,可以重复 |
--sort-column SORT_COLUMN | 指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复 |
值 | 概述 |
---|---|
--quote {all,minimal,none,nonnumeric} | 当包含引号时,默认为 nonnumeric |
值 | 概述 |
---|---|
--noindent | 是否禁用缩进 json |
值 | 概述 |
---|---|
--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>]
值 | 概述 |
---|---|
<ALARM ID 或 NAME> | 警报的 ID 或名称。 |
值 | 概述 |
---|---|
-h, --help | 显示帮助信息并退出 |
--name <NAME> | 警报的名称 |
值 | 概述 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 输出格式,默认为 table |
-c COLUMN, --column COLUMN | 指定要包含的列,可以重复 |
值 | 概述 |
---|---|
--noindent | 是否禁用缩进 json |
值 | 概述 |
---|---|
--prefix PREFIX | 为所有变量名称添加前缀 |
值 | 概述 |
---|---|
--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>]
值 | 概述 |
---|---|
<ALARM ID 或 NAME> | 警报的 ID 或名称。 |
值 | 概述 |
---|---|
-h, --help | 显示帮助信息并退出 |
--name <NAME> | 警报的名称 |
值 | 概述 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 输出格式,默认为 table |
-c COLUMN, --column COLUMN | 指定要包含的列,可以重复 |
值 | 概述 |
---|---|
--noindent | 是否禁用缩进 json |
值 | 概述 |
---|---|
--prefix PREFIX | 为所有变量名称添加前缀 |
值 | 概述 |
---|---|
--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>]
值 | 概述 |
---|---|
<ALARM ID 或 NAME> | 警报的 ID 或名称。 |
值 | 概述 |
---|---|
-h, --help | 显示帮助信息并退出 |
--name <NAME> | 警报的名称 |
--state <STATE> | 警报的状态之一:[ok,alarm,insufficient data] |
值 | 概述 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 输出格式,默认为 table |
-c COLUMN, --column COLUMN | 指定要包含的列,可以重复 |
值 | 概述 |
---|---|
--noindent | 是否禁用缩进 json |
值 | 概述 |
---|---|
--prefix PREFIX | 为所有变量名称添加前缀 |
值 | 概述 |
---|---|
--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>]
值 | 概述 |
---|---|
<ALARM ID 或 NAME> | 警报的 ID 或名称。 |
值 | 概述 |
---|---|
-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} | 真(如果应该重复通知操作,则警报会一直处于目标状态) |
值 | 概述 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 输出格式,默认为 table |
-c COLUMN, --column COLUMN | 指定要包含的列,可以重复 |
值 | 概述 |
---|---|
--noindent | 是否禁用缩进 json |
值 | 概述 |
---|---|
--prefix PREFIX | 为所有变量名称添加前缀 |
值 | 概述 |
---|---|
--max-width <integer> | 最大显示宽度 <1 来禁用。您还可以使用 CLIFF_MAX_TERM_WIDTH 环境变量,但参数具有优先权。 |
--fit-width | 适合显示宽度的表。如果 --max-width 大于 0,则意味着。将环境变量 CLIFF_FIT_WIDTH=1 设置为 always 启用 |
--print-empty | 如果没有要显示数据,则打印空表。 |
值 | 概述 |
---|---|
--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> | 与之比较的运算符,其中之一:[lt、le、eq、ne、ge、gt] |
--evaluation-periods <EVAL_PERIODS> | 要评估的时间段数 |
--threshold <THRESHOLD> | 要评估的阈值。 |
值 | 概述 |
---|---|
--event-type <EVENT_TYPE> | 要评估的事件类型 |
值 | 概述 |
---|---|
--granularity <GRANULARITY> | 查询的时间范围(以秒为单位)。 |
--aggregation-method <AGGR_METHOD> | 与阈值相比的 aggregation_method。 |
--metric <METRIC>, --metrics <METRIC> | 根据警报类型的指标 ID 或名称 |
值 | 概述 |
---|---|
--resource-type <RESOURCE_TYPE> | 资源的类型。 |
--resource-id <RESOURCE_ID> | 资源的 ID。 |
值 | 概述 |
---|---|
--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]
值 | 概述 |
---|---|
-h, --help | 显示帮助信息并退出 |
值 | 概述 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 输出格式,默认为 table |
-c COLUMN, --column COLUMN | 指定要包含的列,可以重复 |
值 | 概述 |
---|---|
--noindent | 是否禁用缩进 json |
值 | 概述 |
---|---|
--prefix PREFIX | 为所有变量名称添加前缀 |
值 | 概述 |
---|---|
--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>
值 | 概述 |
---|---|
<name> | 应用程序凭证的名称 |
值 | 概述 |
---|---|
-h, --help | 显示帮助信息并退出 |
--secret <secret> | 用于身份验证的 secret (如果没有提供,将生成一个) |
--role <role> | 要授权的角色(名称或 id)(重复选项来设置多个值) |
--expiration <expiration> | 为应用程序凭证设置过期日期,格式为 YYYY-mm-ddTHH:MM:SS (如果未提供,应用程序凭证不会过期) |
--description <description> | 应用程序凭证描述 |
--unrestricted | 启用应用程序凭证来创建和删除其他应用程序凭证和信任(这是可能存在的危险行为,默认为禁用) |
--restricted | 禁止应用程序凭证创建和删除其他应用程序凭证和信任(这是默认行为) |
值 | 概述 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 输出格式,默认为 table |
-c COLUMN, --column COLUMN | 指定要包含的列,可以重复 |
值 | 概述 |
---|---|
--noindent | 是否禁用缩进 json |
值 | 概述 |
---|---|
--prefix PREFIX | 为所有变量名称添加前缀 |
值 | 概述 |
---|---|
--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> ...]
值 | 概述 |
---|---|
<application-credential> | 要删除的应用程序凭证(名称或 ID) |
值 | 概述 |
---|---|
-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>]
值 | 概述 |
---|---|
-h, --help | 显示帮助信息并退出 |
--user <user> | 用于列出应用程序凭证的用户(名称或 ID) |
--user-domain <user-domain> | 用户所属的域(名称或 id)。这在用户名之间有冲突时可以使用。 |
值 | 概述 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 输出格式,默认为 table |
-c COLUMN, --column COLUMN | 指定要包含的列,可以重复 |
--sort-column SORT_COLUMN | 指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复 |
值 | 概述 |
---|---|
--quote {all,minimal,none,nonnumeric} | 当包含引号时,默认为 nonnumeric |
值 | 概述 |
---|---|
--noindent | 是否禁用缩进 json |
值 | 概述 |
---|---|
--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>
值 | 概述 |
---|---|
<application-credential> | 要显示的应用程序凭证(名称或 id) |
值 | 概述 |
---|---|
-h, --help | 显示帮助信息并退出 |
值 | 概述 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 输出格式,默认为 table |
-c COLUMN, --column COLUMN | 指定要包含的列,可以重复 |
值 | 概述 |
---|---|
--noindent | 是否禁用缩进 json |
值 | 概述 |
---|---|
--prefix PREFIX | 为所有变量名称添加前缀 |
值 | 概述 |
---|---|
--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]
值 | 概述 |
---|---|
-h, --help | 显示帮助信息并退出 |
--compute | 列出计算可用区 |
--network | 列出网络可用区 |
--volume | 列出卷可用区 |
--long | 列出输出中的其他字段 |
值 | 概述 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 输出格式,默认为 table |
-c COLUMN, --column COLUMN | 指定要包含的列,可以重复 |
--sort-column SORT_COLUMN | 指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复 |
值 | 概述 |
---|---|
--quote {all,minimal,none,nonnumeric} | 当包含引号时,默认为 nonnumeric |
值 | 概述 |
---|---|
--noindent | 是否禁用缩进 json |
值 | 概述 |
---|---|
--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]
值 | 概述 |
---|---|
-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 | 从已部署的提供的节点回填此分配。绕过正常分配过程。 |
值 | 概述 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 输出格式,默认为 table |
-c COLUMN, --column COLUMN | 指定要包含的列,可以重复 |
值 | 概述 |
---|---|
--noindent | 是否禁用缩进 json |
值 | 概述 |
---|---|
--prefix PREFIX | 为所有变量名称添加前缀 |
值 | 概述 |
---|---|
--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> ...]
值 | 概述 |
---|---|
<allocation> | 分配要删除的分配(name 或 uuid)。 |
值 | 概述 |
---|---|
-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> ...]]
值 | 概述 |
---|---|
-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 时,不能使用。 |
值 | 概述 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 输出格式,默认为 table |
-c COLUMN, --column COLUMN | 指定要包含的列,可以重复 |
--sort-column SORT_COLUMN | 指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复 |
值 | 概述 |
---|---|
--quote {all,minimal,none,nonnumeric} | 当包含引号时,默认为 nonnumeric |
值 | 概述 |
---|---|
--noindent | 是否禁用缩进 json |
值 | 概述 |
---|---|
--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>
值 | 概述 |
---|---|
<allocation> | 分配的名称或 uuid |
值 | 概述 |
---|---|
-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>
值 | 概述 |
---|---|
<id> | 分配的 UUID 或名称 |
值 | 概述 |
---|---|
-h, --help | 显示帮助信息并退出 |
--fields <field> [<field> …] | 一个或多个分配字段。只有这些字段将从服务器中获取。 |
值 | 概述 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 输出格式,默认为 table |
-c COLUMN, --column COLUMN | 指定要包含的列,可以重复 |
值 | 概述 |
---|---|
--noindent | 是否禁用缩进 json |
值 | 概述 |
---|---|
--prefix PREFIX | 为所有变量名称添加前缀 |
值 | 概述 |
---|---|
--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>
值 | 概述 |
---|---|
<allocation> | 分配的名称或 uuid |
值 | 概述 |
---|---|
-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>]
值 | 概述 |
---|---|
-h, --help | 显示帮助信息并退出 |
--description <description> | chassis 描述 |
--extra <key=value> | 记录任意键/值元数据。可以多次指定。 |
--uuid <uuid> | chassis 的唯一 uuid |
值 | 概述 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 输出格式,默认为 table |
-c COLUMN, --column COLUMN | 指定要包含的列,可以重复 |
值 | 概述 |
---|---|
--noindent | 是否禁用缩进 json |
值 | 概述 |
---|---|
--prefix PREFIX | 为所有变量名称添加前缀 |
值 | 概述 |
---|---|
--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> ...]
值 | 概述 |
---|---|
<chassis> | 要删除的机箱的 UUID |
值 | 概述 |
---|---|
-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>]]
值 | 概述 |
---|---|
-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)。可以用逗号分隔来指定多个字段和方向。 |
值 | 概述 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 输出格式,默认为 table |
-c COLUMN, --column COLUMN | 指定要包含的列,可以重复 |
--sort-column SORT_COLUMN | 指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复 |
值 | 概述 |
---|---|
--quote {all,minimal,none,nonnumeric} | 当包含引号时,默认为 nonnumeric |
值 | 概述 |
---|---|
--noindent | 是否禁用缩进 json |
值 | 概述 |
---|---|
--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>
值 | 概述 |
---|---|
<chassis> | chassis 的 UUID |
值 | 概述 |
---|---|
-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>
值 | 概述 |
---|---|
<chassis> | chassis 的 UUID |
值 | 概述 |
---|---|
-h, --help | 显示帮助信息并退出 |
--fields <field> [<field> …] | 一个或多个 chassis 字段。只有这些字段从服务器获取。 |
值 | 概述 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 输出格式,默认为 table |
-c COLUMN, --column COLUMN | 指定要包含的列,可以重复 |
值 | 概述 |
---|---|
--noindent | 是否禁用缩进 json |
值 | 概述 |
---|---|
--prefix PREFIX | 为所有变量名称添加前缀 |
值 | 概述 |
---|---|
--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>
值 | 概述 |
---|---|
<chassis> | chassis 的 UUID |
值 | 概述 |
---|---|
-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> ...]]
值 | 概述 |
---|---|
-h, --help | 显示帮助信息并退出 |
--limit <limit> | 每个请求返回的最大编排器数量,0 代表没有限制。默认为 Baremetal API 服务使用的最大值。 |
--marker <conductor> | 编排器的主机名(例如,上一个请求列表中的最后一个编排器)。在此编排器后返回编排器列表。 |
--sort <key>[:<direction>] | 根据指定的编排器字段和指示(如 或 desc)对输出进行排序(默认值: asc 或 dec)。可以用逗号分隔来指定多个字段和方向。 |
--long | 显示有关编排器的详细信息。 |
--fields <field> [<field> …] | 一个或多个编排器字段。只有这些字段将从服务器获取。当指定 -- long 时,不能使用。 |
值 | 概述 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 输出格式,默认为 table |
-c COLUMN, --column COLUMN | 指定要包含的列,可以重复 |
--sort-column SORT_COLUMN | 指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复 |
值 | 概述 |
---|---|
--quote {all,minimal,none,nonnumeric} | 当包含引号时,默认为 nonnumeric |
值 | 概述 |
---|---|
--noindent | 是否禁用缩进 json |
值 | 概述 |
---|---|
--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>
值 | 概述 |
---|---|
<conductor> | 编排器的主机名 |
值 | 概述 |
---|---|
-h, --help | 显示帮助信息并退出 |
--fields <field> [<field> …] | 一个或多个编排器字段。只有这些字段将从服务器获取。 |
值 | 概述 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 输出格式,默认为 table |
-c COLUMN, --column COLUMN | 指定要包含的列,可以重复 |
值 | 概述 |
---|---|
--noindent | 是否禁用缩进 json |
值 | 概述 |
---|---|
--prefix PREFIX | 为所有变量名称添加前缀 |
值 | 概述 |
---|---|
--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> ...]
值 | 概述 |
---|---|
<file> | 文件(.yaml 或 .json),其中包含要创建的资源描述。可多次指定。 |
值 | 概述 |
---|---|
-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>
值 | 概述 |
---|---|
<name> | 此部署模板的唯一名称。必须是有效的特征名称。 |
值 | 概述 |
---|---|
-h, --help | 显示帮助信息并退出 |
--uuid <uuid> | deploy 模板的 UUID。 |
--extra <key=value> | 记录任意键/值元数据。可以多次指定。 |
--steps <steps> | json 格式的部署步骤。可以是包含部署步骤的文件的路径;或 -,包含从标准输入读取的部署步骤;或字符串。该值应该是 deploy-step字典的列表;每个字典都应有键 接口、step、args 和 priority。 |
值 | 概述 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 输出格式,默认为 table |
-c COLUMN, --column COLUMN | 指定要包含的列,可以重复 |
值 | 概述 |
---|---|
--noindent | 是否禁用缩进 json |
值 | 概述 |
---|---|
--prefix PREFIX | 为所有变量名称添加前缀 |
值 | 概述 |
---|---|
--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> ...]
值 | 概述 |
---|---|
<template> | 要删除的部署模板的名称或 uuid。 |
值 | 概述 |
---|---|
-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> ...]]
值 | 概述 |
---|---|
-h, --help | 显示帮助信息并退出 |
--limit <limit> | 每个请求返回的最大部署模板数量,0 代表没有限制。默认为 Baremetal API 服务使用的最大值。 |
--marker <template> | Deploytemplate uuid (例如,上一个请求列表中的最后部署模板)。在此 UUID 后返回部署模板列表。 |
--sort <key>[:<direction>] | 根据指定的部署模板字段和指示(如 或 desc)对输出进行排序(默认值: asc 或 dec)。可以用逗号分隔来指定多个字段和方向。 |
--long | 显示有关部署模板的详细信息。 |
--fields <field> [<field> …] | 一个或多个部署模板字段。只有这些字段将从服务器中获取。指定 --long 时无法使用。 |
值 | 概述 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 输出格式,默认为 table |
-c COLUMN, --column COLUMN | 指定要包含的列,可以重复 |
--sort-column SORT_COLUMN | 指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复 |
值 | 概述 |
---|---|
--quote {all,minimal,none,nonnumeric} | 当包含引号时,默认为 nonnumeric |
值 | 概述 |
---|---|
--noindent | 是否禁用缩进 json |
值 | 概述 |
---|---|
--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>
值 | 概述 |
---|---|
<template> | 部署模板的名称或 uuid |
值 | 概述 |
---|---|
-h, --help | 显示帮助信息并退出 |
--name <name> | 设置部署模板的唯一名称。必须是有效的特征名称。 |
--steps <steps> | json 格式的部署步骤。可以是包含部署步骤的文件的路径;或 -,包含从标准输入读取的部署步骤;或字符串。该值应该是 deploy-step字典的列表;每个字典都应有键 接口、step、args 和 priority。 |
--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>
值 | 概述 |
---|---|
<template> | 部署模板的名称或 uuid。 |
值 | 概述 |
---|---|
-h, --help | 显示帮助信息并退出 |
--fields <field> [<field> …] | 一个或多个部署模板字段。只有这些字段将从服务器中获取。 |
值 | 概述 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 输出格式,默认为 table |
-c COLUMN, --column COLUMN | 指定要包含的列,可以重复 |
值 | 概述 |
---|---|
--noindent | 是否禁用缩进 json |
值 | 概述 |
---|---|
--prefix PREFIX | 为所有变量名称添加前缀 |
值 | 概述 |
---|---|
--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>
值 | 概述 |
---|---|
<template> | 部署模板的名称或 uuid |
值 | 概述 |
---|---|
-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]
值 | 概述 |
---|---|
-h, --help | 显示帮助信息并退出 |
--type <type> | 驱动程序类型("classic"或"ynamic")。默认值为所有它们。 |
--long | 显示有关驱动程序的详细信息。 |
值 | 概述 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 输出格式,默认为 table |
-c COLUMN, --column COLUMN | 指定要包含的列,可以重复 |
--sort-column SORT_COLUMN | 指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复 |
值 | 概述 |
---|---|
--quote {all,minimal,none,nonnumeric} | 当包含引号时,默认为 nonnumeric |
值 | 概述 |
---|---|
--noindent | 是否禁用缩进 json |
值 | 概述 |
---|---|
--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>
值 | 概述 |
---|---|
<driver> | 驱动程序的名称。 |
<method> | 供应商传递方法需要被调用。 |
值 | 概述 |
---|---|
-h, --help | 显示帮助信息并退出 |
--arg <key=value> | 传递给 passthru 方法的参数(重复选项用于指定多个参数)。 |
--http-method <http-method> | passthru 请求中使用的 http 方法。一个 DELETE、GET、PATCH、POST、PUT。默认为 POST。 |
值 | 概述 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 输出格式,默认为 table |
-c COLUMN, --column COLUMN | 指定要包含的列,可以重复 |
值 | 概述 |
---|---|
--noindent | 是否禁用缩进 json |
值 | 概述 |
---|---|
--prefix PREFIX | 为所有变量名称添加前缀 |
值 | 概述 |
---|---|
--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>
值 | 概述 |
---|---|
<driver> | 驱动程序的名称。 |
值 | 概述 |
---|---|
-h, --help | 显示帮助信息并退出 |
值 | 概述 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 输出格式,默认为 table |
-c COLUMN, --column COLUMN | 指定要包含的列,可以重复 |
--sort-column SORT_COLUMN | 指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复 |
值 | 概述 |
---|---|
--quote {all,minimal,none,nonnumeric} | 当包含引号时,默认为 nonnumeric |
值 | 概述 |
---|---|
--noindent | 是否禁用缩进 json |
值 | 概述 |
---|---|
--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>
值 | 概述 |
---|---|
<driver> | 驱动程序的名称。 |
值 | 概述 |
---|---|
-h, --help | 显示帮助信息并退出 |
值 | 概述 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 输出格式,默认为 table |
-c COLUMN, --column COLUMN | 指定要包含的列,可以重复 |
--sort-column SORT_COLUMN | 指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复 |
值 | 概述 |
---|---|
--quote {all,minimal,none,nonnumeric} | 当包含引号时,默认为 nonnumeric |
值 | 概述 |
---|---|
--noindent | 是否禁用缩进 json |
值 | 概述 |
---|---|
--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>
值 | 概述 |
---|---|
<driver> | 驱动程序的名称。 |
值 | 概述 |
---|---|
-h, --help | 显示帮助信息并退出 |
值 | 概述 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 输出格式,默认为 table |
-c COLUMN, --column COLUMN | 指定要包含的列,可以重复 |
--sort-column SORT_COLUMN | 指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复 |
值 | 概述 |
---|---|
--quote {all,minimal,none,nonnumeric} | 当包含引号时,默认为 nonnumeric |
值 | 概述 |
---|---|
--noindent | 是否禁用缩进 json |
值 | 概述 |
---|---|
--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>
值 | 概述 |
---|---|
<driver> | 驱动程序的名称。 |
值 | 概述 |
---|---|
-h, --help | 显示帮助信息并退出 |
值 | 概述 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 输出格式,默认为 table |
-c COLUMN, --column COLUMN | 指定要包含的列,可以重复 |
值 | 概述 |
---|---|
--noindent | 是否禁用缩进 json |
值 | 概述 |
---|---|
--prefix PREFIX | 为所有变量名称添加前缀 |
值 | 概述 |
---|---|
--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
值 | 概述 |
---|---|
node | 裸机恢复节点 uuid 或名称 |
值 | 概述 |
---|---|
-h, --help | 显示帮助信息并退出 |
11.29. 裸机内省数据保存
保存或显示原始内省数据。
使用方法:
openstack baremetal introspection data save [-h] [--file <filename>] node
值 | 概述 |
---|---|
node | 裸机恢复节点 uuid 或名称 |
值 | 概述 |
---|---|
-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
值 | 概述 |
---|---|
node_ident | 裸机恢复节点 uuid 或名称 |
值 | 概述 |
---|---|
-h, --help | 显示帮助信息并退出 |
--vlan VLAN | 仅列出为此 vlan id 配置的接口,才能重复 |
--long | 显示有关接口的详细信息。 |
--fields <field> [<field> …] | 显示一个或多个字段。当指定 -- long 时无法使用。 |
值 | 概述 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 输出格式,默认为 table |
-c COLUMN, --column COLUMN | 指定要包含的列,可以重复 |
--sort-column SORT_COLUMN | 指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复 |
值 | 概述 |
---|---|
--quote {all,minimal,none,nonnumeric} | 当包含引号时,默认为 nonnumeric |
值 | 概述 |
---|---|
--noindent | 是否禁用缩进 json |
值 | 概述 |
---|---|
--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
值 | 概述 |
---|---|
node_ident | 裸机恢复节点 uuid 或名称 |
interface | 接口名称 |
值 | 概述 |
---|---|
-h, --help | 显示帮助信息并退出 |
--fields <field> [<field> …] | 显示一个或多个字段。 |
值 | 概述 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 输出格式,默认为 table |
-c COLUMN, --column COLUMN | 指定要包含的列,可以重复 |
值 | 概述 |
---|---|
--noindent | 是否禁用缩进 json |
值 | 概述 |
---|---|
--prefix PREFIX | 为所有变量名称添加前缀 |
值 | 概述 |
---|---|
--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]
值 | 概述 |
---|---|
-h, --help | 显示帮助信息并退出 |
--marker MARKER | 上一页面中最后一个项目的 UUID |
--limit LIMIT | 要返回的项目数量 |
值 | 概述 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 输出格式,默认为 table |
-c COLUMN, --column COLUMN | 指定要包含的列,可以重复 |
--sort-column SORT_COLUMN | 指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复 |
值 | 概述 |
---|---|
--quote {all,minimal,none,nonnumeric} | 当包含引号时,默认为 nonnumeric |
值 | 概述 |
---|---|
--noindent | 是否禁用缩进 json |
值 | 概述 |
---|---|
--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
值 | 概述 |
---|---|
node | 裸机恢复节点 uuid 或名称 |
值 | 概述 |
---|---|
-h, --help | 显示帮助信息并退出 |
11.34. 裸机内省规则删除
删除内省规则。
使用方法:
openstack baremetal introspection rule delete [-h] uuid
值 | 概述 |
---|---|
uuid | 规则 uuid |
值 | 概述 |
---|---|
-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
值 | 概述 |
---|---|
file | 要导入的 JSON 或 yaml 文件可以包含一个或多个规则 |
值 | 概述 |
---|---|
-h, --help | 显示帮助信息并退出 |
值 | 概述 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 输出格式,默认为 table |
-c COLUMN, --column COLUMN | 指定要包含的列,可以重复 |
--sort-column SORT_COLUMN | 指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复 |
值 | 概述 |
---|---|
--quote {all,minimal,none,nonnumeric} | 当包含引号时,默认为 nonnumeric |
值 | 概述 |
---|---|
--noindent | 是否禁用缩进 json |
值 | 概述 |
---|---|
--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]
值 | 概述 |
---|---|
-h, --help | 显示帮助信息并退出 |
值 | 概述 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 输出格式,默认为 table |
-c COLUMN, --column COLUMN | 指定要包含的列,可以重复 |
--sort-column SORT_COLUMN | 指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复 |
值 | 概述 |
---|---|
--quote {all,minimal,none,nonnumeric} | 当包含引号时,默认为 nonnumeric |
值 | 概述 |
---|---|
--noindent | 是否禁用缩进 json |
值 | 概述 |
---|---|
--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]
值 | 概述 |
---|---|
-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
值 | 概述 |
---|---|
uuid | 规则 uuid |
值 | 概述 |
---|---|
-h, --help | 显示帮助信息并退出 |
值 | 概述 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 输出格式,默认为 table |
-c COLUMN, --column COLUMN | 指定要包含的列,可以重复 |
值 | 概述 |
---|---|
--noindent | 是否禁用缩进 json |
值 | 概述 |
---|---|
--prefix PREFIX | 为所有变量名称添加前缀 |
值 | 概述 |
---|---|
--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 ...]
值 | 概述 |
---|---|
node | 裸机恢复节点 uuid 或名称 |
值 | 概述 |
---|---|
-h, --help | 显示帮助信息并退出 |
--wait | 等待内省完成,结果将在结尾显示 |
--check-errors | 检查内省期间发生了错误;如果出现任何错误,则仅显示错误;只能与 --wait 一起使用 |
值 | 概述 |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | 输出格式,默认为 table |
-c COLUMN, --column COLUMN | 指定要包含的列,可以重复 |
--sort-column SORT_COLUMN | 指定排序数据的列(指定首先具有优先级的非存在列将被忽略)可以重复 |
值 | 概述 |
---|---|
--quote {all,minimal,none,nonnumeric} | 当包含引号时,默认为 nonnumeric |
值 | 概述 |
---|---|
--noindent | 是否禁用缩进 json |
值 | 概述 |
---|---|
--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
值 | 概述 |
---|---|
node | 裸机恢复节点 uuid 或名称 |
值 | 概述 |
---|---|
-h, --help | 显示帮助信息并退出 |
值 | 概述 |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | 输出格式,默认为 table |
-c COLUMN, --column COLUMN | 指定要包含的列,可以重复 |
值 | 概述 |
---|---|