OS X Configuration Profiles

OS X configuration profiles are XML files (.mobileconfig) that provide an easy way to define settings and restrictions for computers and users.

You can use the JAMF Software Server (JSS) to manually create an OS X configuration profile or upload a configuration profile that was created using Apple’s Profile Manager.

Before creating a configuration profile, you should have basic knowledge of configuration profile payloads and settings, and how they affect computers. For detailed information about each payload and setting, see Apple’s Profile Manager documentation at:

https://help.apple.com/profilemanager/mac

Some configuration profile settings are unique to the JSS. For more information on these settings, see the following Knowledge Base article:

Configuration Profiles Reference

When you create an OS X configuration profile, you must specify the level at which to apply the profile—computer level or user level. Each level has a unique set of payloads and a few that are common to both. There are two different ways to distribute an OS X configuration profile: install it automatically (requires no interaction from the user) or make it available in Self Service. You can also specify the computers and users to which the profile should be applied (called “scope”).

Payload Variables for OS X Configuration Profiles

There are several payload variables that you can use to populate settings in an OS X configuration profile with attribute values stored in the JSS. This allows you to create payloads containing information about each computer and user to which you are distributing the profile.

To use a payload variable, enter the variable into any text field when creating a configuration profile in the JSS. When the profile is installed on a computer, the variable is replaced with the value of the corresponding attribute in the JSS.

Variable

Computer Information

$COMPUTERNAME
or
$DEVICENAME

Computer Name

$SITENAME

Site Name

$SITEID

Site ID

$UDID

UDID

$SERIALNUMBER

Serial Number

$USERNAME

Username associated with the computer in the JSS
(computer-level profiles only)

Username of the user logging in to the computer
(user-level profiles only)

$FULLNAME or $REALNAME

Full Name

$EMAIL

Email Address

$PHONE

Phone Number

$POSITION

Position

$DEPARTMENTNAME

Department Name

$DEPARTMENTID

Department ID

$BUILDINGNAME

Building Name

$BUILDINGID

Building ID

$ROOM

Room

$MACADDRESS

MAC Address

$JSSID

JSS ID

$PROFILEJSSID

JSS ID of the Configuration Profile

$EXTENSIONATTRIBUTE_<#>

Value for any LDAP Attribute

Note: An $EXTENSIONATTRIBUTE_<#> variable is generated each time you create an extension attribute with the “LDAP Attribute Mapping” input type. For more information, see Computer Extension Attribute Input Types.

Requirements

To install an OS X configuration profile, you need:

  • A push certificate in the JSS (For more information, see Push Certificates.)

  • The Enable certificate-based authentication and Enable push notifications settings configured in the JSS (For more information, see Security Settings.)

  • Computers with OS X v10.7–v10.11

  • (User-level profiles only) Computers that are bound to a directory service or local user accounts that have been MDM-enabled (For information, see Binding to Directory Services and the Enabling MDM for Local User Accounts Knowledge Base article.)

Manually Creating an OS X Configuration Profile

  1. Log in to the JSS with a web browser.

  2. Click Computers at the top of the page.

  3. Click Configuration Profiles.
    On a smartphone or iPod touch, this option is in the pop-up menu.

  4. Click New images/download/thumbnails/12976301/New_icon.png .

  5. Use the General payload to configure basic settings, including the level at which to apply the profile and the distribution method.
    Only payloads and settings that apply to the selected level are displayed for the profile.

  6. Use the rest of the payloads to configure the settings you want to apply.

  7. Click the Scope tab and configure the scope of the profile.
    If you have migrated users, you can add users and computers as targets to the scope. If you have not migrated users yet, you can only add computers as targets to the scope.
    For more information, see Scope.

  8. (Optional) If you chose to distribute the profile in Self Service, click the Self Service tab to configure Self Service settings for the profile.
    For more information, see Self Service Configuration Profiles for Computers.

  9. Click Save.

Uploading an OS X Configuration Profile

