Menu Close

Chapter 61. software

This chapter describes the commands under the software command.

61.1. software config create

Create software config

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>

Table 61.1. Table Formatter

ValueSummary

--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 61.2. Positional Arguments

ValueSummary

<config-name>

Name of the software config to create

Table 61.3. Output Formatters

ValueSummary

output formatter options-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

Table 61.4. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 61.5. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--group <group>

Group name of tool expected by the software config

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

Table 61.6. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

61.2. software config delete

Delete software configs

Usage:

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

Table 61.7. Positional Arguments

ValueSummary

<config>

Ids of the software configs to delete

Table 61.8. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

61.3. software config list

List software configs

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

Table 61.9. Table Formatter

ValueSummary

--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 61.10. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 61.11. Output Formatters

ValueSummary

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 61.12. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 61.13. Optional Arguments

ValueSummary

--limit <limit>

Limit the number of configs returned

-h, --help

Show this help message and exit

--marker <id>

Return configs that appear after the given config id

61.4. software config show

Show software config details

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>

Table 61.14. Table Formatter

ValueSummary

--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 61.15. Positional Arguments

ValueSummary

<config>

Id of the config

Table 61.16. Output Formatters

ValueSummary

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 61.17. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 61.18. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--config-only

Only display the value of the <config> property.

Table 61.19. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

61.5. software deployment create

Create a software deployment.

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>

Table 61.20. Table Formatter

ValueSummary

--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 61.21. 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 61.22. Output Formatters

ValueSummary

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 61.23. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 61.24. Optional Arguments

ValueSummary

--timeout <timeout>

Deployment timeout in minutes

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

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

-h, --help

Show this help message and exit

--server <server>

Id of the server being deployed to

--input-value <key=value>

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

--config <config>

Id of the configuration to deploy

Table 61.25. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

61.6. software deployment delete

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

Usage:

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

Table 61.26. Positional Arguments

ValueSummary

<deployment>

Id of the deployment(s) to delete.

Table 61.27. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

61.7. software deployment list

List software deployments.

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]

Table 61.28. Table Formatter

ValueSummary

--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 61.29. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 61.30. Output Formatters

ValueSummary

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 61.31. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

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

61.8. software deployment metadata show

Get deployment configuration metadata for the specified server.

Usage:

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

Table 61.33. Positional Arguments

ValueSummary

<server>

Id of the server to fetch deployments for

Table 61.34. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

61.9. software deployment output show

Show a specific deployment output.

Usage:

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

Table 61.35. Positional Arguments

ValueSummary

<deployment>

Id of deployment to show the output for

<output-name>

Name of an output to display

Table 61.36. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--all

Display all deployment outputs

--long

Show full deployment logs in output

61.10. software deployment show

Show SoftwareDeployment Details.

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>

Table 61.37. Table Formatter

ValueSummary

--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 61.38. Positional Arguments

ValueSummary

<deployment>

Id of the deployment

Table 61.39. Output Formatters

ValueSummary

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 61.40. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 61.41. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--long

Show more fields in output

Table 61.42. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names