gve_devnet_meraki_wireless_stat_reporter

prototype script to interact with the Cisco Meraki Dashboard API to monitor and report wireless network statistics into a csv file. Also contains a few script to run in a scheduled interval and also aggregate the data

Contacts

• Jorge Banegas

Solution Components

• Meraki
• MR

Prerequisites

Meraki API Keys

In order to use the Meraki API, you need to enable the API for your organization first. After enabling API access, you can generate an API key. Follow these instructions to enable API access and generate an API key:

1. Login to the Meraki dashboard
2. In the left-hand menu, navigate to Organization > Settings > Dashboard API access
3. Click on Enable access to the Cisco Meraki Dashboard API
4. Go to My Profile > API access
5. Under API access, click on Generate API key
6. Save the API key in a safe place. The API key will only be shown once for security purposes, so it is very important to take note of the key then. In case you lose the key, then you have to revoke the key and a generate a new key. Moreover, there is a limit of only two API keys per profile.

For more information on how to generate an API key, please click here.

Note: You can add your account as Full Organization Admin to your organizations by following the instructions here.

Installation/Configuration

1. Clone this repository with git clone [repository name]. To find the repository name, click the green Code button above the repository files. Then, the dropdown menu will show the https domain name. Click the copy button to the right of the domain name to get the value to replace [repository name] placeholder.

2. Edit variables inside config.py file for later use, use output_org.py to find your Meraki Organization ID. The SSID is for the channel width data point in the report.

api_key = ''
organization_id = ''  # Replace with your organization ID
ssid_name = ''

3. Set up a Python virtual environment. Make sure Python 3 is installed in your environment, and if not, you may download Python here. Once Python 3 is installed in your environment, you can activate the virtual environment with the instructions found here.
4. Install the requirements with pip3 install -r requirements.txt

Usage

To run the program once, use the command:

$ python3 main.py

To run the program at a scheduled time, use the command:

$ python3 scheduler.py

To aggregate the data hourly after using scheulder.py, use the command:

$ python3 aggregate.py

Screenshots

LICENSE

Provided under Cisco Sample Code License, for details see LICENSE

CODE_OF_CONDUCT

Our code of conduct is available here

CONTRIBUTING

See our contributing guidelines here

DISCLAIMER:

Please note: This script is meant for demo purposes only. All tools/ scripts in this repo are released for use "AS IS" without any warranties of any kind, including, but not limited to their installation, use, or performance. Any use of these scripts and tools is at your own risk. There is no guarantee that they have been through thorough testing in a comparable environment and we are not responsible for any damage or data loss incurred with their use. You are responsible for reviewing and testing any scripts you run thoroughly before use in any non-testing environment.