Managing macOS Custom Attributes

Custom attributes enable administrators to extract particular values from a managed device and return it to the Workspace ONE UEM Console.  This can be particularly useful for device configuration auditing and Product sequencing.

1. Custom Attributes

Custom attributes are key-value pairs.  These key value pairs are generated by scripting/commands which execute on the device and whose values are returned to the console through the Workspace ONE Intelligent Hub.  The scripts/commands are delivered to the device using a custom attributes payload in a profile.  The profile also allows scheduling of the script/command to re-occur on a schedule or based on an event.  Additionally, custom attribute payloads execute in the root context on the device, which allows you to gather information about the device without requiring the enrolled user to have Administrative permissions.

2. Custom Attribute Profiles

Previously, custom attributes were sent to the console by creating a shell script to write values to a specific Plist file monitored by the agent. In Workspace ONE UEM 8.2 and later, this functionality is now included as a profile and adds additional features such as scheduling.

2.1. Create Custom Attribute Profile

Add a macOS Device Profile

In the Workspace ONE UEM console:

  1. Select Devices.
  2. Select Profiles & Resources.
  3. Select Profiles.
  4. Select Add
  5. Select Add Profile.

2.2. Select Profile Platform

Select Profile Platform

Select the macOS icon.

2.3. Select the Profile Context

Select the Profile Context

Select the Device Profile icon.

2.4. Configure General Profile Settings

Configure General Profile Settings
  1. Select General if it is not already selected.
  2. Enter macOS Device Custom Attributes in the Name text box.
  3. Copy the profile name in to the Description text box.
  4. Ensure the Assignment Type is set to Auto.
  5. Click in the Assigned Groups field. This will pop-up the list of created Assignment Groups. Enter All Devices and select the All Devices ([email protected]) Assignment Group.
    Note: You may need to scroll down to find the Assigned Groups field.

Note: You DO NOT need to click Save or Save & Publish at this point. This interface allows you to move around to different payload configuration screens before saving.

2.5. Configure Custom Attributes Payload

Configure Custom Attributes Payload
  1. Scroll down the list of Payload Types on the left menu.
  2. Select Custom Attributes.
  3. Click Configure.

2.6. Enter Local Host Name Custom Attribute Command

Enter Local Host Name Custom Attribute Command
  1. Enter LocalHostName as the Attribute Name
  2. Enter the following command: /usr/sbin/scutil --get LocalHostName Be sure to use the correct slash, two hyphens, and proper capitalization.
  3. Select 1 Hour as the Reporting
  4. Click Save & Publish.

2.7. Publish to Device Assignment

Publish to Device Assignment

Click Publish.

3. Locating Custom Attributes

After Workspace ONE UEM delivers a custom attributes profile/payload to a device, the agent will report the initial value of the Custom Attribute back to Workspace ONE UEM and begin the Schedule or Event monitoring. Custom attribute values that have been reported back to the console can be viewed in the device details.

3.1. Access Device List View

Access Device List View
  1. Select Devices.
  2. Select List View.

3.2. Select Your Device

Select Your Device

Select your device.

3.3. Access Custom Attributes

Access Custom Attributes
  1. Select More.
  2. Select Custom Attributes.

3.4. Review Custom Attributes

Review Custom Attributes
  1. Notice that the Source of the attributes is Device Sourced—this means the data was gathered from the device and sent to Workspace ONE UEM.
  2. Note the list of Attributes.  
  3. Note the value of each Attribute. These values were generated by the output of your command/script in the Custom Attributes payload.


Add your comment

E-Mail me when someone replies to this comment

This site is protected by reCAPTCHA and the Google Privacy Policy and Terms of Service apply.