Chapter 66. software

<config-name>

Name of the software config to create

-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

-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

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

--noindent

Whether to disable indenting the json

--prefix PREFIX

Add a prefix to all variable names

<config>

Ids of the software configs to delete

-h, --help

Show this help message and exit

-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

-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

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

--noindent

Whether to disable indenting the json

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

when to include quotes, defaults to nonnumeric

<config>

Id of the config

-h, --help

Show this help message and exit

--config-only

Only display the value of the <config> property.

-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

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

--noindent

Whether to disable indenting the json

--prefix PREFIX

Add a prefix to all variable names

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

-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

-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

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

--noindent

Whether to disable indenting the json

--prefix PREFIX

Add a prefix to all variable names

<deployment>

Id of the deployment(s) to delete.

-h, --help

Show this help message and exit

-h, --help

Show this help message and exit

--server <server>

Id of the server to fetch deployments for

--long

List more fields in output

-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

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

--noindent

Whether to disable indenting the json

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

when to include quotes, defaults to nonnumeric

<server>

Id of the server to fetch deployments for

-h, --help

Show this help message and exit

<deployment>

Id of deployment to show the output for

<output-name>

Name of an output to display

-h, --help

Show this help message and exit

--all

Display all deployment outputs

--long

Show full deployment logs in output

<deployment>

Id of the deployment

-h, --help

Show this help message and exit

--long

Show more fields in output

-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

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

--noindent

Whether to disable indenting the json

--prefix PREFIX

Add a prefix to all variable names