SupportConsoleDevelopersStart a trialContact

Chapter 76. software

This chapter describes the commands under the software command.

76.1. software config create

Create software config

Usage:

openstack software config create [-h]
                                        [-f {json,shell,table,value,yaml}]
                                        [-c COLUMN] [--noindent]
                                        [--prefix PREFIX]
                                        [--max-width <integer>] [--fit-width]
                                        [--print-empty]
                                        [--config-file <config-file>]
                                        [--definition-file <destination-file>]
                                        [--group <group>]
                                        <config-name>

Table 76.1. Positional arguments
ValueSummary

<config-name>

Name of the software config to create

Table 76.2. Command 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

Table 76.3. Output formatter options
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 to show multiple columns

Table 76.4. JSON formatter options
ValueSummary

--noindent

Whether to disable indenting the json

Table 76.5. Shell formatter options
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

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

76.2. software config delete

Delete software configs

Usage:

openstack software config delete [-h] <config> [<config> ...]

Table 76.7. Positional arguments
ValueSummary

<config>

Ids of the software configs to delete

Table 76.8. Command arguments
ValueSummary

-h, --help

Show this help message and exit

76.3. software config list

List software configs

Usage:

openstack software config 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]
                                      [--limit <limit>] [--marker <id>]

Table 76.9. Command 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

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

Table 76.11. CSV formatter options
ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 76.12. JSON formatter options
ValueSummary

--noindent

Whether to disable indenting the json

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

76.4. software config show

Show software config details

Usage:

openstack software config show [-h] [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--noindent]
                                      [--prefix PREFIX]
                                      [--max-width <integer>] [--fit-width]
                                      [--print-empty] [--config-only]
                                      <config>

Table 76.14. Positional arguments
ValueSummary

<config>

Id of the config

Table 76.15. Command arguments
ValueSummary

-h, --help

Show this help message and exit

--config-only

Only display the value of the <config> property.

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

Table 76.17. JSON formatter options
ValueSummary

--noindent

Whether to disable indenting the json

Table 76.18. Shell formatter options
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

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

76.5. software deployment create

Create a software deployment.

Usage:

openstack software deployment create [-h]
                                            [-f {json,shell,table,value,yaml}]
                                            [-c COLUMN] [--noindent]
                                            [--prefix PREFIX]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            [--input-value <key=value>]
                                            [--action <action>]
                                            [--config <config>]
                                            [--signal-transport <signal-transport>]
                                            [--container <container>]
                                            [--timeout <timeout>] --server
                                            <server>
                                            <deployment-name>

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

Table 76.21. Command 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

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

Table 76.23. JSON formatter options
ValueSummary

--noindent

Whether to disable indenting the json

Table 76.24. Shell formatter options
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

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

76.6. software deployment delete

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

Usage:

openstack software deployment delete [-h]
                                            <deployment> [<deployment> ...]

Table 76.26. Positional arguments
ValueSummary

<deployment>

Id of the deployment(s) to delete.

Table 76.27. Command arguments
ValueSummary

-h, --help

Show this help message and exit

76.7. software deployment list

List software deployments.

Usage:

openstack software deployment 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]
                                          [--server <server>] [--long]

Table 76.28. Command 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

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

Table 76.30. CSV formatter options
ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 76.31. JSON formatter options
ValueSummary

--noindent

Whether to disable indenting the json

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

76.8. software deployment metadata show

Get deployment configuration metadata for the specified server.

Usage:

openstack software deployment metadata show [-h] <server>

Table 76.33. Positional arguments
ValueSummary

<server>

Id of the server to fetch deployments for

Table 76.34. Command arguments
ValueSummary

-h, --help

Show this help message and exit

76.9. software deployment output show

Show a specific deployment output.

Usage:

openstack software deployment output show [-h] [--all] [--long]
                                                 <deployment> [<output-name>]

Table 76.35. Positional arguments
ValueSummary

<deployment>

Id of deployment to show the output for

<output-name>

Name of an output to display

Table 76.36. Command arguments
ValueSummary

-h, --help

Show this help message and exit

--all

Display all deployment outputs

--long

Show full deployment logs in output

76.10. software deployment show

Show SoftwareDeployment Details.

Usage:

openstack software deployment show [-h]
                                          [-f {json,shell,table,value,yaml}]
                                          [-c COLUMN] [--noindent]
                                          [--prefix PREFIX]
                                          [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          [--long]
                                          <deployment>

Table 76.37. Positional arguments
ValueSummary

<deployment>

Id of the deployment

Table 76.38. Command arguments
ValueSummary

-h, --help

Show this help message and exit

--long

Show more fields in output

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

Table 76.40. JSON formatter options
ValueSummary

--noindent

Whether to disable indenting the json

Table 76.41. Shell formatter options
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

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

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.

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.

© 2024 Red Hat, Inc.