Configure Tunneled SSID Workflow

📘

Source Code

You can find the source code and documentation for this workflow, as well as several others, by visiting our central-python-workflows GitHub repository !

This script automates the configuration of WLAN overlay in HPE Aruba Networking Central using new Central APIs. The script performs the following actions:

• Creates configuration profiles such as roles and policies in Central
• Creates SSID profiles with associated roles
• Modifies the global policy group and creates overlay WLAN profiles
• Assigns these configurations to the appropriate scopes (global or group)
• Associates devices with sites based on the inventory configuration

🚧

Caution

This script uses a beta version of the pycentral library and is designed for new HPE Aruba Networking Central, which is also in Public Preview. Expect potential changes and updates to the API and functionality.

Prerequisites

This script assumes the following regarding your new Central environment:

• Gateways & APs have been added to device groups & are online in new Central
• Underlay is configured with Gateways in established cluster and any VLANs configured & assigned to the appropriate scopes

This script relies on the following Python packages:

• pycentral - New Central's API client library (beta version v2.0a7 or later)
• PyYAML - YAML parsing for configuration files
• termcolor - For colorized console output

Setup

1. Create a virtual environment (recommended):

   Shell

   python -m venv env
   source env/bin/activate  
   # On Windows: env\Scripts\activate
   

2. Clone the central-python-workflows and change into this workflow's repository:

   1. Shell

      git clone https://github.com/aruba/central-python-workflows.git
      
      cd central-python-workflows/tunneled-ssid-overlay
      

3. Install required packages:

   Shell

   pip install -r requirements.txt
   

Configuration Files

The script requires three YAML configuration files:

1. account_credentials.yaml - Contains API credentials for new Central and classic Central
2. wlan_overlay_profiles.yaml - Defines the necessary profiles including roles, policies, and SSIDs
3. inventory.yaml - Specifies device information and site assignments

Credential Configuration

You'll need to create an account_credentials.yaml file with the following structure:

new_central:
  base_url: https://us4.api.central.arubanetworks.com
  client_id: <your_client_id>
  client_secret: <your_client_secret>
classic:
  base_url: https://apigw-uswest4.central.arubanetworks.com
  token:
    access_token: <your_access_token>

To obtain your API credentials, please refer to: Generating and Managing Access Tokens and to locate the base_url of your new Central cluster refer to API Gateway Base URLs on our Developer Hub.

WLAN Overlay Profiles Configuration

Create a wlan_overlay_profiles.yaml file that defines:

• Roles and their permissions
• Security policies
• SSID configurations, any VLANs must be configured & applied to scope beforehand
• Policy groups
• Overlay WLAN profiles

Inventory Configuration

Create an inventory.yaml file that specifies:

• Site names and their associated devices (with serial numbers)
• Device types, including the clustered Gateway(s)

Example:

<site_name>:
    - device_type: IAP
      devices:
          - PHQSLBN5HB
          - PHQSLBN56K
    - device_type: GATEWAY
      devices:
          - CNSHKLB01W

Usage

After configuring the required YAML files, run the script:

python ssid_tunnel_overlay_workflow.py

Adapting to Your Environment

To adapt this script to your environment:

1. Update account_credentials.yaml with your Central API credentials
2. Modify wlan_overlay_profiles.yaml to define your desired wireless network configuration
3. Adjust inventory.yaml to match your device inventory and site structure
4. Review the script's output to ensure all operations were successful

Limitations

• This script is designed for new HPE Aruba Networking Central, which is currently in beta
• The pycentral library used is also in beta and subject to changes
• Some functions may require adjustments as the new Central API evolves