You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/cisco-meraki-source.md
+36-12Lines changed: 36 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -83,7 +83,7 @@ Sources can be configured using UTF-8 encoded JSON files with the Collector Ma
83
83
| sourceType | String |`"Universal"`| Yes | Type of source. |
84
84
| config | JSON Object |[Configuration object](#configuration-object)| Yes | Source type specific values. |
85
85
86
-
### Configuration Object
86
+
### Configuration object
87
87
88
88
| Parameter | Type | Required | Default | Description | Example |
89
89
|:--|:--|:--|:--|:--|:--|
@@ -103,18 +103,42 @@ Sources can be configured using UTF-8 encoded JSON files with the Collector Ma
103
103
| infraPollingInterval | Integer | No | 24 | This sets how often the Source checks for organization and network info (in hours). ||
104
104
105
105
## Troubleshooting
106
-
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.
107
-
108
-
```json
109
-
{
110
-
"state": "Error",
111
-
"errorType": "THIRD-PARTY-CONFIG",
112
-
"errorCode": 400,
113
-
"errorInfo": "meraki '/api/v1/organizations/orgIdInput' not found using API key"
114
-
}
115
-
```
116
106
117
-
### Known Issues
107
+
* You may receive the following error 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.
108
+
109
+
```json
110
+
{
111
+
"state": "Error",
112
+
"errorType": "THIRD-PARTY-GENERIC",
113
+
"errorCode": 400,
114
+
"errorInfo": "meraki '/api/v1/organizations/orgIdInput' not found using API key"
115
+
}
116
+
```
117
+
118
+
* The following error occurs when the Cisco Meraki API returns a 401 Unauthorized response with the message `Invalid API key`. It indicates that the API key configured in the Cisco Meraki Source is invalid, revoked, or does not have the required permissions. To resolve this issue, verify that you are using the correct and active API key generated from the [Cisco Meraki Dashboard](https://dashboard.meraki.com/) by navigating to **My Profile → API access → Generate new API key**.
119
+
120
+
```json
121
+
{
122
+
"state": "Error",
123
+
"errorType": "THIRD-PARTY-GENERIC",
124
+
"errorCode": 401,
125
+
"errorInfo": "cisco meraki api response 401 Unauthorized: {\"errors\":[\"Invalid API key\"]}"
126
+
}
127
+
```
128
+
129
+
* The following error occurs when the API call to Cisco Meraki fails because the Meraki organization or network associated with the API key does not have a valid license. API access is available only for actively licensed Meraki organizations, and the issue may occur if the organization’s license has expired or if the API key is associated with an unlicensed or trial organization. In this case, visit the [Cisco Meraki Dashboard](https://dashboard.meraki.com/) and check the license status under **Organization → Configure → License info**.
130
+
131
+
```json
132
+
{
133
+
"state": "Error",
134
+
"errorType": "THIRD-PARTY-GENERIC",
135
+
"errorCode": 403,
136
+
"errorInfo": "cisco meraki api response 403 Forbidden: {\"errors\":[\"Meraki API services are available for licensed Meraki devices only. Please contact Meraki support. To renew your licenses, go to 'https://n136.meraki.com/o/s78Gsdic/manage/dashboard/license_info'\"]}"
137
+
}
138
+
```
139
+
140
+
### Known issues
141
+
118
142
* The integration will return an error containing the text `context deadline exceeded (Client.Timeout or context cancellation while reading body)`. This error occurs when the integration is reading the HTTP body, but reaches our timeout which is currently set to 10 minutes. We have observed this behavior across multiple customers when the integration is fetching data from the [Get Network Wireless Air Marshal](https://developer.cisco.com/meraki/api-v1/#!get-network-wireless-air-marshal) endpoint. Increasing the timeout does not appear to solve the issue as the network connection to this specific endpoint will occasionally never complete. Sumo Logic recommends customers contact Cisco Meraki support if they encounter this error.
119
143
* Pagination has a rare occurrence to potentially return a small number duplicate logs. This issue has been reported to Cisco.
120
144
* The Cisco Meraki API has a [rate limit](https://developer.cisco.com/meraki/api-latest/#!rate-limit) of 10 API calls every second. The source can have a collection delay if your Meraki organization has thousands of networks with many product types. The Cisco Meraki API for collecting network events requires one API call per network, per product type. There are a total of 6 product types. The API also requires one API call per network for collecting wireless Air Marshal events. This means 2,000 networks can be around 14,000 API calls (2000*6+2000) to retrieve network events, assuming no pagination is needed. At the rate limit of 10 API calls per second, the quickest we could make API calls is around 24 mins. Occasionally, the Cisco Meraki API can take 1 to 2 seconds to respond, which adds to the time. To solve this issue, Cisco would need to raise the API rate limit or provide an API endpoint for collecting [network events](https://developer.cisco.com/meraki/api-v1/#!get-network-events) and [wireless Air Marshal](https://developer.cisco.com/meraki/api-v1/#!get-network-wireless-air-marshal) events, without the requirement to iterate over each network and product type individually.
0 commit comments