Chapter 66. software


This chapter describes the commands under the software command.

66.1. software config create

Usage:

openstack software config create [-h]

                                      [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--max-width <integer>]
                                      [--fit-width] [--print-empty]
                                      [--noindent] [--prefix PREFIX]
                                      [--config-file <config-file>]
                                      [--definition-file <destination-file>]
                                      [--group <group>]
                                      <config-name>
Copy to Clipboard Toggle word wrap

Create software config

Expand
Table 66.1. Positional Arguments
ValueSummary

<config-name>

Name of the software config to create

Expand
Table 66.2. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--config-file <config-file>

Path to JSON/YAML containing map defining <inputs>,

<outputs>, and <options>

 

--definition-file <destination-file>

Path to software config script/data

--group <group>

Group name of tool expected by the software config

Expand
Table 66.3. Output Formatters
ValueSummary

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

the output format, defaults to json

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

Expand
Table 66.4. Table Formatter
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.

Expand
Table 66.5. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 66.6. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

This command is provided by the python-heatclient plugin.

66.2. software config delete

Usage:

openstack software config delete [-h] <config> [<config> ...]
Copy to Clipboard Toggle word wrap

Delete software configs

Expand
Table 66.7. Positional Arguments
ValueSummary

<config>

Ids of the software configs to delete

Expand
Table 66.8. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

This command is provided by the python-heatclient plugin.

66.3. software config list

Usage:

openstack software config 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]
                                    [--limit <limit>] [--marker <id>]
Copy to Clipboard Toggle word wrap

List software configs

Expand
Table 66.9. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--limit <limit>

Limit the number of configs returned

--marker <id>

Return configs that appear after the given config id

Expand
Table 66.10. Output Formatters
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

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

Expand
Table 66.11. Table Formatter
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.

Expand
Table 66.12. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 66.13. CSV Formatter
ValueSummary

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

when to include quotes, defaults to nonnumeric

This command is provided by the python-heatclient plugin.

66.4. software config show

Usage:

openstack software config show [-h] [-f {json,shell,table,value,yaml}]

                                    [-c COLUMN] [--max-width <integer>]
                                    [--fit-width] [--print-empty]
                                    [--noindent] [--prefix PREFIX]
                                    [--config-only]
                                    <config>
Copy to Clipboard Toggle word wrap

Show software config details

Expand
Table 66.14. Positional Arguments
ValueSummary

<config>

Id of the config

Expand
Table 66.15. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--config-only

Only display the value of the <config> property.

Expand
Table 66.16. Output Formatters
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

Expand
Table 66.17. Table Formatter
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.

Expand
Table 66.18. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 66.19. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

This command is provided by the python-heatclient plugin.

66.5. software deployment create

Usage:

openstack software deployment create [-h]

                                          [-f {json,shell,table,value,yaml}]
                                          [-c COLUMN]
                                          [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          [--noindent] [--prefix PREFIX]
                                          [--input-value <key=value>]
                                          [--action <action>]
                                          [--config <config>]
                                          [--signal-transport <signal-transport>]
                                          [--container <container>]
                                          [--timeout <timeout>] --server
                                          <server>
                                          <deployment-name>
Copy to Clipboard Toggle word wrap

Create a software deployment.

Expand
Table 66.20. Positional Arguments
ValueSummary

<deployment-name>

Name of the derived config associated with this deployment. This is used to apply a sort order to the list of configurations currently deployed to the server.

Expand
Table 66.21. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--input-value <key=value>

Input value to set on the deployment. This can be specified multiple times.

--action <action>

Name of an action for this deployment. this can be a custom action, or one of CREATE, UPDATE, DELETE, SUSPEND, RESUME. Default is UPDATE

--config <config>

Id of the configuration to deploy

--signal-transport <signal-transport>

How the server should signal to heat with the deployment output values. TEMP_URL_SIGNAL will create a Swift TempURL to be signaled via HTTP PUT. ZAQAR_SIGNAL will create a dedicated zaqar queue to be signaled using the provided keystone credentials.NO_SIGNAL will result in the resource going to the COMPLETE state without waiting for any signal

--container <container>

Optional name of container to store TEMP_URL_SIGNAL objects in. If not specified a container will be created with a name derived from the DEPLOY_NAME

--timeout <timeout>

Deployment timeout in minutes

--server <server>

Id of the server being deployed to

Expand
Table 66.22. Output Formatters
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

Expand
Table 66.23. Table Formatter
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.

Expand
Table 66.24. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 66.25. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

This command is provided by the python-heatclient plugin.

66.6. software deployment delete

Usage:

openstack software deployment delete [-h]

                                          <deployment> [<deployment> ...]
Copy to Clipboard Toggle word wrap

Delete software deployment(s) and correlative config(s).

Expand
Table 66.26. Positional Arguments
ValueSummary

<deployment>

Id of the deployment(s) to delete.

Expand
Table 66.27. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

This command is provided by the python-heatclient plugin.

66.7. software deployment list

Usage:

openstack software deployment 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]
                                        [--server <server>] [--long]
Copy to Clipboard Toggle word wrap

List software deployments.

Expand
Table 66.28. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--server <server>

Id of the server to fetch deployments for

--long

List more fields in output

Expand
Table 66.29. Output Formatters
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

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

Expand
Table 66.30. Table Formatter
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.

Expand
Table 66.31. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 66.32. CSV Formatter
ValueSummary

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

when to include quotes, defaults to nonnumeric

This command is provided by the python-heatclient plugin.

66.8. software deployment metadata show

Usage:

openstack software deployment metadata show [-h] <server>
Copy to Clipboard Toggle word wrap

Get deployment configuration metadata for the specified server.

Expand
Table 66.33. Positional Arguments
ValueSummary

<server>

Id of the server to fetch deployments for

Expand
Table 66.34. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

This command is provided by the python-heatclient plugin.

66.9. software deployment output show

Usage:

openstack software deployment output show [-h] [--all] [--long]

                                               <deployment> [<output-name>]
Copy to Clipboard Toggle word wrap

Show a specific deployment output.

Expand
Table 66.35. Positional Arguments
ValueSummary

<deployment>

Id of deployment to show the output for

<output-name>

Name of an output to display

Expand
Table 66.36. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--all

Display all deployment outputs

--long

Show full deployment logs in output

This command is provided by the python-heatclient plugin.

66.10. software deployment show

Usage:

openstack software deployment show [-h]

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

Show SoftwareDeployment Details.

Expand
Table 66.37. Positional Arguments
ValueSummary

<deployment>

Id of the deployment

Expand
Table 66.38. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--long

Show more fields in output

Expand
Table 66.39. Output Formatters
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

Expand
Table 66.40. Table Formatter
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.

Expand
Table 66.41. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 66.42. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

This command is provided by the python-heatclient plugin.

Back to top
Red Hat logoGithubredditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust. Explore our recent updates.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

Theme

© 2025 Red Hat