job
cmr/upgrade/job
Package: cmr
Type: Directory
One upgrade job is one upgrade run. Jobs are created from upgrade rules, and their parameters are copied from the rule at creation and are read-only. A scheduled job resolves its device list only when it starts, so show-devices for a scheduled job can be empty. Remove a queued or processing job to cancel it. The job state becomes cancelled.
| Flag | Name | Description |
|---|---|---|
| X | disabled | Job is disabled. |
| R | rule | Job created from an upgrade rule. |
| Read-only Argument | Type | Description |
|---|---|---|
| labels ( unset ) | object | Devices the job covers, selected by labels. |
| order | object | Execution order of the label groups, used with continue-order. |
| channel | alt | Upgrade channel or the pinned version the job installs. |
| strategy ( unset ) | enum () | How the job upgrades devices: parallel all at the same time, sequential one after another. With continue-order the devices are processed per label group in the order given by order. |
| fail-policy ( unset ) | enum () | Behaviour of the job if a device fails: continue, stop, or continue-order. stop halts the whole job on the first failure; continue-order continues with the next label group in order. |
| schedule-time ( unset ) | date | When the job is scheduled to run, in the same format as the rule's schedule-time. |
| starts-in ( unset ) | time | Time remaining until the job starts. Shown for scheduled jobs. |
| start-time ( unset ) | date | When the job started running. |
| end-time ( unset ) | date | When the job finished. |
| state | enum (scheduled | queued | waiting devices | queued (busy) | version check | processing | done | cancelled) | Current job state: scheduled (waiting to run), queued (created while another job runs, starts when it finishes), waiting devices, version check (looking up the available version), processing (upgrading), done (finished), or cancelled (removed). |
| success ( unset ) | composite { success: num , total: num } | Upgraded/total, for example 3/10. A 0/total occurs when the devices are already on the target version or a covered device is unreachable when the job starts. |
| run-time ( unset ) | time | How long the job took to run. |
| packages ( unset ) | multi { package: string } | Packages the job upgrades. |