Jamf Setup Manager

com.jamf.setupmanager

Jamf Setup Manager settings

macOS

Configuration Keys (34)

Showing 34 of 34 keys

Key	Type	Description	Default	Range
`PFC_SegmentedControl_0`string required	string	—	Default: —	Range: —
`DEBUG`boolean Debug Mode	boolean	Enables debug mode. See documentation for behavior changes.	Default: —	Range: —
`title`string Title	string	The main title over the window. Supports substitutions. (v1.4+) When the title is empty or unset, the default message 'Welcome to Setup Manager' will be shown, unless the banner is set, then no title will be shown instead. This allows for a custom branded title and icon in the banner image.	Default: "Welcome to Setup Manager"	Range: —
`icon`string Icon	string	The icon shown at the top center of the window. There are many options to define icons, as described in the documentation. (v1.4+) When the icon is empty or unset, Setup Manager will show the Setup Manager app icon, unless the banner is set, then no icon will be shown instead. This allows for a custom branded icon and title in the banner image.	Default: "name:AppIcon"	Range: —
`message`string Message	string	The message shown below the title. Supports Markdown and substitutions.	Default: "Setup Manager is configuring your Mac…"	Range: —
`banner`string Banner Image/Color	string	A banner image or color that covers the top of the Setup Manager window. See the documentation for dimensions. Supports both images (using the same sources as Icon) and colors.	Default: —	Range: —
`background`string Background Image/Color	string	When set, Setup Manager displays the image full screen as a background behind the main window. Supports images (using the same sources as Icon) and also colors from v1.4 on.	Default: —	Range: —
`runAt`string Run At	string	This value determines when Setup Manager should launch.	Default: "enrollment"	Range: Enrollment (enrollment), Login Window (loginwindow)
`accentColor`string Accent Color	string	Sets the accent color for buttons, progress bar, SF Symbol icons, and other UI elements. Use this to match branding. Color is encoded as a six digit hex code, e.g. #FF0088.	Default: —	Range: —
`tileColor`string Default Tile Color	string	Sets the action tile background color for all action tiles, unless the value is overridden by an individual action's tileColor key.	Default: —	Range: —
`finalCountdown`integer Final Countdown	integer	Changes the duration (in seconds) of the "final countdown" before the app automatically performs the finalAction. Set to -1 (or any negative number) to disable automated execution. This setting is ignored if finalAction is set to 'none'.	Default: 60	Range: —
`finalAction`string Final Action	string	Sets the action and label for the button shown when Setup Manger has completed.	Default: "continue"	Range: Continue (continue), Restart (restart), Shut Down (shutdown), None (none)
`totalDownloadBytes`integer Total Download Bytes	integer	Use this value to provide an estimate for the total size of all items that will be downloaded.	Default: —	Range: —
`jssID`string Jamf Pro ID (Setup Manager 1.3.1 and earlier)	string	When using JSM with Jamf Pro, set this to $JSSID in a Jamf Pro configuration profile and Setup Manager will be aware of its computer's id in Jamf Pro.	Default: —	Range: $JSSID
`computerID`string Computer ID (Setup Manager 1.4 and later)	string	When using JSM with Jamf Pro, set this to $JSSID in a Jamf Pro configuration profile and Setup Manager will be aware of its computer's id in Jamf Pro. For similar effect with Jamf School, set this to %udid%.	Default: —	Range: $JSSID (For Jamf Pro) ($JSSID), %udid% (For Jamf School) (%udid%)
`userID`string Jamf Pro User ID (Setup Manager 1.3.1 and earlier)	string	Set this to $EMAIL in the configuration profile. This communicates the user who logged in to customized enrollment to Setup Manager. This can be used together with the userEntry.showForUserIDs key to control which users see the user entry UI.	Default: —	Range: $EMAIL, $USERNAME
`enrollmentUserID`string Jamf Pro User ID (Setup Manager 1.4 and later)	string	Set this to $EMAIL in the configuration profile. This communicates the user who logged in to customized enrollment to Setup Manager. This can be used together with the userEntry.showForUserIDs key to control which users see the user entry UI.	Default: —	Range: $EMAIL, $USERNAME
`computerNameTemplate`string Computer Name Template	string	Setup Manager will generate the computer name from this template and set it automatically. See the documentation for substitutions that can used in the template. (Setting this overrides the Computer Name field in user entry.)	Default: —	Range: —
`overrideSerialNumber`string Demonstration Serial Number	string	When set, the "About this Mac" info window will show this value instead of the real serial number.	Default: —	Range: —
`hideActionLabels`boolean Hide Action Labels	boolean	Hides the individual labels under each action's icon.	Default: —	Range: —
`actionOutputLogging`string Action Output Logging	string	Controls whether the output of actions is written to the Setup Manager log file.	Default: "error"	Range: Always (always), Error (error), Never (never)
`finishedMessage`string Finished Message	string	Custom message when Setup Manager workflow is complete. Supports Markdown and substitutions.	Default: —	Range: —
`startingMessage`string Starting Message	string	Custom message shown while Setup Manager is "Getting Ready…" Supports Markdown and substitutions.	Default: "Getting Ready…"	Range: —
`networkQualityCheck`boolean Network Quality Check	boolean	Set this key to false to suppress the network quality check.	Default: true	Range: —
`hideDebugLabel`boolean Hide Debug Label	boolean	Suppresses display of the red 'DEBUG' label in debug mode.	Default: —	Range: —
`simulateMDM`string Simulate an MDM	string	When debug mode is enabled, you can set this to Jamf Pro or Jamf School. This allows you to do test runs on un-enrolled Macs.	Default: —	Range: Jamf Pro, Jamf School
`help`dict Help	dict	When you provide help, a help button (with a circled question mark) will be shown in the lower right corner (for left-to-right localizations). When you click on the help button a window with information will be shown.	Default: —	Range: —
`title`string Help Title	string	The title for the help message.	Default: —	Range: —
`message`string Help Message	string	The help message. Supports Markdown.	Default: —	Range: —
`url`string Help URL	string	The URL will be translated into a QR code and displayed next to the help message.	Default: —	Range: —
`userEntry`dict User Entry	dict	When any of these are defined, Setup Manager will prompt for user data while the enrollment actions are running.	Default: —	Range: —
`userID`dict User ID	dict	—	Default: —	Range: —
`default`string User ID Default	string	A pre-populated value for the User ID field.	Default: —	Range: —
`placeholder`string User ID Placeholder	string	A placeholder value for User ID. This is displayed in gray when no value has been entered.	Default: —	Range: —
`options`array User ID Options	array	Options displayed in a dropdown menu for User ID.	Default: —	Range: —
string Preset Options for User ID	string	—	Default: —	Range: —
`validation`string User ID Validation	string	A regular expression used to validate the value of User ID.	Default: —	Range: —
`validationMessage`string User ID Validation Message	string	A message displayed to the user when User ID fails to match the regular expression.	Default: —	Range: —
`label`string User ID Label	string	Override the default label for the User ID field.	Default: "User ID"	Range: —
`email`dict Email	dict	—	Default: —	Range: —
`default`string Email Default	string	A pre-populated value for the Email field.	Default: —	Range: —
`placeholder`string Email Placeholder	string	A placeholder value for Email. This is displayed in gray when no value has been entered.	Default: —	Range: —
`options`array Email Options	array	Options displayed in a dropdown menu for Email.	Default: —	Range: —
string Preset Options for Email	string	—	Default: —	Range: —
`validation`string Email Validation	string	A regular expression used to validate the value of Email.	Default: —	Range: —
`validationMessage`string Email Validation Message	string	A message displayed to the user when Email fails to match the regular expression.	Default: —	Range: —
`label`string Email Label	string	Override the default label for the Email field.	Default: "Email"	Range: —
`endUsername`dict Account Name	dict	—	Default: —	Range: —
`default`string Account Name Default	string	A pre-populated value for the Account Name field.	Default: —	Range: —
`placeholder`string Account Name Placeholder	string	A placeholder value for Account Name. This is displayed in gray when no value has been entered.	Default: —	Range: —
`options`array Account Name Options	array	Options displayed in a dropdown menu for Account Name.	Default: —	Range: —
string Preset Options for Account Name	string	—	Default: —	Range: —
`validation`string Account Name Validation	string	A regular expression used to validate the value of Account Name.	Default: —	Range: —
`validationMessage`string Account Name Validation Message	string	A message displayed to the user when Account Name fails to match the regular expression.	Default: —	Range: —
`label`string Account Name Label	string	Override the default label for the Account Name field.	Default: "Account Name"	Range: —
`realname`dict Full Name	dict	—	Default: —	Range: —
`default`string Full Name Default	string	A pre-populated value for the Full Name field.	Default: —	Range: —
`placeholder`string Full Name Placeholder	string	A placeholder value for Full Name. This is displayed in gray when no value has been entered.	Default: —	Range: —
`options`array Full Name Options	array	Options displayed in a dropdown menu for Full Name.	Default: —	Range: —
string Preset Options for Full Name	string	—	Default: —	Range: —
`validation`string Full Name Validation	string	A regular expression used to validate the value of Full Name.	Default: —	Range: —
`validationMessage`string Full Name Validation Message	string	A message displayed to the user when Full Name fails to match the regular expression.	Default: —	Range: —
`label`string Full Name Label	string	Override the default label for the Full Name field.	Default: "Full Name"	Range: —
`position`dict Position	dict	—	Default: —	Range: —
`default`string Position Default	string	A pre-populated value for the Position field.	Default: —	Range: —
`placeholder`string Position Placeholder	string	A placeholder value for Position. This is displayed in gray when no value has been entered.	Default: —	Range: —
`options`array Position Options	array	Options displayed in a dropdown menu for Position.	Default: —	Range: —
string Preset Options for Position	string	—	Default: —	Range: —
`validation`string Position Validation	string	A regular expression used to validate the value of Position.	Default: —	Range: —
`validationMessage`string Position Validation Message	string	A message displayed to the user when Position fails to match the regular expression.	Default: —	Range: —
`label`string Position Label	string	Override the default label for the Position field.	Default: "Position"	Range: —
`phone`dict Phone	dict	—	Default: —	Range: —
`default`string Phone Default	string	A pre-populated value for the Phone field.	Default: —	Range: —
`placeholder`string Phone Placeholder	string	A placeholder value for Phone. This is displayed in gray when no value has been entered.	Default: —	Range: —
`options`array Phone Options	array	Options displayed in a dropdown menu for Phone.	Default: —	Range: —
string Preset Options for Phone	string	—	Default: —	Range: —
`validation`string Phone Validation	string	A regular expression used to validate the value of Phone.	Default: —	Range: —
`validationMessage`string Phone Validation Message	string	A message displayed to the user when Phone fails to match the regular expression.	Default: —	Range: —
`label`string Phone Label	string	Override the default label for the Phone field.	Default: "Phone"	Range: —
`department`dict Department	dict	—	Default: —	Range: —
`default`string Department Default	string	A pre-populated value for the Department field.	Default: —	Range: —
`placeholder`string Department Placeholder	string	A placeholder value for Department. This is displayed in gray when no value has been entered.	Default: —	Range: —
`options`array Department Options	array	Options displayed in a dropdown menu for Department.	Default: —	Range: —
string Preset Options for Department	string	—	Default: —	Range: —
`validation`string Department Validation	string	A regular expression used to validate the value of Department.	Default: —	Range: —
`validationMessage`string Department Validation Message	string	A message displayed to the user when Department fails to match the regular expression.	Default: —	Range: —
`label`string Department Label	string	Override the default label for the Department field.	Default: "Department"	Range: —
`building`dict Building	dict	—	Default: —	Range: —
`default`string Building Default	string	A pre-populated value for the Building field.	Default: —	Range: —
`placeholder`string Building Placeholder	string	A placeholder value for Building. This is displayed in gray when no value has been entered.	Default: —	Range: —
`options`array Building Options	array	Options displayed in a dropdown menu for Building.	Default: —	Range: —
string Preset Options for Building	string	—	Default: —	Range: —
`validation`string Building Validation	string	A regular expression used to validate the value of Building.	Default: —	Range: —
`validationMessage`string Building Validation Message	string	A message displayed to the user when Building fails to match the regular expression.	Default: —	Range: —
`label`string Building Label	string	Override the default label for the Building field.	Default: "Building"	Range: —
`room`dict Room	dict	—	Default: —	Range: —
`default`string Room Default	string	A pre-populated value for the Room field.	Default: —	Range: —
`placeholder`string Room Placeholder	string	A placeholder value for Room. This is displayed in gray when no value has been entered.	Default: —	Range: —
`options`array Room Options	array	Options displayed in a dropdown menu for Room.	Default: —	Range: —
string Preset Options for Room	string	—	Default: —	Range: —
`validation`string Room Validation	string	A regular expression used to validate the value of Room.	Default: —	Range: —
`validationMessage`string Room Validation Message	string	A message displayed to the user when Room fails to match the regular expression.	Default: —	Range: —
`label`string Room Label	string	Override the default label for the Room field.	Default: "Room"	Range: —
`assetTag`dict Asset Tag	dict	—	Default: —	Range: —
`default`string Asset Tag Default	string	A pre-populated value for the Asset Tag field.	Default: —	Range: —
`placeholder`string Asset Tag Placeholder	string	A placeholder value for Asset Tag. This is displayed in gray when no value has been entered.	Default: —	Range: —
`options`array Asset Tag Options	array	Options displayed in a dropdown menu for Asset Tag.	Default: —	Range: —
string Preset Options for Asset Tag	string	—	Default: —	Range: —
`validation`string Asset Tag Validation	string	A regular expression used to validate the value of Asset Tag.	Default: —	Range: —
`validationMessage`string Asset Tag Validation Message	string	A message displayed to the user when Asset Tag fails to match the regular expression.	Default: —	Range: —
`label`string Asset Tag Label	string	Override the default label for the Asset Tag field.	Default: "Asset Tag"	Range: —
`computerName`dict Computer Name	dict	If computerNameTemplate is set, any data entry for computer name is ignored.	Default: —	Range: —
`default`string Computer Name Default	string	A pre-populated value for the Computer Name field.	Default: —	Range: —
`placeholder`string Computer Name Placeholder	string	A placeholder value for Computer Name. This is displayed in gray when no value has been entered.	Default: —	Range: —
`options`array Computer Name Options	array	Options displayed in a dropdown menu for Computer Name.	Default: —	Range: —
string Preset Options for Computer Name	string	—	Default: —	Range: —
`validation`string Computer Name Validation	string	A regular expression used to validate the value of Computer Name.	Default: —	Range: —
`validationMessage`string Computer Name Validation Message	string	A message displayed to the user when Computer Name fails to match the regular expression.	Default: —	Range: —
`label`string Computer Name Label	string	Override the default label for the Computer Name field.	Default: "Computer Name"	Range: —
`showForUserIDs`array Show User Entry for User IDs	array	You can configure Setup Manager to only show the user entry section when specified users have authenticated in enrollment customization.	Default: —	Range: —
string User ID	string	—	Default: —	Range: —
`enrollmentActions`array Enrollment Actions	array	Describes the individual actions to be performed by Setup Manager. For each row, complete the Label, Icon, and then one of the following: Shell command, Jamf Pro Policy Trigger, Watch Path, Wait, Wait For User Entry, Jamf Pro Recon, or Installomator Label.	Default: —	Range: —
dict	dict	—	Default: —	Range: —
`label`string Label	string	The label is used as the name of the action in display.	Default: —	Range: —
`icon`string Icon	string	The icon shown for the action.	Default: —	Range: —
`tileColor`string Tile Color	string	The background color of the action's tile.	Default: —	Range: —
`shell`string Shell: command	string	The absolute path to the command or script that should be run for this action.	Default: —	Range: —
`requiresRoot`boolean Shell: run as root	boolean	—	Default: —	Range: Yes (true)
`policy`string Jamf Pro Policy Trigger	string	The absolute path to the command or script that should be run for this action.	Default: —	Range: —
`watchPath`string Watch Path	string	This action will wait until a file at the given path exists or is removed.	Default: —	Range: —
`timeout`integer Watch Path: Timeout	integer	The watchPath action will fail after this timeout.	Default: 600	Range: —
`wait`integer Wait (in seconds)	integer	Wait for a given time.	Default: —	Range: —
`waitForUserEntry`string Wait For User Entry	string	If Setup Manager reaches this action before the user entry has been completed, it will wait until the user entry is completed and the user has clicked 'Save.'	Default: —	Range: Wait For User Entry ()
`recon`string Jamf Pro Recon	string	This will run a Jamf Inventory update.	Default: —	Range: Jamf Pro Recon ()
`installomator`string Installomator Label	string	The installomator label to run. Can also use Arguments.	Default: —	Range: —
`arguments`array Arguments	array	—	Default: —	Range: —
string Argument	string	—	Default: —	Range: —
`finishedScript`string Finished Script	string	A full path to a script file which will be executed after Setup Manager has finished its workflow. This process runs independently of Setup Manager, so it can run installers or scripts that affect Setup Manager.	Default: —	Range: —
`finishedTrigger`string Finished Jamf Pro Policy Trigger	string	A custom Jamf Pro policy trigger which will be executed after Setup Manager has finished its workflow. This process runs independently of Setup Manager, so it can run installers or scripts that affect Setup Manager.	Default: —	Range: —
`webhooks`dict Webhooks	dict	—	Default: —	Range: —
`started`array Started Webhooks	array	Webhooks called when Setup Manager starts its workflow.	Default: —	Range: —
dict	dict	—	Default: —	Range: —
`kind`string Kind	string	Kind of webhook	Default: "generic"	Range: Generic (generic), Microsoft Teams (teams), Slack (slack)
`url`string URL	string	Webhook URL	Default: —	Range: —
`finished`array Finished Webhooks	array	Webhooks called when Setup Manager finishes its workflow.	Default: —	Range: —
dict	dict	—	Default: —	Range: —
`kind`string Kind	string	Kind of webhook	Default: "generic"	Range: Generic (generic), Microsoft Teams (teams), Slack (slack)
`url`string URL	string	Webhook URL	Default: —	Range: —
`DEBUG`boolean Webhook Debug Mode	boolean	Enables webhook debug mode.	Default: —	Range: —
`networkCheck`array Network Checks	array	Provides a list of hosts to check connectivity to. These will be shown in the 'Connectivity' section in the network info pane. Be sure to read the documentation before configuring.	Default: —	Range: —
dict	dict	—	Default: —	Range: —
`host`string Host	string	The host name, e.g. host.example.com (no url scheme) to test a connection to.	Default: —	Range: —
`port`integer Port	integer	The port to test a connection to.	Default: 443	Range: —
`protocol`string Protocol	string	The connection protocol to test	Default: "tcp"	Range: TCP (tcp), UDP (udp)
`label`string Label	string	A display label for the connection test.	Default: —	Range: —
`PLEASE_DO_NOT_TRACK`boolean Do Not Track	boolean	Suppress launch tracking by enabling this setting.	Default: —	Range: —