CTL-QUEUE Command Reference
From ControlTier
Requires Version: 3.5.2
Contents |
Synopsis
ctl-queue <action> [-h] [-e/--eid ID]
Since CTL 3.5
Overview
The ctl-queue command is used to query the Central Dispatcher for a list of currently running Executions, or to Kill a currently running execution.
The tool provides two actions:
- list
- list the currently running executions on the server (default action)
- kill
- kill the execution specified by ID
Related Tools
- ctl-jobs lists the available Jobs and can download their definitions.
- ctl-run runs a Job stored on the server.
- ctl and ctl-exec can use the
-Qflag to submit "transient" executions to the Central Dispatcher
General Options
| Option | alternate | argument | description |
|---|---|---|---|
| -h | --help | false | Displays help and usage information |
List Action
This is the default action of the tool, so to list all running Executions, simply use:
ctl-queue
The output will display the number of executions, and their IDs and identifying names or descriptions, as well as a link to the CTL Center page to follow the output.
Example:
Venkman:~ greg$ ctl-queue Queue: 1 items [160] adhoc script job <http://Venkman.local:9090/ctlcenter/execution/follow/160>
Kill Action
This action allows you to specify the Execution ID of a currently running execution that you want to stop.
ctl-queue kill -e 12
Options:
| Option | alternate | argument | description |
|---|---|---|---|
| -e | --eid | true | ID of the execution |
Example:
Venkman:~ greg$ ctl-queue kill -e 160 ctl-queue kill: success. [160] Job status: killed
| ||||||||||||||
