Jamf Helper Commands

Jamf Pro Documentation 11.30.0

Solution

Application

Content Type

Technical Documentation

Utilities & Services

version

11.30.0

ft:locale

en-US

vrm_version

11.30.0

Common Parameters

The following table shows commonly used parameters:


Parameter	Description	Example Value
`-windowType`	Style of the window	`utility`, `hud`, or `fs`
`-title`	Window title text	`"Software Update"`
`-description`	Main message text	`"Updates are being installed..."`
`-button1`	Primary button text	`"OK"`
`-button2`	Secondary button text (optional)	`"Cancel"`
`-icon`	Path to the icon file	`/System/Library/CoreServices/Software Update.app/Contents/Resources/SoftwareUpdate.icns`
`-timeout`	Auto-close time in seconds	`60`

For a complete list of all available parameters and their usage, run the Jamf Helper on a managed computer with the -help parameter:

/Library/Application Support/JAMF/bin/jamfHelper.app/Contents/MacOS/jamfHelper -help

Example Use Cases

Display a Message with a Timeout

#!/bin/bash

"/Library/Application Support/JAMF/bin/jamfHelper.app/Contents/MacOS/jamfHelper" \
-windowType "hud" \
-title "Maintenance Notice" \
-description "Maintenance will begin in 5 minutes. Please save your work." \
-timeout 300 \
-countdown

Request User Confirmation

#!/bin/bash

"/Library/Application Support/JAMF/bin/jamfHelper.app/Contents/MacOS/jamfHelper" \
-windowType "utility" \
-title "Software Installation" \
-description "Click Install to begin the installation process." \
-button1 "Install" \
-button2 "Cancel" \
-defaultButton 1

Request User Input

#!/bin/bash
# Ask user for their current work location
"/Library/Application Support/JAMF/bin/jamfHelper.app/Contents/MacOS/jamfHelper" \
    -windowType "utility" \
    -title "Work Location" \
    -heading "Where are you working today?" \
    -description "Please select your current work location so we can apply the correct network settings." \
    -icon "/System/Library/CoreServices/CoreTypes.bundle/Contents/Resources/Network.icns" \
    -button1 "Office" \
    -button2 "Remote" \
    -defaultButton 1
SELECTION=$?
# Store the response
case $SELECTION in
    0) LOCATION="Office";;
    2) LOCATION="Remote";;
    *) LOCATION="No selection made";;
esac
# Display confirmation
"/Library/Application Support/JAMF/bin/jamfHelper.app/Contents/MacOS/jamfHelper" \
    -windowType "utility" \
    -title "Thank You" \
    -description "Your location ($LOCATION) has been recorded." \
    -icon "/System/Library/CoreServices/CoreTypes.bundle/Contents/Resources/ToolbarFavoritesIcon.icns" \
    -button1 "OK"

Note:

This example shows the basic concept of collecting user input. For production use, you will need to add code to store the collected data, such as updating an extension attribute. Contact your IT administrator for complete implementation details.