diff --git a/doc/cli-reference/generated/ch_cli_heat_commands.xml b/doc/cli-reference/generated/ch_cli_heat_commands.xml index 5751f19b4e..b28b8b571d 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.2.12. + 0.3.0. For help on a specific heat @@ -77,6 +77,30 @@ + + config-create + + + Create a software configuration. + + + + + config-delete + + + Delete software configurations. + + + + + config-show + + + View details of a software configuration. + + + create @@ -93,6 +117,31 @@ + + deployment-delete + + + Delete software deployments. + + + + + deployment-metadata-show + + + Get deployment configuration metadata for the + specified server. + + + + + deployment-show + + + Show the details of a software deployment. + + + describe @@ -229,6 +278,38 @@ + + service-list + + + List the Heat engines. + + + + + snapshot-delete + + + Delete a snapshot of a stack. + + + + + snapshot-list + + + List the snapshots of a stack. + + + + + snapshot-show + + + Show a snapshot of a stack. + + + stack-abandon @@ -285,6 +366,14 @@ + + stack-restore + + + Restore a snapshot of a stack. + + + stack-show @@ -293,6 +382,14 @@ + + stack-snapshot + + + Make a snapshot of a stack. + + + stack-update @@ -678,6 +775,150 @@ Suspend the stack. Retrieve build information. +
+ heat config-create + usage: heat config-create [-f <FILE or URL>] [-c <FILE or URL>] + [-g <GROUP_NAME>] + <CONFIG_NAME> + +Create a software configuration. + + Positional arguments + + <CONFIG_NAME> + + + Name of the configuration to create. + + + + + + Optional arguments + + -f <FILE or URL>, --definition-file <FILE or URL> + + + Path to JSON/YAML containing map defining <inputs>, + <outputs>, and <options>. + + + + + -c <FILE or URL>, --config-file <FILE or URL> + + + Path to configuration script/data. + + + + + -g <GROUP_NAME>, --group <GROUP_NAME> + + + Group name of configuration tool expected by the + config. + + + + +
+
+ heat config-delete + usage: heat config-delete <ID> [<ID> ...] + +Delete software configurations. + + Positional arguments + + <ID> + + + IDs of the configurations to delete. + + + + +
+
+ heat config-show + usage: heat config-show [-c] <ID> + +View details of a software configuration. + + Positional arguments + + <ID> + + + ID of the config. + + + + + + Optional arguments + + -c, --config-only + + + Only display the value of the <config> property. + + + + +
+
+ heat deployment-delete + usage: heat deployment-delete <ID> [<ID> ...] + +Delete software deployments. + + Positional arguments + + <ID> + + + IDs of the deployments to delete. + + + + +
+
+ heat deployment-metadata-show + usage: heat deployment-metadata-show <ID> + +Get deployment configuration metadata for the specified server. + + Positional arguments + + <ID> + + + ID of the server to fetch deployments for. + + + + +
+
+ heat deployment-show + usage: heat deployment-show <ID> + +Show the details of a software deployment. + + Positional arguments + + <ID> + + + ID of the deployment. + + + + +
heat event-list usage: heat event-list [-r <RESOURCE>] [-f <KEY1=VALUE1;KEY2=VALUE2...>] @@ -787,7 +1028,7 @@ Show available outputs.
heat output-show - usage: heat output-show <NAME or ID> <OUTPUT NAME> + usage: heat output-show [-a] [-F <FORMAT>] <NAME or ID> [<OUTPUT NAME>] Show a specific stack output. @@ -808,6 +1049,25 @@ Show a specific stack output. + + + Optional arguments + + -a, --all + + + Display all stack outputs. + + + + + -F <FORMAT>, --format <FORMAT> + + + The output value format, one of: json, raw + + +
@@ -1012,6 +1272,80 @@ Generate a template based on a resource type. + +
+
+ heat service-list + usage: heat service-list + +List the Heat engines. + +
+
+ heat snapshot-delete + usage: heat snapshot-delete <NAME or ID> <SNAPSHOT> + +Delete a snapshot of a stack. + + Positional arguments + + <NAME or ID> + + + Name or ID of the stack containing the snapshot. + + + + + <SNAPSHOT> + + + The ID of the snapshot to delete. + + + + +
+
+ heat snapshot-list + usage: heat snapshot-list <NAME or ID> + +List the snapshots of a stack. + + Positional arguments + + <NAME or ID> + + + Name or ID of the stack containing the snapshots. + + + + +
+
+ heat snapshot-show + usage: heat snapshot-show <NAME or ID> <SNAPSHOT> + +Show a snapshot of a stack. + + Positional arguments + + <NAME or ID> + + + Name or ID of the stack containing the snapshot. + + + + + <SNAPSHOT> + + + The ID of the snapshot to show. + + +
@@ -1400,6 +1734,31 @@ Preview the stack. + +
+
+ heat stack-restore + usage: heat stack-restore <NAME or ID> <SNAPSHOT> + +Restore a snapshot of a stack. + + Positional arguments + + <NAME or ID> + + + Name or ID of the stack containing the snapshot. + + + + + <SNAPSHOT> + + + The ID of the snapshot to restore. + + +
@@ -1417,6 +1776,34 @@ Describe the stack. + +
+
+ heat stack-snapshot + usage: heat stack-snapshot [-n <NAME>] <NAME or ID> + +Make a snapshot of a stack. + + Positional arguments + + <NAME or ID> + + + Name or ID of stack to snapshot. + + + + + + Optional arguments + + -n <NAME>, --name <NAME> + + + If specified, the name given to the snapshot. + + +