Chapter 45. orchestration
This chapter describes the commands under the orchestration
command.
45.1. orchestration build info
Retrieve build information.
Usage:
openstack orchestration build info [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--fit-width] [--print-empty] [--noindent] [--prefix PREFIX]
Table 45.1. Table Formatter
Value | Summary |
---|---|
--print-empty | Print empty table if there is no data to show. |
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable |
Table 45.2. Output Formatters
Value | Summary |
---|---|
output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
Table 45.3. JSON Formatter
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 45.4. Optional Arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
Table 45.5. Shell Formatter
Value | Summary |
---|---|
a format a UNIX shell can parse (variable="value")--prefix PREFIX | Add a prefix to all variable names |
45.2. orchestration resource type list
List resource types.
Usage:
openstack orchestration resource type list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--fit-width] [--print-empty] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--sort-column SORT_COLUMN] [--filter <key=value>] [--long]
Table 45.6. Table Formatter
Value | Summary |
---|---|
--print-empty | Print empty table if there is no data to show. |
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable |
Table 45.7. CSV Formatter
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
Table 45.8. Output Formatters
Value | Summary |
---|---|
output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
--sort-column SORT_COLUMN | Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated |
Table 45.9. JSON Formatter
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 45.10. Optional Arguments
Value | Summary |
---|---|
--filter <key=value> | Filter parameters to apply on returned resource types. This can be specified multiple times. It can be any of name, version or support_status |
-h, --help | Show this help message and exit |
--long | Show resource types with corresponding description of each resource type. |
45.3. orchestration resource type show
Show details and optionally generate a template for a resource type.
Usage:
openstack orchestration resource type show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--fit-width] [--print-empty] [--noindent] [--prefix PREFIX] [--template-type <template-type>] [--long] <resource-type>
Table 45.11. Table Formatter
Value | Summary |
---|---|
--print-empty | Print empty table if there is no data to show. |
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable |
Table 45.12. Positional Arguments
Value | Summary |
---|---|
<resource-type> | Resource type to show details for |
Table 45.13. Output Formatters
Value | Summary |
---|---|
output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to yaml |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
Table 45.14. JSON Formatter
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 45.15. Optional Arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
--template-type <template-type> | Optional template type to generate, hot or cfn |
--long | Show resource type with corresponding description. |
Table 45.16. Shell Formatter
Value | Summary |
---|---|
a format a UNIX shell can parse (variable="value")--prefix PREFIX | Add a prefix to all variable names |
45.4. orchestration service list
List the Heat engines.
Usage:
openstack orchestration service list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--fit-width] [--print-empty] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--sort-column SORT_COLUMN]
Table 45.17. Table Formatter
Value | Summary |
---|---|
--print-empty | Print empty table if there is no data to show. |
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable |
Table 45.18. CSV Formatter
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
Table 45.19. Output Formatters
Value | Summary |
---|---|
output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
--sort-column SORT_COLUMN | Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated |
Table 45.20. JSON Formatter
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 45.21. Optional Arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
45.5. orchestration template function list
List the available functions.
Usage:
openstack orchestration template function list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--fit-width] [--print-empty] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--sort-column SORT_COLUMN] [--with_conditions] <template-version>
Table 45.22. Table Formatter
Value | Summary |
---|---|
--print-empty | Print empty table if there is no data to show. |
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable |
Table 45.23. Positional Arguments
Value | Summary |
---|---|
<template-version> | Template version to get the functions for |
Table 45.24. CSV Formatter
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
Table 45.25. Output Formatters
Value | Summary |
---|---|
output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
--sort-column SORT_COLUMN | Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated |
Table 45.26. JSON Formatter
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 45.27. Optional Arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
--with_conditions | Show condition functions for template. |
45.6. orchestration template validate
Validate a template
Usage:
openstack orchestration template validate [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--fit-width] [--print-empty] [--noindent] [--prefix PREFIX] [-e <environment>] [--show-nested] [--parameter <key=value>] [--ignore-errors <error1,error2,...>] -t <template>
Table 45.28. Table Formatter
Value | Summary |
---|---|
--print-empty | Print empty table if there is no data to show. |
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable |
Table 45.29. Output Formatters
Value | Summary |
---|---|
output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to yaml |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
Table 45.30. JSON Formatter
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 45.31. Optional Arguments
Value | Summary |
---|---|
--ignore-errors <error1,error2,…> | List of heat errors to ignore |
-e <environment>, --environment <environment> | Path to the environment. can be specified multiple times |
-t <template>, --template <template> | Path to the template |
--parameter <key=value> | Parameter values used to create the stack. this can be specified multiple times |
-h, --help | Show this help message and exit |
--show-nested | Resolve parameters from nested templates as well |
Table 45.32. Shell Formatter
Value | Summary |
---|---|
a format a UNIX shell can parse (variable="value")--prefix PREFIX | Add a prefix to all variable names |
45.7. orchestration template version list
List the available template versions.
Usage:
openstack orchestration template version list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--fit-width] [--print-empty] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--sort-column SORT_COLUMN]
Table 45.33. Table Formatter
Value | Summary |
---|---|
--print-empty | Print empty table if there is no data to show. |
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable |
Table 45.34. CSV Formatter
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
Table 45.35. Output Formatters
Value | Summary |
---|---|
output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
--sort-column SORT_COLUMN | Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated |
Table 45.36. JSON Formatter
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 45.37. Optional Arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |