Skip to main content
Version: 3.5.1

job add Command

The job add command adds a job to the task handler.

Usage​

job add [--id <id>] [--schedule <cron_expression>] [--wait-for-event <event_name>] [--timeout <seconds>] <command>

Parameters​

ParameterDescriptionRequired?Default Value
commandCLI command that will be executed when the job is triggered *✔️

* It is recommended to either surround the command with single quotes (') or escape special characters such as pipes (|) or semicolons (;). Multiple commands can be delimited using semicolons.

Options​

OptionDescriptionRequired?
--id <id>Job identifier (if not provided, a random identifier is generated)❌
--schedule <cron_expression>The schedule as a cron expression➖
--wait-for-event <event_name>Waits for the specified event to occur (if defined in conjunction with the --schedule option, the schedule must trigger first)➖
--timeout <seconds>Number of seconds for which the job is allowed to run before being terminated (3600 seconds by default)❌

Examples​

Print 'hello world' to the console every minute
> jobs add --id say-hello --schedule "* * * * *" echo hello world
​Job say-hello added.
At 4am each morning, wait for message of type collect_done and print a message
> jobs add --id early_hi --schedule "0 4 * * *" --wait-for-event collect_done 'match is("volume") | format id'
​Job early_hi added.
Wait for message of type collect_done and print a message
> jobs add --id wait_for_collect_done collect_done: echo hello world
​Job wait_for_collect_done added.

Further Reading​

Contact Us

 

 

 

Some Engineering Inc.