|
| 1 | +--- |
| 2 | +id: jamf-source |
| 3 | +title: Jamf Source (Beta) |
| 4 | +sidebar_label: Jamf |
| 5 | +tags: |
| 6 | + - cloud-to-cloud |
| 7 | + - jamf |
| 8 | +description: Learn how to collect data from the Jamf platform. |
| 9 | +--- |
| 10 | +import CodeBlock from '@theme/CodeBlock'; |
| 11 | +import ExampleJSON from '/files/c2c/jamf/example.json'; |
| 12 | +import MyComponentSource from '!!raw-loader!/files/c2c/jamf/example.json'; |
| 13 | +import TerraformExample from '!!raw-loader!/files/c2c/jamf/example.tf'; |
| 14 | +import useBaseUrl from '@docusaurus/useBaseUrl'; |
| 15 | + |
| 16 | +<img src={useBaseUrl('img/send-data/jamf.png')} alt="thumbnail icon" width="85"/> |
| 17 | + |
| 18 | +<head> |
| 19 | + <meta name="robots" content="noindex" /> |
| 20 | +</head> |
| 21 | + |
| 22 | +<p><a href="/docs/beta"><span className="beta">Beta</span></a></p> |
| 23 | + |
| 24 | +Jamf is a software company that specializes in mobile device management (MDM) and endpoint management solutions for Apple devices such as Macs, iPhones, iPads, and Apple TVs. This Jamf integration helps you to ingest inventory data using the [Jamf Pro API](https://developer.jamf.com/jamf-pro/v11.4.0/docs/jamf-pro-api-overview) and [Jamf Classic API](https://developer.jamf.com/jamf-pro/v11.4.0/docs/getting-started-2). |
| 25 | + |
| 26 | +## Data collected |
| 27 | + |
| 28 | +| Polling Interval | Data | |
| 29 | +| :--- | :--- | |
| 30 | +| 24 hours | [Inventory ID](https://developer.jamf.com/jamf-pro/reference/get_v1-computers-inventory) <ul><li>[Computer History](https://developer.jamf.com/jamf-pro/reference/findcomputerhistorybyid)</li><li>[Computer Management](https://developer.jamf.com/jamf-pro/reference/findcomputermanagementbyid)</li></ul> | |
| 31 | + |
| 32 | + |
| 33 | +## Setup |
| 34 | + |
| 35 | +### Vendor configuration |
| 36 | + |
| 37 | +The Jamf source requires you to provide the Base URL, Client ID, and Client Secret to access the source data. |
| 38 | + |
| 39 | +- The Base URL is used to retrieve the source data from Jamf. The **Base URL** for Jamf is `https://yourServer.jamfcloud.com`. Replace `yourServer` with your organization server. |
| 40 | +- To generate the **Client ID** and **Client Secret**, follow the instructions mentioned in the [Jamf documentation](https://learn.jamf.com/en-US/bundle/jamf-pro-documentation-current/page/API_Roles_and_Clients.html). |
| 41 | + |
| 42 | +### Source configuration |
| 43 | + |
| 44 | +When you create a Jamf Source, you add it to a Hosted Collector. Before creating the Source, identify the Hosted Collector you want to use or create a new Hosted Collector. For instructions, see [Configure a Hosted Collector and Source](/docs/send-data/hosted-collectors/configure-hosted-collector). |
| 45 | + |
| 46 | +To configure the Jamf Source: |
| 47 | +1. <!--Kanso [**Classic UI**](/docs/get-started/sumo-logic-ui/). Kanso--> In the main Sumo Logic menu, select **Manage Data > Collection > Collection**. <!--Kanso <br/>[**New UI**](/docs/get-started/sumo-logic-ui-new/). In the Sumo Logic top menu select **Configuration**, and then under **Data Collection** select **Collection**. You can also click the **Go To...** menu at the top of the screen and select **Collection**. Kanso--> |
| 48 | +1. On the Collectors page, click **Add Source** next to a Hosted Collector. |
| 49 | +1. Search for and select the **Jamf** icon. |
| 50 | +1. Enter a **Name** to display for the Source in Sumo Logic. The description is optional. |
| 51 | +1. (Optional) For **Source Category**, enter any string to tag the output collected from the Source. Category metadata is stored in a searchable field called `_sourceCategory`. |
| 52 | +1. (Optional) **Fields**. Click the **+Add Field** link to define the fields you want to associate. Each field needs a name (key) and value. |
| 53 | + *  A green circle with a check mark is shown when the field exists in the Fields table schema. |
| 54 | + *  An orange triangle with an exclamation point is shown when the field doesn't exist in the Fields table schema. In this case, an option to automatically add the nonexistent fields to the Fields table schema is provided. If a field is sent to Sumo Logic that does not exist in the Fields schema it is ignored, known as dropped. |
| 55 | +1. In **Base URL**, enter your Jamf instance domain, `https://yourServer.jamfcloud.com`. |
| 56 | +1. In **Client ID**, enter the Client ID you generated from the Jamf platform. |
| 57 | +1. In **Client Secret**, enter the Client Secret you generated from the Jamf platform. |
| 58 | +1. (Optional) The **Polling Interval** is set for 24 hours by default. You can adjust it based on your needs. |
| 59 | +1. (Optional) **Processing Rules for Logs**. Configure any desired filters, such as allowlist, denylist, hash, or mask, as described in [Create a Processing Rule](/docs/send-data/collection/processing-rules/create-processing-rule). |
| 60 | +1. When you are finished configuring the Source, click **Save**. |
| 61 | + |
| 62 | +## JSON schema |
| 63 | + |
| 64 | +Sources can be configured using UTF-8 encoded JSON files with the Collector Management API. See [Use JSON to Configure Sources](/docs/send-data/use-json-configure-sources) for details. |
| 65 | + |
| 66 | +| Parameter | Type | Value | Required | Description | |
| 67 | +|:--|:--|:--|:--|:--| |
| 68 | +| schemaRef | JSON Object | `{"type":"Jamf"}` | Yes | Define the specific schema type. | |
| 69 | +| sourceType | String | `"Universal"` | Yes | Type of source. | |
| 70 | +| config | JSON Object | [Configuration object](#configuration-object) | Yes | Source type specific values. | |
| 71 | + |
| 72 | +### Configuration Object |
| 73 | + |
| 74 | +| Parameter | Type | Required | Default | Description | Example | |
| 75 | +|:--|:--|:--|:--|:--|:--| |
| 76 | +| name | String | Yes | `null` | Type a desired name of the source. The name must be unique per Collector. This value is assigned to the [metadata](/docs/search/get-started-with-search/search-basics/built-in-metadata) field `_source`. | `"mySource"` | |
| 77 | +| description | String | No | `null` | Type a description of the source. | `"Testing source"` |
| 78 | +| category | String | No | `null` | Type a category of the source. This value is assigned to the [metadata](/docs/search/get-started-with-search/search-basics/built-in-metadata) field `_sourceCategory`. See [best practices](/docs/send-data/best-practices) for details. | `"mySource/test"` |
| 79 | +| fields | JSON Object | No | `null` | JSON map of key-value fields (metadata) to apply to the Collector or Source. Use the boolean field `_siemForward` to enable forwarding to SIEM.|`{"_siemForward": false, "fieldA": "valueA"}` | |
| 80 | +| baseURL | String | Yes | `null` | Your Jamf instance domain. | `https://yourServer.jamfcloud.com` | |
| 81 | +| clientID | Boolean | No | `null` | Client ID generated from the JAMF platform. | | |
| 82 | +| clientSecret | String | No | `null` | Client Secret generated from the Jamf platform. | | |
| 83 | +| pollingInterval | String | No | 24 hours | This sets how often the Source checks for data. | `24 Hours` | |
| 84 | + |
| 85 | +### JSON example |
| 86 | + |
| 87 | +<CodeBlock language="json">{MyComponentSource}</CodeBlock> |
| 88 | + |
| 89 | +[Download example](/files/c2c/jamf/example.json) |
| 90 | + |
| 91 | +### Terraform example |
| 92 | + |
| 93 | +<CodeBlock language="json">{TerraformExample}</CodeBlock> |
| 94 | + |
| 95 | +[Download example](/files/c2c/jamf/example.tf) |
0 commit comments