第 12 章 编配服务命令行客户端

子命令

action-check

检查堆栈资源是否处于预期状态。

action-resume

恢复堆栈。

action-suspend

暂停堆栈。

build-info

检索构建信息。

config-create

创建软件配置。

config-delete

删除软件配置。

config-show

查看软件配置的详细信息。

deployment-create

创建软件部署。

deployment-delete

删除软件部署。

deployment-list

列出软件部署。

deployment-metadata-show

获取指定服务器的部署配置元数据。

deployment-output-show

显示特定的部署输出。

deployment-show

显示软件部署的详细信息。

event

弃用！改为使用 event-show。

event-list

列出堆栈的事件。

event-show

描述事件。

hook-clear

清除给定堆栈上的 hook。

hook-poll

列出堆栈的待处理 hook 资源。

output-list

显示可用的输出。

output-show

显示特定的堆栈输出。

resource-list

显示属于堆栈的资源列表。

resource-metadata

列出资源元数据。

resource-show

描述资源。

resource-signal

发送信号到资源。

resource-template

弃用！改为使用 resource-type-template。

resource-type-list

列出可用的资源类型。

resource-type-show

显示资源类型。

resource-type-template

根据资源类型生成模板。

service-list

列出 Heat 引擎。

snapshot-delete

删除堆栈的快照。

snapshot-list

列出堆栈的快照。

snapshot-show

显示堆栈的快照。

stack-abandon

取消堆栈。

stack-adopt

采用堆栈。

stack-cancel-update

取消当前运行堆栈的更新。

stack-create

创建堆栈。

stack-delete

删除堆栈。

stack-list

列出用户的堆栈。

stack-preview

堆栈预览。

stack-restore

恢复堆栈的快照。

stack-show

描述堆栈。

stack-snapshot

生成堆栈的快照。

stack-update

更新堆栈。

template-function-list

列出可用的功能。

template-show

获取指定堆栈的模板。

template-validate

使用参数验证模板。

template-version-list

列出可用的模板版本。

bash-completion

将所有命令和选项输出到 stdout。

帮助

显示有关该程序或其其中一个子命令的帮助。

--version

显示客户端版本并退出。

-d, --debug

默认为 env[HEATCLIENT_DEBUG]。

-v, --verbose

打印更详细的输出。

--api-timeout API_TIMEOUT

等待 API 响应的秒数，默认为系统套接字超时

--os-no-client-auth

不要联系令牌的 keystone。默认为 env[OS_NO_CLIENT_AUTH]。

--Heat-url HEAT_URL

默认为 env[HEAT_URL]。

--Heat-api-version HEAT_API_VERSION

默认为 env[HEAT_API_VERSION] 或 1。

--include-password

将 os-username 和 os-password 发送到 heat。

-k, --insecure

明确允许 heatclient 执行"不安全 SSL" (https)请求。服务器的证书不会针对任何证书颁发机构进行验证。这个选项应谨慎使用。

--os-cert OS_CERT

SSL 连接中使用的证书文件的路径。此文件可以选择使用私钥前添加。

--cert-file OS_CERT

弃用！使用 --os-cert。

--os-key OS_KEY

SSL 连接中使用的客户端密钥的路径。如果您的密钥在您的证书文件前面添加，则不需要这个选项。

--key-file OS_KEY

弃用！使用 --os-key。

--os-cacert <ca-certificate-file>

用于验证远程服务器证书的 CA TLS 证书的路径。如果没有此选项，则 glance 会查找默认的系统 CA 证书。

--ca-file OS_CACERT

弃用！使用 --os-cacert。

--os-username OS_USERNAME

默认为 env[OS_USERNAME]。

--os-user-id OS_USER_ID

默认为 env[OS_USER_ID]。

--os-user-domain-id OS_USER_DOMAIN_ID

默认为 env[OS_USER_DOMAIN_ID]。

--os-user-domain-name OS_USER_DOMAIN_NAME

默认为 env[OS_USER_DOMAIN_NAME]。

--os-project-id OS_PROJECT_ID

指定租户 ID 的另一种方式。这个选项与 --os-tenant-id 相互排斥。默认为 env[OS_PROJECT_ID]。

--os-project-name OS_PROJECT_NAME

指定租户名称的另一种方法。这个选项与 --os-tenant-name 相互排斥。默认为 env[OS_PROJECT_NAME]。