You can create an OS X configuration profile by uploading a profile that was created using Apple’s Profile Manager.

Note: Some payloads and settings configured with Profile Manager are not displayed in the JSS. Although you cannot view or edit these payloads, they are still applied to computers and users.

  1. Log in to the JSS with a web browser.

  2. Click Computers at the top of the page.

  3. Click Configuration Profiles.
    On a smartphone or iPod touch, this option is in the pop-up menu.

  4. Click Upload images/download/thumbnails/12976301/Upload_icon.png and upload the configuration profile (.mobileconfig).

  5. Use the General payload to change or configure basic settings for the profile, including a distribution method.

  6. Use the rest of the payloads to configure or edit settings as needed.

  7. Click the Scope tab and configure the scope of the profile.
    If you have migrated users, you can add users and computers as targets to the scope. If you have not migrated users yet, you can only add computers as targets to the scope.
    For more information, see Scope.

  8. (Optional) If you chose to distribute the profile in Self Service, click the Self Service tab to configure Self Service settings for the profile.
    For more information, see Self Service Configuration Profiles for Computers.

  9. Click Save.

Cloning, Editing, or Deleting an OS X Configuration Profile

  1. Log in to the JSS with a web browser.

  2. Click Computers at the top of the page.

  3. Click Configuration Profiles.
    On a smartphone or iPod touch, this option is in the pop-up menu.

  4. Click the configuration profile you want to clone, edit, or delete.

  5. Do one of the following:

    • To clone the profile, click Clone and make changes as needed. Then click Save.

    • To edit the profile, click Edit and make changes as needed. Then click Save.

    • To delete the profile, click Delete and then click Delete again to confirm.

Downloading an OS X Configuration Profile

If you want to view the contents of an OS X configuration profile for troubleshooting purposes, you can download the profile (.mobileconfig) from the JSS.

  1. Log in to the JSS with a web browser.

  2. Click Computers at the top of the page.

  3. Click Configuration Profiles.
    On a smartphone or iPod touch, this option is in the pop-up menu.

  4. Click the configuration profile you want to download.

  5. Click Download.

The profile downloads immediately.

Viewing the Status of an OS X Configuration Profile

For each OS X configuration profile, you can view the number of computers for which the profile installation has a status of Completed, Remaining, or Failed.

Note: Depending on your system configuration, some historical status data may not be available for profiles installed using the Casper Suite v9.63 or earlier.

  1. Log in to the JSS with a web browser.

  2. Click Computers at the top of the page.

  3. Click Configuration Profiles.
    On a smartphone or iPod touch, this option is in the pop-up menu.
    A list of OS X configuration profiles is displayed.
    For each profile, you can view the number of computers for which the profile installation has a Completed, Remaining, or Failed status.
    Note: If a computer becomes unmanaged after a profile is successfully distributed to it, the profile will continue to be displayed in the Completed column.

  4. To view a list of computers for which the profile installation has a Completed, Remaining, or Failed status, click the number displayed in the corresponding column. Then click Done.

Viewing Logs for an OS X Configuration Profile

The logs for an OS X configuration profile include a list of computers that are in the scope of the profile, as well as the username of the user who installed the profile, the date/time that the status was last updated, and the status of the profile for each computer.

Note: Depending on your system configuration, some historical log data may not be available for profiles installed using v9.63 or earlier.

  1. Log in to the JSS with a web browser.

  2. Click Computers at the top of the page.

  3. Click Configuration Profiles.
    On a smartphone or iPod touch, this option is in the pop-up menu.
    A list of OS X configuration profiles is displayed.

  4. Click View next to the configuration profile you want to view logs for.
    A list of computers that are in the scope of the configuration profile is displayed.

  5. To view logs for a different date range, specify the starting and ending dates using the Date Range pop-up calendars.

  6. Click Done.

Related Information

For related information, see the following sections in this guide:

Copyright | Privacy | Terms of Use | Security
Copyright JAMF Software, LLC 2016