|
| 1 | +--- |
| 2 | +id: automox-source |
| 3 | +title: Automox Source |
| 4 | +sidebar_label: Automox |
| 5 | +tags: |
| 6 | + - cloud-to-cloud |
| 7 | + - automox |
| 8 | +description: The Automox Source provides a secure endpoint to receive all events objects, audit trail events, and device inventory details from the Automox platform. |
| 9 | +--- |
| 10 | + |
| 11 | +import CodeBlock from '@theme/CodeBlock'; |
| 12 | +import ExampleJSON from '/files/c2c/automox/example.json'; |
| 13 | +import MyComponentSource from '!!raw-loader!/files/c2c/automox/example.json'; |
| 14 | +import TerraformExample from '!!raw-loader!/files/c2c/automox/example.tf'; |
| 15 | +import ForwardToSiem from '/docs/reuse/forward-to-siem.md'; |
| 16 | +import useBaseUrl from '@docusaurus/useBaseUrl'; |
| 17 | + |
| 18 | +<img src={useBaseUrl('img/send-data/automox-logo.png')} alt="automox-logo" width="50" /> |
| 19 | + |
| 20 | +Automox is a cloud-based platform for automated IT operations, offering patching, software deployment, and configuration management across Windows, macOS, and Linux devices. It enhances security by automating vulnerability remediation and ensuring systems stay up-to-date. |
| 21 | + |
| 22 | +## Data collected |
| 23 | + |
| 24 | +| Polling Interval | Data | |
| 25 | +| :--- | :--- | |
| 26 | +| 5 min | [Events Details](https://developer.automox.com/openapi/axconsole/operation/getEvents/#tag/Events/operation/getEvents) | |
| 27 | +| 12 hours | [List Devices](https://developer.automox.com/openapi/axconsole/operation/getDevices/#tag/Devices/operation/getDevices) | |
| 28 | +| 5 min | [Audit Details](https://developer.automox.com/openapi/audit-trail/operation/getAuditEvents/#tag/Audit-Trail/operation/getAuditEvents) | |
| 29 | + |
| 30 | +## Setup |
| 31 | + |
| 32 | +### Vendor configuration |
| 33 | + |
| 34 | +The Automox source requires you to provide the Bearer Token and Organization ID. Follow the below steps to generate the required values: |
| 35 | + |
| 36 | +- To generate the **Bearer Token**, follow the instructions mentioned in the [Automox documentation](https://support.zendesk.com/hc/en-us/articles/4408889192858-Managing-access-to-the-Zendesk-API#topic_bsw_lfg_mmb). |
| 37 | +- To generate the **Organization ID**, follow the instructions mentioned in the [Automox documentation](https://developer.automox.com/developer-portal/newbie-api-guide/#step-3-create-your-first-api-call). |
| 38 | + |
| 39 | +### Source configuration |
| 40 | + |
| 41 | +When you create a Automox 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 [Create a Hosted Collector](/docs/send-data/hosted-collectors/configure-hosted-collector). |
| 42 | + |
| 43 | +To configure a Automox Source: |
| 44 | +1. [**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu, select **Manage Data > Collection > Collection**. <br/>[**New UI**](/docs/get-started/sumo-logic-ui). 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**. |
| 45 | +1. On the Collectors page, click **Add Source** next to a Hosted Collector. |
| 46 | +1. Search for and select **Automox**. |
| 47 | +1. Enter a **Name** for the Source. The **description** is optional. |
| 48 | +1. (Optional) For **Source Category**, enter any string to tag the output collected from the Source. Category [metadata](/docs/search/get-started-with-search/search-basics/built-in-metadata) is stored in a searchable field called `_sourceCategory`. |
| 49 | +1. (Optional) **Fields**. Click the **+Add** link to add custom log metadata [Fields](/docs/manage/fields). |
| 50 | + * Define the fields you want to associate, each field needs a name (key) and value. |
| 51 | + *  A green circle with a check mark is shown when the field exists and is enabled in the Fields table schema. |
| 52 | + *  An orange triangle with an exclamation point is shown when the field doesn't exist, or is disabled, in the Fields table schema. In this case, an option to automatically add or enable the nonexistent fields to the Fields table schema is provided. If a field is sent to Sumo that does not exist in the Fields schema or is disabled it is ignored, known as dropped. |
| 53 | +1. In **Bearer Token**, enter the bearer token collected from the Automox platform. |
| 54 | +1. In **Organization ID**, enter the Organization ID collected from the Automox platform. |
| 55 | +1. Select the **Colleect Audit Trail Logs** checkbox to collect the audit details. |
| 56 | +1. The **Audit Trail Logs Interval** is set for 5 minutes by default. You can adjust it based on your needs. |
| 57 | +1. Select the **Colleect Events Logs** checkbox to collect the event details. Enter the supported events that you want to collect. Leaving this empty will collect all events. |
| 58 | +1. The **Event Logs Interval** is set for 5 minutes by default. You can adjust it based on your needs. |
| 59 | +1. Select the **Colleect Devices** checkbox to collect the devices list details. |
| 60 | +1. The **Devices Logs Interval** is set for 12 hours by default. You can adjust it based on your needs. |
| 61 | +1. **Processing Rules**. 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). |
| 62 | +1. When you are finished configuring the Source, click **Save**. |
| 63 | + |
| 64 | +## JSON schema |
| 65 | + |
| 66 | +Sources can be configured using UTF-8 encoded JSON files with the [Collector Management API](/docs/api/collector-management). See [Use JSON to configure Sources](/docs/send-data/use-json-configure-sources) for details. |
| 67 | + |
| 68 | +| Parameter | Type | Value | Required | Description | |
| 69 | +|:--|:--|:--|:--|:--| |
| 70 | +| schemaRef | JSON Object | `{"type":"Automox"}` | Yes | Define the specific schema type. | |
| 71 | +| sourceType | String | `"Universal"` | Yes | Type of source. | |
| 72 | +| config | JSON Object | [Configuration object](#configuration-object) | Yes | Source type specific values. | |
| 73 | + |
| 74 | +### Configuration Object |
| 75 | + |
| 76 | +| Parameter | Type | Required | Default | Description | Example | |
| 77 | +|:--|:--|:--|:--|:--|:--| |
| 78 | +| 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"` | |
| 79 | +| description | String | No | `null` | Type a description of the source. | `"Testing source"` |
| 80 | +| 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"` |
| 81 | +| 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"}` | |
| 82 | +| bearerToken | String | Yes | `null` | The bearer API token created for the account in the Automox console.| | |
| 83 | +| orgId | Integer | Yes | `null` | Specify the organization's ID from which the data needs to be pulled.| | |
| 84 | +| collectAuditTrailLogs | Boolean | No | `True` | Specifies if we need to collect the audit trail logs.| | |
| 85 | +| collectEventLogs | Boolean | No | `False` | Specifies if we need to collect the event logs.| | |
| 86 | +| collectDevices | Boolean | No | `False` | Specifies if we need to collect the data of the device.| | |
| 87 | +| eventNames | Boolean | NO | `All` | Specify the event names for which the data should be pulled.| | |
| 88 | +| pollingIntervalAuditMin | Integer | Yes | 5 minutes | Time interval (in minutes) after which the source will check for new data for API: Audit events. | | |
| 89 | +| pollingIntervalEventMin | Integer | Yes | 5 minutes | Time interval (in minutes) after which the source will check for new data for API: Event API. | | |
| 90 | +| pollingIntervalDeviceHour | Integer | Yes | 12 hours | Time interval (in hours) after which the source will check for new data for API: List All Devices.| | |
| 91 | + |
| 92 | +### JSON example |
| 93 | + |
| 94 | +<CodeBlock language="json">{MyComponentSource}</CodeBlock> |
| 95 | + |
| 96 | +<a href="/files/c2c/automox/example.json" target="_blank">Download example</a> |
| 97 | + |
| 98 | +### Terraform example |
| 99 | + |
| 100 | +<CodeBlock language="json">{TerraformExample}</CodeBlock> |
| 101 | + |
| 102 | +<a href="/files/c2c/automox/example.tf" target="_blank">Download example</a> |
| 103 | + |
| 104 | +## FAQ |
| 105 | + |
| 106 | +:::info |
| 107 | +Click [here](/docs/c2c/info) for more information about Cloud-to-Cloud sources. |
| 108 | +::: |
0 commit comments