Jamf Setup Manager

com.jamf.setupmanager

Jamf Setup Manager settings

macOS

Configuration Keys (34)

Key	Type	Title	Description	Default	Range
`PFC_SegmentedControl_0`required	string	—	—	—	—
`DEBUG`	boolean	Debug Mode	Enables debug mode. See documentation for behavior changes.	—	—
`title`	string	Title	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.	"Welcome to Setup Manager"	—
`icon`	string	Icon	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.	"name:AppIcon"	—
`message`	string	Message	The message shown below the title. Supports Markdown and substitutions.	"Setup Manager is configuring your Mac…"	—
`banner`	string	Banner Image/Color	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.	—	—
`background`	string	Background Image/Color	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.	—	—
`runAt`	string	Run At	This value determines when Setup Manager should launch.	"enrollment"
`accentColor`	string	Accent Color	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.	—	—
`tileColor`	string	Default Tile Color	Sets the action tile background color for all action tiles, unless the value is overridden by an individual action's tileColor key.	—	—
`finalCountdown`	integer	Final Countdown	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'.	60	—
`finalAction`	string	Final Action	Sets the action and label for the button shown when Setup Manger has completed.	"continue"
`totalDownloadBytes`	integer	Total Download Bytes	Use this value to provide an estimate for the total size of all items that will be downloaded.	—	—
`jssID`	string	Jamf Pro ID (Setup Manager 1.3.1 and earlier)	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.	—
`computerID`	string	Computer ID (Setup Manager 1.4 and later)	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%.	—
`userID`	string	Jamf Pro User ID (Setup Manager 1.3.1 and earlier)	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.	—
`enrollmentUserID`	string	Jamf Pro User ID (Setup Manager 1.4 and later)	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.	—
`computerNameTemplate`	string	Computer Name Template	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.)	—	—
`overrideSerialNumber`	string	Demonstration Serial Number	When set, the "About this Mac" info window will show this value instead of the real serial number.	—	—
`hideActionLabels`	boolean	Hide Action Labels	Hides the individual labels under each action's icon.	—	—
`actionOutputLogging`	string	Action Output Logging	Controls whether the output of actions is written to the Setup Manager log file.	"error"
`finishedMessage`	string	Finished Message	Custom message when Setup Manager workflow is complete. Supports Markdown and substitutions.	—	—
`startingMessage`	string	Starting Message	Custom message shown while Setup Manager is "Getting Ready…" Supports Markdown and substitutions.	"Getting Ready…"	—
`networkQualityCheck`	boolean	Network Quality Check	Set this key to false to suppress the network quality check.	true	—
`hideDebugLabel`	boolean	Hide Debug Label	Suppresses display of the red 'DEBUG' label in debug mode.	—	—
`simulateMDM`	string	Simulate an MDM	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.	—
`help`	dict	Help	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.	—	—
`userEntry`	dict	User Entry	When any of these are defined, Setup Manager will prompt for user data while the enrollment actions are running.	—	—
`enrollmentActions`	array	Enrollment Actions	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.	—	—
`finishedScript`	string	Finished Script	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.	—	—
`finishedTrigger`	string	Finished Jamf Pro Policy Trigger	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.	—	—
`webhooks`	dict	Webhooks	—	—	—
`networkCheck`	array	Network Checks	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.	—	—
`PLEASE_DO_NOT_TRACK`	boolean	Do Not Track	Suppress launch tracking by enabling this setting.	—	—
`title`	string	Help Title	The title for the help message.	—	—
`message`	string	Help Message	The help message. Supports Markdown.	—	—
`url`	string	Help URL	The URL will be translated into a QR code and displayed next to the help message.	—	—
`userID`	dict	User ID	—	—	—
`email`	dict	Email	—	—	—
`endUsername`	dict	Account Name	—	—	—
`realname`	dict	Full Name	—	—	—
`position`	dict	Position	—	—	—
`phone`	dict	Phone	—	—	—
`department`	dict	Department	—	—	—
`building`	dict	Building	—	—	—
`room`	dict	Room	—	—	—
`assetTag`	dict	Asset Tag	—	—	—
`computerName`	dict	Computer Name	If computerNameTemplate is set, any data entry for computer name is ignored.	—	—
`showForUserIDs`	array	Show User Entry for User IDs	You can configure Setup Manager to only show the user entry section when specified users have authenticated in enrollment customization.	—	—
`default`	string	User ID Default	A pre-populated value for the User ID field.	—	—
`placeholder`	string	User ID Placeholder	A placeholder value for User ID. This is displayed in gray when no value has been entered.	—	—
`options`	array	User ID Options	Options displayed in a dropdown menu for User ID.	—	—
`validation`	string	User ID Validation	A regular expression used to validate the value of User ID.	—	—
`validationMessage`	string	User ID Validation Message	A message displayed to the user when User ID fails to match the regular expression.	—	—
`label`	string	User ID Label	Override the default label for the User ID field.	"User ID"	—
	string	Preset Options for User ID	—	—	—
