Deployment considerations
Auvik’s Meraki integration can be configured at the global, multi-site, or individual site level. Configure the integration at the highest appropriate level when the same Meraki credentials apply to multiple Auvik sites, and then map each Meraki network to the correct site.
Meraki Dashboard API requests can be sent through either Auvik’s cloud or an Auvik Collector:
If you don’t select a collector, API requests continue to be sent through Auvik’s cloud.
If you select a collector, Auvik sends API requests through an eligible online collector available to the level where the integration is configured.
The collector doesn’t need to be deployed directly at the same level as the integration. You can select a collector shared from a higher level, provided it is available and approved at the level where the integration is configured.
When an integration is mapped to child sites, the selected collector doesn’t need to be approved separately at each child site.
For availability, the selected collector isn’t necessarily an exclusive path. If multiple Meraki integrations at the same level use different collectors, Auvik may send API requests through any of those eligible collectors. If those collectors are unavailable, Auvik may use another online, approved collector available at that level. If no eligible collector is online, the API requests fail until a collector becomes available or the integration is updated.
Changing or deleting a grandfathered Meraki integration may be irreversible. Review the current integration design before making changes.
How to generate a Meraki API key
The Meraki user generating the key must have access to all organizations and networks that Auvik will manage.
If Login IP ranges are enabled in the Meraki Dashboard, make sure the allowed list includes every address from which the integration’s API requests may originate:
If no collector is selected, allow the applicable Auvik cloud IP addresses.
If a collector is selected, allow the public IP addresses of the selected collector and any other eligible collectors that Auvik may use for automatic failover.
If multiple Meraki integrations at the same level use different collectors, API traffic may originate from any of those collectors.
Then generate the API key:
Log in to the Meraki Dashboard.
If the Dashboard contains multiple organizations, select the organization associated with the integration.
From the side navigation, hover over Organization.
Select API Key & Webhooks.
Select the API Keys and Access tab.
Select Generate API key.
Copy and securely store the API key.
How to add API credentials in Auvik
In Auvik, click Discovery in the side navigation bar.
Click the Manage Credentials tab.
Click the API Credentials tab.
Hover over Add API Credentials.
Choose Meraki.
-
Enter the following information:
Credential name
Meraki API key
Auvik Collector — Optional. Select an approved collector available at the level where you’re configuring the integration. Leave this field unselected to continue sending Meraki API requests through Auvik’s cloud.
Click Test Connection.
Click Save after the connection test succeeds.
If the controller was added from an MSP dashboard, map the Meraki networks to the appropriate Auvik client sites. If it was added from a client dashboard, select the cloud networks that should be managed.
You don’t need to approve the selected collector separately at every child site to which a Meraki network is mapped.
Configure discovery and reachability
The collector selected in the Meraki API credential is used to send requests to the Meraki Dashboard API. It doesn’t need to be the same collector responsible for discovering and monitoring devices at every mapped child site.
For proper device discovery and management, confirm that:
The subnets where Meraki devices reside are assigned to the correct Auvik sites.
The required networks are set to Scan under Discovery > Manage Networks.
A collector responsible for discovery at each site can reach the local Meraki device subnets.
Firewalls and ACLs allow the required traffic between those collectors and the devices.
Meraki devices respond to ping from the applicable site collector where required for discovery.
Managing a Meraki controller across multiple sites
When one Meraki Dashboard contains networks belonging to multiple Auvik sites, configure the API credentials once at the appropriate level and map each Meraki network to the correct Auvik site.
The collector selected for the integration only needs to be available and approved at the level where the integration is configured. It doesn’t need to be approved separately at each mapped child site. A collector shared from a higher level can also be selected if it is available to the integration owner.
Before saving the configuration, confirm that:
Each Meraki network is mapped to the intended Auvik site.
The API user has access to all required Meraki organizations and networks.
If a collector is selected, it is online and approved at the level where the integration is configured.
The public IP addresses of all possible API source collectors are allowed in Meraki when Login IP ranges are enabled.
The collectors responsible for device discovery at the mapped sites can reach the applicable devices.
The same Meraki network isn’t managed by multiple overlapping integrations.
Changing the collector used by a Meraki integration
You can update the collector associated with a Meraki credential when you want Meraki API requests to use a different collector.
Go to Discovery > Manage Credentials.
Click Edit next to the Meraki credential.
Select an approved Auvik Collector available at that level.
Click Test Connection.
If the test succeeds, click Save.
Selecting a collector identifies the preferred API path, but it doesn’t guarantee that all requests will originate from that collector. For automatic failover, Auvik may use another eligible online collector available at the level where the integration is configured.
If multiple Meraki integrations at the same level have different collectors selected, API requests may be sent through any of those collectors. Make sure Meraki Login IP ranges allow the public IP addresses of every collector that may be used.
If the selected collector is deleted or becomes unavailable and no other eligible collector is online, Meraki API requests fail until an eligible collector becomes available or the integration is updated.
Troubleshooting
No organizations or networks appear
Confirm that the Meraki API key is valid.
Confirm that the Meraki user has access to the required organizations and networks.
Test the API connection again in Auvik.
If a collector is selected, confirm that it still exists, is online, and is approved at the level where the integration is configured.
If the selected collector was deleted, select another available collector.
Review any Login IP range restrictions in the Meraki Dashboard.
If a collector is selected, confirm that the allowed list includes the public IP addresses of all collectors that may be used, including automatic fallback collectors.
If no collector is selected, confirm that the applicable Auvik cloud IP addresses are allowed.
API requests originate from a different collector
This can occur when multiple Meraki integrations at the same level have different collectors selected, or when the selected collector is unavailable. Auvik may use another eligible online collector to maintain the integration.
If Meraki Login IP ranges are enabled, add the public IP addresses of all eligible collectors to the allowed list.
The integration stopped working after a collector was removed
If the selected collector was deleted or is no longer available, Auvik attempts to use another eligible online collector at the level where the integration is configured. If no eligible collector is available, the API requests fail.
Edit the Meraki API credential and select an available approved collector, or make another eligible collector available at that level.
Legacy Meraki integrations
Existing Meraki integrations that don’t have a collector selected continue to send API requests through Auvik’s cloud. A collector isn’t automatically required.
To send API requests through a collector, edit the integration and select an approved collector available at the level where the integration is configured. The collector can be shared from a higher level and doesn’t need to be approved separately at every mapped child site.
Using collectors can distribute Meraki API traffic across public IP addresses and help reduce the effect of Meraki API rate limits in large environments.
Changing or deleting a grandfathered integration may be irreversible. Review the existing configuration before making changes.
