Chapter 26. cron

This chapter describes the commands under the cron command.

26.1. cron trigger create

Create new trigger.

Usage:

openstack cron trigger create [-h] [-f {json,shell,table,value,yaml}]
                                     [-c COLUMN] [--noindent]
                                     [--prefix PREFIX] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--params PARAMS] [--pattern <* * * * *>]
                                     [--first-time <YYYY-MM-DD HH:MM>]
                                     [--count <integer>] [--utc]
                                     name workflow_identifier [workflow_input]

Table 26.1. Positional Arguments

ValueSummary

name

Cron trigger name

workflow_identifier

Workflow name or id

workflow_input

Workflow input

Table 26.2. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--params PARAMS

Workflow params

--pattern <* * * * *>

Cron trigger pattern

--first-time <YYYY-MM-DD HH:MM>

Date and time of the first execution. time is treated as local time unless --utc is also specified

--count <integer>

Number of wanted executions

--utc

All times specified should be treated as utc

Table 26.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 26.4. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 26.5. Shell Formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

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

26.2. cron trigger delete

Delete trigger.

Usage:

openstack cron trigger delete [-h] cron_trigger [cron_trigger ...]

Table 26.7. Positional Arguments

ValueSummary

cron_trigger

Name of cron trigger(s).

Table 26.8. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

26.3. cron trigger list

List all cron triggers.

Usage:

openstack cron 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 26.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 26.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 26.11. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 26.12. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

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

26.4. cron trigger show

Show specific cron trigger.

Usage:

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

Table 26.14. Positional Arguments

ValueSummary

cron_trigger

Cron trigger name

Table 26.15. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 26.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 26.17. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 26.18. Shell Formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

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