A preflight script for setting a time window in which Munki will run.
Munki Time Window consists of a preflight script and a file containing preferences to set the time window.
Munki Time Window will look for preferences in the following order and locations:
- MCX/Configuration Profiles
- /Library/Preferences/ManagedInstalls.plist (or another plist that you specify)
Minimum Munki version: With the switch to /usr/local/munki/munki-python (due to the removal of Python 2.7 in macOS 12.3), the minimum supported version of Munki is 5.1.1.
MunkiTimeWindow.py can be set as a preflight script for either Munki (placed in /usr/local/munki/ and renamed to preflight) or for munkireport-php (placed in /usr/local/munki/preflight_abort.d).
Note that munkireport-php will overwrite the Munki preflight script upon install so if you intend to use munkireport-php, it's recommended to install munkireport-php before installing Munki Time Window.
Munki Time Window has three preference keys:
| Key | Type | Default | Description |
|---|---|---|---|
| TimeWindowAllowManual | boolean | true | If true, users will be able to run Munki manually outside the set time window (both MSC and from Terminal) |
| TimeWindowStart | string | 1:00AM | Time at which Munki Time Window will begin allowing Munki to run |
| TimeWindowEnd | string | 5:00AM | Time at which Munki Time Window will begin preventing Munki from running |
Tim Sutton has written a handy, command-line utility (mcxToProfile) to create "Custom Settings" Configuration Profiles.
A sample command, feeding it a .plist that contains the time window preferences:
./mcxToProfile.py --plist /path/to/org.example.my.MunkiTimeWindow.plist --identifier MunkiTimeWindow --manage Always --organization "My Awesome Company"
Note that the name of the .plist corresponds to the variable BUNDLE_ID in MunkiTimeWindow.py. So for the example above, BUNDLE_ID should be set to 'org.example.my.MunkiTimeWindow'.
See org.example.my.MunkiTimeWindow.plist for a sample plist to use with mcxToProfile and MunkiTimeWindow.mobileconfig for an example of the resulting mobileconfig file.
If you're setting Munki Time Window preferences using a plist, the default plist is the Munki preferences file (/Library/Preferences/ManagedInstalls.plist). The preference keys should use the following format:
<key>TimeWindowAllowManual</key>
<true/>
<key>TimeWindowStart</key>
<string>10:30PM</string>
<key>TimeWindowEnd</key>
<string>7:00AM</string>
Another plist file can be used in place of ManagedInstalls.plist by modifying the variable munki_prefs_location in MunkiTimeWindow.py to point to the location of the other plist.
If you have additional questions, or need even more help getting started, post a question to munkitimewindow. Please don't post support questions as comments on wiki documentation pages, or as GitHub code issues.