Update Settings Policy Type

Use Update Settings policies to centrally push configuration to endpoints (most commonly plugin configuration), without manually editing files on each machine.


What it’s for

  • Rolling out standardized plugin settings

  • Updating agent-side configuration consistently across a deployment

How it works (high level)

Agents run a configuration processor job (often named Process Configuration Policies) which finds policies with PolicyType "SettingsUpdate" and writes the provided JSON to the appropriate location.

Important behavior: for plugin files, the processor replaces the entire file with Extension.SettingsJson (not a merge).

Step-by-step: Create an Update Settings 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

Set: PolicyType to "SettingsUpdate"

7

Define Extension Fields

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

8

Save the Policy

Required JSON Fields

Set PolicyType and include an Extension object with either PluginName or TargetFile, plus SettingsJson.

  • Extension.PluginName = plugin name (targets that plugin’s JSON)

  • Extension.SettingsJson = full plugin JSON as a string

  • Extension.Action = Update or Add (as used in your implementation)

Option B (advanced): Update a file by path

  • Extension.TargetFile = file path (e.g., Plugins/KeeperPolicy.json)

  • Extension.SettingsJson = full file contents as a string

  • Extension.Action = Update or Add

Example JSON Snippet

Example (TargetFile)

Important: SettingsJson must contain the entire plugin JSON, because the processor replaces the whole file.

Validate on an endpoint

  1. Ensure the endpoint is in scope for targeting.

  2. Run/trigger the job that processes configuration policies.

  3. Confirm the target plugin JSON file (or target file) was updated.

Last updated

Was this helpful?