Meraki Integration ZenPack
Support
This ZenPack is developed and supported by Virtana. Enterprise support is available to Virtana customers with an active subscription or support agreement. ZenPacks are available at delivery.zenoss.com. To request more information about this or any other ZenPack, contact Virtana.
This ZenPack is developed and supported by Virtana Professional Services, and is a supplemental monitoring offering to the standard Virtana product subscription or support agreement. These are offered as separate subscriptions in order to provide initial setup, training, and ongoing compatibility and maintenance. All standard packages are renewable every 12 months from the date of purchase. Contact Virtana to request more information regarding this or any other ZenPacks.
Name
Meraki Integration ZenPack (ZenPacks.zenoss.PS.Meraki)
Version 3.7.9 Released on 2026-3-12.
About
This ZenPack provides discovery, modeling, and monitoring for Meraki network devices through the Meraki Dashboard API and SNMP Polling.
SNMP Polling can be enabled for Dashboard devices and for individual network devices if enabled and if network connectivity exists between the collector and the device.
API Polling, using a global API, is available regardless of network connectivity between Virtana and the network devices.
Prerequisites
Prerequisite | Restriction |
|---|---|
Product | Zenoss 6.0.0 or higher |
Required ZenPacks | - ZenPacks.zenoss.ZenPacklib >=2.1.0 |
| - ZenPacks.zenoss.PS.Util >=1.14.10 |
Other dependencies | None |
Sources of Data Used for this ZenPack
This ZenPack uses several sources of data for modeling and monitoring Meraki Devices. How these are used may differ between Dashboard and Network Devices.
Meraki Dashboard REST API
The Dashboard REST API is used by both the Dashboard and Network Devices for modeling and monitoring (see details in the modeler plugins and configuration sections below).
Meraki SNMP Proxy
A cloud service that aggregates data from Network Devices and provides it through a unified SNMP endpoint.
This endpoint is polled by both Dashboard (using meraki.snmp.DashboardDevices modeler) and Network Devices (using meraki.snmp.DeviceInterfaces modeler). Network Devices obtain their SNMP connection information from the zMerakiSnmpHost and zSnmpCommunity properties on the associated Dashboard Device.
Network Device SNMP
This is the traditional SNMP as used elsewhere in Virtana, where the Device's manageIp is polled directly via SNMP. Use of SNMP polling may not be possible or practical depending on the network architecture. It is expected that most use cases will not support this, but we include it as a 'best effort' to try get as much data as possible from the devices.
The zenoss.snmp.InterfaceMap modeler is included by default.
Connection information is configured with the typical zProperties on the Devices.
Network Device ICMP
The Meraki Network Devices are configured with a customized Ping monitor. Rather than monitoring the manageIp as typical with Virtana devices, this ZenPack instead monitors the IP address of each of the Uplink components.
Configuration and Adding Dashboard Devices
Add a Meraki Dashboard device in Virtana under the /Network/Meraki/Dashboard Device Class. The hostname/IP for this device is not directly used for modeling or polling, so any unique value can be set.
Each added Dashboard device monitors all Networks and Devices in a single Meraki Organization. If multiple Organizations are to be monitored, a Dashboard device will need to be added in Virtana for each.
SNMP Proxy Polling Configuration
Because the Meraki SNMP Proxy uses the same IP for multiple Organizations, each Dashboard needs to be configured for its unique SNMP settings, which are available in the Meraki Dashboard under Organization > Settings > SNMP.
Configure the zMerakiSnmpHost and zSnmpCommunity properties with these provided settings. The zMerakiSnmpHost property also specifies the port, for example, snmp.meraki.com:16100.
SNMP Polling from the Dashboard provides the following components and monitoring on the Dashboard Device:
Meraki Devices
Number of Clients
Device Status
Additionally this information is used on the Meraki Devices to model and monitor
Device Interfaces
Packet / Bytes Throughput
SNMP Traps Configuration
SNMP Trap translation is provided by the ZenPack. Configure devices to send SNMP Traps to Virtana to create Events.
API Configuration
Note
Starting in version 3.3.0, these zProperties are pulled from the corresponding Dashboard device for all end devices. The zProperties on individual devices will be ignored. This is to support changing API credentials, so that only the Dashboard device needs to be updated.
Configure the following zProperties on the Dashboard device to enable API communication:
zMerakiAPIBaseUrl: Likely defaults to 'https://api.meraki.com/api'.zMerakiAPIKey: API Key for the monitoring user.zMerakiAPIRequestRetries: The number of retries allowed if the Dashboard API rate-limiting blocks a request. An increasing backoff is applied and the request will be retried.zMerakiAPIRequestRetriesBackOffFactor: This property will be used as a minimum retry-after time in case Meraki API doesn't send Retry-After time for 429 response.
In addition, the Organization ID will need to be set (editable on the Device Overview page). If the ID is unknown, this can be left unset and the meraki.rest.Organizations modeling plugin will pull a list of the Organizations the API user can access and display them on the Dashboard Device Overview Page.
If manually adding end devices (not using the built-in discovery), then each device will also need to be configured with the organizationId and Device Serial Number.
HTTP Proxy Configuration
If an HTTP Proxy is required for communication with the Meraki Dashboard API, the following zProperties are used:
zMerakiAPIProxyHost: (Optional) Hostname or IP of the Proxy. If blank, no proxy will be configured.zMerakiAPIProxyPort: TCP Port of the Proxy. The default value is 80.zMerakiAPIProxyUser: (Optional) User name for Basic Authentication.zMerakiAPIProxyPassword: (Optional) Password for Basic Authentication.
Dashboard Devices
The following modeler plugins are provided for Dashboard Devices:
meraki.snmp.DashboardDevices: Creates Device components for Network Devices returned from the Meraki SNMP Proxy.meraki.rest.Organizations: Retrieves the list of Organizations that the configured API Key can be used to access and displays on the Dashboard Device Overview page. Note that only one Organization can be configured on each Dashboard device in VirtanazMerakiOrganizationId. This plugin allows auditing of the access provided to the user. In a shared environment, care should be taken to ensure the user is restricted to the proper Organizations.meraki.rest.NetworksAndDevices: Creates components for Networks and Network Devices reported by the Dashboard API. Upon modeling, this plugin creates devices inzMerakiDeviceClasscorresponding to devices reported in the Dashboard. Devices no longer reported by the API will be removed. If zMerakiDeviceMatchByTag is defined, any Devices with a matching tag will be modeled. Networks that match zMerakiNetworkNamesIgnore will be excluded from modeling (see Discovery configuration section for more).
Network Devices
zenoss.snmp.InterfaceMap: If SNMP is configured, this plugin creates and monitors network interfaces on the Device.meraki.rest.Device: Models and monitors the following Device properties with the API. These display on the Device Overview page:namenetworkNameorganizationNamelanIpmacmodelnotesNote
nameis mapped to the Virtana device Title - if the device name is set in Meraki then this will override the Title set on the device.
meraki.rest.DeviceUplinks: Model and monitor the Uplinks available on the Device with the API. Models both Uplinks (physical links) and Cellular Uplinks.meraki.snmp.DeviceInterfaces: Creates Device Interface components as reported by the Meraki SNMP Proxy. These components are polled using the SNMP settings configured on the Dashboard Device.
There is also a speed attribute on the DeviceInterface components. This is a user-editable attribute provided for convenience in tracking the available speed of links for use in reporting, but must be manually set by the customer as this information is not available in the Meraki API.
Dashboard Devices
Meraki Dashboard SNMP Proxy
merakiDevTemplate: Monitors the 'Device' components on the Dashboard device.Device Status
Client Count
Dashboard API
The merakiNetworkDevTemplate monitors the 'Network Device' components on the Dashboard device.
Status events are unique because they can be opened against two possible entities, depending on the environment's modeling scheme. When a Meraki Network Device status event is generated, the system first attempts to find a device with a matching serial number.
If a match is found, the status event is created against the matched device.
If no match is found, the status event is created against the component.
Note
As of version 3.7.8, Meraki Network Device status events are generated only when the status value changes. Prior to this version, the status event's occurrence attribute would increment during each poll cycle if the device had an unacceptable value.
Network Devices
SNMP (direct to devices, if enabled)
zenoss.snmp.InterfaceMapModeler plugin can be enabled to model and monitor Network Interfaces if direct SNMP polling is supported. Meraki Dashboard SNMP ProxymerakiDevInterfaceTemplate: Monitors Device Interface components from the Meraki SNMP Proxy. Note this uses the SNMP connection settings from the associated Dashboard device.
Dashboard API
merakiDeviceLatency: This template monitors Uplink components. Latency and Loss metrics are monitored with the API. If no metrics are reported for an Uplink, it is considered to be in an invalid state and an event is created with the 'merakiUplinkLatency' eventClassKey. The values will be the average across all destination IPs.merakiCellularUplink: Template for monitoring Cellular Uplinks. Monitors Ping RTT (with ICMP as mentioned below), Latency, Loss, Status, andsignalStatmetrics (rsrp, rsrq) from the API. The default template raises an event for any Status other than 'Ready'.
ICMP
Monitors Ping RTT with ICMP for Uplinks with an assigned IP address. Note that this uses a custom monitor which ignores
zPingMonitorIgnore. UsezPythonPingMonitorIgnoreto disable Ping monitoring instead.
Discovery
Discovery of Meraki Network Devices is provided by the meraki.rest.NetworksAndDevices plugin on the Dashboard device.
The following zProperties control discovery behavior:
zMerakiDeviceClass: Device Class in Virtana where newly discovered Meraki Devices will be added. The default (/Network/Meraki/Device) works, but a custom sub-class is recommended for customized monitoring templates.zMerakiDeviceClassMapping: A list of mappings from device Model prefix to Device Class for newly discovered Devices. These model-specific mappings override thezMerakiDeviceClassdefault.zMerakiCreateDevices: Whether to create new Meraki Network Devices discovered through the Dashboard API by themeraki.rest.NetworksAndDevicesmodeler plugin.zMerakiRemoveDevices: Whether to remove Meraki Network Devices that are no longer reported by the Dashboard API.zMerakiSkipDeviceIps: If set, the device's Lan IP address is not added to the newly created device. This leavesmanageIpunset, disabling SNMP and ICMP modeling/monitoring, but API monitoring will still function. Useful for networks where network space may overlap and IP address conflicts exist.zMerakiNetworkNamesIgnore: When modeling Networks from the Dashboard, any Network Names that match a regex provided in this zProperty will not be modeled. Any devices in these Networks will also be excluded.zMerakiDeviceMatchByTag: When modeling Network Devices from the Dashboard, any Network Devices with tags that match one of defined values in this zProperty will be modeled.zMerakiDefaultProdState: The default Production State to assign to created devices. Note: This is not automatically updated after creation; devices created with a non-production state will require a separate workflow to update them to production.zMerakiAgentConnectTimeout: The time (in seconds) the HTTP Agent will wait for the peer to accept a connection.zMerakiAgentPoolMaxPersistentConnections: The maximum number of cached persistent connections for a host. Must be set only at the /Network/Meraki device class.zMerakiAgentPoolCachedConnectionTimeout: Number of seconds a cached persistent connection will stay open before disconnecting. Must be set only at the /Network/Meraki device class.zMerakiClientCacheTTL: The time (in seconds) the Client will store cached data. Recommended to set the same for all devices belonging to a single organization.zMerakiAllDeviceStatusRefresh: The cycle time (in hours) to perform a status refresh of all Meraki Network Devices.
Note
To apply new zMerakiClientCacheTTL, zMerakiAgentPoolMaxPersistentConnections, and zMerakiAgentPoolCachedConnectionTimeout values, the zenpython service needs to be restarted.
The Device Class used for new Devices is controlled by zMerakiDeviceClass and zMerakiDeviceClassMapping. If the Products Model matches a prefix in zMerakiDeviceClassMapping, the corresponding Device Class will be used. If a matching prefix is not found, the class in zMerakiDeviceClass will be used.
For example, MS:/Network/Meraki/Device/Switch will place MS-120-8 Devices in /Network/Meraki/Device/Switch.
MS:/Network/Meraki/Device/Switch
Events are created on the Dashboard device in Virtana for auditing new or removed Devices, using the eventClassKeys MerakiDeviceAdded and MerakiDeviceRemoved.
These devices will then perform SNMP polling (if configured) and their own API modeling and monitoring. Devices removed from the Meraki Network are automatically removed from Virtana during modeling (unless disabled with zMerakiRemoveDevices).
Scaling Limitations
The Meraki Dashboard API enforces a rate limit of 5 requests per second. To handle this limitation, requests from Virtana are deduplicated and cached as appropriate to minimize the total number of requests. Where available, requests for device aggregated data are used to avoid separate requests per Device.
The update to the Dashboard v1 API reduces the total number of requests needed to gather information, as endpoints now aggregate data from multiple devices. However, very large Meraki organizations may still encounter rate-limiting-related issues. Further, if there are other systems also querying the Meraki API, these will consume additional available requests as rate-limiting is enforced on a per-organization basis.
It may be necessary to reduce the cycleTime of template datasources if ongoing issues are noticed (events will be raised warning of the failures).
Example Configuration - Monitoring the Cisco DevNet Sandbox
This example monitors the 'Meraki Always On' Sandbox Lab at https://devnetsandbox.cisco.com/ (credentials may change, log in to confirm current settings).
Add a Dashboard Device under /Network/Meraki/Dashboard.
Since this lab lacks SNMP support, the IP or hostname does not matter.
Title:
Meraki DevNetzMerakiAPIKey:6bec40cf957de430a6f1f2baa056b99a4fac9ea0zMerakiOrganizationId:549236
Model the Device.
New Devices should appear under /Network/Meraki/Device and in the System Organizer 'Meraki'.
Model the new Devices; since SNMP is disabled, only Uplink components will be available for monitoring.
Common Troubleshooting Tips
SNMP Agent Down Events: Meraki Device classes include
zenoss.snmp.DeviceMapandzenoss.snmp.InterfaceMapby default. If the Devices are not reachable from the collector, for example, when monitoring remote branches, these plugins can be disabled.SNMP Timeout errors: The Meraki SNMP proxy may occasionally timeout; increasing
zSnmpTimeoutcan help.Dashboard SNMP issues: SNMP polling on dashboards uses a custom zProperty. Make sure to set up the zProps as detailed under "SNMP Proxy Polling Configuration" above.
Modeler Plugins
• zenoss.snmp.DeviceMap
• zenoss.snmp.InterfaceMap
• meraki.rest.Device
• meraki.rest.DeviceUplinks
• meraki.snmp.DeviceInterfacesComponents Modeled
• Network Device
• Network
• Meraki Device
• Cellular Uplink
• (merakiDev)MerakiDevInterface
• Device Interface
• UplinkDevice Class Templates
Devices/Network/Meraki/Dashboard
• merakiNetworkDevTemplate
• merakiDevTemplate
– Graphs
* Status
* Clients
– Datapoints
* devMeshStatus
* devStatus
* devClientCountDevices/Network/Meraki/Device
• merakiDevInterfaceTemplate
– Graphs
* Packets
* Throughput
– Datapoints
* ddevInterfaceRecvBytes
* ddevInterfaceRecvPkts
* devInterfaceSentPkts
* devInterfaceSentBytesDevices/Network/Meraki
• merakiDeviceLatency
– Graphs
* Latency
* Loss
– Datapoints
* latency
* loss
• merakiCellularUplink
– Graphs
* Cellular RSRP
* Cellular RSRQ
– Datapoints
* rsrp
* rsrq
• merakiPingStatus
– Graphs
* Ping RTT
– Datapoints
* rttChangelog
3.7.9
Feature
SVC-4078: Add a periodic status refresh for all Meraki Network Devices
SVC-4079: Update Meraki Device Status monitoring, lookup event device by Meraki serial number
3.7.8
Features
SVC-4002: Move away from deprecated Meraki API endpoint; getOrganizationDevicesStatuses (https://developer.cisco.com/meraki/api-v1/deprecated-operations/#2024-october) Changes the behavior of Meraki Network Device status polling, Events only generate when status changes.
SVC-4058: New zMerakiDeviceMatchByTag, discover Network devices by Meraki Tag
3.7.7
Fixes
SVC-4034: Meraki Device Uplink components, handle empty or null value API metric results
3.7.6
Fixes
SVC-4020: Update Meraki Device Uplink component logic, average latency & loss values for all Destination IPs
3.7.5
Fixes
SVC-4013: Move "not reporting" status events to collecting failure events
3.7.4
Fixes
SVC-3998:
Add more info to "Device not found in reults" event messaging
DeviceDiscoveryjob, add unsync'ed catalog errors on device removalUpdate rate-limiting logic that is potentially causing missed metric polling
3.7.3
Fixes
SVC-3934: Performance fixes
SVC-3934: Redis connection logic fix
SVC-3934: Move polling & modeling error events out of
/Status/event classes
3.7.2
Removed from distribution due to performance limitations at scale
3.7.1
Fixes
SVC-3929: Revert certificate validation checking
3.7.0
Features
ZPS-7862: API client over-haul, limit API request to a single fetch per poll cycle across collector
ZPS-7862: API client over-haul, API responses cached & available to all instances across collector
Fixes
ZPS-7862: Clean-up and make polling error events clearer in their messaging
ZPS-7862: Clean-up and simplification pass with Datasource & Modeler plugins
3.6.3
Features
SVC-3776: Update to support internal jobs updates
3.6.2
Features
SVC-3534: add setProductKey to modeler
3.6.1
Fixes
ZPS-8483: Client requests for NetworkDevices and DeviceUplinks collect paginated results.
3.6.0
Fixes
Reduce the occurrence and fix the event message for Intermittent Twisted Connection Lost Errors / Events
3.5.2
Fixes
Updated twisted client to use HTTP Connection Pool
Added client cache and agent timeouts to configurations
Added a millisecond wait before returning Client cache
3.5.1
Fixes
Remove default Device SNMP
sysUpTimetemplate for Dashboard Devices
3.5.0
Features
Add
zMerakiDefaultProdState
Fixes
Unicode encoding breaks ConfigurationManager integration.
Some devices mapped to wrong Network in Systems organizers.
Fix
DeviceUplinksmodeler skipped when Organization has no Uplinks on any devices.
3.4.2
Fixes
Fix some requests caching to invalid Url, effectively skipping caching.
3.4.1
Fixes
Fix DeviceUplinks modeler processing skipped if no Device results.
3.4.0
Features
Increase internal response cache from 180 Seconds to 290 seconds (just under 5 minute cycle).
Fixes
DeviceUplinks modeler previously would not update if there were no components, leaving any prior found components (especially an issue on Switch and Access Point devices which don't have Uplinks in Dashboard API v1).
3.3.0
Features
Remove Latency and Loss monitoring from Cellular components - data not provided in API.
Pull API connection details from Dashboard device, not end devices.
API Client queueing update - previously API Requests from all Organizations shared the same queue, giving larger organizations more access since more devices added more tasks to the same queue. Now ensure equal access for all organizations to minimize the impact of a single large organization with failing requests blocking the queue with retries.
Fix traceback in MerakiUplinkStatusDataSourcePlugin when missing Uplink data.
3.2.0
Features
Enable
merakiUplinkStatusstatus monitoring template for 'Uplink' components.Add the /Network/Meraki/Device/Teleworker device class for Z series Gateways (the new default mapping adds 'Z:/Network/Meraki/Device/Teleworker' but will not affect existing installs).
Fixes
Fix tracebacks in Cellular Uplink monitoring when missing some fields in API.
Remove Ping monitoring from Cellular Uplinks by default (the
merakiPingStatustemplate can be added where needed).
3.1.0
Features
Add
zMerakiNetworkNamesIgnoreto ignore Networks by Names.Add Cellular Uplink components and monitoring.
Fixes
Fix missing pagination in requests leading to missing components / monitoring.
3.0.0
Features
Switch to Dashboard API v1 endpoints.
Remove
networkTypemodeled attribute, no longer present in API.Default Device ID no longer includes network name as device may be moved between networks.
2.2.0
Fixes
Missing
devMaccauses a traceback in modeler.MerakiUplinkLatencyDataSourcePlugin- separate events for missing datapoints and polling issues.
2.1.2
Fixes
Fix "NotFound is not defined" error when running jobs
2.1.1
Fixes
Index devices on creation to add to Catalog
2.1.0
Features
Add
speedattribute to Device Interface components for manual tracking.
2.0.0
Features
The Device Interfaces component is moved from the Dashboard Devices to the Network Devices. Existing components on Dashboards may remain to preserve historical data but will no longer be modeled or monitored and may need manual deletion if no longer needed.
1.7.1
Fixes
Move Device Status event to /Status/Meraki/Device since events in /Status/Ping disable monitoring.
1.7.0
Fixes
Move Device Status event to /Status/Ping to provide availability for reporting.
1.6.0
Fixes
Add missing eventClass mappings causing events in /Unknown class.
Allow editing CycleTime in datasources.
Include snmpindex in component details to be accessible through the API.
Add
zMerakiSkipDeviceIpsto allow creating devices withoutmanageIPs.Update
UplinkStatusmonitoring to not use a separate API call, but derive from Latency monitoring status.
1.5.0
Features
Add HTTP Proxy support
1.4.3
Features
Improved logging details for missing
lanIpon devices.
1.4.2
Fixes
Add migration to rebuild device relations.
1.4.1
Fixes
Remove port from
zMerakiSnmpHostdefault - usezSnmpPortinstead'Ready' is a valid status for
merakiUplinkStatusRelationship for
MerakiDevInterfacetoMerakiDevice
1.4.0
Features
Add
zMerakiSnmpHostto override SNMP connection IP to connect to Meraki proxy.Now requires
ZenPacks.zenoss.PS.Util >= 1.7.0.
1.3.0
Features
Add Uplink Ping Monitoring DataSource
Model Meraki Device Name in
meraki.rest.DeviceNow requires
ZenPacks.zenoss.PS.Util >= 1.3.0
1.2.0
Features
Disable Ping based monitoring by default, use device status from Meraki API.
Split
DeviceClassesbased onzMerakiDeviceClassMapping.
1.1.1
Fixes
Fix catalog load to create missing index.
1.1.0
Features
Remove the
zMerakiOrganizationIdzProperty, replace with a Device property and add to the Device Overview page.Discovery no longer depends on Device ID so that Devices can be created manually or the ID changed.
Use the Device Name from the Meraki API for Device Title
Update Device and Uplink Status Templates to set Event Class and Severity