Meraki Automated Port Monitoring Prototype

The Prototype solution was built to demonstrate the "Art of Possible" around the following use-cases:

Provide and "Easy-to-Use" Dashboard for first-level staff to configure Meraki Switchports.
Enable an Organization-wide, Automated, Notification system to monitor Switchports that meet the defined criteria.

Contacts

Alex Hoecht
Jason Mah

Solution Components

Python3
SQLite Database
Flask Web-Application framework
Cisco UI Kit
Meraki Dashboard API
Cisco Webex API

Dependencies/Environment

Required Packages

Flask (pip install Flask)
Requests (pip install requests)
Click (pip install click)
Schedule (pip install schedule)

# Create a Virtual Environment
python3 -m venv Virtual_Environment

# Activate Virtual Environment
source Virtual_Environment/bin/activate # (MacOS)
Virtual_Environment/Scripts/activate # (Windows)

# Install Dependencies
pip install -r requirements.txt

Starting the Application

Once Dependencies are installed to Environment:

# Setup Flask application
export FLASK_APP=src # (MacOS)
set FLASK_APP=src # (Windows Command Prompt)
$env:FLASK_APP = "src" # (Windows PowerShell)

# Enable Development Features
export FLASK_ENV=development

# Start Application
flask run

Documentation

User Interface (Dashboard)

High-Level Diagram

Developer Resources

Meraki API Reference - See Docs
Flask Application Framework - See Docs
Python Job Scheduling - See Docs
Webex Messages - See Docs
Webex Message Formatting - See Docs
Create a Webex Bot - See Docs

LICENSE

Provided under Cisco Sample Code License, for details see here

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.