the_information_nexus/sandbox_api.md at 1b80e4efbeccda7903a55404f3f8f6eba2bfd5be

Files

medusa 1b80e4efbe Update work/tbx/meraki/sandbox_api.md

2024-06-01 05:23:06 +00:00

7.5 KiB

Raw Blame History

To help you get started with using the Meraki Dashboard API in a sandbox environment, I'll provide you with a project structure and an example script that you can use as a template. This project folder will include a sample Python script, a configuration for environment variables, and instructions for running the script.

Project Folder Structure

automation-scripts/
├── README.md
├── scripts/
│   ├── clientcount.py
│   ├── get_license.py
│   └── inventorycsv.py
├── requirements.txt
└── setup_env.sh

README.md

# Meraki Dashboard API Automation Scripts

This project contains Python scripts for automating tasks with the Meraki Dashboard API.

## Prerequisites

- Python 3.x
- Meraki API Key
- Required Python packages (listed in `requirements.txt`)

## Setup

1. Clone this repository.
2. Install the required Python packages:

    ```sh
    pip install -r requirements.txt
    ```

3. Set up your environment variables by sourcing the `setup_env.sh` file:

    ```sh
    source setup_env.sh
    ```

## Running Scripts

### Get Client Count

```sh
python scripts/clientcount.py -k $MERAKI_DASHBOARD_API_KEY -o "DeLab"

Get License Information

python scripts/get_license.py -k $MERAKI_DASHBOARD_API_KEY -o "DeLab"

Get Inventory List

python scripts/inventorycsv.py -k $MERAKI_DASHBOARD_API_KEY -o "DeLab" -f DeLab_inventory_list.csv

Notes

Make sure to check each script's usage information in the header of the script.


### requirements.txt

```txt
requests
pyyaml
pymongo
pysnmp
meraki

setup_env.sh

#!/bin/bash

# Set your Meraki API key here
export MERAKI_DASHBOARD_API_KEY="d03190ff333a3c7feaed89fec5b3b2529f59e8ec"

scripts/clientcount.py

import requests
import argparse

def get_client_count(api_key, org_name):
    base_url = 'https://api.meraki.com/api/v1'
    headers = {
        'Authorization': f'Bearer {api_key}'
    }

    # Get the list of organizations
    orgs_response = requests.get(f'{base_url}/organizations', headers=headers)
    orgs = orgs_response.json()

    # Find the organization ID for the given name
    org_id = None
    for org in orgs:
        if org['name'] == org_name:
            org_id = org['id']
            break

    if org_id is None:
        print(f'Organization {org_name} not found')
        return

    # Get the list of networks in the organization
    networks_response = requests.get(f'{base_url}/organizations/{org_id}/networks', headers=headers)
    networks = networks_response.json()

    # Count the number of unique clients across all networks
    unique_clients = set()
    for network in networks:
        network_id = network['id']
        clients_response = requests.get(f'{base_url}/networks/{network_id}/clients', headers=headers)
        clients = clients_response.json()
        for client in clients:
            unique_clients.add(client['mac'])

    print(f'Total unique client MAC addresses across all WLAN APs: {len(unique_clients)}')

if __name__ == '__main__':
    parser = argparse.ArgumentParser(description='Get client count for a Meraki organization')
    parser.add_argument('-k', '--api_key', required=True, help='Meraki API key')
    parser.add_argument('-o', '--org_name', required=True, help='Meraki organization name')
    args = parser.parse_args()
    get_client_count(args.api_key, args.org_name)

scripts/get_license.py

import requests
import argparse

def get_license_info(api_key, org_name):
    base_url = 'https://api.meraki.com/api/v1'
    headers = {
        'Authorization': f'Bearer {api_key}'
    }

    # Get the list of organizations
    orgs_response = requests.get(f'{base_url}/organizations', headers=headers)
    orgs = orgs_response.json()

    # Find the organization ID for the given name
    org_id = None
    for org in orgs:
        if org['name'] == org_name:
            org_id = org['id']
            break

    if org_id is None:
        print(f'Organization {org_name} not found')
        return

    # Get the license information for the organization
    license_response = requests.get(f'{base_url}/organizations/{org_id}/licenses', headers=headers)
    license_info = license_response.json()

    print(f'License info for organization "{org_name}" (ID: {org_id})')
    print(f'Status: {license_info["status"]}')
    print(f'Expiration date: {license_info["expirationDate"]}')
    print('Licensed device counts:')
    for license in license_info['licenses']:
        print(f'{license["productType"]}:\t{license["total"]}')

if __name__ == '__main__':
    parser = argparse.ArgumentParser(description='Get license info for a Meraki organization')
    parser.add_argument('-k', '--api_key', required=True, help='Meraki API key')
    parser.add_argument('-o', '--org_name', required=True, help='Meraki organization name')
    args = parser.parse_args()
    get_license_info(args.api_key, args.org_name)

scripts/inventorycsv.py

import requests
import csv
import argparse

def get_inventory(api_key, org_name, filename):
    base_url = 'https://api.meraki.com/api/v1'
    headers = {
        'Authorization': f'Bearer {api_key}'
    }

    # Get the list of organizations
    orgs_response = requests.get(f'{base_url}/organizations', headers=headers)
    orgs = orgs_response.json()

    # Find the organization ID for the given name
    org_id = None
    for org in orgs:
        if org['name'] == org_name:
            org_id = org['id']
            break

    if org_id is None:
        print(f'Organization {org_name} not found')
        return

    # Get the inventory for the organization
    inventory_response = requests.get(f'{base_url}/organizations/{org_id}/inventory/devices', headers=headers)
    inventory = inventory_response.json()

    # Write the inventory to a CSV file
    with open(filename, 'w', newline='') as csvfile:
        fieldnames = ['serial', 'model', 'networkId', 'mac', 'claimedAt']
        writer = csv.DictWriter(csvfile, fieldnames=fieldnames)

        writer.writeheader()
        for device in inventory:
            writer.writerow(device)

    print(f'Inventory for organization "{org_name}" saved to {filename}')

if __name__ == '__main__':
    parser = argparse.ArgumentParser(description='Get inventory for a Meraki organization')
    parser.add_argument('-k', '--api_key', required=True, help='Meraki API key')
    parser.add_argument('-o', '--org_name', required=True, help='Meraki organization name')
    parser.add_argument('-f', '--filename', required=True, help='Output CSV file')
    args = parser.parse_args()
    get_inventory(args.api_key, args.org_name, args.filename)

Instructions for Running the Project

Clone the repository:

git clone https://github.com/yourusername/automation-scripts.git
cd automation-scripts

Install required Python packages:

pip install -r requirements.txt

Set up environment variables:

source setup_env.sh

Run the scripts:

Get client count:

python scripts/clientcount.py -k $MERAKI_DASHBOARD_API_KEY -o "DeLab"

Get license information:

python scripts/get_license.py -k $MERAKI_DASHBOARD_API_KEY -o "DeLab"

Get inventory list:

python scripts/inventorycsv.py -k $MERAKI_DASHBOARD_API_KEY -o "DeLab" -f DeLab_inventory_list.csv

This setup should give you a good starting point for working with the Meraki Dashboard API in a sandbox environment. If you have any further questions or need additional examples, feel free to ask!

7.5 KiB Raw Blame History