PayloadKit

S.U.P.E.R.M.A.N

com.macjutsu.super

Use this section to define settings for S.U.P.E.R.M.A.N (super)

macOS
macOS 11.0+

Configuration Keys (77)

Showing 77 of 77 keys

KeyTypeDescriptionDefaultRange
string—Default: —Range: —

Auth Ask User To Save Password

booleanPrompt the end user to save their password which can then be used to authenticate the local softwareupdate commandDefault: falseRange: —

Auth Credential Failover To User

booleanIf any managed automatic authentication method fails validation, then failover to local end user authenticationDefault: trueRange: —

Auth Jamf Computer ID

stringUse this when using super with Jamf Pro API accountDefault: —Range: —

Jamf Custom URL Override

stringAllows you to override the default Jamf Pro management URL for a custom Jamf Pro API URLDefault: —Range: —

User Authentication MDM Failover

stringThe MDM workflow can be unreliable due to its complexity, and super will automatically try again upon failure, however this settings allows super to try other optionsDefault: —Range: —

Focus Count Deadline

stringThe maximum number of automatic deferrals allowed if the system is in user-enabled Focus/Do Not Disturb or when a process has requested that the display not go to sleepDefault: —Range: —

Hard Count Deadline

stringThe maximum number of user selected deferrals allowed before the computer automatically restarts for updates without asking the user for approvalDefault: —Range: —

Soft Count Deadline

stringThe maximum number of user selected deferrals allowed before showing a soft deadline dialogDefault: —Range: —

Focus Date Deadline

stringThis is the last date and time when automatic deferrals are allowed if the system is in user-enabled Focus/Do Not Disturb or when a process has requested that the display not go to sleep (for example, during an active meeting)Default: —Range: —

Hard Date Deadline

stringIf this date has passed, the computer restarts and udpates without asking the user for approvalDefault: —Range: —

Soft Date Deadline

stringIf this date and time have passed, an interactive update restart dialog appears indicating that no more user deferrals are allowedDefault: —Range: —

Focus Days Deadline

stringThe maximum number of days that automatic deferrals are allowed if the system is in user-enabled Focus/Do Not Disturb or when a process has requested that the display not go to sleep (for example, during an active meeting).Default: —Range: —

Hard Days Deadline

stringThe maximum number of days allowed before the computer automatically restarts for updates without asking the user for approvalDefault: —Range: —

Soft Days Deadline

stringThe maximum number of days allowed before the soft deadline dialog. The soft deadline is an interactive update restart dialog indicating that no more deferrals are allowedDefault: —Range: —

Dialog Timeout Restart Or Defer

stringSets an automatic timeout for the restart or defer dialog in secondsDefault: —Range: —

Workflow Jamf Policy Triggers

stringMake the super workflow run one or more Jamf Pro Policy Triggers that are comma separated with no spacesDefault: —Range: —

Display Accessory User Auth File

stringSpecifies a local path or web URL to a file with the content to be shown in dialogs only when showing the Apple silicon user authentication dialogDefault: —Range: —

Display Accessory Update File

stringSpecifies a local path or web URL to a file with the content to be shown in dialogs only when performing macOS updatesDefault: —Range: —

Display Accessory Upgrade File

stringSpecifies a local path or web URL to a file with the content to be shown in dialogs only when performing macOS upgradesDefault: —Range: —

Workflow Zero Date Manual

stringInstead of having super automatically select the beginning date and time of the super workflow (aka. day zero), this option sets a specific date and time as day zeroDefault: —Range: —

Focus Defer Timer

stringThe number of minutes to defer the update restart dialog automatically if a process has prevented display sleep (for example, during an active meeting) or the user has Focus or Do Not Disturb enabledDefault: —Range: —

Default Dialog Timeout

stringSets the default timeout for any dialog that doesn't have a specific timeout settingDefault: —Range: —

Free Space Timeout

stringTimeout for computers with not enough free spaceDefault: —Range: —

Battery Timeout

stringTimeout for computers where power is requiredDefault: —Range: —

