Skip to content

Commit 3aee3d9

Browse files
priyansh-sumojpipkin1amee-sumo
authored
CONN-5140: Updated Document for Network Traffic Endpoint (#5761)
* CONN-5140: updated document for network traffic endpoint * Fixed grammar. Co-authored-by: John Pipkin (Sumo Logic) <[email protected]> * Update cisco-meraki-source.md * Update cisco-meraki-source.md --------- Co-authored-by: John Pipkin (Sumo Logic) <[email protected]> Co-authored-by: Amee Lepcha <[email protected]>
1 parent dd0b3b8 commit 3aee3d9

File tree

1 file changed

+34
-21
lines changed

1 file changed

+34
-21
lines changed

docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/cisco-meraki-source.md

Lines changed: 34 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,14 @@ The Cisco Meraki Source provides a secure endpoint to receive data from the Mer
1515
## Data collected
1616

1717
| Polling Interval | Data |
18-
|:------------------|:----------------------------------------------|
19-
| Every 12 Hours | [Get Organizations](https://developer.cisco.com/meraki/api-latest/#!get-organizations) |
20-
| Every 12 Hours | [Get Organization Networks](https://developer.cisco.com/meraki/api-latest/#!get-organization-networks) |
21-
| Every 15 Minutes | [Get Organization Appliance Security Events](https://developer.cisco.com/meraki/api-v1/#!get-organization-appliance-security-events) |
22-
| Every 15 Minutes | [Get Organization Configuration Changes](https://developer.cisco.com/meraki/api-v1/#!get-organization-configuration-changes) |
23-
| Every 15 Minutes | [Get Network Events](https://developer.cisco.com/meraki/api-v1/#!get-network-events) |
24-
| Every 15 Minutes | [Get Network Wireless Air Marshal](https://developer.cisco.com/meraki/api-v1/#!get-network-wireless-air-marshal) |
18+
|:--|:--|
19+
| Every 12 Hours | [Get Organizations](https://developer.cisco.com/meraki/api-latest/#!get-organizations) |
20+
| Every 12 Hours | [Get Organization Networks](https://developer.cisco.com/meraki/api-latest/#!get-organization-networks) |
21+
| Every 15 Minutes | [Get Organization Appliance Security Events](https://developer.cisco.com/meraki/api-v1/#!get-organization-appliance-security-events) |
22+
| Every 15 Minutes | [Get Organization Configuration Changes](https://developer.cisco.com/meraki/api-v1/#!get-organization-configuration-changes) |
23+
| Every 15 Minutes | [Get Network Events](https://developer.cisco.com/meraki/api-v1/#!get-network-events) |
24+
| Every 15 Minutes | [Get Network Wireless Air Marshal](https://developer.cisco.com/meraki/api-v1/#!get-network-wireless-air-marshal) |
25+
| Every 15 Minutes | [Get Network Traffic Events](https://developer.cisco.com/meraki/api-v1/get-network-traffic/) |
2526

2627
## Setup
2728

@@ -52,19 +53,25 @@ When you create an Cisco Meraki Source, you add it to a Hosted Collector. Before
5253

5354
To configure Cisco Meraki Source:
5455
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 main menu select **Data Management**, and then under **Data Collection** select **Collection**. You can also click the **Go To...** menu at the top of the screen and select **Collection**.
55-
1. On the Collectors page, click **Add Source** next to a **Hosted Collector**.
56-
1. Search for and select **Cisco Meraki**.
57-
1. Enter a **Name** to display for the Source in the Sumo Logic web application. The description is optional.
58-
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`.
59-
1. (Optional) **Fields.** Click the **+Add Field** link to define the fields you want to associate. Each field needs a name (key) and value.
56+
2. On the Collectors page, click **Add Source** next to a **Hosted Collector**.
57+
3. Search for and select **Cisco Meraki**.
58+
4. Enter a **Name** to display for the Source in the Sumo Logic web application. The description is optional.
59+
5. (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`.
60+
6. (Optional) **Fields.** Click the **+Add Field** link to define the fields you want to associate. Each field needs a name (key) and value.
6061
* <img src={useBaseUrl('img/reuse/green-check-circle.png')} alt="green check circle.png" width="20"/> A green circle with a checkmark is shown when the field exists in the Fields table schema.
6162
* <img src={useBaseUrl('img/reuse/orange-exclamation-point.png')} alt="orange exclamation point.png" width="20"/> An orange triangle with an exclamation point is shown when the field doesn't exist in the Fields table schema. In this case, you'll see an option to automatically add or enable the nonexistent fields to the Fields table schema. If a field is sent to Sumo Logic but isn’t present or enabled in the schema, it’s ignored and marked as **Dropped**.
62-
1. **Base URL**. It refers to the default URL where your Meraki account is hosted. If you are located in China, you have the option to modify the base URL.
63-
1. **API Key**. Provide the API key you generated from your Meraki account.
64-
1. **Meraki Organization ID**. Provide the numeric Meraki organization ID of the Meraki org you want to collect data from. You can only provide one ID. Please create multiple sources for multiple Meraki organizations.
65-
1. **Network Event Collection**. Enable or disable this option to collect information about your Meraki Networks, their network events, and wireless Air Marshal events.
66-
1. (Optional) The **Polling Interval** is set to 300 seconds by default, you can adjust it based on your needs.
67-
1. When you are finished configuring the Source, click **Save**.
63+
7. **Base URL**. It refers to the default URL where your Meraki account is hosted. If you are located in China, you have the option to modify the base URL.
64+
8. **API Key**. Provide the [API key](#vendor-configuration) you generated from your Meraki account.
65+
9. **Meraki Organization ID**. Provide the numeric [Meraki organization ID](#vendor-configuration) of the Meraki org you want to collect data from. You can only provide one ID. Please create multiple sources for multiple Meraki organizations.
66+
10. **API Collection**. Choose the APIs below to collect data. Organization and Network details are fetched by default.
67+
- **Security Event Collection**
68+
- **Organization Configuration Changes Collection**
69+
- **Network Wireless Air Marshal Events Collection**
70+
- **Network Event Collection**
71+
- **Network Traffic Event Collection**
72+
11. (Optional) The **Polling Interval** is set to 900 seconds by default. You can adjust this value as needed.
73+
12. (Optional) The **Infra Polling Interval** is set to 24 hours by default. You can adjust this value as needed.
74+
13. When you are finished configuring the Source, click **Save**.
6875

6976
## JSON schema
7077

@@ -85,9 +92,15 @@ Sources can be configured using UTF-8 encoded JSON files with the Collector Ma
8592
| 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"`
8693
| 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"}` |
8794
| baseURL | String | Yes | `null` | Region URL of the Cisco Meraki application. | |
88-
| apiSecretKey | String | Yes | `null` | Cisco Meraki API secret key. | |
89-
| merakiOrg | String | Yes | `null` | Cisco Meraki Organization ID. | |
90-
| pollingInterval | Integer | No | 300 | This sets how often the Source checks for new data. | |
95+
| apiKey | String | Yes | `null` | Cisco Meraki API secret key used for authentication. | |
96+
| organizationID | String | Yes | `null` | Cisco Meraki Organization ID you want to collect events from. | |
97+
| collectSecurityEvents | Boolean | No | `True` | Specify if you need to collect the security events. | |
98+
| collectOrgConfigChangesEvents | Boolean | No | `True` | Specify if you need to collect the organization config changes events. | |
99+
| collectAirMarshalEvents | Boolean | No | `True` | Specify if you need to collect the wireless air marshal events. | |
100+
| collectNetworkEvents | Boolean | No | `True` | Specify if you need to collect the network events. | |
101+
| collectNetworkTrafficEvents | Boolean | No | `True` | Specify if you need to collect the network traffic events. | |
102+
| pollingInterval | Integer | No | 900 | This sets how often the Source checks for new data. | |
103+
| infraPollingInterval | Integer | No | 24 | This sets how often the Source checks for organization and network info (in hours). | |
91104

92105
## Troubleshooting
93106
You may receive the follow error below if you enter an invalid Cisco Meraki organization ID in your configuration. Please follow the steps in the section [Gather Meraki Organization IDs](#gather-meraki-organization-ids) to ensure you are using an ID for a Meraki organization returned in that query.

0 commit comments

Comments
 (0)