55 lines
No EOL
1.4 KiB
Markdown
55 lines
No EOL
1.4 KiB
Markdown
# Meraki API Utilities
|
|
|
|
## Configuration
|
|
|
|
This project requires a `.env` file to run both scripts.
|
|
|
|
---
|
|
|
|
## Environment Variables
|
|
|
|
The following environment variables must be defined in your `.env` file:
|
|
|
|
- **API_KEY**
|
|
Your Cisco Meraki API key used to access and manage Meraki networks.
|
|
`Required by every script.`
|
|
|
|
- **NETWORK_ID**
|
|
The network ID of the network you want to parse.
|
|
`Required by deviceCheck.py.`
|
|
|
|
- **DEVICE_MAC**
|
|
The MAC address of the device you want to monitor.
|
|
`Required by deviceCheck.py.`
|
|
|
|
- **DEVICE_NICK**
|
|
The nickname of the device you want to monitor.
|
|
`Required by deviceCheck.py.`
|
|
|
|
- **SMTP_SERVER**
|
|
Your outgoing SMTP mail server address.
|
|
`Required by deviceCheck.py.`
|
|
|
|
- **SMTP_PORT**
|
|
Your outgoing SMTP mail server port.
|
|
`Required by deviceCheck.py.`
|
|
|
|
- **SMTP_EMAIL**
|
|
The email address used to send notifications.
|
|
`Required by deviceCheck.py.`
|
|
|
|
- **SMTP_PASS**
|
|
The password for the SMTP email account.
|
|
`Required by deviceCheck.py.`
|
|
|
|
- **SMTP_RECEIVER**
|
|
The email address that will be receiving the notifications.
|
|
`Required by deviceCheck.py.`
|
|
|
|
---
|
|
|
|
## Notes
|
|
|
|
- Ensure the `.env` file is stored securely and is not committed to version control.
|
|
- Verify that the API key has the required permissions for your intended operations.
|
|
- SMTP credentials should be for a dedicated service account where possible. |