Skip to main content

Scheduling and Configuration Preferences

These preferences are used to customize the scheduling of updates and other advanced configuration options.

Domain: com.alectrona.patch-agent

SettingDescription
InstallOrUpdate

The software titles to automatically install or update (even if they are not currently installed) using the Patch Agent.

<key>InstallOrUpdate</key>
<array>
  <string>1password</string>
  <string>slack</string>
</array>
UpdateOnly

The software titles to automatically update if installed and out-of-date using the Patch Agent.

<key>UpdateOnly</key>
<array>
  <string>google-chrome</string>
  <string>docker-desktop</string>
</array>
OtherManagedSoftware

The software titles to enable the Active Intervals feature for even when not included in the InstallOrUpdate or UpdateOnly preference keys. These software titles might be updated using the patch command line tool in scripted workflows external to the Patch Agent.

<key>OtherManagedSoftware</key>
<array>
  <string>zoom-us</string>
  <string>vmware-fusion-13</string>
</array>
UpdateAll

Set to true to configure the automatic update every app in the Patch Catalog that is installed and out-of-date.

info

This will ignore apps specified in the UpdateOnly key.

<key>UpdateAll</key>
<true/>
UpdateAllExclusions

The software titles to exclude from being updated with the Update All feature.

<key>UpdateAllExclusions</key>
<array>
  <string>mozilla-firefox-esr</string>
  <string>nodejs-lts</string>
</array>
RunInterval

The Patch Agent runs every 4 hours by default. You can adjust this interval time for your environment.

info

This key is configured in seconds. The minimum setting is 600 seconds (10 minutes) and there is currently no maximum.

<key>RunInterval</key>
<integer>600</integer>
SkipFirstPatchAgentRun

When Alectrona Patch runs for the first time, it performs what is called a "Patch Agent Run" where it runs all configured installs/updates. You can skip the first Patch Agent Run by setting this key to true.

<key>SkipFirstPatchAgentRun</key>
<true/>
RunOnConstrainedNetworks

Set to false to pause automatic updates when connected to expensive networks like cellular, personal hotspots, or network interfaces in Low Data Mode.

<key>RunOnConstrainedNetworks</key>
<false/>
ActiveIntervals

The Patch Agent will attempt to silently update any recently deferred app that exists in the InstallOrUpdate or UpdateOnly keys immediately after that app has been terminated by the user (even during an interval period). You can disable this behavior by setting to false.

<key>ActiveIntervals</key>
<false/>
RemovePatchSymlink

Set to true to remove the symlink located at /usr/local/bin/patch. This will remove patch from the user's $PATH and allows for accessing the built-in BSD patch command without using its full path.

Don't Forget

When setting this key to true you will need to access the Patch CLT at its full path in Terminal or custom scripts.

<key>RemovePatchSymlink</key>
<true/>
ReconAfterInstall

Set to true to perform a Jamf Pro inventory update after a software title is installed or updated using the Patch Agent.

<key>ReconAfterInstall</key>
<true/>
DeferIfRunning

If an app is running when an update occurs, setting this key to true will suppress the Classic Update Dialog and automatically perform a deferral.

<key>DeferIfRunning</key>
<true/>
RespectDND

Set to true to suppress Classic Update Dialogs for users that have Do Not Disturb (DND) enabled.

<key>RespectDND</key>
<true/>
RespectMeetings

Set to true to suppress Classic Update Dialogs for users that are likely in a Zoom, Webex Meetings, or Microsoft Teams meeting.

<key>RespectMeetings</key>
<true/>
UpdateMAS

Set to true to attempt to update and convert Mac App Store (MAS) apps to their non-MAS counterpart.

info

This feature only applies to apps you have configured Alectrona Patch to manage updates for using either the InstallOrUpdate or UpdateOnly keys. Additionally, it only affects Mac App Store apps that have a supported non-Mac App Store counterpart (there are relatively few of these).

<key>UpdateMAS</key>
<true/>
Make It Easy

All of these preferences can be effortlessly configured with our Patch Desktop app.

Last updated on