--os-project-domain-id OS_PROJECT_DOMAIN_ID

默认为 env[OS_PROJECT_DOMAIN_ID]。

--os-project-domain-name OS_PROJECT_DOMAIN_NAME

默认为 env[OS_PROJECT_DOMAIN_NAME]。

--os-password OS_PASSWORD

默认为 env[OS_PASSWORD]。

--os-tenant-id OS_TENANT_ID

默认为 env[OS_TENANT_ID]。

--os-tenant-name OS_TENANT_NAME

默认为 env[OS_TENANT_NAME]。

--os-auth-url OS_AUTH_URL

默认为 env[OS_AUTH_URL]。

--os-region-name OS_REGION_NAME

默认为 env[OS_REGION_NAME]。

--os-auth-token OS_AUTH_TOKEN

默认为 env[OS_AUTH_TOKEN]。

--os-service-type OS_SERVICE_TYPE

默认为 env[OS_SERVICE_TYPE]。

--os-endpoint-type OS_ENDPOINT_TYPE

默认为 env[OS_ENDPOINT_TYPE]。

--profile HMAC_KEY

HMAC 密钥用于加密上下文数据以进行操作性能分析。这个键应该是 heat 中 osprofiler 中间件中配置的 HMAC 键的值，它在粘贴配置(/etc/heat/api-paste.ini)中指定。如果没有密钥，即使服务器端启用了 osprofiler，也不会触发性能分析。

positional 参数

<NAME 或 ID>

要检查的堆栈的名称或 ID。

positional 参数

<NAME 或 ID>

要恢复的堆栈的名称或 ID。

positional 参数

<NAME 或 ID>

要暂停的堆栈的名称或 ID。

positional 参数

<CONFIG_NAME>

要创建的配置的名称。

可选参数

-f <FILE 或 URL>, --definition-file <FILE 或 URL>

包含定义 <inputs>、<outputs> 和 <options> 的映射的 JSON/YAML 的路径。

-c <FILE 或 URL>, --config-file <FILE 或 URL>

配置脚本/数据的路径。

-g <GROUP_NAME>, --group <GROUP_NAME>

配置预期的配置工具的组名称。

positional 参数

<ID>

要删除的配置 ID。

positional 参数

<ID>

配置的 ID。

可选参数

-c, --config-only

仅显示 <config> 属性的值。

positional 参数

<DEPLOY_NAME>

与此部署关联的派生配置的名称。这用于将排序顺序应用到当前部署到服务器的配置列表中。

可选参数

-i <KEY=VALUE>, --input-value <KEY=VALUE>

要在部署上设置的输入值。这可以多次指定。

-a <ACTION>, --action <ACTION>

此部署的操作名称。可以是自定义操作，也可以是以下之一： CREATE、UPDATE、DELETE、SUSPEND、RESUME

-c <CONFIG>, --config <CONFIG>

要部署的配置的 ID。

-s <SERVER>, --server <SERVER>

要部署到的服务器 ID。

-t <TRANSPORT>, --signal-transport <TRANSPORT>

服务器如何通过部署输出值向 heat 发出信号。TEMP_URL_SIGNAL 将创建一个 Swift TempURL，以通过 HTTP PUT 发出信号。NO_SIGNAL 将导致资源进入 COMPLETE 状态，而不等待任何信号。

--Container <CONTAINER_NAME>

要存储 TEMP_SIGNAL 对象的容器名称。如果没有指定容器，则会使用从 DEPLOY_NAME 派生的名称创建容器

--timeout <TIMEOUT>

部署超时（以分钟为单位）。

positional 参数

<ID>

要删除的部署 ID。

可选参数

-s <SERVER>, --server <SERVER>

要获取部署的服务器的 ID。

positional 参数

<ID>

要获取部署的服务器的 ID。

positional 参数

<ID>

显示输出的 ID 部署。

<OUTPUT NAME>

要显示的输出名称。

可选参数

-a, --all

显示所有部署输出。

-F <FORMAT>, --format <FORMAT>

输出格式，其中一个：raw、json

positional 参数

<ID>

部署的 ID。

positional 参数

<NAME 或 ID>

用于显示事件的堆栈的名称或 ID。

可选参数

-r <RESOURCE>, --resource <RESOURCE>

用于过滤事件的资源名称。

-f <KEY1=VALUE1;KEY2=VALUE2...>, --filters <KEY1=VALUE1;KEY2=VALUE2..>

过滤要应用到返回的事件的参数。这可以多次指定，或使用以分号分开的参数一次指定。

-L <LIMIT>, --limit <LIMIT>

限制返回的事件数量。

-m <ID>, --marker <ID>

仅返回给定事件 ID 后出现的事件。

-n <DEPTH>, --nested-depth <DEPTH>

从中显示事件的嵌套堆栈的深度。请注意，这无法通过 --resource 指定。

-F <FORMAT>, --format <FORMAT>

输出格式，其中之一： log, table

positional 参数

<NAME 或 ID>

用于显示事件的堆栈的名称或 ID。

<RESOURCE>

事件所属的资源名称。

<EVENT>

显示详情的事件 ID。

positional 参数

<NAME 或 ID>

这些资源所属堆栈的名称或 ID。

<RESOURCE>

带有 hook 的资源名称需要清除。可以使用斜杠作为分隔符来设置嵌套堆栈中的资源： nested_stack/another/my_resource。您可以使用通配符来匹配多个堆栈或资源： nested_stack/an* configured_resource

可选参数

--pre-create

清除 pre-create hook （可选）

--pre-update

清除 pre-update hook （可选）

positional 参数

<NAME 或 ID>

堆栈的名称或 ID，以显示待处理的 hook。

可选参数

-n <DEPTH>, --nested-depth <DEPTH>

深度显示 hook 的嵌套堆栈。

positional 参数

<NAME 或 ID>

要查询的堆栈的名称或 ID。

positional 参数

<NAME 或 ID>

要查询的堆栈的名称或 ID。

<OUTPUT NAME>

要显示的输出名称。

可选参数

-a, --all

显示所有堆栈输出。

-F <FORMAT>, --format <FORMAT>

输出格式，其中一个： json、raw

positional 参数

<NAME 或 ID>

用于显示其资源的堆栈名称或 ID。

可选参数

-n <DEPTH>, --nested-depth <DEPTH>

从中显示资源的嵌套堆栈的深度。

--with-detail

启用为资源列表中显示的每个资源的详细信息。

positional 参数

<NAME 或 ID>

用于显示资源元数据的堆栈名称或 ID。

<RESOURCE>

显示元数据的资源名称。

positional 参数

<NAME 或 ID>

用于显示其资源的堆栈名称或 ID。

<RESOURCE>

要显示详细信息的资源的名称。

可选参数

-a <ATTRIBUTE>, --with-attr <ATTRIBUTE>

要显示的属性，可以多次指定。

positional 参数

<NAME 或 ID>

资源所属的堆栈的名称或 ID。

<RESOURCE>

要信号的资源的名称。

可选参数

-d <DATA>, --data <DATA>

要发送到信号处理程序的 JSON 数据。

-f <FILE>, --data-file <FILE>

包含要发送到信号处理程序的 JSON 数据的文件。

可选参数

-f <KEY1=VALUE1;KEY2=VALUE2...>, --filters <KEY1=VALUE1;KEY2=VALUE2..>

过滤要应用到返回的资源类型的参数。这可以多次指定，或使用以分号分开的参数一次指定。它可以是任何 name、version 和 support_status

positional 参数

<RESOURCE_TYPE>

用于获取.

positional 参数

<RESOURCE_TYPE>

生成模板的资源类型。

可选参数

-T <TEMPLATE_TYPE>, --template-type <TEMPLATE_TYPE>

要生成、热或 cfn 的模板类型。

-F <FORMAT>, --format <FORMAT>

模板输出格式，其中之一： yaml、json。

positional 参数

<NAME 或 ID>

包含快照的堆栈的名称或 ID。

<SNAPSHOT>

要删除的快照的 ID。

positional 参数

<NAME 或 ID>

包含快照的堆栈的名称或 ID。

positional 参数

<NAME 或 ID>

包含快照的堆栈的名称或 ID。

<SNAPSHOT>

要显示的快照 ID。

positional 参数

<NAME 或 ID>

带给的堆栈名称或 ID。

可选参数

-o <FILE>, --output-file <FILE>

输出带外结果的文件。如果指定了该选项，则结果将输出到 <FILE>。

positional 参数

<STACK_NAME>

要采用的堆栈的名称。

可选参数

-e <FILE 或 URL>, --environment-file <FILE 或 URL>

环境的路径，可以多次指定。

-c <TIMEOUT>, --create-timeout <TIMEOUT>

