Chapter 69. software This chapter describes the commands under the software command. 69.1. software config create Create software config Usage: Table 69.1. Positional arguments Value Summary <config-name> Name of the software config to create Table 69.2. Command arguments Value Summary -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 69.3. Output formatter options Value Summary -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 69.4. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 69.5. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 69.6. Table formatter options 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. 69.2. software config delete Delete software configs Usage: Table 69.7. Positional arguments Value Summary <config> Ids of the software configs to delete Table 69.8. Command arguments Value Summary -h, --help Show this help message and exit 69.3. software config list List software configs Usage: Table 69.9. Command arguments Value Summary -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 69.10. Output formatter options 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 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 69.11. CSV formatter options Value Summary --quote {all,minimal,none,nonnumeric} When to include quotes, defaults to nonnumeric Table 69.12. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 69.13. Table formatter options 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. 69.4. software config show Show software config details Usage: Table 69.14. Positional arguments Value Summary <config> Id of the config Table 69.15. Command arguments Value Summary -h, --help Show this help message and exit --config-only Only display the value of the <config> property. Table 69.16. Output formatter options 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 to show multiple columns Table 69.17. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 69.18. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 69.19. Table formatter options 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. 69.5. software deployment create Create a software deployment. Usage: Table 69.20. Positional arguments Value Summary <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 69.21. Command arguments Value Summary -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 69.22. Output formatter options 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 to show multiple columns Table 69.23. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 69.24. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 69.25. Table formatter options 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. 69.6. software deployment delete Delete software deployment(s) and correlative config(s). Usage: Table 69.26. Positional arguments Value Summary <deployment> Id of the deployment(s) to delete. Table 69.27. Command arguments Value Summary -h, --help Show this help message and exit 69.7. software deployment list List software deployments. Usage: Table 69.28. Command arguments Value Summary -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 69.29. Output formatter options 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 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 69.30. CSV formatter options Value Summary --quote {all,minimal,none,nonnumeric} When to include quotes, defaults to nonnumeric Table 69.31. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 69.32. Table formatter options 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. 69.8. software deployment metadata show Get deployment configuration metadata for the specified server. Usage: Table 69.33. Positional arguments Value Summary <server> Id of the server to fetch deployments for Table 69.34. Command arguments Value Summary -h, --help Show this help message and exit 69.9. software deployment output show Show a specific deployment output. Usage: Table 69.35. Positional arguments Value Summary <deployment> Id of deployment to show the output for <output-name> Name of an output to display Table 69.36. Command arguments Value Summary -h, --help Show this help message and exit --all Display all deployment outputs --long Show full deployment logs in output 69.10. software deployment show Show SoftwareDeployment Details. Usage: Table 69.37. Positional arguments Value Summary <deployment> Id of the deployment Table 69.38. Command arguments Value Summary -h, --help Show this help message and exit --long Show more fields in output Table 69.39. Output formatter options 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 to show multiple columns Table 69.40. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 69.41. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 69.42. Table formatter options 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.

Commands:
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>
openstack software config delete [-h] <config> [<config> ...]
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>]
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>
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>
openstack software deployment delete [-h] <deployment> [<deployment> ...]
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]
openstack software deployment metadata show [-h] <server>
openstack software deployment output show [-h] [--all] [--long] <deployment> [<output-name>]
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>