Update Jobs Policy Type

Use Update Jobs policies to deploy, modify, or remove job definitions on endpoints from a central place.


How it works (high level)

Agents process policies with PolicyType "JobUpdate". The policy’s Extension tells the agent which job file to add/update/delete under Jobs/{JobId}.json.

Step-by-step: Create an Update Jobs policy (via Advanced JSON)

1
2

Click Create Policy Button

This will spawn the Create Policy modal form.

3

Define Policy Attributes

Choose a aptly discriptive name for your new policy.

Choose any existing policy type available in the UI for your new policy(this is just a starting template since Update Settings is set in JSON).

Choose a status for your new policy. We recommend monitor mode when initially setting up a policy.

Add one or more Controls by clicking on the "Add Control" button and then selecting the controls that you would like to see applied to your new policy.

Choose a User Group, a Machine Collection, and an Application Collection.

4

Configure Policy Targeting

Configure any targeting you want in the UI (collections/users/machines/apps/platforms). Who or What does your policy apply to?

5

Open the Policy’s Advanced Mode (JSON view)

To open the Policy's Advanced Mode, click on the "Advanced Mode" link in the bottom left corner of the Policy Form.

6

Redefine Policy Type in JSON

7

Define Extension Fields

Set: Extension fields as described in the Required Etension Fields section of this document

8

Save the Policy

Required Extension Fields

  • Extension.JobId — job identifier; agent writes/deletes Jobs/{JobId}.json

  • Extension.Action"Add", "Update", or "Delete"

  • Extension.JobJson — required for Add/Update; omit for Delete

ID requirement: JobJson must include an internal id matching JobId.


Example JSON Snippets

Example 1: Add a Job (JobUpdate / Action=Add)

Notes

  • Extension.JobJson is a string containing the full job JSON.

  • Make sure the inner job JSON includes "id": "my-maintenance-job" matching JobId.


Example 2: Update an Existing Job (JobUpdate / Action=Update)

Notes

  • Updates typically replace the job file contents with whatever you provide in JobJson, so include all required fields for your job schema.


Example 3: Delete a Job (JobUpdate / Action=Delete)

Notes

  • For Delete, omit JobJson.

What you’ll typically edit in real use

  • PolicyId: keep the one generated by the UI.

  • Status: "on"/"off" depending on rollout.

  • UserCheck / MachineCheck: populate the arrays using your console’s normal targeting entries.

  • Extension.JobId: the filename key (ends up as Jobs/{JobId}.json on endpoints).

  • Extension.JobJson: stringified full job definition for Add/Update.

Validate on an endpoint

  • Add/Update: confirm Jobs/{JobId}.json exists and matches your provided job JSON.

  • Delete: confirm Jobs/{JobId}.json is removed.

Last updated

Was this helpful?