Skip to content

Latest commit

 

History

History
137 lines (103 loc) · 8.77 KB

README.md

File metadata and controls

137 lines (103 loc) · 8.77 KB
Raw

Meraki - New Client Joined The Network Email Alert - Covene

Script

For more detailed instructions, see the two blog posts at Covene.com. This will help setup Python, your virtual environment, and getting the required data and files.

This script will utilize the Meraki API to pull network client data, then sorts the data to find clients that have a first connected date that matches todays date. It then will create a .csv file and add entries to the file each time a new client connects to the network. The script checks if the new clients csv file has increased in size (aka a new client was found), and if so it utilizes Microsoft Azure to send an email notifying you that a new client was detected. It attaches the updated .csv file.

Assumptions

  • Email Integration setup with Microsoft Azure.
    • This requires a paid account with microsoft.
    • Other third-party email servers would also be acceptable but will not be covered in this script.
    • See reference guides below for instructions on how to configure the Azure integration.
  • You want to re-run the get network clients check every x minutes. (change the variable Sleeptime=x to change how long to wait between re-tries.)

Instructions

To use this script, you will need to configure the following in Azure:

  • Communication Resource
  • Email Communication Resource
  • A Verified Domain or free azure domain.
  • Obtain and store your Azure Communication Resource URL in the script.

See the references below to review instructions on creating azure communication resources and setting up a domain. You may also use another Email solution, such as Google's Gmail.

Setup

You will need to have two environment variables configured, that store your Meraki API Key, and Azure communication resource string. In the script, the API has the following Environment Variables Named:

- API_Key
- Azure_Communication_Resource

Azure Email Settings

Organizations

If your API key has access to one organization, this script proceed automatically for that Organization.

If your API key has access to more than 1 organization, you will be prompted to select the ORG. Example:

2024-12-05 14:50:06,932 - GetBSSID - INFO - Fetching organizations...
2024-12-05 14:50:07,685 - GetBSSID - INFO - Organizations fetched successfully.

Available Organizations:
0: Blue Wave (ID: 123456)
1: Quantum .(ID: 234567)
2: Apex (ID: 345678)
3: Orion Tech (ID: 456789)
4: GreenLeaf (ID: 567890)
5: NorthStar ID: 987654321012345678)
6: Vertex (ID: 876543210987654321)
7: Horizon (ID: 123123123123123123)
8: Stellar Associates (ID: 234234234234234234)
9: Zenith Facility (ID: 345345345345345345)
Enter the number of the organization to proceed: 9
2024-12-05 14:50:12,634 - GetBSSID - INFO - Getting network IDs for organization: Zenith Facility Services (ID: 345345345345345345)
2024-12-05 14:50:13,196 - GetBSSID - INFO - Fetched networks successfully.

Networks

The GetNetworkIDs function will show the networks that it is going to pull from. You will be prompted to select which networks to include in the BSSID output. Select option 1 to include all networks. Select option 2 to select specific networks to include, separated by a comma. For example, 0,2,4,6,8. Example:

Available Networks:
0: NY - Albany (ID: L_111111111111111111)
1: CA - Los Angeles (ID: L_222222222222222222)
2: TX - Austin (ID: L_333333333333333333)
3: FL - Miami (ID: L_444444444444444444)
4: CO - Denver (ID: L_555555555555555555)
5: IL - Chicago - HQ (ID: L_666666666666666666)
6: GA - Atlanta (ID: L_777777777777777777)
7: WA - Seattle (ID: L_888888888888888888)
8: OH - Cleveland (ID: L_999999999999999999)
9: WI - Madison (ID: L_000000000000000000)
10: NV - Las Vegas (ID: L_101010101010101010)
11: AR - Little Rock - SG360 (ID: L_202020202020202020)
12: WI - Green Bay - EcoClean (ID: L_303030303030303030)
13: MI - Detroit - Hi-Tec (ID: L_404040404040404040)
Options:
1: Include all networks.
2: Select specific networks by their indices (e.g., 0,2,4).
3: Abort.
Enter your choice (1, 2, or 3): 2
Enter the indices of the networks to include (comma-separated): 0,2,4,6,8
2024-12-05 14:50:22,659 - GetBSSID - INFO - Selected networks:
{
    "L_111111111111111111": "NY - Albany",
    "L_333333333333333333": "TX - Austin",
    "L_555555555555555555": "CO - Denver",
    "L_777777777777777777": "GA - Atlanta",
    "L_999999999999999999": "OH - Cleveland"
}

Python Dependencies

Use pip install -r requirements.txt command to download each Python package:

Ensure you download the requirements.txt file, and then run pip install -r requirements.txt. Each required package will be downloaded. The requirements.txt file contains all the packages used by the script.

Please note that a virtual environment will help isolate package dependencies, and ensure each package is found by the IDE.

Also, you may need to change your python interpreter to use the virtual environment with CTRL + SHIFT + P and search Python: Select Interpreter. Ensure the virtual environment is chosen.

Finally, this script was built on python 3.

Improvements To Be Made

The Get Network Clients script was created by a Network Engineer by trade, and not a python developer. As a result, while this code functions, there is room for improvements. Items that may be useful for this script include:

  • JSON files are created but not really required. They are there mostly to provide you with the raw data from the API request. Feel free to tweak and remove the json files from being used.
  • Update Mechanism: Implement a mechanism to check for updates or patches to dependencies, ensuring the script remains compatible with new versions of libraries.
  • At Times, you will get a random 503 error from Meraki when the dashboard does not respond in time, or if they are having issues. The script provided has no mechanism to re-start itself, or notify you that is has stopped running.
  • It may be more reliable to utilize windows task scheduler or cron jobs instead of the built in while true loop for continued monitoring of new clients.
  • You may choose to hardcode your org and network IDs, so you do not require manual input to start the script.

Custom Logging

This script now also includes custom logging to track data historically. You must have the custom_logger.py to proceed without errors. You can add the file path to the file name if you want to store this in a specific location.This logging script will rotate automatically, and only store 3 backup files.

Reference Guides