Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dexterlabora/cmxreceiver-python
A Cisco Meraki CMX receiver based on Python with Flask
https://github.com/dexterlabora/cmxreceiver-python
Last synced: 3 months ago
JSON representation
A Cisco Meraki CMX receiver based on Python with Flask
- Host: GitHub
- URL: https://github.com/dexterlabora/cmxreceiver-python
- Owner: dexterlabora
- License: apache-2.0
- Created: 2016-10-12T22:50:19.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2020-09-11T08:52:26.000Z (over 4 years ago)
- Last Synced: 2024-08-03T01:13:31.639Z (6 months ago)
- Language: Python
- Size: 15.6 KB
- Stars: 13
- Watchers: 5
- Forks: 8
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-merakiapis - cmxreceiver-python - A Cisco Meraki CMX receiver based on Python with Flask. (Location / Contents)
README
### cmxreceiver-python
### A basic web service to accept CMX data from a Cisco Meraki network
- Accept a GET request from Meraki and respond with a validator
- Meraki will POST to server, if validated.
- POST will contain a secret, which can be verified by the server.
- JSON data will be in the req.body.data. This will be available in the cmxData function's data object.
*note: CMX is now called Scanning API in Meraki documentation
## cmxreceiver.py
-- The basic app will only place the data received on the console.
## cmxreceiver-mongodb.py
-- Extends the basic app by placing data into a local MongoDB database.
## Prerequisites
* Flask must be installed
http://flask.pocoo.org/docs/0.12/
* Cisco Meraki Network with CMX/Scanning API enabled and configured to point to this server
## Installation and Run
```
$ git clone <>
```
### Direct Run with Python3
* Option 1 - Basic Receiver
```
python3 cmxreceiver.py -v -s '
```
* Option 2 - Receiver with MongoDB
```
python3 cmxreceiver-mongodb.py -v -s '
```
### Via Flask
* Option 1 - Basic Receiver
```
export FLASK_APP=cmxreceiver.py -v yourValidatorKey -s yourSecret
flask run -h 0.0.0.0
* Running on http://0.0.0.0:5000/
```
* Option 2 - Receiver with MongoDB
```
export FLASK_APP=cmxreceiver-mongodb.py -v yourValidatorKey -s yourSecret
flask run -h 0.0.0.0
* Running on http://0.0.0.0:5000/
```
## Defaults
* Port: 5000
* CMX Post URL: http://yourserver:5000/
## TIP
* use ngrok to expose port 5000
```
ngrok http 5000
```
Then use the new url it creates as your base URL. `https://2a6eed03.ngrok.io/`
# Cisco Meraki CMX Location API Documentation
https://documentation.meraki.com/MR/Monitoring_and_Reporting/CMX_Analytics#CMX_Location_API
### Written by Cory Guynn
2016
http://www.InternetOfLEGO.com
http://Developers.Meraki.com