meraki-quick-check

Quick Meraki Dashboard API Check

Description

This script provides a quick and brief overview of the organization networks from the Meraki Dashboard API v1.

Installation

Note: This installation was done on macOS Monterey Version 12.4.

1. Clone the repository and change into new directory:

git clone https://github.com/nscon-gmbh/meraki-quick-check.git
cd meraki-quick-check

2. Create and activate virtual environment:

python3 -m venv venv
source venv/bin/activate

3. Install Python modules used in the script:

pip install -r requirements.txt

Configuration

There is no need for any further configuration. It is optional to use your Meraki API key as environment variable called "YOUR_MERAKI_API_KEY" in the script. Otherwise you will get a prompt to paste your API key during execution of the script.

Make sure to have a valid Meraki API key. Please check the Meraki Dashboard API documentation for any further information.

Usage

Run the script:

python meraki_quick_check.py

Example output:

(venv) danielkuhl@localhost meraki-quick-check % python meraki_quick_check.py 

Enter your Meraki API key: <HERE IS YOUR API KEY>

Your organization "YOUR ORG NAME" with ID 123456 includes the following networks:

╒═══════╤═════════════════╤══════════════════════╤═══════════════════════════╤════════════════════════╤════════════════════╕
│   No. │ Network Name    │ Network ID           │ Devices                   │ Clients last 24h       │ Traffic last 24h   │
╞═══════╪═════════════════╪══════════════════════╪═══════════════════════════╪════════════════════════╪════════════════════╡
│     0 │ PROD_NET        │ L_123456789012345678 │ 2 MX(s), 6 MS(s), 8 MR(s) │ 45 Online / 9 Offline  │ 123456 bytes       │
├───────┼─────────────────┼──────────────────────┼───────────────────────────┼────────────────────────┼────────────────────┤
│     1 │ TEST_NET        │ L_098765432109876543 │ 1 MX(s), 1 MS(s), 1 MR(s) │ 0 Online / 0 Offline   │ n/a                │
╘═══════╧═════════════════╧══════════════════════╧═══════════════════════════╧════════════════════════╧════════════════════╛

Known issues

There are currently no known issues. Please use GitHub Issues to open a new issue by providing a helpful description about the issue.

Getting help

In case you need any help please create an issue against this repository or reach out to the author.

Example

If you have questions, concerns, bug reports, etc., please create an issue against this repository.

Getting involved

Please get involved by giving feedback on features, fixing certain bugs, building important pieces, etc.

Author(s)

This project was written and is maintained by the following individuals:

• Daniel Kuhl [email protected]