Soft Display Timeout

stringSets an automatic timeout for interactive update restart dialogs in secondsDefault: —Range: —

User Authentication Timeout

stringOn Mac computers with Apple Silicon, the number of seconds to wait for the user to successfully authenticate when presented with the user authenticated dialogDefault: —Range: —

User Choice Dialog Timeout

stringSets an automatic timeout for the user choice (restart/install or defer) dialog in secondsDefault: —Range: —

User Scheduled Install User Choice Dialog Timeout

stringSets an automatic timeout for the scheduled install user choice dialog in secondsDefault: —Range: —

Default Accessory File

stringLocal path or http(s) URL to a file that is the default accessoryDefault: —Range: —

Jamf Policy Accessory File

stringLocal path or http(s) URL to a file that is the accessory to display when the InstallJamfPolicyTriggers payload option is also enabled and the workflow target is only Jamf Pro Policy TriggersDefault: —Range: —

Major Upgrades Accessory File

stringLocal path or http(s) URL to a file that is the accessory to display when performing macOS upgradesDefault: —Range: —

Minor Updates Updates Accessory File

stringLocal path or http(s) URL to a file that is the accessory to display when performing macOS updatesDefault: —Range: —

Non-System Updates Accessory File

stringLocal path or http(s) URL to a file that is the accessory to display when the InstallNonSystemUpdatesWithoutRestarting payload option is also enabled and the workflow target is only non-system updatesDefault: —Range: —

Restart Without Updates Accessory File

stringLocal path or http(s) URL to a file that is the accessory to display when the WorkflowRestartWithoutUpdates payload option is also enabled and the workflow target is only a forced restart without any updatesDefault: —Range: —

Custom Display Accessory

stringInteractive dialogs (but not notifications) generated by IBM Notifier can be easily customized via several display accessory optionsDefault: —Range: Textbox (TEXTBOX), HTML (White Bounding Box) (HTMLBOX), HTML (Blank Background) (HTML), Image (IMAGE), Video (VIDEO), Video (Auto-Play) (VIDEOAUTO)

Help Button

stringPlain text to display or http(s) URL link to follow for the Help ButtonDefault: —Range: —

Display Hide Progress Bar

stringThis option hides the animated progress bar (as opposed showing it) for notifications and alertsDefault: —Range: —

Dark Display Icon

stringLocal path or http(s) URL to a file that is the picture to display in notifications or dialogs when in dark mode. Failover to DisplayIconFile payload if configuredDefault: —Range: —

Light Display Icon

stringLocal path or http(s) URL to a file that is the picture to display in notifications or dialogs when in light mode. Failover to DisplayIconFile payload if configuredDefault: —Range: —

Display Icon

stringLocal path or http(s) URL to a file that is the picture to display in notifications or dialogsDefault: —Range: —

Display Icon Size

stringNumber of pixels for the DisplayIcon in IBM Notifier dialogsDefault: —Range: —

Install Jamf Policy Triggers

stringIf a restart is required for system updates or forced via RestartWithoutUpdates, this list of Jamf Policy Triggers runs before any available updates install and the computer restartsDefault: —Range: —

Install Jamf Policies Without A Restart

booleanAllows for installation of Jamf Pro Policies even if there are no available macOS updates/upgradesDefault: falseRange: —

Apple Zero Day Workflow Date

booleanLeverages the public MacAdmin's SOFA macOS machine readable JSON feed to discover release dates for use in workflows with deadline day optionsDefault: trueRange: —

Scheduled Install User Choice

booleanAdds a Schedule button to the standard deferral dialogDefault: trueRange: —
TestModeboolean

Test Mode

booleanMode to validate parameters, credentials, notifications, dialogs, deferrals, and deadline logicDefault: trueRange: —

Start Workflow Immediately

booleanKicks off the super workflow immediately, prompting user that an update has begunDefault: falseRange: —

Schedule Workflow Active

stringAllows you to define multiple weekday time frames that specify when the super workflow is allowed to be active (aka maintenance windows)Default: —Range: —

