Chapter 32. event

This chapter describes the commands under the event command.

32.1. event trigger create

Create new trigger.

Usage:

openstack event trigger create [-h] [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--noindent]
                                      [--prefix PREFIX]
                                      [--max-width <integer>] [--fit-width]
                                      [--print-empty] [--params PARAMS]
                                      name workflow_id exchange topic event
                                      [workflow_input]

Table 32.1. Positional Arguments

ValueSummary

name

Event trigger name

workflow_id

Workflow id

exchange

Event trigger exchange

topic

Event trigger topic

event

Event trigger event name

workflow_input

Workflow input

Table 32.2. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--params PARAMS

Workflow params

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

Table 32.4. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 32.5. Shell Formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

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

32.2. event trigger delete

Delete trigger.

Usage:

openstack event trigger delete [-h]
                                      event_trigger_id [event_trigger_id ...]

Table 32.7. Positional Arguments

ValueSummary

event_trigger_id

Id of event trigger(s).

Table 32.8. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

32.3. event trigger list

List all event triggers.

Usage:

openstack event trigger 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]
                                    [--marker [MARKER]] [--limit [LIMIT]]
                                    [--sort_keys [SORT_KEYS]]
                                    [--sort_dirs [SORT_DIRS]]
                                    [--filter FILTERS]

Table 32.9. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--marker [MARKER]

The last execution uuid of the previous page, displays list of executions after "marker".

--limit [LIMIT]

Maximum number of entries to return in a single result.

--sort_keys [SORT_KEYS]

Comma-separated list of sort keys to sort results by. Default: created_at. Example: mistral execution-list --sort_keys=id,description

--sort_dirs [SORT_DIRS]

Comma-separated list of sort directions. default: asc. Example: mistral execution-list --sort_keys=id,description --sort_dirs=asc,desc

--filter FILTERS

Filters. can be repeated.

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

Table 32.11. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 32.12. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

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

32.4. event trigger show

Show specific event trigger.

Usage:

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

Table 32.14. Positional Arguments

ValueSummary

event_trigger

Event trigger id

Table 32.15. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

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

Table 32.17. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 32.18. Shell Formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

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