Chapter 56. orchestration
Chapter 56. orchestration This chapter describes the commands under the orchestration command. 56.1. orchestration build info Retrieve build information. Usage: Table 56.1. Optional Arguments Value Summary -h, --help Show this help message and exit Table 56.2. Output Formatters Value Summary -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 56.3. JSON Formatter Value Summary --noindent Whether to disable indenting the json Table 56.4. Shell Formatter Value Summary --prefix PREFIX Add a prefix to all variable names Table 56.5. Table Formatter Value Summary --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 --print-empty Print empty table if there is no data to show. 56.2. orchestration resource type list List resource types. Usage: Table 56.6. Optional Arguments Value Summary -h, --help Show this help message and exit --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 --long Show resource types with corresponding description of each resource type. Table 56.7. Output Formatters Value Summary -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 56.8. CSV Formatter Value Summary --quote {all,minimal,none,nonnumeric} When to include quotes, defaults to nonnumeric Table 56.9. JSON Formatter Value Summary --noindent Whether to disable indenting the json Table 56.10. Table Formatter Value Summary --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 --print-empty Print empty table if there is no data to show. 56.3. orchestration resource type show Show details and optionally generate a template for a resource type. Usage: Table 56.11. Positional Arguments Value Summary <resource-type> Resource type to show details for Table 56.12. 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 56.13. Output Formatters Value Summary -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 56.14. JSON Formatter Value Summary --noindent Whether to disable indenting the json Table 56.15. Shell Formatter Value Summary --prefix PREFIX Add a prefix to all variable names Table 56.16. Table Formatter Value Summary --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 --print-empty Print empty table if there is no data to show. 56.4. orchestration service list List the Heat engines. Usage: Table 56.17. Optional Arguments Value Summary -h, --help Show this help message and exit Table 56.18. Output Formatters Value Summary -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 56.19. CSV Formatter Value Summary --quote {all,minimal,none,nonnumeric} When to include quotes, defaults to nonnumeric Table 56.20. JSON Formatter Value Summary --noindent Whether to disable indenting the json Table 56.21. Table Formatter Value Summary --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 --print-empty Print empty table if there is no data to show. 56.5. orchestration template function list List the available functions. Usage: Table 56.22. Positional Arguments Value Summary <template-version> Template version to get the functions for Table 56.23. Optional Arguments Value Summary -h, --help Show this help message and exit --with_conditions Show condition functions for template. Table 56.24. Output Formatters Value Summary -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 56.25. CSV Formatter Value Summary --quote {all,minimal,none,nonnumeric} When to include quotes, defaults to nonnumeric Table 56.26. JSON Formatter Value Summary --noindent Whether to disable indenting the json Table 56.27. Table Formatter Value Summary --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 --print-empty Print empty table if there is no data to show. 56.6. orchestration template validate Validate a template Usage: Table 56.28. Optional Arguments Value Summary -h, --help Show this help message and exit -e <environment>, --environment <environment> Path to the environment. can be specified multiple times --show-nested Resolve parameters from nested templates as well --parameter <key=value> Parameter values used to create the stack. this can be specified multiple times --ignore-errors <error1,error2,... > List of heat errors to ignore -t <template>, --template <template> Path to the template Table 56.29. Output Formatters Value Summary -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 56.30. JSON Formatter Value Summary --noindent Whether to disable indenting the json Table 56.31. Shell Formatter Value Summary --prefix PREFIX Add a prefix to all variable names Table 56.32. Table Formatter Value Summary --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 --print-empty Print empty table if there is no data to show. 56.7. orchestration template version list List the available template versions. Usage: Table 56.33. Optional Arguments Value Summary -h, --help Show this help message and exit Table 56.34. Output Formatters Value Summary -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 56.35. CSV Formatter Value Summary --quote {all,minimal,none,nonnumeric} When to include quotes, defaults to nonnumeric Table 56.36. JSON Formatter Value Summary --noindent Whether to disable indenting the json Table 56.37. Table Formatter Value Summary --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 --print-empty Print empty table if there is no data to show.
openstack orchestration build info [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] openstack orchestration resource type 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] [--filter <key=value>] [--long] openstack orchestration resource type show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--template-type <template-type>] [--long] <resource-type> openstack orchestration service 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] openstack orchestration template function 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] [--with_conditions] <template-version> openstack orchestration template validate [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [-e <environment>] [--show-nested] [--parameter <key=value>] [--ignore-errors <error1,error2,...>] -t <template> openstack orchestration template version 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]