堆栈创建超时（以分钟为单位）。DEPRECATED 使用 --timeout 替代。

-t <TIMEOUT>, --timeout <TIMEOUT>

堆栈创建超时（以分钟为单位）。

-a <FILE 或 URL>, --adopt-file <FILE 或 URL>

采用堆栈数据文件的路径。

-r, --enable-rollback

在 create/update 失败时启用回滚。

-p <KEY1=VALUE1;KEY2=VALUE2...>, --parameters <KEY1=VALUE1;KEY2=VALUE2..>

用于创建堆栈的参数值。这可以多次指定，或使用以分号分开的参数一次指定。

positional 参数

<NAME 或 ID>

要取消更新的堆栈的名称或 ID。

positional 参数

<STACK_NAME>

要创建的堆栈的名称。

可选参数

-f <FILE>, --template-file <FILE>

模板的路径。

-e <FILE 或 URL>, --environment-file <FILE 或 URL>

环境的路径，可以多次指定。

--pre-create <RESOURCE>

将预先创建 hook 设置为的资源的名称。可以使用斜杠作为分隔符来设置嵌套堆栈中的资源： nested_stack/another/my_resource。您可以使用通配符来匹配多个堆栈或资源： nested_stack/an* configured_resource。这可以多次指定

-u <URL>, --template-url <URL>

模板的 URL。

-o <URL>, --template-object <URL>

检索模板对象的 URL （如从 swift）。

-c <TIMEOUT>, --create-timeout <TIMEOUT>

堆栈创建超时（以分钟为单位）。DEPRECATED 使用 --timeout 替代。

-t <TIMEOUT>, --timeout <TIMEOUT>

堆栈创建超时（以分钟为单位）。

-r, --enable-rollback

在 create/update 失败时启用回滚。

-p <KEY1=VALUE1;KEY2=VALUE2...>, --parameters <KEY1=VALUE1;KEY2=VALUE2..>

用于创建堆栈的参数值。这可以多次指定，或使用以分号分开的参数一次指定。

-PF <KEY=FILE>, --parameter-file <KEY=FILE>

用于创建堆栈的 文件中的参数值。这可以多次指定。参数值将是文件的内容

--poll [SECONDS]

轮询和报告事件，直到堆栈完成。可选的轮询间隔（以秒为单位）作为参数提供，默认 5。

--tags <TAG1,TAG2>

与堆栈关联的标签列表。

positional 参数

<NAME 或 ID>

要删除的堆栈名称或 ID。

可选参数

-s, --show-deleted

在堆栈列表中包括软删除堆栈。

-n,--show-nested

在堆栈列表中包括嵌套堆栈。

-a, --show-hidden

在堆栈列表中包括隐藏的堆栈。

-f <KEY1=VALUE1;KEY2=VALUE2...>, --filters <KEY1=VALUE1;KEY2=VALUE2..>

过滤要应用到返回的堆栈的参数。这可以多次指定，或使用以分号分开的参数一次指定。

-t <TAG1,TAG2..>, --tags <TAG1,TAG2..>

显示包含这些标签的堆栈，使用布尔值 AND 表达式组合多个标签

--tags- any <TAG1,TAG2..>

显示包含这些标签的堆栈，使用布尔值 OR 表达式组合多个标签

--not-tags <TAG1,TAG2...>

显示堆栈不包含这些标签，使用布尔值 AND 表达式组合多个标签

--not-tags-any <TAG1,TAG2...>

显示堆栈不包含这些标签，使用布尔值 OR 表达式组合多个标签

-L <LIMIT>, --limit <LIMIT>

限制返回的堆栈数量。

-m <ID>, --marker <ID>

仅返回给定堆栈 ID 后显示的堆栈。

-k <KEY1,KEY2..>, --sort-keys <KEY1,KEY2..>

用于排序返回的堆栈的键列表。这可以多次指定，或使用以分号分开的键一次指定。有效排序键包括 "stack_name", "stack_status", "creation_time" 和 "updated_time"。

-d [asc|desc], --sort-dir [asc|desc]