`default`	string	Email Default	A pre-populated value for the Email field.	—	—
`placeholder`	string	Email Placeholder	A placeholder value for Email. This is displayed in gray when no value has been entered.	—	—
`options`	array	Email Options	Options displayed in a dropdown menu for Email.	—	—
`validation`	string	Email Validation	A regular expression used to validate the value of Email.	—	—
`validationMessage`	string	Email Validation Message	A message displayed to the user when Email fails to match the regular expression.	—	—
`label`	string	Email Label	Override the default label for the Email field.	"Email"	—
	string	Preset Options for Email	—	—	—
`default`	string	Account Name Default	A pre-populated value for the Account Name field.	—	—
`placeholder`	string	Account Name Placeholder	A placeholder value for Account Name. This is displayed in gray when no value has been entered.	—	—
`options`	array	Account Name Options	Options displayed in a dropdown menu for Account Name.	—	—
`validation`	string	Account Name Validation	A regular expression used to validate the value of Account Name.	—	—
`validationMessage`	string	Account Name Validation Message	A message displayed to the user when Account Name fails to match the regular expression.	—	—
`label`	string	Account Name Label	Override the default label for the Account Name field.	"Account Name"	—
	string	Preset Options for Account Name	—	—	—
`default`	string	Full Name Default	A pre-populated value for the Full Name field.	—	—
`placeholder`	string	Full Name Placeholder	A placeholder value for Full Name. This is displayed in gray when no value has been entered.	—	—
`options`	array	Full Name Options	Options displayed in a dropdown menu for Full Name.	—	—
`validation`	string	Full Name Validation	A regular expression used to validate the value of Full Name.	—	—
`validationMessage`	string	Full Name Validation Message	A message displayed to the user when Full Name fails to match the regular expression.	—	—
`label`	string	Full Name Label	Override the default label for the Full Name field.	"Full Name"	—
	string	Preset Options for Full Name	—	—	—
`default`	string	Position Default	A pre-populated value for the Position field.	—	—
`placeholder`	string	Position Placeholder	A placeholder value for Position. This is displayed in gray when no value has been entered.	—	—
`options`	array	Position Options	Options displayed in a dropdown menu for Position.	—	—
`validation`	string	Position Validation	A regular expression used to validate the value of Position.	—	—
`validationMessage`	string	Position Validation Message	A message displayed to the user when Position fails to match the regular expression.	—	—
`label`	string	Position Label	Override the default label for the Position field.	"Position"	—
	string	Preset Options for Position	—	—	—
`default`	string	Phone Default	A pre-populated value for the Phone field.	—	—
`placeholder`	string	Phone Placeholder	A placeholder value for Phone. This is displayed in gray when no value has been entered.	—	—
`options`	array	Phone Options	Options displayed in a dropdown menu for Phone.	—	—
`validation`	string	Phone Validation	A regular expression used to validate the value of Phone.	—	—
`validationMessage`	string	Phone Validation Message	A message displayed to the user when Phone fails to match the regular expression.	—	—
`label`	string	Phone Label	Override the default label for the Phone field.	"Phone"	—
	string	Preset Options for Phone	—	—	—
`default`	string	Department Default	A pre-populated value for the Department field.	—	—
`placeholder`	string	Department Placeholder	A placeholder value for Department. This is displayed in gray when no value has been entered.	—	—
`options`	array	Department Options	Options displayed in a dropdown menu for Department.	—	—
`validation`	string	Department Validation	A regular expression used to validate the value of Department.	—	—
`validationMessage`	string	Department Validation Message	A message displayed to the user when Department fails to match the regular expression.	—	—
`label`	string	Department Label	Override the default label for the Department field.	"Department"	—
	string	Preset Options for Department	—	—	—
