MIST ADOPT

This script automates the adoption of Juniper devices to the Mist platform. It reads device information from an Excel file, fetches the adoption configuration from the Mist API, and pushes the configuration to the devices using NETCONF.

Requirements

• Python 3
• Libraries: pandas, openpyxl, requests, ncclient, and concurrent.futures
• Excel file with device information
• Mist API key

Installation

1. Make sure you have Python 3 installed.
2. Install the required libraries using pip:

pip install pandas openpyxl requests ncclient

Usage

python mist-adopt.py <excel_file> [-k] [--keep-phone-home] [-t] [--max-threads] [-a] [--api-key]

Arguments

• <excel_file>: Path to the Excel file containing device information (org_id, site_id, ip, user_id, password).
• -k, --keep-phone-home: Keep the 'delete system phone-home' command in the configuration (optional).
• -t, --max-threads: Maximum number of concurrent threads (default: 10) (optional).
• -a, --api-key: Mist API key (optional).

Excel file format

The Excel file should contain the following columns:

• org_id: Mist organization ID.
• site_id: Mist site ID.
• ip: Device IP address.
• user_id: Device username.
• password: Device password.

Example

python mist-adopt.py devices.xlsx -t 5 -a <your_mist_api_key>

Notes

The script will use the Mist API key from the environment variable "MIST_API_KEY" if available. If not found, it will try to read the API key from the configuration file located at "~/.mist/config.ini". If the API key is not found in either of these locations, the user must provide it using the -a or --api-key option. If the --keep-phone-home option is not specified, the script will remove the 'delete system phone-home' command from the configuration before pushing it to the devices.

To store your Mist API key in a config.ini file, follow these steps:

1. Create a new directory for your Mist configuration, if it doesn't exist:

mkdir -p ~/.mist

2. Create a config.ini file in the ~/.mist directory:

touch ~/.mist/config.ini

3. Open config.ini in a text editor and add the following content:

[Mist]
api_key = YOUR_MIST_API_KEY
Replace YOUR_MIST_API_KEY with your actual Mist API key.

4. Save the file and close the text editor.

To create an example Excel file for the script, you can use the following format. Your Excel file should have a header row followed by rows containing the device information. Make sure the header names match the field names expected by the script (org_id, site_id, ip, user_id, and password).

Example:

org_id	site_id	ip	user_id	password
org-1234abcd	site-5678efgh	192.168.1.2	admin	p@ssw0rd
org-1234abcd	site-5678efgh	192.168.1.3	admin	p@ssw0rd
org-1234abcd	site-5678efgh	192.168.1.4	admin	p@ssw0rd

To create this example file using Microsoft Excel, LibreOffice Calc, or any other spreadsheet software:

1. Open your preferred spreadsheet software.
2. Create a new spreadsheet.
3. Add the headers (org_id, site_id, ip, user_id, and password) to the first row.
4. Add the device information in the subsequent rows, using the example format shown above.
5. Save the file as an Excel file (.xlsx). Now you have an example Excel file that can be used with the script. Remember to replace the example values with your actual device information.