4.9 KiB
automation-scripts
Meraki Dashboard API automation/migration scripts in Python 3
Table of contents
- Notes
- Running scripts locally
- Running scripts in the Cisco DevNet Code Exchange development environment
- Descriptions of scripts in this repository
Notes
Here you can find Meraki Dashboard API scripts written for Python 3.
NOTE: These scripts will not run in Python 2. Make sure you are using Python 3 with the appropriate commands for your operating system. You can check your Python version with command "python --version" in Windows and "python3 --version" in Linux/Mac.
IMPORTANT NOTE: Some of the older scripts in this repository use the Meraki Dashboard API v0, which is end of life and unsupported. If you are using a script written for v0 and want it converted to v1, please raise an issue about it.
Check back from time to time, as new scripts are added and existing ones are sometimes polished and improved after initial posting. Please note that since the Meraki APIs are expanded constantly, there may be more efficient ways to complete a task than what was available when these scripts were created. For the latest info on Meraki APIs, visit: https://developer.cisco.com/meraki/whats-new/
Running scripts locally
To run scripts on your computer locally, you will need to have Python 3 installed, as well as possibly some optional modules, such as the Meraki module, Requests or PyYAML.
- For the latest version of Python 3, please visit: https://www.python.org/downloads/
- The easiest way to install optional packages is via pip: https://pypi.org/project/pip/
- Although not a requirement, many developers use Python virtual environements to run their scripts: https://docs.python.org/3/library/venv.html
The opening comments of the scripts contained in this repository will typically include an explanation of the correct syntax to run the script, as well as any required third party modules.
Many scripts support passing your Meraki Dashboard API key via an OS environment variable. The variable name used is MERAKI_DASHBOARD_API_KEY. Please refer to documentation of your operating system to configure this. Most scripts provide an alternate way to provide the key as well, such as a config file or a command line argument, in case you prefer not to modify your environment variables.
Running scripts in the Cisco DevNet Code Exchange development environment
If you run this project using the Cisco Exchange Dev environment
For some scripts, you can add Meraki API key as a parameter.
python3 tag_all_ports.py -k <api_key> -t <tag> [-o <org_name>]
[-n <network_name>] [-f <filter>] [-a <add/remove>]
For others set as an environment variable named MERAKI_DASHBOARD_API_KEY, DASHBOARD_API_ORG_ID, DASHBOARD_API_SHARD_ID
For example
export DASHBOARD_API_KEY=d03190ff333a3c7feaed89fec5b3b2529f59e8ec
You can test these scripts using Cisco Meraki Always-on sandbox with MERAKI_DASHBOARD_API_KEY
In the Cisco Exchange Dev environment, you can try with the following commands:
Install Python packages
pip install requests pyyaml pymongo pysnmp meraki
Run clientcount.py
python clientcount.py -k d03190ff333a3c7feaed89fec5b3b2529f59e8ec -o "DeLab"
Terminal output (sample)
Total unique client MAC addresses across all WLAN APs: 38
Get the license info for Meraki organization(s)
python get_license.py -k d03190ff333a3c7feaed89fec5b3b2529f59e8ec -o "DeLab"
Terminal output (sample)
License info for organization "DeLab" (ID: 681155)
Status: OK
Expiration date: Oct 13, 2024 UTC
Licensed device counts:
wireless 40
MS220-8P 9
MX65 6
MC 4
MV 9
MS220-8 1
SM 5
MX250 1
MS250-48FP 1
Get an inventory list for a specific organization or all organizations accessible by an administrator to a CSV file.
python inventorycsv.py -k d03190ff333a3c7feaed89fec5b3b2529f59e8ec -o "DeLab" -f DeLab_inventory_list.csv
Find file in Explorer > SRC
In the header of each script, you can find Usage information.
See also: Meraki Enterprise Sandbox, Meraki Small Business Sandbox