`default`	string	Building Default	A pre-populated value for the Building field.	—	—
`placeholder`	string	Building Placeholder	A placeholder value for Building. This is displayed in gray when no value has been entered.	—	—
`options`	array	Building Options	Options displayed in a dropdown menu for Building.	—	—
`validation`	string	Building Validation	A regular expression used to validate the value of Building.	—	—
`validationMessage`	string	Building Validation Message	A message displayed to the user when Building fails to match the regular expression.	—	—
`label`	string	Building Label	Override the default label for the Building field.	"Building"	—
	string	Preset Options for Building	—	—	—
`default`	string	Room Default	A pre-populated value for the Room field.	—	—
`placeholder`	string	Room Placeholder	A placeholder value for Room. This is displayed in gray when no value has been entered.	—	—
`options`	array	Room Options	Options displayed in a dropdown menu for Room.	—	—
`validation`	string	Room Validation	A regular expression used to validate the value of Room.	—	—
`validationMessage`	string	Room Validation Message	A message displayed to the user when Room fails to match the regular expression.	—	—
`label`	string	Room Label	Override the default label for the Room field.	"Room"	—
	string	Preset Options for Room	—	—	—
`default`	string	Asset Tag Default	A pre-populated value for the Asset Tag field.	—	—
`placeholder`	string	Asset Tag Placeholder	A placeholder value for Asset Tag. This is displayed in gray when no value has been entered.	—	—
`options`	array	Asset Tag Options	Options displayed in a dropdown menu for Asset Tag.	—	—
`validation`	string	Asset Tag Validation	A regular expression used to validate the value of Asset Tag.	—	—
`validationMessage`	string	Asset Tag Validation Message	A message displayed to the user when Asset Tag fails to match the regular expression.	—	—
`label`	string	Asset Tag Label	Override the default label for the Asset Tag field.	"Asset Tag"	—
	string	Preset Options for Asset Tag	—	—	—
`default`	string	Computer Name Default	A pre-populated value for the Computer Name field.	—	—
`placeholder`	string	Computer Name Placeholder	A placeholder value for Computer Name. This is displayed in gray when no value has been entered.	—	—
`options`	array	Computer Name Options	Options displayed in a dropdown menu for Computer Name.	—	—
`validation`	string	Computer Name Validation	A regular expression used to validate the value of Computer Name.	—	—
`validationMessage`	string	Computer Name Validation Message	A message displayed to the user when Computer Name fails to match the regular expression.	—	—
`label`	string	Computer Name Label	Override the default label for the Computer Name field.	"Computer Name"	—
	string	Preset Options for Computer Name	—	—	—
	string	User ID	—	—	—
	dict	—	—	—	—
`label`	string	Label	The label is used as the name of the action in display.	—	—
`icon`	string	Icon	The icon shown for the action.	—	—
`tileColor`	string	Tile Color	The background color of the action's tile.	—	—
`shell`	string	Shell: command	The absolute path to the command or script that should be run for this action.	—	—
`requiresRoot`	boolean	Shell: run as root	—	—
`policy`	string	Jamf Pro Policy Trigger	The absolute path to the command or script that should be run for this action.	—	—
`watchPath`	string	Watch Path	This action will wait until a file at the given path exists or is removed.	—	—
`timeout`	integer	Watch Path: Timeout	The watchPath action will fail after this timeout.	600	—
`wait`	integer	Wait (in seconds)	Wait for a given time.	—	—
`waitForUserEntry`	string	Wait For User Entry	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.'	—
`recon`	string	Jamf Pro Recon	This will run a Jamf Inventory update.	—
`installomator`	string	Installomator Label	The installomator label to run. Can also use Arguments.	—	—
`arguments`	array	Arguments	—	—	—
	string	Argument	—	—	—
`started`	array	Started Webhooks	Webhooks called when Setup Manager starts its workflow.	—	—
`finished`	array	Finished Webhooks	Webhooks called when Setup Manager finishes its workflow.	—	—
`DEBUG`	boolean	Webhook Debug Mode	Enables webhook debug mode.	—	—
	dict	—	—	—	—
`kind`	string	Kind	Kind of webhook	"generic"
`url`	string	URL	Webhook URL	—	—
	dict	—	—	—	—
`kind`	string	Kind	Kind of webhook	"generic"
`url`	string	URL	Webhook URL	—	—
	dict	—	—	—	—
`host`	string	Host	The host name, e.g. host.example.com (no url scheme) to test a connection to.	—	—
`port`	integer	Port	The port to test a connection to.	443	—
`protocol`	string	Protocol	The connection protocol to test	"tcp"
`label`	string	Label	A display label for the connection test.	—	—