Computer Extension Attributes

Extension attributes allow you to collect extra inventory information. Extension attribute values are populated using an input type, which can be any of the following:

  • Text field

  • Pop-up menu

  • Script

  • LDAP attribute mapping

In Jamf Pro, you can create extension attributes manually, from an available template in Jamf Pro, or by uploading an extension attribute from Jamf Nation.

Examples:

  • A text field input can collect the retire date of a computer.

  • A script input can collect data about your company's antivirus software on a computer.

Extension attributes can be used as criteria in a smart group or as a variable in a configuration profile, which allows you to administer dynamic management workflows and tasks based on the data collected with extension attributes.

Note: Depending on the input type and data type (string, integer, date), extension attributes may add time and network traffic to the inventory collection process.

Extension Attribute Input Types

Extension attributes collect inventory data by using an input type. You can configure the following input types:

Text Fields

You can display a text field in inventory information or Recon to collect inventory data. You can enter a value in the field during enrollment with Recon or anytime using Jamf Pro.

Note: Only manually created extension attributes can use a text field.

Pop-up Menus

You can display a pop-up menu in inventory information or Recon to collect inventory data. You can choose a value from the pop-up menu when enrolling a computer using Recon or any time using Jamf Pro.

Note: Pop-up menus can only be configured by a manually created extension attribute.

Scripts

You can run a script that returns a data value each time a computer submits inventory to Jamf Pro. You can write your own extension attribute script or create one from a template in Jamf Pro.

Keep the following in mind when writing extension attribute scripts:

  • Scripts can be written in any language that has an interpreter installed. The most common interpreters are Bash, Perl, and Python.

  • When an extension attribute is populated by a script, the text between the <result></result> tag is stored in Jamf Pro.

  • You can temporarily disable extension attributes to troubleshoot processes.

The following example script collects the hostname from Mac computers:

#!/bin/bash

echo "<result>`hostname 2>&1`</result>"

For more examples and templates, see the Extension Attributes webpage on Jamf Nation.

LDAP Attribute Mapping

You can use an LDAP attribute mapping to populate an extension attribute. Extension attributes can be populated by multiple-value attributes from an LDAP server, such as "memberOf". The multiple values can later be used when creating smart groups and advanced searches with the extension attribute criteria and the “has" or "does not have” operators.

Keep the following limitations in mind when using LDAP multiple-value extension attributes:

  • When creating smart groups and advanced searches, the criteria value must accurately reflect the value returned in the computer inventory. To ensure you use the correct value, copy the extension attribute inventory value, and paste it in the criteria value field.

  • Multiple-value attribute mapping will not work with nested groups. Only the groups directly listed on the User record will be displayed in the mapped LDAP extension attribute.

  • For the extension attributes to work correctly, values returned from the LDAP server cannot contain the sequence of repeating vertical-bar characters (ASCII code 124, HTML entity = &vert;).

Extension Attribute IDs and Variables

Creating a computer extension attribute generates a variable that can be used to populate configuration profile settings. The variable is $EXTENSIONATTRIBUTE_#, where # is the extension attribute ID.

For information about using payload variables for configuration profiles, see Computer Configuration Profiles.

For extension attributes that use a text field, pop-up menu, or script input type, the ID number is found in the extension attribute URL. In the example URL below, "id=2" indicates the extension attribute ID number:

Example: https://instancename.jamfcloud.com/computerExtensionAttributes.html?id=2&o=r

For extension attributes with the LDAP attribute mapping input type, the ID number is displayed in the LDAP Attribute Variable field after you save the extension attribute.

Manually Creating a Computer Extension Attribute

Requirements

If you are creating a computer extension attribute with the “LDAP Attribute Mapping” input type, you need the following:

Procedure

  1. Log in to Jamf Pro.

  2. In the top-right corner of the page, click Settings images/download/thumbnails/81541862/Icon_Settings_Hover.png .

  3. Click Computer Management.

  4. In the ”Computer Management–Management Framework” section, click Extension Attributes images/download/thumbnails/81541862/Extension_Attributes.png .

  5. Click New images/download/thumbnails/81541862/Icon_New_Button.png .

  6. Configure the following settings:

    1. Name your extension attribute.

    2. (Optional) Enter a description.

    3. Choose the type of data being collected from the Data Type pop-up menu.

    4. Choose a category in which to display the extension attribute in Jamf Pro from the Inventory Display pop-up menu.

    5. Choose an input type to populate your extension attribute from the Input Type pop-up menu.

  7. Click Save images/download/thumbnails/81531754/floppy-disk.png .

Creating a Computer Extension Attribute from a Template

Jamf Pro has built-in templates for many commonly used extension attributes.

  1. Log in to Jamf Pro.

  2. In the top-right corner of the page, click Settings images/download/thumbnails/81541862/Icon_Settings_Hover.png .

  3. Click Computer Management.

  4. In the ”Computer Management–Management Framework” section, click Extension Attributes images/download/thumbnails/81541862/Extension_Attributes.png .

  5. Click New From Template.

  6. Click the extension attribute template you want to use.

  7. (Optional) Make changes to the settings as needed.

  8. Click Save images/download/thumbnails/81531754/floppy-disk.png .

Uploading a Template for a Computer Extension Attribute

You can create an extension attribute by uploading an extension attribute template obtained from Jamf Nation. Extension attribute templates are available in Jamf Nation at:
https://www.jamf.com/jamf-nation/third-party-products/files/extension-attributes

  1. Log in to Jamf Pro.

  2. In the top-right corner of the page, click Settings images/download/thumbnails/81541862/Icon_Settings_Hover.png .

  3. Click Computer Management.

  4. In the ”Computer Management–Management Framework” section, click Extension Attributes images/download/thumbnails/81541862/Extension_Attributes.png .

  5. Click Upload and upload the extension attribute template.

  6. (Optional) Make changes to the settings as needed.

  7. Click Save images/download/thumbnails/81531754/floppy-disk.png .

Disabling a Computer Extension Attribute

To troubleshoot workflows, you can temporarily disable extension attributes with the script input type. You can also choose whether to retain or delete data collected by that extension attribute.

  1. Log in to Jamf Pro.

  2. In the top-right corner of the page, click Settings images/download/thumbnails/81541862/Icon_Settings_Hover.png .

  3. Click Computer Management.

  4. In the "Computer Management–Management Framework" section, click Extension Attributes images/download/thumbnails/81541862/Extension_Attributes.png .

  5. Select the extension attribute you want to disable.

    Note: Only extension attributes with the script input type can be disabled.

  6. Click Edit images/download/thumbnails/81532686/edit.png .

  7. Deselect the Enabled (script input type only) checkbox.

  8. Click Save images/download/thumbnails/81531754/floppy-disk.png .

  9. Use the pop-up dialog to choose one of the following:

    • To retain data collected by the extension attribute, select Retain Existing Data, and then click Save.

      Note: All settings and computers using data collected by disabled extension attributes will display or use the last value collected by the extension attribute before it is disabled.

    • To delete data collected by the extension attribute, select Delete Existing Data, and then click Save.

      Note: If smart computer groups or other settings are using the extension attribute data, deleting existing data may prevent those items from functioning correctly.

Related Information

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

Copyright     Privacy Policy     Terms of Use     Security
© copyright 2002-2020 Jamf. All rights reserved.