Red Hat Summit Red Hat SummitSuporteConsoleDesenvolvedoresComeçar um testeContato

Este conteúdo não está disponível no idioma selecionado.

Chapter 56. orchestration

This chapter describes the commands under the orchestration command.

56.1. orchestration build info
Copiar o link

Retrieve build information.

Usage:

openstack orchestration build info [-h]
                                          [-f {json,shell,table,value,yaml}]
                                          [-c COLUMN] [--noindent]
                                          [--prefix PREFIX]
                                          [--max-width <integer>]
                                          [--fit-width] [--print-empty]
Copy to Clipboard Toggle word wrap

Expand
Table 56.1. Command arguments
ValueSummary

-h, --help

Show this help message and exit

Expand
Table 56.2. Output formatter options
ValueSummary

-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 to show multiple columns

Expand
Table 56.3. JSON formatter options
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 56.4. Shell formatter options
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Expand
Table 56.5. Table formatter options
ValueSummary

--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
Copiar o link

List resource types.

Usage:

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]
                                                  [--sort-ascending | --sort-descending]
                                                  [--filter <key=value>]
                                                  [--long]
Copy to Clipboard Toggle word wrap

Expand
Table 56.6. Command arguments
ValueSummary

-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.

Expand
Table 56.7. Output formatter options
ValueSummary

-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 to show multiple columns

--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

--sort-ascending

Sort the column(s) in ascending order

--sort-descending

Sort the column(s) in descending order

Expand
Table 56.8. CSV formatter options
ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Expand
Table 56.9. JSON formatter options
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 56.10. Table formatter options
ValueSummary

--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
Copiar o link

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] [--noindent]
                                                  [--prefix PREFIX]
                                                  [--max-width <integer>]
                                                  [--fit-width]
                                                  [--print-empty]
                                                  [--template-type <template-type>]
                                                  [--long]
                                                  <resource-type>
Copy to Clipboard Toggle word wrap

Expand
Table 56.11. Positional arguments
ValueSummary

<resource-type>

Resource type to show details for

Expand
Table 56.12. Command arguments
ValueSummary

-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.

Expand
Table 56.13. Output formatter options
ValueSummary

-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 to show multiple columns

Expand
Table 56.14. JSON formatter options
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 56.15. Shell formatter options
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Expand
Table 56.16. Table formatter options
ValueSummary

--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
Copiar o link

List the Heat engines.

Usage:

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]
                                            [--sort-ascending | --sort-descending]
Copy to Clipboard Toggle word wrap

Expand
Table 56.17. Command arguments
ValueSummary

-h, --help

Show this help message and exit

Expand
Table 56.18. Output formatter options
ValueSummary

-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 to show multiple columns

--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

--sort-ascending

Sort the column(s) in ascending order

--sort-descending

Sort the column(s) in descending order

Expand
Table 56.19. CSV formatter options
ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Expand
Table 56.20. JSON formatter options
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 56.21. Table formatter options
ValueSummary

--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
Copiar o link

List the available functions.

Usage:

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]
                                                      [--sort-ascending | --sort-descending]
                                                      [--with_conditions]
                                                      <template-version>
Copy to Clipboard Toggle word wrap

Expand
Table 56.22. Positional arguments
ValueSummary

<template-version>

Template version to get the functions for

Expand
Table 56.23. Command arguments
ValueSummary

-h, --help

Show this help message and exit

--with_conditions

Show condition functions for template.

Expand
Table 56.24. Output formatter options
ValueSummary

-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 to show multiple columns

--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

--sort-ascending

Sort the column(s) in ascending order

--sort-descending

Sort the column(s) in descending order

Expand
Table 56.25. CSV formatter options
ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Expand
Table 56.26. JSON formatter options
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 56.27. Table formatter options
ValueSummary

--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
Copiar o link

Validate a template

Usage:

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>]
                                                 [-s <files-container>]
                                                 [--ignore-errors <error1,error2,...>]
                                                 -t <template>
Copy to Clipboard Toggle word wrap

Expand
Table 56.28. Command arguments
ValueSummary

-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

-s <files-container>, --files-container <files-container>

Swift files container name. local files other than root template would be ignored. If other files are not found in swift, heat engine would raise an error.

--ignore-errors <error1,error2,…​>

List of heat errors to ignore

-t <template>, --template <template>

Path to the template

Expand
Table 56.29. Output formatter options
ValueSummary

-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 to show multiple columns

Expand
Table 56.30. JSON formatter options
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 56.31. Shell formatter options
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Expand
Table 56.32. Table formatter options
ValueSummary

--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
Copiar o link

List the available template versions.

Usage:

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]
                                                     [--sort-ascending | --sort-descending]
Copy to Clipboard Toggle word wrap

Expand
Table 56.33. Command arguments
ValueSummary

-h, --help

Show this help message and exit

Expand
Table 56.34. Output formatter options
ValueSummary

-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 to show multiple columns

--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

--sort-ascending

Sort the column(s) in ascending order

--sort-descending

Sort the column(s) in descending order

Expand
Table 56.35. CSV formatter options
ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Expand
Table 56.36. JSON formatter options
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 56.37. Table formatter options
ValueSummary

--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.

Voltar ao topo
Red Hat logoGithubredditYoutubeTwitter

Aprender

Experimente, compre e venda

Comunidades

Sobre a documentação da Red Hat

Ajudamos os usuários da Red Hat a inovar e atingir seus objetivos com nossos produtos e serviços com conteúdo em que podem confiar. Explore nossas atualizações recentes.

Tornando o open source mais inclusivo

A Red Hat está comprometida em substituir a linguagem problemática em nosso código, documentação e propriedades da web. Para mais detalhes veja o Blog da Red Hat.

Sobre a Red Hat

Fornecemos soluções robustas que facilitam o trabalho das empresas em plataformas e ambientes, desde o data center principal até a borda da rede.

Theme

© 2025 Red Hat