VLANs configured as site variables

When setting up a universal template to be used across multiple sites, there are certain factors which may differ from site to site. Different sites may have unique VLAN configurations, and to support these use cases we are allowing VLAN IDs to be configured as a site variable. With this function, set the VLAN ID on your config template to be a variable. Then, using a PUT operation from the API, define the specific VLAN ID for each site.

Here is an example on how to use site variables with VLANs:

1) Navigate to Organization > Config Templates > Create Template > Add WLAN to configure a WLAN to be used on all sites. In the VLAN field, enter in a variable instead of a numerical value. In this example we use {{VLAN_VAR}} as our variable. Note: you may use variables for any type of VLAN configurations, but VLAN pooling requires a specific format, demonstrated below.

 

2) Configure your WLAN VLANs on a per site basis using our API. Replace the “:site_id” with the respective Site ID and replace the VLAN_VAR variable with the right values corresponding to your site.

 

Static VLAN configuration

PUT /api/v1/sites/:site_id/setting

{

 "vars": {

 "VLAN_VAR": "11"

 }

}

 

VLAN Pool Configuration (option 1)

Site Variable using list of VLANs, with the WLAN referencing that Site Variable as a string:

/sites/:site_id/setting

{

"vars": {

"VLAN_ID_VAR": "1, 2, 3, 4, 5, 6"

}

}

/sites/wlans/:wlan_id

{

"vlan_ids": "{{VLAN_ID_VAR}}"

}

 

VLAN Pool Configuration (option 2)

Site Variable using multiple separate VLANs (each VLAN has its own unique variable), with the WLAN referencing those Site Variables in a list:

/sites/:site_id/setting

{

"vars": {

"VLAN_ID_VAR1": "1",

"VLAN_ID_VAR2": "2"

}

}

/sites/wlans/:wlan_id

{

"vlan_ids: [ "{{VLAN_ID_VAR1}}", "{{VLAN_ID_VAR2}}" ]

}

 

By using Site Variables you won’t need to change the Config Template, and the VLANs can be changed on a per site basis with a PUT operation from the API.