oo jobs
Jobs submitted with oo jobs run or oo run.
Jobs submitted with oo jobs run or oo run. These commands call the /api/v1/jobs routes; oo api routes --path /api/v1/jobs shows their inputs and permissions.
oo jobs list
List jobs
oo jobs list [options]| Argument | Required | Default | Choices | Description |
|---|---|---|---|---|
--query NAME=VALUE | no |
It also takes the connection options.
oo jobs get
Show one by ID
oo jobs get [options] id| Argument | Required | Default | Choices | Description |
|---|---|---|---|---|
id | yes | ID from oo jobs list | ||
--output OUTPUT | no | write response to a protected file (required for a new credential) | ||
--overwrite | no |
It also takes the connection options.
oo jobs cancel
Request cancellation. Dispatched work may still finish; read the job for its actual outcome and acknowledgement.
oo jobs cancel id| Argument | Required | Default | Choices | Description |
|---|---|---|---|---|
id | yes | job ID from oo jobs list |
It also takes the connection options.
oo jobs wait
Follow a job until it succeeds or fails: exit 0 succeeded, 1 failed, 124 timed out while the job continues; run the same command again to keep waiting.
oo jobs wait [options] id| Argument | Required | Default | Choices | Description |
|---|---|---|---|---|
id | yes | job ID from oo run or oo jobs list | ||
--timeout TIMEOUT | no | 300.0 | ||
--interval INTERVAL | no | 2.0 |
It also takes the connection options.
oo jobs run
Run one action of a job family, such as backups snapshot, as a job: the generic way to queue any job. oo api route POST /api/v1/jobs lists the families, their actions and inputs. Each action is queued as one capability, which the job names and oo run also takes. Success means status succeeded, not accepted: without --wait this prints acceptance at submission; with --wait it follows the job: exit 0 succeeded, 1 failed, 124 timed out while the job continues. A risky action, as the action table marks it, asks first or takes --yes. Exit 3 means nothing ran: it sent nothing (confirmation_required), or it waits for an administrator's click (approval_required).
oo jobs run [options] family action [key=value ...]| Argument | Required | Default | Choices | Description |
|---|---|---|---|---|
family | yes | a job family, such as agents.lifecycle, backups or vm | ||
action | yes | one of the family's actions | ||
key=value | no | an input; a value is JSON if it parses, text otherwise | ||
--json @FILE|@- | no | the inputs as one JSON object, from @FILE or @- for stdin; key=value inputs add keys it doesn't have | ||
--wait | no | follow the job to its end: exit 0 succeeded, 1 failed, 124 timed out while it continues | ||
--timeout TIMEOUT | no | 300.0 | ||
--interval INTERVAL | no | 2.0 | ||
--yes | no | confirm it now; an agent passes it only once the person confirmed it in chat |
It also takes the connection options.