为排序键排序方向(asc"或"desc")。

-g, --global-tenant

显示来自所有租户的堆栈。仅针对与 heat 的 policy.json 中策略匹配的用户执行操作。

-o, --show-owner

显示堆栈所有者信息。使用 --global-tenant 时会自动启用。

positional 参数

<STACK_NAME>

要预览的堆栈的名称。

可选参数

-f <FILE>, --template-file <FILE>

模板的路径。

-e <FILE 或 URL>, --environment-file <FILE 或 URL>

环境的路径，可以多次指定。

-u <URL>, --template-url <URL>

模板的 URL。

-o <URL>, --template-object <URL>

检索模板对象的 URL （如从 swift）

-t <TIMEOUT>, --timeout <TIMEOUT>

堆栈创建超时（以分钟为单位）。这只在预览过程中使用。

-r, --enable-rollback

失败时启用回滚。这个选项在preview 期间不使用，且仅适用于带有 stack- create 的 symmetry。

-p <KEY1=VALUE1;KEY2=VALUE2...>, --parameters <KEY1=VALUE1;KEY2=VALUE2..>

用于预览堆栈的参数值。这可以多次指定，或使用以分号分开的参数一次指定。

-PF <KEY=FILE>, --parameter-file <KEY=FILE>

用于创建堆栈的 文件中的参数值。这可以多次指定。参数值将是文件的内容

--tags <TAG1,TAG2>

与堆栈关联的标签列表。

positional 参数

<NAME 或 ID>

包含快照的堆栈的名称或 ID。

<SNAPSHOT>

要恢复的快照 ID。

positional 参数

<NAME 或 ID>

要描述的堆栈的名称或 ID。

positional 参数

<NAME 或 ID>

要快照的堆栈名称或 ID。

可选参数

-n <NAME>, --name <NAME>

如果指定，则提供给快照的名称。

positional 参数

<NAME 或 ID>

要更新的堆栈的名称或 ID。

可选参数

-f <FILE>, --template-file <FILE>

模板的路径。

-e <FILE 或 URL>, --environment-file <FILE 或 URL>

环境的路径，可以多次指定。

--pre-update <RESOURCE>

将 pre-update hook 设置为的资源名称。可以使用斜杠作为分隔符来设置嵌套堆栈中的资源： nested_stack/another/my_resource。您可以使用通配符来匹配多个堆栈或资源： nested_stack/an* configured_resource。这可以多次指定

-u <URL>, --template-url <URL>

模板的 URL。

-o <URL>, --template-object <URL>

检索模板对象的 URL （如从 swift）。

-t <TIMEOUT>, --timeout <TIMEOUT>

堆栈更新超时（以分钟为单位）。

-r, --enable-rollback

弃用！改为使用 --rollback 参数。在堆栈更新失败时启用回滚。注意：默认行为是使用现有堆栈的回滚值。

--rollback <VALUE>

在更新失败时设置回滚。值('1', 't', 'true', 'on', 'y', 'yes')将回滚设置为 enabled。值('0', 'f', 'false', 'off', 'n', 'no')将回滚设置为 disabled。默认为使用要更新的现有堆栈的值。

-y, --dry-run

不要实际执行堆栈更新，但显示要更改的内容

-p <KEY1=VALUE1;KEY2=VALUE2...>, --parameters <KEY1=VALUE1;KEY2=VALUE2..>

用于创建堆栈的参数值。这可以多次指定，或使用以分号分开的参数一次指定。

-PF <KEY=FILE>, --parameter-file <KEY=FILE>

用于创建堆栈的 文件中的参数值。这可以多次指定。参数值将是文件的内容

-x,--existing

重新使用当前堆栈的模板、参数和环境。如果省略 template 参数，则使用现有的模板。如果没有指定 --environment-file，则使用现有的环境。在 --parameters 中指定的参数将修补当前堆栈中的现有值。省略的参数将保留现有的值。

-c <PARAMETER>, --clear-parameter <PARAMETER>

从 stack-update 的当前堆栈的参数集合中移除参数。将使用模板中的默认值。这可以多次指定。

--tags <TAG1,TAG2>

与堆栈关联的更新的标签列表。

positional 参数

<TEMPLATE_VERSION>

获取以下功能的模板版本。

positional 参数

<NAME 或 ID>

用于获取模板的堆栈名称或 ID。

可选参数

-u <URL>, --template-url <URL>

模板的 URL。

-f <FILE>, --template-file <FILE>

模板的路径。

-e <FILE 或 URL>, --environment-file <FILE 或 URL>

环境的路径，可以多次指定。

-o <URL>, --template-object <URL>

检索模板对象的 URL （如从 swift）。

-n,--show-nested

也从嵌套模板解析参数。