Test Battery Level

stringMinmum Battery PercentageDefault: —Range: —

Test Mode Timeout

stringThe amount of time in seconds to leave test notifications and dialogs open before moving on in the workflowDefault: —Range: —

Free Space Update

stringFree space required for updatesDefault: —Range: —

Test Free Space Upgrade

stringFree space required for upgradesDefault: —Range: —

Manual Zero Day Workflow Date

stringInstead of having the days deadline counter, automatically select the day zero dateDefault: —Range: —

Apple Zero Day Custom URL

stringAllows for a custom self-hosted MacAdmin's SOFA macOS machine readable JSON feedDefault: —Range: —

Scheduled Install Date

stringAllows you to specify a date and time that a scheduled installation takes placeDefault: —Range: —

Scheduled Install Days

stringAllows you to specify the number of days after the zero date that a scheduled installation takes placeDefault: —Range: —

Scheduled Install Reminder

stringAllows you to specify a list of minutes separated by commas (no spaces) that define how often a scheduled installation reminder dialog appears prior to a scheduled installationDefault: —Range: —

Deferral Timer Default

stringThe number of minutes to defer until the next update workflow attempt if a user choses not restartDefault: —Range: —

Deferral Timer Error

stringThe number of minutes to defer if super detects an error in the workflow (for example, network or MDM connectivity issues)Default: —Range: —

Deferral Timer Menu

stringDisplay a deferral time pop-up menu in the non-deadline restart dialog that allows the user to override the Deferral Timer Default timerDefault: —Range: —

Deferral Timer Workflow Relaunch

stringThe number of minutes to defer if no software updates are available or allowed. Enabling this option results in super acting as a permanent agent that checks for software updates on a regular basisDefault: —Range: —

Display Hide Background

stringHide the background while displaying super dialogs and notificationsDefault: —Range: —

Display Notifications Centered

stringDisplay super notifications in the center of the screenDefault: —Range: —

Display Silently

stringDo not play the system alert sound when opening super dialogs and notificationsDefault: —Range: —

Display Unmovable

stringDisable the users ability to move super dialogs and notificationsDefault: —Range: —

Display Warning Button String

stringA plain text string or URL to open when the user clicks the warning button (exclamation mark icon) in all interactive dialogs (but not notifications)Default: —Range: —

Install macOS Major Upgrades

booleanWith this option enabled super leverages built-in commands and the mist command to find compatible macOS major upgrade versions. If a newer macOS major upgrade is available then the super workflow attempts to download and install the upgrade. The default super workflow always selects the newest compatible macOS major upgrade versionDefault: falseRange: —

Restart Without Updates

booleanForce a restart even if Apple software updates do not need it

Depends on: DisplayAccessoryRestartWithoutUpdatesFile

Default: falseRange: —

Install MacOS Major Version Target

stringLimit the installation of macOS major upgrade versions to the major (whole number) version specified in this option. This option requires that you have also specified the InstallMacOSMajorUpgrades optionDefault: —Range: —

Install Non System Updates Without Restarting

booleanIf there are no pending restart-required macOS updates or upgrades, make the super workflow install non-system Apple software updates as soon as they become available

Depends on: DisplayAccessoryNonSystemUpdatesFile

Default: trueRange: —

Install Rapid Security Responses

booleanAllow the super workflow to install macOS Rapid Security Response (RSR) updatesDefault: trueRange: —

Install macOS BSI Update

booleanAllows the super workflow to install macOS BSI UpdatesDefault: trueRange: —

Workflow Disable Relaunch

booleanDisable the automatic relaunch of the super workflow when no macOS updates or upgrades are available or allowedDefault: falseRange: —

Workflow Disable Update Check

booleanDisable the super workflow from checking for, downloading, or installing any Apple software updates or upgrades, even if they are availableDefault: falseRange: —

Workflow Only Download

booleanDownload and prepare macOS updates or upgrades but do not start any installation workflowDefault: falseRange: —

Verbose Mode

booleanMode to generate additional log outputDefault: falseRange: —