From 4f5443f5e30b5f96fef37b5ec2c64a8cb70d750a Mon Sep 17 00:00:00 2001 From: Atsushi SAKAI Date: Thu, 3 Sep 2015 09:45:57 +0900 Subject: [PATCH] Update CLI reference for python-heatclient 0.7.0 Change-Id: I8bf057f97b5b400b725734f9add2d0848044d3db --- .../generated/ch_cli_heat_commands.xml | 210 ++++++++++++++++-- 1 file changed, 190 insertions(+), 20 deletions(-) diff --git a/doc/cli-reference/generated/ch_cli_heat_commands.xml b/doc/cli-reference/generated/ch_cli_heat_commands.xml index 31e68484ac..8e118a43e6 100644 --- a/doc/cli-reference/generated/ch_cli_heat_commands.xml +++ b/doc/cli-reference/generated/ch_cli_heat_commands.xml @@ -15,7 +15,7 @@ interface (CLI) for the Orchestration API and its extensions. This chapter documents heat version - 0.6.0. + 0.7.0. For help on a specific heat @@ -89,7 +89,7 @@ config-delete - Delete software configurations. + Delete a software configuration. @@ -105,6 +105,7 @@ deployment-create + Create a software deployment. @@ -112,7 +113,15 @@ deployment-delete - Delete software deployments. + Delete a software deployment. + + + + + deployment-list + + + List software deployments. @@ -129,7 +138,7 @@ deployment-output-show - Show a specific stack output. + Show a specific deployment output. @@ -381,6 +390,14 @@ + + template-function-list + + + List the available functions. + + + template-show @@ -397,6 +414,14 @@ + + template-version-list + + + List the available template versions. + + + bash-completion @@ -794,7 +819,7 @@ Create a software configuration. heat config-delete usage: heat config-delete <ID> [<ID> ...] -Delete software configurations. +Delete a software configuration. Positional arguments @@ -837,12 +862,13 @@ View details of a software configuration.
heat deployment-create - usage: heat deployment-create [-i <KEY=VALUE>] [-a <ACTION>] [-c <CONFIG>] - [-s <SERVER>] [-t <TRANSPORT>] + usage: heat deployment-create [-i <KEY=VALUE>] [-a <ACTION>] [-c <CONFIG>] -s + <SERVER> [-t <TRANSPORT>] [--container <CONTAINER_NAME>] [--timeout <TIMEOUT>] <DEPLOY_NAME> +Create a software deployment. Positional arguments @@ -930,7 +956,7 @@ View details of a software configuration. heat deployment-delete usage: heat deployment-delete <ID> [<ID> ...] -Delete software deployments. +Delete a software deployment. Positional arguments @@ -941,6 +967,23 @@ Delete software deployments. + +
+
+ heat deployment-list + usage: heat deployment-list [-s <SERVER>] + +List software deployments. + + Optional arguments + + -s <SERVER>, --server <SERVER> + + + ID of the server to fetch deployments for. + + +
@@ -964,7 +1007,7 @@ Get deployment configuration metadata for the specified server. heat deployment-output-show usage: heat deployment-output-show [-a] [-F <FORMAT>] <ID> [<OUTPUT NAME>] -Show a specific stack output. +Show a specific deployment output. Positional arguments @@ -1024,7 +1067,7 @@ Show the details of a software deployment.
heat event-list usage: heat event-list [-r <RESOURCE>] [-f <KEY1=VALUE1;KEY2=VALUE2...>] - [-l <LIMIT>] [-m <ID>] [-n <DEPTH>] + [-l <LIMIT>] [-m <ID>] [-n <DEPTH>] [-F <FORMAT>] <NAME or ID> List events for a stack. @@ -1085,6 +1128,14 @@ List events for a stack. + + -F <FORMAT>, --format <FORMAT> + + + The output value format, one of: log, table + + +
@@ -1260,7 +1311,7 @@ Show a specific stack output.
heat resource-list - usage: heat resource-list [-n <DEPTH>] <NAME or ID> + usage: heat resource-list [-n <DEPTH>] [--with-detail] <NAME or ID> Show list of resources belonging to a stack. @@ -1285,6 +1336,15 @@ Show list of resources belonging to a stack. + + --with-detail + + + Enable detail information presented for each resource + in resources list. + + +
@@ -1314,7 +1374,7 @@ List resource metadata.
heat resource-show - usage: heat resource-show <NAME or ID> <RESOURCE> + usage: heat resource-show [-a <ATTRIBUTE>] <NAME or ID> <RESOURCE> Describe the resource. @@ -1335,6 +1395,17 @@ Describe the resource. + + + Optional arguments + + -a <ATTRIBUTE>, --with-attr <ATTRIBUTE> + + + Attribute to show, it can be specified multiple times. + + +
@@ -1645,7 +1716,8 @@ Cancel currently running update of the stack. usage: heat stack-create [-f <FILE>] [-e <FILE or URL>] [--pre-create <RESOURCE>] [-u <URL>] [-o <URL>] [-c <TIMEOUT>] [-t <TIMEOUT>] [-r] - [-P <KEY1=VALUE1;KEY2=VALUE2...>] [-Pf <KEY=VALUE>] + [-P <KEY1=VALUE1;KEY2=VALUE2...>] [-Pf <KEY=FILE>] + [--poll [SECONDS]] [--tags <TAG1,TAG2>] <STACK_NAME> Create the stack. @@ -1744,7 +1816,7 @@ Create the stack. - -Pf <KEY=VALUE>, --parameter-file <KEY=VALUE> + -Pf <KEY=FILE>, --parameter-file <KEY=FILE> Parameter values from file used to create the stack. @@ -1753,6 +1825,24 @@ Create the stack. + + --poll [SECONDS] + + + Poll and report events until stack completes. Optional + poll interval in seconds can be provided as argument, + default 5. + + + + + --tags <TAG1,TAG2> + + + A list of tags to associate with the stack. + + +
@@ -1775,7 +1865,10 @@ Delete the stack(s).
heat stack-list usage: heat stack-list [-s] [-n] [-a] [-f <KEY1=VALUE1;KEY2=VALUE2...>] - [-l <LIMIT>] [-m <ID>] [-g] [-o] + [-t <TAG1,TAG2...>] [--tags-any <TAG1,TAG2...>] + [--not-tags <TAG1,TAG2...>] + [--not-tags-any <TAG1,TAG2...>] [-l <LIMIT>] [-m <ID>] + [-g] [-o] List the user's stacks. @@ -1814,6 +1907,42 @@ List the user's stacks. + + -t <TAG1,TAG2...>, --tags <TAG1,TAG2...> + + + Show stacks containing these tags, combine multiple + tags using the boolean AND expression + + + + + --tags-any <TAG1,TAG2...> + + + Show stacks containing these tags, combine multiple + tags using the boolean OR expression + + + + + --not-tags <TAG1,TAG2...> + + + Show stacks not containing these tags, combine + multiple tags using the boolean AND expression + + + + + --not-tags-any <TAG1,TAG2...> + + + Show stacks not containing these tags, combine + multiple tags using the boolean OR expression + + + -l <LIMIT>, --limit <LIMIT> @@ -1856,7 +1985,8 @@ List the user's stacks. heat stack-preview usage: heat stack-preview [-f <FILE>] [-e <FILE or URL>] [-u <URL>] [-o <URL>] [-t <TIMEOUT>] [-r] - [-P <KEY1=VALUE1;KEY2=VALUE2...>] [-Pf <KEY=VALUE>] + [-P <KEY1=VALUE1;KEY2=VALUE2...>] [-Pf <KEY=FILE>] + [--tags <TAG1,TAG2>] <STACK_NAME> Preview the stack. @@ -1936,7 +2066,7 @@ Preview the stack. - -Pf <KEY=VALUE>, --parameter-file <KEY=VALUE> + -Pf <KEY=FILE>, --parameter-file <KEY=FILE> Parameter values from file used to create the stack. @@ -1945,6 +2075,14 @@ Preview the stack. + + --tags <TAG1,TAG2> + + + A list of tags to associate with the stack. + + +
@@ -2022,8 +2160,8 @@ Make a snapshot of a stack. usage: heat stack-update [-f <FILE>] [-e <FILE or URL>] [--pre-update <RESOURCE>] [-u <URL>] [-o <URL>] [-t <TIMEOUT>] [-r] [--rollback <VALUE>] - [-P <KEY1=VALUE1;KEY2=VALUE2...>] [-Pf <KEY=VALUE>] - [-x] [-c <PARAMETER>] + [-P <KEY1=VALUE1;KEY2=VALUE2...>] [-Pf <KEY=FILE>] + [-x] [-c <PARAMETER>] [--tags <TAG1,TAG2>] <NAME or ID> Update the stack. @@ -2128,7 +2266,7 @@ Update the stack. - -Pf <KEY=VALUE>, --parameter-file <KEY=VALUE> + -Pf <KEY=FILE>, --parameter-file <KEY=FILE> Parameter values from file used to create the stack. @@ -2159,6 +2297,31 @@ Update the stack. + + --tags <TAG1,TAG2> + + + An updated list of tags to associate with the stack. + + + + +
+
+ heat template-function-list + usage: heat template-function-list <TEMPLATE_VERSION> + +List the available functions. + + Positional arguments + + <TEMPLATE_VERSION> + + + Template version to get the functions for. + + +
@@ -2221,4 +2384,11 @@ Validate a template with parameters.
+
+ heat template-version-list + usage: heat template-version-list + +List the available template versions. + +