Name	Name	Last commit message	Last commit date
parent directory ..
assets	assets
README.md	README.md
vlan_policy_maker.py	vlan_policy_maker.py

VLAN Policy Maker

The VLAN Policy Maker for Cisco Intersight automates the creation of VLAN Policies.

Features

Automatically build an Intersight VLAN Policy to your exact specification. Anything that can be done through the Intersight GUI can be done here and more!
Automatically attach the VLAN Policy to a UCS Domain Profile if desired, during the VLAN Policy configuration. The VLAN Policy can be attached to Fabric Interconnect A, B, or both.
Set default Multicast Policies for any configured VLANs.
Quickly restore VLAN Policy configurations as part of your on-prem Intersight backup solution.
Optionally, import into other Python programs or scripts to use the matching named function for easy integration.
Supported with Intersight SaaS, Connected Virtual Appliance, and Private Virtual Appliance.

Prerequisites

Python 3.7 or higher installed, which can be downloaded from https://www.python.org/downloads/.
- If you're installing for the first time on Windows, select the option "Add Python 3.x to PATH" during the installation.
Install the Cisco Intersight SDK for Python by running the following command:
```
pip install intersight
```
More information on the Cisco Intersight SDK for Python can be found at https://github.com/ciscodevnet/intersight-python.
[Optional] If you already have the Cisco Intersight SDK for Python installed, you may need to upgrade. An upgrade can be performed by running the following command:
```
pip install intersight --upgrade --user
```
Clone or download the Cisco IMM Automation Tools repository by using the link on the main repository web page or by running the following command from the target directory if Git is locally installed:
```
git clone https://github.com/ugo-emekauwa/cisco-imm-automation-tools
```
If you are downloading the repository file as a zipped file, unzip the file once the download has completed.
Generate a version 3 or version 2 API key from your Intersight account.

(a). Log into your Intersight account, click the Settings icon and select Settings.

(b). Under the API section in the work pane, click API Keys.

(c). In the API Keys section in the work pane, click the Generate API Key button.

(d). In the Generate API Key window, enter a description or name for your API key.

(e). In the Generate API Key window, under API Key Purpose, select a version 3 or version 2 API key.

(f). In the Generate API Key window, click the Generate button.

(g). In the Generate API Key window, a new API key will be generated. Copy the API Key ID and download the Secret Key to a secure location.

How to Use

Please ensure that the above Prerequisites have been met.
Within the unzipped Cisco IMM Automation Tools repository, navigate to the folder \src\policy_makers\vlan_policy_maker.
Edit the vlan_policy_maker.py file to set the key_id variable using the following instructions:

(a). Open the vlan_policy_maker.py file in an IDLE or text editor of choice.

(b). Find the comment # MODULE REQUIREMENT 1 #.

(c). Underneath, you will find the variable key_id. The variable is currently empty.

(d). Fill in between the quotes of the key_id variable value with the ID of your API key. For example:
```
key_id = "5c89885075646127773ec143/5c82fc477577712d3088eb2f/5c8987b17577712d302eaaff"
```
Edit the vlan_policy_maker.py file to set the key variable using the following instructions:

(a). Open the vlan_policy_maker.py file in an IDLE or text editor of choice.

(b). Find the comment # MODULE REQUIREMENT 2 #.

(c). Underneath, you will find the variable key. The variable is currently empty.

(d). Fill in between the quotes of the key variable value with your system's file path to the SecretKey.txt file for your API key. For example:
```
key = "C:\\Keys\\Key1\\SecretKey.txt"
```
Edit the vlan_policy_maker.py file to set all the configuration variable values using the following instructions:

(a). Open the vlan_policy_maker.py file in an IDLE or text editor of choice.

(b). Find the comment # MODULE REQUIREMENT 3 #.

(c). Underneath, you will find the instructions to edit the configuration variable values to match your environment. Each variable has a sample value for ease of use. The variable values to edit begin under the comment ####### Start Configuration Settings - Provide values for the variables listed below. #######.

Completion of editing the configuration variable values is marked by the comment ####### Finish Configuration Settings - The required value entries are complete. #######.
Save the changes you have made to the vlan_policy_maker.py file.
Run the vlan_policy_maker.py file.