Skip to Content
Referenceoo CLI

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]
ArgumentRequiredDefaultChoicesDescription
--query NAME=VALUEno

It also takes the connection options.

oo jobs get

Show one by ID

oo jobs get [options] id
ArgumentRequiredDefaultChoicesDescription
idyesID from oo jobs list
--output OUTPUTnowrite response to a protected file (required for a new credential)
--overwriteno

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
ArgumentRequiredDefaultChoicesDescription
idyesjob 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
ArgumentRequiredDefaultChoicesDescription
idyesjob ID from oo run or oo jobs list
--timeout TIMEOUTno300.0
--interval INTERVALno2.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 ...]
ArgumentRequiredDefaultChoicesDescription
familyyesa job family, such as agents.lifecycle, backups or vm
actionyesone of the family's actions
key=valuenoan input; a value is JSON if it parses, text otherwise
--json @FILE|@-nothe inputs as one JSON object, from @FILE or @- for stdin; key=value inputs add keys it doesn't have
--waitnofollow the job to its end: exit 0 succeeded, 1 failed, 124 timed out while it continues
--timeout TIMEOUTno300.0
--interval INTERVALno2.0
--yesnoconfirm it now; an agent passes it only once the person confirmed it in chat

It also takes the connection options.

On this page