Juniper Mist v0.3.0 published on Wednesday, Apr 9, 2025 by Pulumi
junipermist.site.getWlans
Explore with Pulumi AI
This data source provides the list of Site Wlans.
The WLAN object contains all the required configuration to broadcast an SSID (Authentication, VLAN, …)
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as junipermist from "@pulumi/junipermist";
const siteWlans = junipermist.site.getWlans({
siteId: "15fca2ac-b1a6-47cc-9953-cc6906281550",
});
import pulumi
import pulumi_junipermist as junipermist
site_wlans = junipermist.site.get_wlans(site_id="15fca2ac-b1a6-47cc-9953-cc6906281550")
package main
import (
"github.com/pulumi/pulumi-junipermist/sdk/go/junipermist/site"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := site.GetWlans(ctx, &site.GetWlansArgs{
SiteId: "15fca2ac-b1a6-47cc-9953-cc6906281550",
}, nil)
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using JuniperMist = Pulumi.JuniperMist;
return await Deployment.RunAsync(() =>
{
var siteWlans = JuniperMist.Site.GetWlans.Invoke(new()
{
SiteId = "15fca2ac-b1a6-47cc-9953-cc6906281550",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.junipermist.site.SiteFunctions;
import com.pulumi.junipermist.site.inputs.GetWlansArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var siteWlans = SiteFunctions.getWlans(GetWlansArgs.builder()
.siteId("15fca2ac-b1a6-47cc-9953-cc6906281550")
.build());
}
}
variables:
siteWlans:
fn::invoke:
function: junipermist:site:getWlans
arguments:
siteId: 15fca2ac-b1a6-47cc-9953-cc6906281550
Using getWlans
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getWlans(args: GetWlansArgs, opts?: InvokeOptions): Promise<GetWlansResult>
function getWlansOutput(args: GetWlansOutputArgs, opts?: InvokeOptions): Output<GetWlansResult>
def get_wlans(site_id: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetWlansResult
def get_wlans_output(site_id: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetWlansResult]
func GetWlans(ctx *Context, args *GetWlansArgs, opts ...InvokeOption) (*GetWlansResult, error)
func GetWlansOutput(ctx *Context, args *GetWlansOutputArgs, opts ...InvokeOption) GetWlansResultOutput
> Note: This function is named GetWlans
in the Go SDK.
public static class GetWlans
{
public static Task<GetWlansResult> InvokeAsync(GetWlansArgs args, InvokeOptions? opts = null)
public static Output<GetWlansResult> Invoke(GetWlansInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetWlansResult> getWlans(GetWlansArgs args, InvokeOptions options)
public static Output<GetWlansResult> getWlans(GetWlansArgs args, InvokeOptions options)
fn::invoke:
function: junipermist:site/getWlans:getWlans
arguments:
# arguments dictionary
The following arguments are supported:
- Site
Id This property is required. string
- Site
Id This property is required. string
- site
Id This property is required. String
- site
Id This property is required. string
- site_
id This property is required. str
- site
Id This property is required. String
getWlans Result
The following output properties are available:
- Id string
- The provider-assigned unique ID for this managed resource.
- Site
Id string - Site
Wlans List<Pulumi.Juniper Mist. Site. Outputs. Get Wlans Site Wlan>
- Id string
- The provider-assigned unique ID for this managed resource.
- Site
Id string - Site
Wlans []GetWlans Site Wlan
- id String
- The provider-assigned unique ID for this managed resource.
- site
Id String - site
Wlans List<GetWlans Site Wlan>
- id string
- The provider-assigned unique ID for this managed resource.
- site
Id string - site
Wlans GetWlans Site Wlan[]
- id str
- The provider-assigned unique ID for this managed resource.
- site_
id str - site_
wlans Sequence[GetWlans Site Wlan]
- id String
- The provider-assigned unique ID for this managed resource.
- site
Id String - site
Wlans List<Property Map>
Supporting Types
GetWlansSiteWlan
- Acct
Immediate Update This property is required. bool - Enable coa-immediate-update and address-change-immediate-update on the access profile.
- Acct
Interim Interval This property is required. int - How frequently should interim accounting be reported, 60-65535. default is 0 (use one specified in Access-Accept request from RADIUS Server). Very frequent messages can affect the performance of the radius server, 600 and up is recommended when enabled
- Acct
Servers This property is required. List<Pulumi.Juniper Mist. Site. Inputs. Get Wlans Site Wlan Acct Server> - List of RADIUS accounting servers, optional, order matters where the first one is treated as primary
- Airwatch
This property is required. Pulumi.Juniper Mist. Site. Inputs. Get Wlans Site Wlan Airwatch - Airwatch wlan settings
- Allow
Ipv6Ndp This property is required. bool - Only applicable when limit_bcast==true, which allows or disallows ipv6 Neighbor Discovery packets to go through
- Allow
Mdns This property is required. bool - Only applicable when limit_bcast==true, which allows mDNS / Bonjour packets to go through
- Allow
Ssdp This property is required. bool - Only applicable when
limit_bcast
==true
, which allows SSDP - Ap
Ids This property is required. List<string> - List of device ids
- App
Limit This property is required. Pulumi.Juniper Mist. Site. Inputs. Get Wlans Site Wlan App Limit - Bandwidth limiting for apps (applies to up/down)
- App
Qos This property is required. Pulumi.Juniper Mist. Site. Inputs. Get Wlans Site Wlan App Qos - APp qos wlan settings
- Apply
To This property is required. string - enum:
aps
,site
,wxtags
- Arp
Filter This property is required. bool - Whether to enable smart arp filter
- Auth
This property is required. Pulumi.Juniper Mist. Site. Inputs. Get Wlans Site Wlan Auth - Authentication wlan settings
- Auth
Server Selection This property is required. string - When ordered, AP will prefer and go back to the first server if possible. enum:
ordered
,unordered
- Auth
Servers This property is required. List<Pulumi.Juniper Mist. Site. Inputs. Get Wlans Site Wlan Auth Server> - List of RADIUS authentication servers, at least one is needed if
auth type
==eap
, order matters where the first one is treated as primary - Auth
Servers Nas Id This property is required. string - Optional, up to 48 bytes, will be dynamically generated if not provided. used only for authentication servers
- Auth
Servers Nas Ip This property is required. string - Optional, NAS-IP-ADDRESS to use
- Auth
Servers Retries This property is required. int - Radius auth session retries. Following fast timers are set if "fast_dot1x_timers" knob is enabled. ‘retries’ are set to value of auth_servers_retries. ‘max-requests’ is also set when setting auth_servers_retries and is set to default value to 3.
- Auth
Servers Timeout This property is required. int - Radius auth session timeout. Following fast timers are set if "fast_dot1x_timers" knob is enabled. ‘quite-period’ and ‘transmit-period’ are set to half the value of auth_servers_timeout. ‘supplicant-timeout’ is also set when setting auth_servers_timeout and is set to default value of 10.
- Band
Steer This property is required. bool - Whether to enable band_steering, this works only when band==both
- Band
Steer Force Band5 This property is required. bool - Force dual_band capable client to connect to 5G
- Bands
This property is required. List<string> - List of radios that the wlan should apply to.
- Block
Blacklist Clients This property is required. bool - Whether to block the clients in the blacklist (up to first 256 macs)
- Bonjour
This property is required. Pulumi.Juniper Mist. Site. Inputs. Get Wlans Site Wlan Bonjour - Bonjour gateway wlan settings
- Cisco
Cwa This property is required. Pulumi.Juniper Mist. Site. Inputs. Get Wlans Site Wlan Cisco Cwa - Cisco CWA (central web authentication) required RADIUS with COA in order to work. See CWA: https://www.cisco.com/c/en/us/support/docs/security/identity-services-engine/115732-central-web-auth-00.html
- Client
Limit Down This property is required. int - In kbps
- Client
Limit Down Enabled This property is required. bool - If downlink limiting per-client is enabled
- Client
Limit Up This property is required. int - In kbps
- Client
Limit Up Enabled This property is required. bool - If uplink limiting per-client is enabled
- Coa
Servers This property is required. List<Pulumi.Juniper Mist. Site. Inputs. Get Wlans Site Wlan Coa Server> - List of COA (change of authorization) servers, optional
- Created
Time This property is required. double - When the object has been created, in epoch
- Disable11ax
This property is required. bool - Some old WLAN drivers may not be compatible
- Disable11be
This property is required. bool - To disable Wi-Fi 7 EHT IEs
- Disable
Ht Vht Rates This property is required. bool - To disable ht or vht rates
- Disable
Uapsd This property is required. bool - Whether to disable U-APSD
- Disable
V1Roam Notify This property is required. bool - Disable sending v2 roam notification messages
- Disable
V2Roam Notify This property is required. bool - Disable sending v2 roam notification messages
- Disable
When Gateway Unreachable This property is required. bool - When any of the following is true, this WLAN will be disabled
- cannot get IP
- cannot obtain default gateway
- cannot reach default gateway
- Disable
When Mxtunnel Down This property is required. bool - Disable
Wmm This property is required. bool - Whether to disable WMM
- Dns
Server Rewrite This property is required. Pulumi.Juniper Mist. Site. Inputs. Get Wlans Site Wlan Dns Server Rewrite - For radius_group-based DNS server (rewrite DNS request depending on the Group RADIUS server returns)
- Dtim
This property is required. int - Dynamic
Psk This property is required. Pulumi.Juniper Mist. Site. Inputs. Get Wlans Site Wlan Dynamic Psk - For dynamic PSK where we get per_user PSK from Radius. dynamic_psk allows PSK to be selected at runtime depending on context (wlan/site/user/...) thus following configurations are assumed (currently)
- PSK will come from RADIUS server
- AP sends client MAC as username and password (i.e.
enable_mac_auth
is assumed) - AP sends BSSID:SSID as Caller-Station-ID
auth_servers
is required- PSK will come from cloud WLC if source is cloud_psks
- default_psk will be used if cloud WLC is not available
multi_psk_only
andpsk
is ignoredpairwise
can only be wpa2-ccmp (for now, wpa3 support on the roadmap)
- Dynamic
Vlan This property is required. Pulumi.Juniper Mist. Site. Inputs. Get Wlans Site Wlan Dynamic Vlan - For 802.1x
- Enable
Local Keycaching This property is required. bool - Enable AP-AP keycaching via multicast
- Enable
Wireless Bridging This property is required. bool - By default, we'd inspect all DHCP packets and drop those unrelated to the wireless client itself in the case where client is a wireless bridge (DHCP packets for other MACs will need to be forwarded), wireless_bridging can be enabled
- Enable
Wireless Bridging Dhcp Tracking This property is required. bool - If the client bridge is doing DHCP on behalf of other devices (L2-NAT), enable dhcp_tracking will cut down DHCP response packets to be forwarded to wireless
- Enabled
This property is required. bool - If this wlan is enabled
- Fast
Dot1x Timers This property is required. bool - If set to true, sets default fast-timers with values calculated from ‘auth_servers_timeout’ and ‘auth_server_retries’ .
- Hide
Ssid This property is required. bool - Whether to hide SSID in beacon
- Hostname
Ie This property is required. bool - Include hostname inside IE in AP beacons / probe responses
- Hotspot20
This property is required. Pulumi.Juniper Mist. Site. Inputs. Get Wlans Site Wlan Hotspot20 - Hostspot 2.0 wlan settings
- Id
This property is required. string - Unique ID of the object instance in the Mist Organization
- Inject
Dhcp Option82 This property is required. Pulumi.Juniper Mist. Site. Inputs. Get Wlans Site Wlan Inject Dhcp Option82 - Interface
This property is required. string - where this WLAN will be connected to. enum:
all
,eth0
,eth1
,eth2
,eth3
,mxtunnel
,site_mxedge
,wxtunnel
- Isolation
This property is required. bool - Whether to stop clients to talk to each other
- L2Isolation
This property is required. bool - If isolation is enabled, whether to deny clients to talk to L2 on the LAN
- Legacy
Overds This property is required. bool - Legacy devices requires the Over-DS (for Fast BSS Transition) bit set (while our chip doesn’t support it). Warning! Enabling this will cause problem for iOS devices.
- Limit
Bcast This property is required. bool - Whether to limit broadcast packets going to wireless (i.e. only allow certain bcast packets to go through)
- Limit
Probe Response This property is required. bool - Limit probe response base on some heuristic rules
- Max
Idletime This property is required. int - Max idle time in seconds
- Max
Num Clients This property is required. int - Maximum number of client connected to the SSID.
0
means unlimited - Mist
Nac This property is required. Pulumi.Juniper Mist. Site. Inputs. Get Wlans Site Wlan Mist Nac - Modified
Time This property is required. double - When the object has been modified for the last time, in epoch
- Msp
Id This property is required. string - Mxtunnel
Ids This property is required. List<string> - When
interface
=mxtunnel
, id of the Mist Tunnel - Mxtunnel
Names This property is required. List<string> - When
interface
=site_mxedge
, name of the mxtunnel that in mxtunnels under Site Setting - No
Static Dns This property is required. bool - Whether to only allow client to use DNS that we’ve learned from DHCP response
- No
Static Ip This property is required. bool - Whether to only allow client that we’ve learned from DHCP exchange to talk
- Org
Id This property is required. string - Portal
This property is required. Pulumi.Juniper Mist. Site. Inputs. Get Wlans Site Wlan Portal - Portal wlan settings
- Portal
Allowed Hostnames This property is required. List<string> - List of hostnames without http(s):// (matched by substring)
- Portal
Allowed Subnets This property is required. List<string> - List of CIDRs
- Portal
Api Secret This property is required. string - APi secret (auto-generated) that can be used to sign guest authorization requests
- Portal
Denied Hostnames This property is required. List<string> - List of hostnames without http(s):// (matched by substring), this takes precedence over portal_allowed_hostnames
- Portal
Image This property is required. string - Url of portal background image
- Portal
Sso Url This property is required. string - Qos
This property is required. Pulumi.Juniper Mist. Site. Inputs. Get Wlans Site Wlan Qos - Radsec
This property is required. Pulumi.Juniper Mist. Site. Inputs. Get Wlans Site Wlan Radsec - RadSec settings
- Rateset
This property is required. Dictionary<string, Pulumi.Juniper Mist. Site. Inputs. Get Wlans Site Wlan Rateset> - Property key is the RF band. enum:
24
,5
,6
- Reconnect
Clients When Roaming Mxcluster This property is required. bool - When different mxcluster is on different subnet, we'd want to disconnect clients (so they'll reconnect and get new IPs)
- Roam
Mode This property is required. string - enum:
11r
,OKC
,NONE
- Schedule
This property is required. Pulumi.Juniper Mist. Site. Inputs. Get Wlans Site Wlan Schedule - WLAN operating schedule, default is disabled
- Site
Id This property is required. string - Sle
Excluded This property is required. bool - Whether to exclude this WLAN from SLE metrics
- Ssid
This property is required. string - Name of the SSID
- Use
Eapol V1 This property is required. bool - If
auth.type
==eap
orauth.type
==psk
, should only be set for legacy client, such as pre-2004, 802.11b devices - Vlan
Enabled This property is required. bool - If vlan tagging is enabled
- Vlan
Id This property is required. string - Vlan
Ids This property is required. List<string> - if
vlan_enabled
==true
andvlan_pooling
==true
. List of VLAN IDs (comma separated) to be used in the VLAN Pool - Vlan
Pooling This property is required. bool - Requires
vlan_enabled
==true
to be set totrue
. Vlan pooling allows AP to place client on different VLAN using a deterministic algorithm - Wlan
Limit Down This property is required. int - In kbps
- Wlan
Limit Down Enabled This property is required. bool - If downlink limiting for whole wlan is enabled
- Wlan
Limit Up This property is required. int - In kbps
- Wlan
Limit Up Enabled This property is required. bool - If uplink limiting for whole wlan is enabled
- Wxtag
Ids This property is required. List<string> - List of wxtag_ids
- Wxtunnel
Id This property is required. string - When
interface
=wxtunnel
, id of the WXLAN Tunnel - Wxtunnel
Remote Id This property is required. string - When
interface
=wxtunnel
, remote tunnel identifier
- Acct
Immediate Update This property is required. bool - Enable coa-immediate-update and address-change-immediate-update on the access profile.
- Acct
Interim Interval This property is required. int - How frequently should interim accounting be reported, 60-65535. default is 0 (use one specified in Access-Accept request from RADIUS Server). Very frequent messages can affect the performance of the radius server, 600 and up is recommended when enabled
- Acct
Servers This property is required. []GetWlans Site Wlan Acct Server - List of RADIUS accounting servers, optional, order matters where the first one is treated as primary
- Airwatch
This property is required. GetWlans Site Wlan Airwatch - Airwatch wlan settings
- Allow
Ipv6Ndp This property is required. bool - Only applicable when limit_bcast==true, which allows or disallows ipv6 Neighbor Discovery packets to go through
- Allow
Mdns This property is required. bool - Only applicable when limit_bcast==true, which allows mDNS / Bonjour packets to go through
- Allow
Ssdp This property is required. bool - Only applicable when
limit_bcast
==true
, which allows SSDP - Ap
Ids This property is required. []string - List of device ids
- App
Limit This property is required. GetWlans Site Wlan App Limit - Bandwidth limiting for apps (applies to up/down)
- App
Qos This property is required. GetWlans Site Wlan App Qos - APp qos wlan settings
- Apply
To This property is required. string - enum:
aps
,site
,wxtags
- Arp
Filter This property is required. bool - Whether to enable smart arp filter
- Auth
This property is required. GetWlans Site Wlan Auth - Authentication wlan settings
- Auth
Server Selection This property is required. string - When ordered, AP will prefer and go back to the first server if possible. enum:
ordered
,unordered
- Auth
Servers This property is required. []GetWlans Site Wlan Auth Server - List of RADIUS authentication servers, at least one is needed if
auth type
==eap
, order matters where the first one is treated as primary - Auth
Servers Nas Id This property is required. string - Optional, up to 48 bytes, will be dynamically generated if not provided. used only for authentication servers
- Auth
Servers Nas Ip This property is required. string - Optional, NAS-IP-ADDRESS to use
- Auth
Servers Retries This property is required. int - Radius auth session retries. Following fast timers are set if "fast_dot1x_timers" knob is enabled. ‘retries’ are set to value of auth_servers_retries. ‘max-requests’ is also set when setting auth_servers_retries and is set to default value to 3.
- Auth
Servers Timeout This property is required. int - Radius auth session timeout. Following fast timers are set if "fast_dot1x_timers" knob is enabled. ‘quite-period’ and ‘transmit-period’ are set to half the value of auth_servers_timeout. ‘supplicant-timeout’ is also set when setting auth_servers_timeout and is set to default value of 10.
- Band
Steer This property is required. bool - Whether to enable band_steering, this works only when band==both
- Band
Steer Force Band5 This property is required. bool - Force dual_band capable client to connect to 5G
- Bands
This property is required. []string - List of radios that the wlan should apply to.
- Block
Blacklist Clients This property is required. bool - Whether to block the clients in the blacklist (up to first 256 macs)
- Bonjour
This property is required. GetWlans Site Wlan Bonjour - Bonjour gateway wlan settings
- Cisco
Cwa This property is required. GetWlans Site Wlan Cisco Cwa - Cisco CWA (central web authentication) required RADIUS with COA in order to work. See CWA: https://www.cisco.com/c/en/us/support/docs/security/identity-services-engine/115732-central-web-auth-00.html
- Client
Limit Down This property is required. int - In kbps
- Client
Limit Down Enabled This property is required. bool - If downlink limiting per-client is enabled
- Client
Limit Up This property is required. int - In kbps
- Client
Limit Up Enabled This property is required. bool - If uplink limiting per-client is enabled
- Coa
Servers This property is required. []GetWlans Site Wlan Coa Server - List of COA (change of authorization) servers, optional
- Created
Time This property is required. float64 - When the object has been created, in epoch
- Disable11ax
This property is required. bool - Some old WLAN drivers may not be compatible
- Disable11be
This property is required. bool - To disable Wi-Fi 7 EHT IEs
- Disable
Ht Vht Rates This property is required. bool - To disable ht or vht rates
- Disable
Uapsd This property is required. bool - Whether to disable U-APSD
- Disable
V1Roam Notify This property is required. bool - Disable sending v2 roam notification messages
- Disable
V2Roam Notify This property is required. bool - Disable sending v2 roam notification messages
- Disable
When Gateway Unreachable This property is required. bool - When any of the following is true, this WLAN will be disabled
- cannot get IP
- cannot obtain default gateway
- cannot reach default gateway
- Disable
When Mxtunnel Down This property is required. bool - Disable
Wmm This property is required. bool - Whether to disable WMM
- Dns
Server Rewrite This property is required. GetWlans Site Wlan Dns Server Rewrite - For radius_group-based DNS server (rewrite DNS request depending on the Group RADIUS server returns)
- Dtim
This property is required. int - Dynamic
Psk This property is required. GetWlans Site Wlan Dynamic Psk - For dynamic PSK where we get per_user PSK from Radius. dynamic_psk allows PSK to be selected at runtime depending on context (wlan/site/user/...) thus following configurations are assumed (currently)
- PSK will come from RADIUS server
- AP sends client MAC as username and password (i.e.
enable_mac_auth
is assumed) - AP sends BSSID:SSID as Caller-Station-ID
auth_servers
is required- PSK will come from cloud WLC if source is cloud_psks
- default_psk will be used if cloud WLC is not available
multi_psk_only
andpsk
is ignoredpairwise
can only be wpa2-ccmp (for now, wpa3 support on the roadmap)
- Dynamic
Vlan This property is required. GetWlans Site Wlan Dynamic Vlan - For 802.1x
- Enable
Local Keycaching This property is required. bool - Enable AP-AP keycaching via multicast
- Enable
Wireless Bridging This property is required. bool - By default, we'd inspect all DHCP packets and drop those unrelated to the wireless client itself in the case where client is a wireless bridge (DHCP packets for other MACs will need to be forwarded), wireless_bridging can be enabled
- Enable
Wireless Bridging Dhcp Tracking This property is required. bool - If the client bridge is doing DHCP on behalf of other devices (L2-NAT), enable dhcp_tracking will cut down DHCP response packets to be forwarded to wireless
- Enabled
This property is required. bool - If this wlan is enabled
- Fast
Dot1x Timers This property is required. bool - If set to true, sets default fast-timers with values calculated from ‘auth_servers_timeout’ and ‘auth_server_retries’ .
- Hide
Ssid This property is required. bool - Whether to hide SSID in beacon
- Hostname
Ie This property is required. bool - Include hostname inside IE in AP beacons / probe responses
- Hotspot20
This property is required. GetWlans Site Wlan Hotspot20 - Hostspot 2.0 wlan settings
- Id
This property is required. string - Unique ID of the object instance in the Mist Organization
- Inject
Dhcp Option82 This property is required. GetWlans Site Wlan Inject Dhcp Option82 - Interface
This property is required. string - where this WLAN will be connected to. enum:
all
,eth0
,eth1
,eth2
,eth3
,mxtunnel
,site_mxedge
,wxtunnel
- Isolation
This property is required. bool - Whether to stop clients to talk to each other
- L2Isolation
This property is required. bool - If isolation is enabled, whether to deny clients to talk to L2 on the LAN
- Legacy
Overds This property is required. bool - Legacy devices requires the Over-DS (for Fast BSS Transition) bit set (while our chip doesn’t support it). Warning! Enabling this will cause problem for iOS devices.
- Limit
Bcast This property is required. bool - Whether to limit broadcast packets going to wireless (i.e. only allow certain bcast packets to go through)
- Limit
Probe Response This property is required. bool - Limit probe response base on some heuristic rules
- Max
Idletime This property is required. int - Max idle time in seconds
- Max
Num Clients This property is required. int - Maximum number of client connected to the SSID.
0
means unlimited - Mist
Nac This property is required. GetWlans Site Wlan Mist Nac - Modified
Time This property is required. float64 - When the object has been modified for the last time, in epoch
- Msp
Id This property is required. string - Mxtunnel
Ids This property is required. []string - When
interface
=mxtunnel
, id of the Mist Tunnel - Mxtunnel
Names This property is required. []string - When
interface
=site_mxedge
, name of the mxtunnel that in mxtunnels under Site Setting - No
Static Dns This property is required. bool - Whether to only allow client to use DNS that we’ve learned from DHCP response
- No
Static Ip This property is required. bool - Whether to only allow client that we’ve learned from DHCP exchange to talk
- Org
Id This property is required. string - Portal
This property is required. GetWlans Site Wlan Portal - Portal wlan settings
- Portal
Allowed Hostnames This property is required. []string - List of hostnames without http(s):// (matched by substring)
- Portal
Allowed Subnets This property is required. []string - List of CIDRs
- Portal
Api Secret This property is required. string - APi secret (auto-generated) that can be used to sign guest authorization requests
- Portal
Denied Hostnames This property is required. []string - List of hostnames without http(s):// (matched by substring), this takes precedence over portal_allowed_hostnames
- Portal
Image This property is required. string - Url of portal background image
- Portal
Sso Url This property is required. string - Qos
This property is required. GetWlans Site Wlan Qos - Radsec
This property is required. GetWlans Site Wlan Radsec - RadSec settings
- Rateset
This property is required. map[string]GetWlans Site Wlan Rateset - Property key is the RF band. enum:
24
,5
,6
- Reconnect
Clients When Roaming Mxcluster This property is required. bool - When different mxcluster is on different subnet, we'd want to disconnect clients (so they'll reconnect and get new IPs)
- Roam
Mode This property is required. string - enum:
11r
,OKC
,NONE
- Schedule
This property is required. GetWlans Site Wlan Schedule - WLAN operating schedule, default is disabled
- Site
Id This property is required. string - Sle
Excluded This property is required. bool - Whether to exclude this WLAN from SLE metrics
- Ssid
This property is required. string - Name of the SSID
- Use
Eapol V1 This property is required. bool - If
auth.type
==eap
orauth.type
==psk
, should only be set for legacy client, such as pre-2004, 802.11b devices - Vlan
Enabled This property is required. bool - If vlan tagging is enabled
- Vlan
Id This property is required. string - Vlan
Ids This property is required. []string - if
vlan_enabled
==true
andvlan_pooling
==true
. List of VLAN IDs (comma separated) to be used in the VLAN Pool - Vlan
Pooling This property is required. bool - Requires
vlan_enabled
==true
to be set totrue
. Vlan pooling allows AP to place client on different VLAN using a deterministic algorithm - Wlan
Limit Down This property is required. int - In kbps
- Wlan
Limit Down Enabled This property is required. bool - If downlink limiting for whole wlan is enabled
- Wlan
Limit Up This property is required. int - In kbps
- Wlan
Limit Up Enabled This property is required. bool - If uplink limiting for whole wlan is enabled
- Wxtag
Ids This property is required. []string - List of wxtag_ids
- Wxtunnel
Id This property is required. string - When
interface
=wxtunnel
, id of the WXLAN Tunnel - Wxtunnel
Remote Id This property is required. string - When
interface
=wxtunnel
, remote tunnel identifier
- acct
Immediate Update This property is required. Boolean - Enable coa-immediate-update and address-change-immediate-update on the access profile.
- acct
Interim Interval This property is required. Integer - How frequently should interim accounting be reported, 60-65535. default is 0 (use one specified in Access-Accept request from RADIUS Server). Very frequent messages can affect the performance of the radius server, 600 and up is recommended when enabled
- acct
Servers This property is required. List<GetWlans Site Wlan Acct Server> - List of RADIUS accounting servers, optional, order matters where the first one is treated as primary
- airwatch
This property is required. GetWlans Site Wlan Airwatch - Airwatch wlan settings
- allow
Ipv6Ndp This property is required. Boolean - Only applicable when limit_bcast==true, which allows or disallows ipv6 Neighbor Discovery packets to go through
- allow
Mdns This property is required. Boolean - Only applicable when limit_bcast==true, which allows mDNS / Bonjour packets to go through
- allow
Ssdp This property is required. Boolean - Only applicable when
limit_bcast
==true
, which allows SSDP - ap
Ids This property is required. List<String> - List of device ids
- app
Limit This property is required. GetWlans Site Wlan App Limit - Bandwidth limiting for apps (applies to up/down)
- app
Qos This property is required. GetWlans Site Wlan App Qos - APp qos wlan settings
- apply
To This property is required. String - enum:
aps
,site
,wxtags
- arp
Filter This property is required. Boolean - Whether to enable smart arp filter
- auth
This property is required. GetWlans Site Wlan Auth - Authentication wlan settings
- auth
Server Selection This property is required. String - When ordered, AP will prefer and go back to the first server if possible. enum:
ordered
,unordered
- auth
Servers This property is required. List<GetWlans Site Wlan Auth Server> - List of RADIUS authentication servers, at least one is needed if
auth type
==eap
, order matters where the first one is treated as primary - auth
Servers Nas Id This property is required. String - Optional, up to 48 bytes, will be dynamically generated if not provided. used only for authentication servers
- auth
Servers Nas Ip This property is required. String - Optional, NAS-IP-ADDRESS to use
- auth
Servers Retries This property is required. Integer - Radius auth session retries. Following fast timers are set if "fast_dot1x_timers" knob is enabled. ‘retries’ are set to value of auth_servers_retries. ‘max-requests’ is also set when setting auth_servers_retries and is set to default value to 3.
- auth
Servers Timeout This property is required. Integer - Radius auth session timeout. Following fast timers are set if "fast_dot1x_timers" knob is enabled. ‘quite-period’ and ‘transmit-period’ are set to half the value of auth_servers_timeout. ‘supplicant-timeout’ is also set when setting auth_servers_timeout and is set to default value of 10.
- band
Steer This property is required. Boolean - Whether to enable band_steering, this works only when band==both
- band
Steer Force Band5 This property is required. Boolean - Force dual_band capable client to connect to 5G
- bands
This property is required. List<String> - List of radios that the wlan should apply to.
- block
Blacklist Clients This property is required. Boolean - Whether to block the clients in the blacklist (up to first 256 macs)
- bonjour
This property is required. GetWlans Site Wlan Bonjour - Bonjour gateway wlan settings
- cisco
Cwa This property is required. GetWlans Site Wlan Cisco Cwa - Cisco CWA (central web authentication) required RADIUS with COA in order to work. See CWA: https://www.cisco.com/c/en/us/support/docs/security/identity-services-engine/115732-central-web-auth-00.html
- client
Limit Down This property is required. Integer - In kbps
- client
Limit Down Enabled This property is required. Boolean - If downlink limiting per-client is enabled
- client
Limit Up This property is required. Integer - In kbps
- client
Limit Up Enabled This property is required. Boolean - If uplink limiting per-client is enabled
- coa
Servers This property is required. List<GetWlans Site Wlan Coa Server> - List of COA (change of authorization) servers, optional
- created
Time This property is required. Double - When the object has been created, in epoch
- disable11ax
This property is required. Boolean - Some old WLAN drivers may not be compatible
- disable11be
This property is required. Boolean - To disable Wi-Fi 7 EHT IEs
- disable
Ht Vht Rates This property is required. Boolean - To disable ht or vht rates
- disable
Uapsd This property is required. Boolean - Whether to disable U-APSD
- disable
V1Roam Notify This property is required. Boolean - Disable sending v2 roam notification messages
- disable
V2Roam Notify This property is required. Boolean - Disable sending v2 roam notification messages
- disable
When Gateway Unreachable This property is required. Boolean - When any of the following is true, this WLAN will be disabled
- cannot get IP
- cannot obtain default gateway
- cannot reach default gateway
- disable
When Mxtunnel Down This property is required. Boolean - disable
Wmm This property is required. Boolean - Whether to disable WMM
- dns
Server Rewrite This property is required. GetWlans Site Wlan Dns Server Rewrite - For radius_group-based DNS server (rewrite DNS request depending on the Group RADIUS server returns)
- dtim
This property is required. Integer - dynamic
Psk This property is required. GetWlans Site Wlan Dynamic Psk - For dynamic PSK where we get per_user PSK from Radius. dynamic_psk allows PSK to be selected at runtime depending on context (wlan/site/user/...) thus following configurations are assumed (currently)
- PSK will come from RADIUS server
- AP sends client MAC as username and password (i.e.
enable_mac_auth
is assumed) - AP sends BSSID:SSID as Caller-Station-ID
auth_servers
is required- PSK will come from cloud WLC if source is cloud_psks
- default_psk will be used if cloud WLC is not available
multi_psk_only
andpsk
is ignoredpairwise
can only be wpa2-ccmp (for now, wpa3 support on the roadmap)
- dynamic
Vlan This property is required. GetWlans Site Wlan Dynamic Vlan - For 802.1x
- enable
Local Keycaching This property is required. Boolean - Enable AP-AP keycaching via multicast
- enable
Wireless Bridging This property is required. Boolean - By default, we'd inspect all DHCP packets and drop those unrelated to the wireless client itself in the case where client is a wireless bridge (DHCP packets for other MACs will need to be forwarded), wireless_bridging can be enabled
- enable
Wireless Bridging Dhcp Tracking This property is required. Boolean - If the client bridge is doing DHCP on behalf of other devices (L2-NAT), enable dhcp_tracking will cut down DHCP response packets to be forwarded to wireless
- enabled
This property is required. Boolean - If this wlan is enabled
- fast
Dot1x Timers This property is required. Boolean - If set to true, sets default fast-timers with values calculated from ‘auth_servers_timeout’ and ‘auth_server_retries’ .
- hide
Ssid This property is required. Boolean - Whether to hide SSID in beacon
- hostname
Ie This property is required. Boolean - Include hostname inside IE in AP beacons / probe responses
- hotspot20
This property is required. GetWlans Site Wlan Hotspot20 - Hostspot 2.0 wlan settings
- id
This property is required. String - Unique ID of the object instance in the Mist Organization
- inject
Dhcp Option82 This property is required. GetWlans Site Wlan Inject Dhcp Option82 - interface_
This property is required. String - where this WLAN will be connected to. enum:
all
,eth0
,eth1
,eth2
,eth3
,mxtunnel
,site_mxedge
,wxtunnel
- isolation
This property is required. Boolean - Whether to stop clients to talk to each other
- l2Isolation
This property is required. Boolean - If isolation is enabled, whether to deny clients to talk to L2 on the LAN
- legacy
Overds This property is required. Boolean - Legacy devices requires the Over-DS (for Fast BSS Transition) bit set (while our chip doesn’t support it). Warning! Enabling this will cause problem for iOS devices.
- limit
Bcast This property is required. Boolean - Whether to limit broadcast packets going to wireless (i.e. only allow certain bcast packets to go through)
- limit
Probe Response This property is required. Boolean - Limit probe response base on some heuristic rules
- max
Idletime This property is required. Integer - Max idle time in seconds
- max
Num Clients This property is required. Integer - Maximum number of client connected to the SSID.
0
means unlimited - mist
Nac This property is required. GetWlans Site Wlan Mist Nac - modified
Time This property is required. Double - When the object has been modified for the last time, in epoch
- msp
Id This property is required. String - mxtunnel
Ids This property is required. List<String> - When
interface
=mxtunnel
, id of the Mist Tunnel - mxtunnel
Names This property is required. List<String> - When
interface
=site_mxedge
, name of the mxtunnel that in mxtunnels under Site Setting - no
Static Dns This property is required. Boolean - Whether to only allow client to use DNS that we’ve learned from DHCP response
- no
Static Ip This property is required. Boolean - Whether to only allow client that we’ve learned from DHCP exchange to talk
- org
Id This property is required. String - portal
This property is required. GetWlans Site Wlan Portal - Portal wlan settings
- portal
Allowed Hostnames This property is required. List<String> - List of hostnames without http(s):// (matched by substring)
- portal
Allowed Subnets This property is required. List<String> - List of CIDRs
- portal
Api Secret This property is required. String - APi secret (auto-generated) that can be used to sign guest authorization requests
- portal
Denied Hostnames This property is required. List<String> - List of hostnames without http(s):// (matched by substring), this takes precedence over portal_allowed_hostnames
- portal
Image This property is required. String - Url of portal background image
- portal
Sso Url This property is required. String - qos
This property is required. GetWlans Site Wlan Qos - radsec
This property is required. GetWlans Site Wlan Radsec - RadSec settings
- rateset
This property is required. Map<String,GetWlans Site Wlan Rateset> - Property key is the RF band. enum:
24
,5
,6
- reconnect
Clients When Roaming Mxcluster This property is required. Boolean - When different mxcluster is on different subnet, we'd want to disconnect clients (so they'll reconnect and get new IPs)
- roam
Mode This property is required. String - enum:
11r
,OKC
,NONE
- schedule
This property is required. GetWlans Site Wlan Schedule - WLAN operating schedule, default is disabled
- site
Id This property is required. String - sle
Excluded This property is required. Boolean - Whether to exclude this WLAN from SLE metrics
- ssid
This property is required. String - Name of the SSID
- use
Eapol V1 This property is required. Boolean - If
auth.type
==eap
orauth.type
==psk
, should only be set for legacy client, such as pre-2004, 802.11b devices - vlan
Enabled This property is required. Boolean - If vlan tagging is enabled
- vlan
Id This property is required. String - vlan
Ids This property is required. List<String> - if
vlan_enabled
==true
andvlan_pooling
==true
. List of VLAN IDs (comma separated) to be used in the VLAN Pool - vlan
Pooling This property is required. Boolean - Requires
vlan_enabled
==true
to be set totrue
. Vlan pooling allows AP to place client on different VLAN using a deterministic algorithm - wlan
Limit Down This property is required. Integer - In kbps
- wlan
Limit Down Enabled This property is required. Boolean - If downlink limiting for whole wlan is enabled
- wlan
Limit Up This property is required. Integer - In kbps
- wlan
Limit Up Enabled This property is required. Boolean - If uplink limiting for whole wlan is enabled
- wxtag
Ids This property is required. List<String> - List of wxtag_ids
- wxtunnel
Id This property is required. String - When
interface
=wxtunnel
, id of the WXLAN Tunnel - wxtunnel
Remote Id This property is required. String - When
interface
=wxtunnel
, remote tunnel identifier
- acct
Immediate Update This property is required. boolean - Enable coa-immediate-update and address-change-immediate-update on the access profile.
- acct
Interim Interval This property is required. number - How frequently should interim accounting be reported, 60-65535. default is 0 (use one specified in Access-Accept request from RADIUS Server). Very frequent messages can affect the performance of the radius server, 600 and up is recommended when enabled
- acct
Servers This property is required. GetWlans Site Wlan Acct Server[] - List of RADIUS accounting servers, optional, order matters where the first one is treated as primary
- airwatch
This property is required. GetWlans Site Wlan Airwatch - Airwatch wlan settings
- allow
Ipv6Ndp This property is required. boolean - Only applicable when limit_bcast==true, which allows or disallows ipv6 Neighbor Discovery packets to go through
- allow
Mdns This property is required. boolean - Only applicable when limit_bcast==true, which allows mDNS / Bonjour packets to go through
- allow
Ssdp This property is required. boolean - Only applicable when
limit_bcast
==true
, which allows SSDP - ap
Ids This property is required. string[] - List of device ids
- app
Limit This property is required. GetWlans Site Wlan App Limit - Bandwidth limiting for apps (applies to up/down)
- app
Qos This property is required. GetWlans Site Wlan App Qos - APp qos wlan settings
- apply
To This property is required. string - enum:
aps
,site
,wxtags
- arp
Filter This property is required. boolean - Whether to enable smart arp filter
- auth
This property is required. GetWlans Site Wlan Auth - Authentication wlan settings
- auth
Server Selection This property is required. string - When ordered, AP will prefer and go back to the first server if possible. enum:
ordered
,unordered
- auth
Servers This property is required. GetWlans Site Wlan Auth Server[] - List of RADIUS authentication servers, at least one is needed if
auth type
==eap
, order matters where the first one is treated as primary - auth
Servers Nas Id This property is required. string - Optional, up to 48 bytes, will be dynamically generated if not provided. used only for authentication servers
- auth
Servers Nas Ip This property is required. string - Optional, NAS-IP-ADDRESS to use
- auth
Servers Retries This property is required. number - Radius auth session retries. Following fast timers are set if "fast_dot1x_timers" knob is enabled. ‘retries’ are set to value of auth_servers_retries. ‘max-requests’ is also set when setting auth_servers_retries and is set to default value to 3.
- auth
Servers Timeout This property is required. number - Radius auth session timeout. Following fast timers are set if "fast_dot1x_timers" knob is enabled. ‘quite-period’ and ‘transmit-period’ are set to half the value of auth_servers_timeout. ‘supplicant-timeout’ is also set when setting auth_servers_timeout and is set to default value of 10.
- band
Steer This property is required. boolean - Whether to enable band_steering, this works only when band==both
- band
Steer Force Band5 This property is required. boolean - Force dual_band capable client to connect to 5G
- bands
This property is required. string[] - List of radios that the wlan should apply to.
- block
Blacklist Clients This property is required. boolean - Whether to block the clients in the blacklist (up to first 256 macs)
- bonjour
This property is required. GetWlans Site Wlan Bonjour - Bonjour gateway wlan settings
- cisco
Cwa This property is required. GetWlans Site Wlan Cisco Cwa - Cisco CWA (central web authentication) required RADIUS with COA in order to work. See CWA: https://www.cisco.com/c/en/us/support/docs/security/identity-services-engine/115732-central-web-auth-00.html
- client
Limit Down This property is required. number - In kbps
- client
Limit Down Enabled This property is required. boolean - If downlink limiting per-client is enabled
- client
Limit Up This property is required. number - In kbps
- client
Limit Up Enabled This property is required. boolean - If uplink limiting per-client is enabled
- coa
Servers This property is required. GetWlans Site Wlan Coa Server[] - List of COA (change of authorization) servers, optional
- created
Time This property is required. number - When the object has been created, in epoch
- disable11ax
This property is required. boolean - Some old WLAN drivers may not be compatible
- disable11be
This property is required. boolean - To disable Wi-Fi 7 EHT IEs
- disable
Ht Vht Rates This property is required. boolean - To disable ht or vht rates
- disable
Uapsd This property is required. boolean - Whether to disable U-APSD
- disable
V1Roam Notify This property is required. boolean - Disable sending v2 roam notification messages
- disable
V2Roam Notify This property is required. boolean - Disable sending v2 roam notification messages
- disable
When Gateway Unreachable This property is required. boolean - When any of the following is true, this WLAN will be disabled
- cannot get IP
- cannot obtain default gateway
- cannot reach default gateway
- disable
When Mxtunnel Down This property is required. boolean - disable
Wmm This property is required. boolean - Whether to disable WMM
- dns
Server Rewrite This property is required. GetWlans Site Wlan Dns Server Rewrite - For radius_group-based DNS server (rewrite DNS request depending on the Group RADIUS server returns)
- dtim
This property is required. number - dynamic
Psk This property is required. GetWlans Site Wlan Dynamic Psk - For dynamic PSK where we get per_user PSK from Radius. dynamic_psk allows PSK to be selected at runtime depending on context (wlan/site/user/...) thus following configurations are assumed (currently)
- PSK will come from RADIUS server
- AP sends client MAC as username and password (i.e.
enable_mac_auth
is assumed) - AP sends BSSID:SSID as Caller-Station-ID
auth_servers
is required- PSK will come from cloud WLC if source is cloud_psks
- default_psk will be used if cloud WLC is not available
multi_psk_only
andpsk
is ignoredpairwise
can only be wpa2-ccmp (for now, wpa3 support on the roadmap)
- dynamic
Vlan This property is required. GetWlans Site Wlan Dynamic Vlan - For 802.1x
- enable
Local Keycaching This property is required. boolean - Enable AP-AP keycaching via multicast
- enable
Wireless Bridging This property is required. boolean - By default, we'd inspect all DHCP packets and drop those unrelated to the wireless client itself in the case where client is a wireless bridge (DHCP packets for other MACs will need to be forwarded), wireless_bridging can be enabled
- enable
Wireless Bridging Dhcp Tracking This property is required. boolean - If the client bridge is doing DHCP on behalf of other devices (L2-NAT), enable dhcp_tracking will cut down DHCP response packets to be forwarded to wireless
- enabled
This property is required. boolean - If this wlan is enabled
- fast
Dot1x Timers This property is required. boolean - If set to true, sets default fast-timers with values calculated from ‘auth_servers_timeout’ and ‘auth_server_retries’ .
- hide
Ssid This property is required. boolean - Whether to hide SSID in beacon
- hostname
Ie This property is required. boolean - Include hostname inside IE in AP beacons / probe responses
- hotspot20
This property is required. GetWlans Site Wlan Hotspot20 - Hostspot 2.0 wlan settings
- id
This property is required. string - Unique ID of the object instance in the Mist Organization
- inject
Dhcp Option82 This property is required. GetWlans Site Wlan Inject Dhcp Option82 - interface
This property is required. string - where this WLAN will be connected to. enum:
all
,eth0
,eth1
,eth2
,eth3
,mxtunnel
,site_mxedge
,wxtunnel
- isolation
This property is required. boolean - Whether to stop clients to talk to each other
- l2Isolation
This property is required. boolean - If isolation is enabled, whether to deny clients to talk to L2 on the LAN
- legacy
Overds This property is required. boolean - Legacy devices requires the Over-DS (for Fast BSS Transition) bit set (while our chip doesn’t support it). Warning! Enabling this will cause problem for iOS devices.
- limit
Bcast This property is required. boolean - Whether to limit broadcast packets going to wireless (i.e. only allow certain bcast packets to go through)
- limit
Probe Response This property is required. boolean - Limit probe response base on some heuristic rules
- max
Idletime This property is required. number - Max idle time in seconds
- max
Num Clients This property is required. number - Maximum number of client connected to the SSID.
0
means unlimited - mist
Nac This property is required. GetWlans Site Wlan Mist Nac - modified
Time This property is required. number - When the object has been modified for the last time, in epoch
- msp
Id This property is required. string - mxtunnel
Ids This property is required. string[] - When
interface
=mxtunnel
, id of the Mist Tunnel - mxtunnel
Names This property is required. string[] - When
interface
=site_mxedge
, name of the mxtunnel that in mxtunnels under Site Setting - no
Static Dns This property is required. boolean - Whether to only allow client to use DNS that we’ve learned from DHCP response
- no
Static Ip This property is required. boolean - Whether to only allow client that we’ve learned from DHCP exchange to talk
- org
Id This property is required. string - portal
This property is required. GetWlans Site Wlan Portal - Portal wlan settings
- portal
Allowed Hostnames This property is required. string[] - List of hostnames without http(s):// (matched by substring)
- portal
Allowed Subnets This property is required. string[] - List of CIDRs
- portal
Api Secret This property is required. string - APi secret (auto-generated) that can be used to sign guest authorization requests
- portal
Denied Hostnames This property is required. string[] - List of hostnames without http(s):// (matched by substring), this takes precedence over portal_allowed_hostnames
- portal
Image This property is required. string - Url of portal background image
- portal
Sso Url This property is required. string - qos
This property is required. GetWlans Site Wlan Qos - radsec
This property is required. GetWlans Site Wlan Radsec - RadSec settings
- rateset
This property is required. {[key: string]: GetWlans Site Wlan Rateset} - Property key is the RF band. enum:
24
,5
,6
- reconnect
Clients When Roaming Mxcluster This property is required. boolean - When different mxcluster is on different subnet, we'd want to disconnect clients (so they'll reconnect and get new IPs)
- roam
Mode This property is required. string - enum:
11r
,OKC
,NONE
- schedule
This property is required. GetWlans Site Wlan Schedule - WLAN operating schedule, default is disabled
- site
Id This property is required. string - sle
Excluded This property is required. boolean - Whether to exclude this WLAN from SLE metrics
- ssid
This property is required. string - Name of the SSID
- use
Eapol V1 This property is required. boolean - If
auth.type
==eap
orauth.type
==psk
, should only be set for legacy client, such as pre-2004, 802.11b devices - vlan
Enabled This property is required. boolean - If vlan tagging is enabled
- vlan
Id This property is required. string - vlan
Ids This property is required. string[] - if
vlan_enabled
==true
andvlan_pooling
==true
. List of VLAN IDs (comma separated) to be used in the VLAN Pool - vlan
Pooling This property is required. boolean - Requires
vlan_enabled
==true
to be set totrue
. Vlan pooling allows AP to place client on different VLAN using a deterministic algorithm - wlan
Limit Down This property is required. number - In kbps
- wlan
Limit Down Enabled This property is required. boolean - If downlink limiting for whole wlan is enabled
- wlan
Limit Up This property is required. number - In kbps
- wlan
Limit Up Enabled This property is required. boolean - If uplink limiting for whole wlan is enabled
- wxtag
Ids This property is required. string[] - List of wxtag_ids
- wxtunnel
Id This property is required. string - When
interface
=wxtunnel
, id of the WXLAN Tunnel - wxtunnel
Remote Id This property is required. string - When
interface
=wxtunnel
, remote tunnel identifier
- acct_
immediate_ update This property is required. bool - Enable coa-immediate-update and address-change-immediate-update on the access profile.
- acct_
interim_ interval This property is required. int - How frequently should interim accounting be reported, 60-65535. default is 0 (use one specified in Access-Accept request from RADIUS Server). Very frequent messages can affect the performance of the radius server, 600 and up is recommended when enabled
- acct_
servers This property is required. Sequence[GetWlans Site Wlan Acct Server] - List of RADIUS accounting servers, optional, order matters where the first one is treated as primary
- airwatch
This property is required. GetWlans Site Wlan Airwatch - Airwatch wlan settings
- allow_
ipv6_ ndp This property is required. bool - Only applicable when limit_bcast==true, which allows or disallows ipv6 Neighbor Discovery packets to go through
- allow_
mdns This property is required. bool - Only applicable when limit_bcast==true, which allows mDNS / Bonjour packets to go through
- allow_
ssdp This property is required. bool - Only applicable when
limit_bcast
==true
, which allows SSDP - ap_
ids This property is required. Sequence[str] - List of device ids
- app_
limit This property is required. GetWlans Site Wlan App Limit - Bandwidth limiting for apps (applies to up/down)
- app_
qos This property is required. GetWlans Site Wlan App Qos - APp qos wlan settings
- apply_
to This property is required. str - enum:
aps
,site
,wxtags
- arp_
filter This property is required. bool - Whether to enable smart arp filter
- auth
This property is required. GetWlans Site Wlan Auth - Authentication wlan settings
- auth_
server_ selection This property is required. str - When ordered, AP will prefer and go back to the first server if possible. enum:
ordered
,unordered
- auth_
servers This property is required. Sequence[GetWlans Site Wlan Auth Server] - List of RADIUS authentication servers, at least one is needed if
auth type
==eap
, order matters where the first one is treated as primary - auth_
servers_ nas_ id This property is required. str - Optional, up to 48 bytes, will be dynamically generated if not provided. used only for authentication servers
- auth_
servers_ nas_ ip This property is required. str - Optional, NAS-IP-ADDRESS to use
- auth_
servers_ retries This property is required. int - Radius auth session retries. Following fast timers are set if "fast_dot1x_timers" knob is enabled. ‘retries’ are set to value of auth_servers_retries. ‘max-requests’ is also set when setting auth_servers_retries and is set to default value to 3.
- auth_
servers_ timeout This property is required. int - Radius auth session timeout. Following fast timers are set if "fast_dot1x_timers" knob is enabled. ‘quite-period’ and ‘transmit-period’ are set to half the value of auth_servers_timeout. ‘supplicant-timeout’ is also set when setting auth_servers_timeout and is set to default value of 10.
- band_
steer This property is required. bool - Whether to enable band_steering, this works only when band==both
- band_
steer_ force_ band5 This property is required. bool - Force dual_band capable client to connect to 5G
- bands
This property is required. Sequence[str] - List of radios that the wlan should apply to.
- block_
blacklist_ clients This property is required. bool - Whether to block the clients in the blacklist (up to first 256 macs)
- bonjour
This property is required. GetWlans Site Wlan Bonjour - Bonjour gateway wlan settings
- cisco_
cwa This property is required. GetWlans Site Wlan Cisco Cwa - Cisco CWA (central web authentication) required RADIUS with COA in order to work. See CWA: https://www.cisco.com/c/en/us/support/docs/security/identity-services-engine/115732-central-web-auth-00.html
- client_
limit_ down This property is required. int - In kbps
- client_
limit_ down_ enabled This property is required. bool - If downlink limiting per-client is enabled
- client_
limit_ up This property is required. int - In kbps
- client_
limit_ up_ enabled This property is required. bool - If uplink limiting per-client is enabled
- coa_
servers This property is required. Sequence[GetWlans Site Wlan Coa Server] - List of COA (change of authorization) servers, optional
- created_
time This property is required. float - When the object has been created, in epoch
- disable11ax
This property is required. bool - Some old WLAN drivers may not be compatible
- disable11be
This property is required. bool - To disable Wi-Fi 7 EHT IEs
- disable_
ht_ vht_ rates This property is required. bool - To disable ht or vht rates
- disable_
uapsd This property is required. bool - Whether to disable U-APSD
- disable_
v1_ roam_ notify This property is required. bool - Disable sending v2 roam notification messages
- disable_
v2_ roam_ notify This property is required. bool - Disable sending v2 roam notification messages
- disable_
when_ gateway_ unreachable This property is required. bool - When any of the following is true, this WLAN will be disabled
- cannot get IP
- cannot obtain default gateway
- cannot reach default gateway
- disable_
when_ mxtunnel_ down This property is required. bool - disable_
wmm This property is required. bool - Whether to disable WMM
- dns_
server_ rewrite This property is required. GetWlans Site Wlan Dns Server Rewrite - For radius_group-based DNS server (rewrite DNS request depending on the Group RADIUS server returns)
- dtim
This property is required. int - dynamic_
psk This property is required. GetWlans Site Wlan Dynamic Psk - For dynamic PSK where we get per_user PSK from Radius. dynamic_psk allows PSK to be selected at runtime depending on context (wlan/site/user/...) thus following configurations are assumed (currently)
- PSK will come from RADIUS server
- AP sends client MAC as username and password (i.e.
enable_mac_auth
is assumed) - AP sends BSSID:SSID as Caller-Station-ID
auth_servers
is required- PSK will come from cloud WLC if source is cloud_psks
- default_psk will be used if cloud WLC is not available
multi_psk_only
andpsk
is ignoredpairwise
can only be wpa2-ccmp (for now, wpa3 support on the roadmap)
- dynamic_
vlan This property is required. GetWlans Site Wlan Dynamic Vlan - For 802.1x
- enable_
local_ keycaching This property is required. bool - Enable AP-AP keycaching via multicast
- enable_
wireless_ bridging This property is required. bool - By default, we'd inspect all DHCP packets and drop those unrelated to the wireless client itself in the case where client is a wireless bridge (DHCP packets for other MACs will need to be forwarded), wireless_bridging can be enabled
- enable_
wireless_ bridging_ dhcp_ tracking This property is required. bool - If the client bridge is doing DHCP on behalf of other devices (L2-NAT), enable dhcp_tracking will cut down DHCP response packets to be forwarded to wireless
- enabled
This property is required. bool - If this wlan is enabled
- fast_
dot1x_ timers This property is required. bool - If set to true, sets default fast-timers with values calculated from ‘auth_servers_timeout’ and ‘auth_server_retries’ .
- hide_
ssid This property is required. bool - Whether to hide SSID in beacon
- hostname_
ie This property is required. bool - Include hostname inside IE in AP beacons / probe responses
- hotspot20
This property is required. GetWlans Site Wlan Hotspot20 - Hostspot 2.0 wlan settings
- id
This property is required. str - Unique ID of the object instance in the Mist Organization
- inject_
dhcp_ option82 This property is required. GetWlans Site Wlan Inject Dhcp Option82 - interface
This property is required. str - where this WLAN will be connected to. enum:
all
,eth0
,eth1
,eth2
,eth3
,mxtunnel
,site_mxedge
,wxtunnel
- isolation
This property is required. bool - Whether to stop clients to talk to each other
- l2_
isolation This property is required. bool - If isolation is enabled, whether to deny clients to talk to L2 on the LAN
- legacy_
overds This property is required. bool - Legacy devices requires the Over-DS (for Fast BSS Transition) bit set (while our chip doesn’t support it). Warning! Enabling this will cause problem for iOS devices.
- limit_
bcast This property is required. bool - Whether to limit broadcast packets going to wireless (i.e. only allow certain bcast packets to go through)
- limit_
probe_ response This property is required. bool - Limit probe response base on some heuristic rules
- max_
idletime This property is required. int - Max idle time in seconds
- max_
num_ clients This property is required. int - Maximum number of client connected to the SSID.
0
means unlimited - mist_
nac This property is required. GetWlans Site Wlan Mist Nac - modified_
time This property is required. float - When the object has been modified for the last time, in epoch
- msp_
id This property is required. str - mxtunnel_
ids This property is required. Sequence[str] - When
interface
=mxtunnel
, id of the Mist Tunnel - mxtunnel_
names This property is required. Sequence[str] - When
interface
=site_mxedge
, name of the mxtunnel that in mxtunnels under Site Setting - no_
static_ dns This property is required. bool - Whether to only allow client to use DNS that we’ve learned from DHCP response
- no_
static_ ip This property is required. bool - Whether to only allow client that we’ve learned from DHCP exchange to talk
- org_
id This property is required. str - portal
This property is required. GetWlans Site Wlan Portal - Portal wlan settings
- portal_
allowed_ hostnames This property is required. Sequence[str] - List of hostnames without http(s):// (matched by substring)
- portal_
allowed_ subnets This property is required. Sequence[str] - List of CIDRs
- portal_
api_ secret This property is required. str - APi secret (auto-generated) that can be used to sign guest authorization requests
- portal_
denied_ hostnames This property is required. Sequence[str] - List of hostnames without http(s):// (matched by substring), this takes precedence over portal_allowed_hostnames
- portal_
image This property is required. str - Url of portal background image
- portal_
sso_ url This property is required. str - qos
This property is required. GetWlans Site Wlan Qos - radsec
This property is required. GetWlans Site Wlan Radsec - RadSec settings
- rateset
This property is required. Mapping[str, GetWlans Site Wlan Rateset] - Property key is the RF band. enum:
24
,5
,6
- reconnect_
clients_ when_ roaming_ mxcluster This property is required. bool - When different mxcluster is on different subnet, we'd want to disconnect clients (so they'll reconnect and get new IPs)
- roam_
mode This property is required. str - enum:
11r
,OKC
,NONE
- schedule
This property is required. GetWlans Site Wlan Schedule - WLAN operating schedule, default is disabled
- site_
id This property is required. str - sle_
excluded This property is required. bool - Whether to exclude this WLAN from SLE metrics
- ssid
This property is required. str - Name of the SSID
- use_
eapol_ v1 This property is required. bool - If
auth.type
==eap
orauth.type
==psk
, should only be set for legacy client, such as pre-2004, 802.11b devices - vlan_
enabled This property is required. bool - If vlan tagging is enabled
- vlan_
id This property is required. str - vlan_
ids This property is required. Sequence[str] - if
vlan_enabled
==true
andvlan_pooling
==true
. List of VLAN IDs (comma separated) to be used in the VLAN Pool - vlan_
pooling This property is required. bool - Requires
vlan_enabled
==true
to be set totrue
. Vlan pooling allows AP to place client on different VLAN using a deterministic algorithm - wlan_
limit_ down This property is required. int - In kbps
- wlan_
limit_ down_ enabled This property is required. bool - If downlink limiting for whole wlan is enabled
- wlan_
limit_ up This property is required. int - In kbps
- wlan_
limit_ up_ enabled This property is required. bool - If uplink limiting for whole wlan is enabled
- wxtag_
ids This property is required. Sequence[str] - List of wxtag_ids
- wxtunnel_
id This property is required. str - When
interface
=wxtunnel
, id of the WXLAN Tunnel - wxtunnel_
remote_ id This property is required. str - When
interface
=wxtunnel
, remote tunnel identifier
- acct
Immediate Update This property is required. Boolean - Enable coa-immediate-update and address-change-immediate-update on the access profile.
- acct
Interim Interval This property is required. Number - How frequently should interim accounting be reported, 60-65535. default is 0 (use one specified in Access-Accept request from RADIUS Server). Very frequent messages can affect the performance of the radius server, 600 and up is recommended when enabled
- acct
Servers This property is required. List<Property Map> - List of RADIUS accounting servers, optional, order matters where the first one is treated as primary
- airwatch
This property is required. Property Map - Airwatch wlan settings
- allow
Ipv6Ndp This property is required. Boolean - Only applicable when limit_bcast==true, which allows or disallows ipv6 Neighbor Discovery packets to go through
- allow
Mdns This property is required. Boolean - Only applicable when limit_bcast==true, which allows mDNS / Bonjour packets to go through
- allow
Ssdp This property is required. Boolean - Only applicable when
limit_bcast
==true
, which allows SSDP - ap
Ids This property is required. List<String> - List of device ids
- app
Limit This property is required. Property Map - Bandwidth limiting for apps (applies to up/down)
- app
Qos This property is required. Property Map - APp qos wlan settings
- apply
To This property is required. String - enum:
aps
,site
,wxtags
- arp
Filter This property is required. Boolean - Whether to enable smart arp filter
- auth
This property is required. Property Map - Authentication wlan settings
- auth
Server Selection This property is required. String - When ordered, AP will prefer and go back to the first server if possible. enum:
ordered
,unordered
- auth
Servers This property is required. List<Property Map> - List of RADIUS authentication servers, at least one is needed if
auth type
==eap
, order matters where the first one is treated as primary - auth
Servers Nas Id This property is required. String - Optional, up to 48 bytes, will be dynamically generated if not provided. used only for authentication servers
- auth
Servers Nas Ip This property is required. String - Optional, NAS-IP-ADDRESS to use
- auth
Servers Retries This property is required. Number - Radius auth session retries. Following fast timers are set if "fast_dot1x_timers" knob is enabled. ‘retries’ are set to value of auth_servers_retries. ‘max-requests’ is also set when setting auth_servers_retries and is set to default value to 3.
- auth
Servers Timeout This property is required. Number - Radius auth session timeout. Following fast timers are set if "fast_dot1x_timers" knob is enabled. ‘quite-period’ and ‘transmit-period’ are set to half the value of auth_servers_timeout. ‘supplicant-timeout’ is also set when setting auth_servers_timeout and is set to default value of 10.
- band
Steer This property is required. Boolean - Whether to enable band_steering, this works only when band==both
- band
Steer Force Band5 This property is required. Boolean - Force dual_band capable client to connect to 5G
- bands
This property is required. List<String> - List of radios that the wlan should apply to.
- block
Blacklist Clients This property is required. Boolean - Whether to block the clients in the blacklist (up to first 256 macs)
- bonjour
This property is required. Property Map - Bonjour gateway wlan settings
- cisco
Cwa This property is required. Property Map - Cisco CWA (central web authentication) required RADIUS with COA in order to work. See CWA: https://www.cisco.com/c/en/us/support/docs/security/identity-services-engine/115732-central-web-auth-00.html
- client
Limit Down This property is required. Number - In kbps
- client
Limit Down Enabled This property is required. Boolean - If downlink limiting per-client is enabled
- client
Limit Up This property is required. Number - In kbps
- client
Limit Up Enabled This property is required. Boolean - If uplink limiting per-client is enabled
- coa
Servers This property is required. List<Property Map> - List of COA (change of authorization) servers, optional
- created
Time This property is required. Number - When the object has been created, in epoch
- disable11ax
This property is required. Boolean - Some old WLAN drivers may not be compatible
- disable11be
This property is required. Boolean - To disable Wi-Fi 7 EHT IEs
- disable
Ht Vht Rates This property is required. Boolean - To disable ht or vht rates
- disable
Uapsd This property is required. Boolean - Whether to disable U-APSD
- disable
V1Roam Notify This property is required. Boolean - Disable sending v2 roam notification messages
- disable
V2Roam Notify This property is required. Boolean - Disable sending v2 roam notification messages
- disable
When Gateway Unreachable This property is required. Boolean - When any of the following is true, this WLAN will be disabled
- cannot get IP
- cannot obtain default gateway
- cannot reach default gateway
- disable
When Mxtunnel Down This property is required. Boolean - disable
Wmm This property is required. Boolean - Whether to disable WMM
- dns
Server Rewrite This property is required. Property Map - For radius_group-based DNS server (rewrite DNS request depending on the Group RADIUS server returns)
- dtim
This property is required. Number - dynamic
Psk This property is required. Property Map - For dynamic PSK where we get per_user PSK from Radius. dynamic_psk allows PSK to be selected at runtime depending on context (wlan/site/user/...) thus following configurations are assumed (currently)
- PSK will come from RADIUS server
- AP sends client MAC as username and password (i.e.
enable_mac_auth
is assumed) - AP sends BSSID:SSID as Caller-Station-ID
auth_servers
is required- PSK will come from cloud WLC if source is cloud_psks
- default_psk will be used if cloud WLC is not available
multi_psk_only
andpsk
is ignoredpairwise
can only be wpa2-ccmp (for now, wpa3 support on the roadmap)
- dynamic
Vlan This property is required. Property Map - For 802.1x
- enable
Local Keycaching This property is required. Boolean - Enable AP-AP keycaching via multicast
- enable
Wireless Bridging This property is required. Boolean - By default, we'd inspect all DHCP packets and drop those unrelated to the wireless client itself in the case where client is a wireless bridge (DHCP packets for other MACs will need to be forwarded), wireless_bridging can be enabled
- enable
Wireless Bridging Dhcp Tracking This property is required. Boolean - If the client bridge is doing DHCP on behalf of other devices (L2-NAT), enable dhcp_tracking will cut down DHCP response packets to be forwarded to wireless
- enabled
This property is required. Boolean - If this wlan is enabled
- fast
Dot1x Timers This property is required. Boolean - If set to true, sets default fast-timers with values calculated from ‘auth_servers_timeout’ and ‘auth_server_retries’ .
- hide
Ssid This property is required. Boolean - Whether to hide SSID in beacon
- hostname
Ie This property is required. Boolean - Include hostname inside IE in AP beacons / probe responses
- hotspot20
This property is required. Property Map - Hostspot 2.0 wlan settings
- id
This property is required. String - Unique ID of the object instance in the Mist Organization
- inject
Dhcp Option82 This property is required. Property Map - interface
This property is required. String - where this WLAN will be connected to. enum:
all
,eth0
,eth1
,eth2
,eth3
,mxtunnel
,site_mxedge
,wxtunnel
- isolation
This property is required. Boolean - Whether to stop clients to talk to each other
- l2Isolation
This property is required. Boolean - If isolation is enabled, whether to deny clients to talk to L2 on the LAN
- legacy
Overds This property is required. Boolean - Legacy devices requires the Over-DS (for Fast BSS Transition) bit set (while our chip doesn’t support it). Warning! Enabling this will cause problem for iOS devices.
- limit
Bcast This property is required. Boolean - Whether to limit broadcast packets going to wireless (i.e. only allow certain bcast packets to go through)
- limit
Probe Response This property is required. Boolean - Limit probe response base on some heuristic rules
- max
Idletime This property is required. Number - Max idle time in seconds
- max
Num Clients This property is required. Number - Maximum number of client connected to the SSID.
0
means unlimited - mist
Nac This property is required. Property Map - modified
Time This property is required. Number - When the object has been modified for the last time, in epoch
- msp
Id This property is required. String - mxtunnel
Ids This property is required. List<String> - When
interface
=mxtunnel
, id of the Mist Tunnel - mxtunnel
Names This property is required. List<String> - When
interface
=site_mxedge
, name of the mxtunnel that in mxtunnels under Site Setting - no
Static Dns This property is required. Boolean - Whether to only allow client to use DNS that we’ve learned from DHCP response
- no
Static Ip This property is required. Boolean - Whether to only allow client that we’ve learned from DHCP exchange to talk
- org
Id This property is required. String - portal
This property is required. Property Map - Portal wlan settings
- portal
Allowed Hostnames This property is required. List<String> - List of hostnames without http(s):// (matched by substring)
- portal
Allowed Subnets This property is required. List<String> - List of CIDRs
- portal
Api Secret This property is required. String - APi secret (auto-generated) that can be used to sign guest authorization requests
- portal
Denied Hostnames This property is required. List<String> - List of hostnames without http(s):// (matched by substring), this takes precedence over portal_allowed_hostnames
- portal
Image This property is required. String - Url of portal background image
- portal
Sso Url This property is required. String - qos
This property is required. Property Map - radsec
This property is required. Property Map - RadSec settings
- rateset
This property is required. Map<Property Map> - Property key is the RF band. enum:
24
,5
,6
- reconnect
Clients When Roaming Mxcluster This property is required. Boolean - When different mxcluster is on different subnet, we'd want to disconnect clients (so they'll reconnect and get new IPs)
- roam
Mode This property is required. String - enum:
11r
,OKC
,NONE
- schedule
This property is required. Property Map - WLAN operating schedule, default is disabled
- site
Id This property is required. String - sle
Excluded This property is required. Boolean - Whether to exclude this WLAN from SLE metrics
- ssid
This property is required. String - Name of the SSID
- use
Eapol V1 This property is required. Boolean - If
auth.type
==eap
orauth.type
==psk
, should only be set for legacy client, such as pre-2004, 802.11b devices - vlan
Enabled This property is required. Boolean - If vlan tagging is enabled
- vlan
Id This property is required. String - vlan
Ids This property is required. List<String> - if
vlan_enabled
==true
andvlan_pooling
==true
. List of VLAN IDs (comma separated) to be used in the VLAN Pool - vlan
Pooling This property is required. Boolean - Requires
vlan_enabled
==true
to be set totrue
. Vlan pooling allows AP to place client on different VLAN using a deterministic algorithm - wlan
Limit Down This property is required. Number - In kbps
- wlan
Limit Down Enabled This property is required. Boolean - If downlink limiting for whole wlan is enabled
- wlan
Limit Up This property is required. Number - In kbps
- wlan
Limit Up Enabled This property is required. Boolean - If uplink limiting for whole wlan is enabled
- wxtag
Ids This property is required. List<String> - List of wxtag_ids
- wxtunnel
Id This property is required. String - When
interface
=wxtunnel
, id of the WXLAN Tunnel - wxtunnel
Remote Id This property is required. String - When
interface
=wxtunnel
, remote tunnel identifier
GetWlansSiteWlanAcctServer
- Host
This property is required. string - IP/ hostname of RADIUS server
- Keywrap
Enabled This property is required. bool - Keywrap
Format This property is required. string - enum:
ascii
,hex
- Keywrap
Kek This property is required. string - Keywrap
Mack This property is required. string - Port
This property is required. int - Acct port of RADIUS server
- Secret
This property is required. string - Secret of RADIUS server
- Host
This property is required. string - IP/ hostname of RADIUS server
- Keywrap
Enabled This property is required. bool - Keywrap
Format This property is required. string - enum:
ascii
,hex
- Keywrap
Kek This property is required. string - Keywrap
Mack This property is required. string - Port
This property is required. int - Acct port of RADIUS server
- Secret
This property is required. string - Secret of RADIUS server
- host
This property is required. String - IP/ hostname of RADIUS server
- keywrap
Enabled This property is required. Boolean - keywrap
Format This property is required. String - enum:
ascii
,hex
- keywrap
Kek This property is required. String - keywrap
Mack This property is required. String - port
This property is required. Integer - Acct port of RADIUS server
- secret
This property is required. String - Secret of RADIUS server
- host
This property is required. string - IP/ hostname of RADIUS server
- keywrap
Enabled This property is required. boolean - keywrap
Format This property is required. string - enum:
ascii
,hex
- keywrap
Kek This property is required. string - keywrap
Mack This property is required. string - port
This property is required. number - Acct port of RADIUS server
- secret
This property is required. string - Secret of RADIUS server
- host
This property is required. str - IP/ hostname of RADIUS server
- keywrap_
enabled This property is required. bool - keywrap_
format This property is required. str - enum:
ascii
,hex
- keywrap_
kek This property is required. str - keywrap_
mack This property is required. str - port
This property is required. int - Acct port of RADIUS server
- secret
This property is required. str - Secret of RADIUS server
- host
This property is required. String - IP/ hostname of RADIUS server
- keywrap
Enabled This property is required. Boolean - keywrap
Format This property is required. String - enum:
ascii
,hex
- keywrap
Kek This property is required. String - keywrap
Mack This property is required. String - port
This property is required. Number - Acct port of RADIUS server
- secret
This property is required. String - Secret of RADIUS server
GetWlansSiteWlanAirwatch
- Api
Key This property is required. string - API Key
- Console
Url This property is required. string - Console URL
- Enabled
This property is required. bool - Password
This property is required. string - Password
- Username
This property is required. string - Username
- Api
Key This property is required. string - API Key
- Console
Url This property is required. string - Console URL
- Enabled
This property is required. bool - Password
This property is required. string - Password
- Username
This property is required. string - Username
- api
Key This property is required. String - API Key
- console
Url This property is required. String - Console URL
- enabled
This property is required. Boolean - password
This property is required. String - Password
- username
This property is required. String - Username
- api
Key This property is required. string - API Key
- console
Url This property is required. string - Console URL
- enabled
This property is required. boolean - password
This property is required. string - Password
- username
This property is required. string - Username
- api_
key This property is required. str - API Key
- console_
url This property is required. str - Console URL
- enabled
This property is required. bool - password
This property is required. str - Password
- username
This property is required. str - Username
- api
Key This property is required. String - API Key
- console
Url This property is required. String - Console URL
- enabled
This property is required. Boolean - password
This property is required. String - Password
- username
This property is required. String - Username
GetWlansSiteWlanAppLimit
- Apps
This property is required. Dictionary<string, int> - Map from app key to bandwidth in kbps. Property key is the app key, defined in Get Application List
- Enabled
This property is required. bool - Wxtag
Ids This property is required. Dictionary<string, int> - Map from wxtag_id of Hostname Wxlan Tags to bandwidth in kbps. Property key is the
wxtag_id
- Apps
This property is required. map[string]int - Map from app key to bandwidth in kbps. Property key is the app key, defined in Get Application List
- Enabled
This property is required. bool - Wxtag
Ids This property is required. map[string]int - Map from wxtag_id of Hostname Wxlan Tags to bandwidth in kbps. Property key is the
wxtag_id
- apps
This property is required. Map<String,Integer> - Map from app key to bandwidth in kbps. Property key is the app key, defined in Get Application List
- enabled
This property is required. Boolean - wxtag
Ids This property is required. Map<String,Integer> - Map from wxtag_id of Hostname Wxlan Tags to bandwidth in kbps. Property key is the
wxtag_id
- apps
This property is required. {[key: string]: number} - Map from app key to bandwidth in kbps. Property key is the app key, defined in Get Application List
- enabled
This property is required. boolean - wxtag
Ids This property is required. {[key: string]: number} - Map from wxtag_id of Hostname Wxlan Tags to bandwidth in kbps. Property key is the
wxtag_id
- apps
This property is required. Mapping[str, int] - Map from app key to bandwidth in kbps. Property key is the app key, defined in Get Application List
- enabled
This property is required. bool - wxtag_
ids This property is required. Mapping[str, int] - Map from wxtag_id of Hostname Wxlan Tags to bandwidth in kbps. Property key is the
wxtag_id
- apps
This property is required. Map<Number> - Map from app key to bandwidth in kbps. Property key is the app key, defined in Get Application List
- enabled
This property is required. Boolean - wxtag
Ids This property is required. Map<Number> - Map from wxtag_id of Hostname Wxlan Tags to bandwidth in kbps. Property key is the
wxtag_id
GetWlansSiteWlanAppQos
- Apps
This property is required. Dictionary<string, Pulumi.Juniper Mist. Site. Inputs. Get Wlans Site Wlan App Qos Apps> - Enabled
This property is required. bool - Others
This property is required. List<Pulumi.Juniper Mist. Site. Inputs. Get Wlans Site Wlan App Qos Other>
- Apps
This property is required. map[string]GetWlans Site Wlan App Qos Apps - Enabled
This property is required. bool - Others
This property is required. []GetWlans Site Wlan App Qos Other
- apps
This property is required. Map<String,GetWlans Site Wlan App Qos Apps> - enabled
This property is required. Boolean - others
This property is required. List<GetWlans Site Wlan App Qos Other>
- apps
This property is required. {[key: string]: GetWlans Site Wlan App Qos Apps} - enabled
This property is required. boolean - others
This property is required. GetWlans Site Wlan App Qos Other[]
- apps
This property is required. Mapping[str, GetWlans Site Wlan App Qos Apps] - enabled
This property is required. bool - others
This property is required. Sequence[GetWlans Site Wlan App Qos Other]
- apps
This property is required. Map<Property Map> - enabled
This property is required. Boolean - others
This property is required. List<Property Map>
GetWlansSiteWlanAppQosApps
- Dscp
This property is required. string - Dst
Subnet This property is required. string - Subnet filter is not required but helps AP to only inspect certain traffic (thus reducing AP load)
- Src
Subnet This property is required. string - Subnet filter is not required but helps AP to only inspect certain traffic (thus reducing AP load)
- Dscp
This property is required. string - Dst
Subnet This property is required. string - Subnet filter is not required but helps AP to only inspect certain traffic (thus reducing AP load)
- Src
Subnet This property is required. string - Subnet filter is not required but helps AP to only inspect certain traffic (thus reducing AP load)
- dscp
This property is required. String - dst
Subnet This property is required. String - Subnet filter is not required but helps AP to only inspect certain traffic (thus reducing AP load)
- src
Subnet This property is required. String - Subnet filter is not required but helps AP to only inspect certain traffic (thus reducing AP load)
- dscp
This property is required. string - dst
Subnet This property is required. string - Subnet filter is not required but helps AP to only inspect certain traffic (thus reducing AP load)
- src
Subnet This property is required. string - Subnet filter is not required but helps AP to only inspect certain traffic (thus reducing AP load)
- dscp
This property is required. str - dst_
subnet This property is required. str - Subnet filter is not required but helps AP to only inspect certain traffic (thus reducing AP load)
- src_
subnet This property is required. str - Subnet filter is not required but helps AP to only inspect certain traffic (thus reducing AP load)
- dscp
This property is required. String - dst
Subnet This property is required. String - Subnet filter is not required but helps AP to only inspect certain traffic (thus reducing AP load)
- src
Subnet This property is required. String - Subnet filter is not required but helps AP to only inspect certain traffic (thus reducing AP load)
GetWlansSiteWlanAppQosOther
- Dscp
This property is required. string - Dst
Subnet This property is required. string - Port
Ranges This property is required. string - Protocol
This property is required. string - Src
Subnet This property is required. string
- Dscp
This property is required. string - Dst
Subnet This property is required. string - Port
Ranges This property is required. string - Protocol
This property is required. string - Src
Subnet This property is required. string
- dscp
This property is required. String - dst
Subnet This property is required. String - port
Ranges This property is required. String - protocol
This property is required. String - src
Subnet This property is required. String
- dscp
This property is required. string - dst
Subnet This property is required. string - port
Ranges This property is required. string - protocol
This property is required. string - src
Subnet This property is required. string
- dscp
This property is required. str - dst_
subnet This property is required. str - port_
ranges This property is required. str - protocol
This property is required. str - src_
subnet This property is required. str
- dscp
This property is required. String - dst
Subnet This property is required. String - port
Ranges This property is required. String - protocol
This property is required. String - src
Subnet This property is required. String
GetWlansSiteWlanAuth
- Anticlog
Threshold This property is required. int - SAE anti-clogging token threshold
- Eap
Reauth This property is required. bool - Whether to trigger EAP reauth when the session ends
- Enable
Mac Auth This property is required. bool - Whether to enable MAC Auth, uses the same auth_servers
- Key
Idx This property is required. int - When
type
==wep
- Keys
This property is required. List<string> - When type=wep, four 10-character or 26-character hex string, null can be used. All keys, if provided, have to be in the same length
- Multi
Psk Only This property is required. bool - When
type
==psk
, whether to only use multi_psk - Owe
This property is required. string - if
type
==open
. enum:disabled
,enabled
(means transition mode),required
- Pairwises
This property is required. List<string> - When
type
=psk
ortype
=eap
, one or more ofwpa1-ccmp
,wpa1-tkip
,wpa2-ccmp
,wpa2-tkip
,wpa3
- Private
Wlan This property is required. bool - When
multi_psk_only
==true
, whether private wlan is enabled - Psk
This property is required. string - When
type
==psk
, 8-64 characters, or 64 hex characters - Type
This property is required. string - enum:
eap
,eap192
,open
,psk
,psk-tkip
,psk-wpa2-tkip
,wep
- Wep
As Secondary Auth This property is required. bool - Enable WEP as secondary auth
- Anticlog
Threshold This property is required. int - SAE anti-clogging token threshold
- Eap
Reauth This property is required. bool - Whether to trigger EAP reauth when the session ends
- Enable
Mac Auth This property is required. bool - Whether to enable MAC Auth, uses the same auth_servers
- Key
Idx This property is required. int - When
type
==wep
- Keys
This property is required. []string - When type=wep, four 10-character or 26-character hex string, null can be used. All keys, if provided, have to be in the same length
- Multi
Psk Only This property is required. bool - When
type
==psk
, whether to only use multi_psk - Owe
This property is required. string - if
type
==open
. enum:disabled
,enabled
(means transition mode),required
- Pairwises
This property is required. []string - When
type
=psk
ortype
=eap
, one or more ofwpa1-ccmp
,wpa1-tkip
,wpa2-ccmp
,wpa2-tkip
,wpa3
- Private
Wlan This property is required. bool - When
multi_psk_only
==true
, whether private wlan is enabled - Psk
This property is required. string - When
type
==psk
, 8-64 characters, or 64 hex characters - Type
This property is required. string - enum:
eap
,eap192
,open
,psk
,psk-tkip
,psk-wpa2-tkip
,wep
- Wep
As Secondary Auth This property is required. bool - Enable WEP as secondary auth
- anticlog
Threshold This property is required. Integer - SAE anti-clogging token threshold
- eap
Reauth This property is required. Boolean - Whether to trigger EAP reauth when the session ends
- enable
Mac Auth This property is required. Boolean - Whether to enable MAC Auth, uses the same auth_servers
- key
Idx This property is required. Integer - When
type
==wep
- keys
This property is required. List<String> - When type=wep, four 10-character or 26-character hex string, null can be used. All keys, if provided, have to be in the same length
- multi
Psk Only This property is required. Boolean - When
type
==psk
, whether to only use multi_psk - owe
This property is required. String - if
type
==open
. enum:disabled
,enabled
(means transition mode),required
- pairwises
This property is required. List<String> - When
type
=psk
ortype
=eap
, one or more ofwpa1-ccmp
,wpa1-tkip
,wpa2-ccmp
,wpa2-tkip
,wpa3
- private
Wlan This property is required. Boolean - When
multi_psk_only
==true
, whether private wlan is enabled - psk
This property is required. String - When
type
==psk
, 8-64 characters, or 64 hex characters - type
This property is required. String - enum:
eap
,eap192
,open
,psk
,psk-tkip
,psk-wpa2-tkip
,wep
- wep
As Secondary Auth This property is required. Boolean - Enable WEP as secondary auth
- anticlog
Threshold This property is required. number - SAE anti-clogging token threshold
- eap
Reauth This property is required. boolean - Whether to trigger EAP reauth when the session ends
- enable
Mac Auth This property is required. boolean - Whether to enable MAC Auth, uses the same auth_servers
- key
Idx This property is required. number - When
type
==wep
- keys
This property is required. string[] - When type=wep, four 10-character or 26-character hex string, null can be used. All keys, if provided, have to be in the same length
- multi
Psk Only This property is required. boolean - When
type
==psk
, whether to only use multi_psk - owe
This property is required. string - if
type
==open
. enum:disabled
,enabled
(means transition mode),required
- pairwises
This property is required. string[] - When
type
=psk
ortype
=eap
, one or more ofwpa1-ccmp
,wpa1-tkip
,wpa2-ccmp
,wpa2-tkip
,wpa3
- private
Wlan This property is required. boolean - When
multi_psk_only
==true
, whether private wlan is enabled - psk
This property is required. string - When
type
==psk
, 8-64 characters, or 64 hex characters - type
This property is required. string - enum:
eap
,eap192
,open
,psk
,psk-tkip
,psk-wpa2-tkip
,wep
- wep
As Secondary Auth This property is required. boolean - Enable WEP as secondary auth
- anticlog_
threshold This property is required. int - SAE anti-clogging token threshold
- eap_
reauth This property is required. bool - Whether to trigger EAP reauth when the session ends
- enable_
mac_ auth This property is required. bool - Whether to enable MAC Auth, uses the same auth_servers
- key_
idx This property is required. int - When
type
==wep
- keys
This property is required. Sequence[str] - When type=wep, four 10-character or 26-character hex string, null can be used. All keys, if provided, have to be in the same length
- multi_
psk_ only This property is required. bool - When
type
==psk
, whether to only use multi_psk - owe
This property is required. str - if
type
==open
. enum:disabled
,enabled
(means transition mode),required
- pairwises
This property is required. Sequence[str] - When
type
=psk
ortype
=eap
, one or more ofwpa1-ccmp
,wpa1-tkip
,wpa2-ccmp
,wpa2-tkip
,wpa3
- private_
wlan This property is required. bool - When
multi_psk_only
==true
, whether private wlan is enabled - psk
This property is required. str - When
type
==psk
, 8-64 characters, or 64 hex characters - type
This property is required. str - enum:
eap
,eap192
,open
,psk
,psk-tkip
,psk-wpa2-tkip
,wep
- wep_
as_ secondary_ auth This property is required. bool - Enable WEP as secondary auth
- anticlog
Threshold This property is required. Number - SAE anti-clogging token threshold
- eap
Reauth This property is required. Boolean - Whether to trigger EAP reauth when the session ends
- enable
Mac Auth This property is required. Boolean - Whether to enable MAC Auth, uses the same auth_servers
- key
Idx This property is required. Number - When
type
==wep
- keys
This property is required. List<String> - When type=wep, four 10-character or 26-character hex string, null can be used. All keys, if provided, have to be in the same length
- multi
Psk Only This property is required. Boolean - When
type
==psk
, whether to only use multi_psk - owe
This property is required. String - if
type
==open
. enum:disabled
,enabled
(means transition mode),required
- pairwises
This property is required. List<String> - When
type
=psk
ortype
=eap
, one or more ofwpa1-ccmp
,wpa1-tkip
,wpa2-ccmp
,wpa2-tkip
,wpa3
- private
Wlan This property is required. Boolean - When
multi_psk_only
==true
, whether private wlan is enabled - psk
This property is required. String - When
type
==psk
, 8-64 characters, or 64 hex characters - type
This property is required. String - enum:
eap
,eap192
,open
,psk
,psk-tkip
,psk-wpa2-tkip
,wep
- wep
As Secondary Auth This property is required. Boolean - Enable WEP as secondary auth
GetWlansSiteWlanAuthServer
- Host
This property is required. string - IP/ hostname of RADIUS server
- Keywrap
Enabled This property is required. bool - Keywrap
Format This property is required. string - enum:
ascii
,hex
- Keywrap
Kek This property is required. string - Keywrap
Mack This property is required. string - Port
This property is required. int - Auth port of RADIUS server
- Require
Message Authenticator This property is required. bool - Whether to require Message-Authenticator in requests
- Secret
This property is required. string - Secret of RADIUS server
- Host
This property is required. string - IP/ hostname of RADIUS server
- Keywrap
Enabled This property is required. bool - Keywrap
Format This property is required. string - enum:
ascii
,hex
- Keywrap
Kek This property is required. string - Keywrap
Mack This property is required. string - Port
This property is required. int - Auth port of RADIUS server
- Require
Message Authenticator This property is required. bool - Whether to require Message-Authenticator in requests
- Secret
This property is required. string - Secret of RADIUS server
- host
This property is required. String - IP/ hostname of RADIUS server
- keywrap
Enabled This property is required. Boolean - keywrap
Format This property is required. String - enum:
ascii
,hex
- keywrap
Kek This property is required. String - keywrap
Mack This property is required. String - port
This property is required. Integer - Auth port of RADIUS server
- require
Message Authenticator This property is required. Boolean - Whether to require Message-Authenticator in requests
- secret
This property is required. String - Secret of RADIUS server
- host
This property is required. string - IP/ hostname of RADIUS server
- keywrap
Enabled This property is required. boolean - keywrap
Format This property is required. string - enum:
ascii
,hex
- keywrap
Kek This property is required. string - keywrap
Mack This property is required. string - port
This property is required. number - Auth port of RADIUS server
- require
Message Authenticator This property is required. boolean - Whether to require Message-Authenticator in requests
- secret
This property is required. string - Secret of RADIUS server
- host
This property is required. str - IP/ hostname of RADIUS server
- keywrap_
enabled This property is required. bool - keywrap_
format This property is required. str - enum:
ascii
,hex
- keywrap_
kek This property is required. str - keywrap_
mack This property is required. str - port
This property is required. int - Auth port of RADIUS server
- require_
message_ authenticator This property is required. bool - Whether to require Message-Authenticator in requests
- secret
This property is required. str - Secret of RADIUS server
- host
This property is required. String - IP/ hostname of RADIUS server
- keywrap
Enabled This property is required. Boolean - keywrap
Format This property is required. String - enum:
ascii
,hex
- keywrap
Kek This property is required. String - keywrap
Mack This property is required. String - port
This property is required. Number - Auth port of RADIUS server
- require
Message Authenticator This property is required. Boolean - Whether to require Message-Authenticator in requests
- secret
This property is required. String - Secret of RADIUS server
GetWlansSiteWlanBonjour
- Additional
Vlan Ids This property is required. List<string> - additional VLAN IDs (on the LAN side or from other WLANs) should we be forwarding bonjour queries/responses
- Enabled
This property is required. bool - Whether to enable bonjour for this WLAN. Once enabled, limit_bcast is assumed true, allow_mdns is assumed false
- Services
This property is required. Dictionary<string, Pulumi.Juniper Mist. Site. Inputs. Get Wlans Site Wlan Bonjour Services> - What services are allowed. Property key is the service name
- Additional
Vlan Ids This property is required. []string - additional VLAN IDs (on the LAN side or from other WLANs) should we be forwarding bonjour queries/responses
- Enabled
This property is required. bool - Whether to enable bonjour for this WLAN. Once enabled, limit_bcast is assumed true, allow_mdns is assumed false
- Services
This property is required. map[string]GetWlans Site Wlan Bonjour Services - What services are allowed. Property key is the service name
- additional
Vlan Ids This property is required. List<String> - additional VLAN IDs (on the LAN side or from other WLANs) should we be forwarding bonjour queries/responses
- enabled
This property is required. Boolean - Whether to enable bonjour for this WLAN. Once enabled, limit_bcast is assumed true, allow_mdns is assumed false
- services
This property is required. Map<String,GetWlans Site Wlan Bonjour Services> - What services are allowed. Property key is the service name
- additional
Vlan Ids This property is required. string[] - additional VLAN IDs (on the LAN side or from other WLANs) should we be forwarding bonjour queries/responses
- enabled
This property is required. boolean - Whether to enable bonjour for this WLAN. Once enabled, limit_bcast is assumed true, allow_mdns is assumed false
- services
This property is required. {[key: string]: GetWlans Site Wlan Bonjour Services} - What services are allowed. Property key is the service name
- additional_
vlan_ ids This property is required. Sequence[str] - additional VLAN IDs (on the LAN side or from other WLANs) should we be forwarding bonjour queries/responses
- enabled
This property is required. bool - Whether to enable bonjour for this WLAN. Once enabled, limit_bcast is assumed true, allow_mdns is assumed false
- services
This property is required. Mapping[str, GetWlans Site Wlan Bonjour Services] - What services are allowed. Property key is the service name
- additional
Vlan Ids This property is required. List<String> - additional VLAN IDs (on the LAN side or from other WLANs) should we be forwarding bonjour queries/responses
- enabled
This property is required. Boolean - Whether to enable bonjour for this WLAN. Once enabled, limit_bcast is assumed true, allow_mdns is assumed false
- services
This property is required. Map<Property Map> - What services are allowed. Property key is the service name
GetWlansSiteWlanBonjourServices
- Disable
Local This property is required. bool - Whether to prevent wireless clients to discover bonjour devices on the same WLAN
- Radius
Groups This property is required. List<string> - Optional, if the service is further restricted for certain RADIUS groups
- Scope
This property is required. string - how bonjour services should be discovered for the same WLAN. enum:
same_ap
,same_map
,same_site
- Disable
Local This property is required. bool - Whether to prevent wireless clients to discover bonjour devices on the same WLAN
- Radius
Groups This property is required. []string - Optional, if the service is further restricted for certain RADIUS groups
- Scope
This property is required. string - how bonjour services should be discovered for the same WLAN. enum:
same_ap
,same_map
,same_site
- disable
Local This property is required. Boolean - Whether to prevent wireless clients to discover bonjour devices on the same WLAN
- radius
Groups This property is required. List<String> - Optional, if the service is further restricted for certain RADIUS groups
- scope
This property is required. String - how bonjour services should be discovered for the same WLAN. enum:
same_ap
,same_map
,same_site
- disable
Local This property is required. boolean - Whether to prevent wireless clients to discover bonjour devices on the same WLAN
- radius
Groups This property is required. string[] - Optional, if the service is further restricted for certain RADIUS groups
- scope
This property is required. string - how bonjour services should be discovered for the same WLAN. enum:
same_ap
,same_map
,same_site
- disable_
local This property is required. bool - Whether to prevent wireless clients to discover bonjour devices on the same WLAN
- radius_
groups This property is required. Sequence[str] - Optional, if the service is further restricted for certain RADIUS groups
- scope
This property is required. str - how bonjour services should be discovered for the same WLAN. enum:
same_ap
,same_map
,same_site
- disable
Local This property is required. Boolean - Whether to prevent wireless clients to discover bonjour devices on the same WLAN
- radius
Groups This property is required. List<String> - Optional, if the service is further restricted for certain RADIUS groups
- scope
This property is required. String - how bonjour services should be discovered for the same WLAN. enum:
same_ap
,same_map
,same_site
GetWlansSiteWlanCiscoCwa
- Allowed
Hostnames This property is required. List<string> - List of hostnames without http(s):// (matched by substring)
- Allowed
Subnets This property is required. List<string> - List of CIDRs
- Blocked
Subnets This property is required. List<string> - List of blocked CIDRs
- Enabled
This property is required. bool
- Allowed
Hostnames This property is required. []string - List of hostnames without http(s):// (matched by substring)
- Allowed
Subnets This property is required. []string - List of CIDRs
- Blocked
Subnets This property is required. []string - List of blocked CIDRs
- Enabled
This property is required. bool
- allowed
Hostnames This property is required. List<String> - List of hostnames without http(s):// (matched by substring)
- allowed
Subnets This property is required. List<String> - List of CIDRs
- blocked
Subnets This property is required. List<String> - List of blocked CIDRs
- enabled
This property is required. Boolean
- allowed
Hostnames This property is required. string[] - List of hostnames without http(s):// (matched by substring)
- allowed
Subnets This property is required. string[] - List of CIDRs
- blocked
Subnets This property is required. string[] - List of blocked CIDRs
- enabled
This property is required. boolean
- allowed_
hostnames This property is required. Sequence[str] - List of hostnames without http(s):// (matched by substring)
- allowed_
subnets This property is required. Sequence[str] - List of CIDRs
- blocked_
subnets This property is required. Sequence[str] - List of blocked CIDRs
- enabled
This property is required. bool
- allowed
Hostnames This property is required. List<String> - List of hostnames without http(s):// (matched by substring)
- allowed
Subnets This property is required. List<String> - List of CIDRs
- blocked
Subnets This property is required. List<String> - List of blocked CIDRs
- enabled
This property is required. Boolean
GetWlansSiteWlanCoaServer
- Disable
Event Timestamp Check This property is required. bool - Whether to disable Event-Timestamp Check
- Enabled
This property is required. bool - Ip
This property is required. string - Port
This property is required. int - Secret
This property is required. string
- Disable
Event Timestamp Check This property is required. bool - Whether to disable Event-Timestamp Check
- Enabled
This property is required. bool - Ip
This property is required. string - Port
This property is required. int - Secret
This property is required. string
- disable
Event Timestamp Check This property is required. Boolean - Whether to disable Event-Timestamp Check
- enabled
This property is required. Boolean - ip
This property is required. String - port
This property is required. Integer - secret
This property is required. String
- disable
Event Timestamp Check This property is required. boolean - Whether to disable Event-Timestamp Check
- enabled
This property is required. boolean - ip
This property is required. string - port
This property is required. number - secret
This property is required. string
- disable_
event_ timestamp_ check This property is required. bool - Whether to disable Event-Timestamp Check
- enabled
This property is required. bool - ip
This property is required. str - port
This property is required. int - secret
This property is required. str
- disable
Event Timestamp Check This property is required. Boolean - Whether to disable Event-Timestamp Check
- enabled
This property is required. Boolean - ip
This property is required. String - port
This property is required. Number - secret
This property is required. String
GetWlansSiteWlanDnsServerRewrite
- Enabled
This property is required. bool - Radius
Groups This property is required. Dictionary<string, string> - Map between radius_group and the desired DNS server (IPv4 only). Property key is the RADIUS group, property value is the desired DNS Server
- Enabled
This property is required. bool - Radius
Groups This property is required. map[string]string - Map between radius_group and the desired DNS server (IPv4 only). Property key is the RADIUS group, property value is the desired DNS Server
- enabled
This property is required. Boolean - radius
Groups This property is required. Map<String,String> - Map between radius_group and the desired DNS server (IPv4 only). Property key is the RADIUS group, property value is the desired DNS Server
- enabled
This property is required. boolean - radius
Groups This property is required. {[key: string]: string} - Map between radius_group and the desired DNS server (IPv4 only). Property key is the RADIUS group, property value is the desired DNS Server
- enabled
This property is required. bool - radius_
groups This property is required. Mapping[str, str] - Map between radius_group and the desired DNS server (IPv4 only). Property key is the RADIUS group, property value is the desired DNS Server
- enabled
This property is required. Boolean - radius
Groups This property is required. Map<String> - Map between radius_group and the desired DNS server (IPv4 only). Property key is the RADIUS group, property value is the desired DNS Server
GetWlansSiteWlanDynamicPsk
- Default
Psk This property is required. string - Default PSK to use if cloud WLC is not available, 8-63 characters
- Default
Vlan Id This property is required. string - Enabled
This property is required. bool - Force
Lookup This property is required. bool - When 11r is enabled, we'll try to use the cached PMK, this can be disabled.
false
means auto - Source
This property is required. string - enum:
cloud_psks
,radius
- Default
Psk This property is required. string - Default PSK to use if cloud WLC is not available, 8-63 characters
- Default
Vlan Id This property is required. string - Enabled
This property is required. bool - Force
Lookup This property is required. bool - When 11r is enabled, we'll try to use the cached PMK, this can be disabled.
false
means auto - Source
This property is required. string - enum:
cloud_psks
,radius
- default
Psk This property is required. String - Default PSK to use if cloud WLC is not available, 8-63 characters
- default
Vlan Id This property is required. String - enabled
This property is required. Boolean - force
Lookup This property is required. Boolean - When 11r is enabled, we'll try to use the cached PMK, this can be disabled.
false
means auto - source
This property is required. String - enum:
cloud_psks
,radius
- default
Psk This property is required. string - Default PSK to use if cloud WLC is not available, 8-63 characters
- default
Vlan Id This property is required. string - enabled
This property is required. boolean - force
Lookup This property is required. boolean - When 11r is enabled, we'll try to use the cached PMK, this can be disabled.
false
means auto - source
This property is required. string - enum:
cloud_psks
,radius
- default_
psk This property is required. str - Default PSK to use if cloud WLC is not available, 8-63 characters
- default_
vlan_ id This property is required. str - enabled
This property is required. bool - force_
lookup This property is required. bool - When 11r is enabled, we'll try to use the cached PMK, this can be disabled.
false
means auto - source
This property is required. str - enum:
cloud_psks
,radius
- default
Psk This property is required. String - Default PSK to use if cloud WLC is not available, 8-63 characters
- default
Vlan Id This property is required. String - enabled
This property is required. Boolean - force
Lookup This property is required. Boolean - When 11r is enabled, we'll try to use the cached PMK, this can be disabled.
false
means auto - source
This property is required. String - enum:
cloud_psks
,radius
GetWlansSiteWlanDynamicVlan
- Default
Vlan Ids This property is required. List<string> - Default VLAN ID(s) can be a number, a range of VLAN IDs, a variable or multiple numbers, ranges or variables as a VLAN pool. Default VLAN as a pool of VLANS requires 0.14.x or newer firmware
- Enabled
This property is required. bool - Requires
vlan_enabled
==true
to be set totrue
. Whether to enable dynamic vlan - Local
Vlan Ids This property is required. List<string> - VLAN_ids to be locally bridged
- Type
This property is required. string - standard (using Tunnel-Private-Group-ID, widely supported), airespace-interface-name (Airespace/Cisco). enum:
airespace-interface-name
,standard
- Vlans
This property is required. Dictionary<string, string> - Map between vlan_id (as string) to airespace interface names (comma-separated) or null for standard mapping
- if
dynamic_vlan.type
==standard
, property key is the Vlan ID and property value is "" - if
dynamic_vlan.type
==airespace-interface-name
, property key is the Vlan ID and property value is the Airespace Interface Name
- if
- Default
Vlan Ids This property is required. []string - Default VLAN ID(s) can be a number, a range of VLAN IDs, a variable or multiple numbers, ranges or variables as a VLAN pool. Default VLAN as a pool of VLANS requires 0.14.x or newer firmware
- Enabled
This property is required. bool - Requires
vlan_enabled
==true
to be set totrue
. Whether to enable dynamic vlan - Local
Vlan Ids This property is required. []string - VLAN_ids to be locally bridged
- Type
This property is required. string - standard (using Tunnel-Private-Group-ID, widely supported), airespace-interface-name (Airespace/Cisco). enum:
airespace-interface-name
,standard
- Vlans
This property is required. map[string]string - Map between vlan_id (as string) to airespace interface names (comma-separated) or null for standard mapping
- if
dynamic_vlan.type
==standard
, property key is the Vlan ID and property value is "" - if
dynamic_vlan.type
==airespace-interface-name
, property key is the Vlan ID and property value is the Airespace Interface Name
- if
- default
Vlan Ids This property is required. List<String> - Default VLAN ID(s) can be a number, a range of VLAN IDs, a variable or multiple numbers, ranges or variables as a VLAN pool. Default VLAN as a pool of VLANS requires 0.14.x or newer firmware
- enabled
This property is required. Boolean - Requires
vlan_enabled
==true
to be set totrue
. Whether to enable dynamic vlan - local
Vlan Ids This property is required. List<String> - VLAN_ids to be locally bridged
- type
This property is required. String - standard (using Tunnel-Private-Group-ID, widely supported), airespace-interface-name (Airespace/Cisco). enum:
airespace-interface-name
,standard
- vlans
This property is required. Map<String,String> - Map between vlan_id (as string) to airespace interface names (comma-separated) or null for standard mapping
- if
dynamic_vlan.type
==standard
, property key is the Vlan ID and property value is "" - if
dynamic_vlan.type
==airespace-interface-name
, property key is the Vlan ID and property value is the Airespace Interface Name
- if
- default
Vlan Ids This property is required. string[] - Default VLAN ID(s) can be a number, a range of VLAN IDs, a variable or multiple numbers, ranges or variables as a VLAN pool. Default VLAN as a pool of VLANS requires 0.14.x or newer firmware
- enabled
This property is required. boolean - Requires
vlan_enabled
==true
to be set totrue
. Whether to enable dynamic vlan - local
Vlan Ids This property is required. string[] - VLAN_ids to be locally bridged
- type
This property is required. string - standard (using Tunnel-Private-Group-ID, widely supported), airespace-interface-name (Airespace/Cisco). enum:
airespace-interface-name
,standard
- vlans
This property is required. {[key: string]: string} - Map between vlan_id (as string) to airespace interface names (comma-separated) or null for standard mapping
- if
dynamic_vlan.type
==standard
, property key is the Vlan ID and property value is "" - if
dynamic_vlan.type
==airespace-interface-name
, property key is the Vlan ID and property value is the Airespace Interface Name
- if
- default_
vlan_ ids This property is required. Sequence[str] - Default VLAN ID(s) can be a number, a range of VLAN IDs, a variable or multiple numbers, ranges or variables as a VLAN pool. Default VLAN as a pool of VLANS requires 0.14.x or newer firmware
- enabled
This property is required. bool - Requires
vlan_enabled
==true
to be set totrue
. Whether to enable dynamic vlan - local_
vlan_ ids This property is required. Sequence[str] - VLAN_ids to be locally bridged
- type
This property is required. str - standard (using Tunnel-Private-Group-ID, widely supported), airespace-interface-name (Airespace/Cisco). enum:
airespace-interface-name
,standard
- vlans
This property is required. Mapping[str, str] - Map between vlan_id (as string) to airespace interface names (comma-separated) or null for standard mapping
- if
dynamic_vlan.type
==standard
, property key is the Vlan ID and property value is "" - if
dynamic_vlan.type
==airespace-interface-name
, property key is the Vlan ID and property value is the Airespace Interface Name
- if
- default
Vlan Ids This property is required. List<String> - Default VLAN ID(s) can be a number, a range of VLAN IDs, a variable or multiple numbers, ranges or variables as a VLAN pool. Default VLAN as a pool of VLANS requires 0.14.x or newer firmware
- enabled
This property is required. Boolean - Requires
vlan_enabled
==true
to be set totrue
. Whether to enable dynamic vlan - local
Vlan Ids This property is required. List<String> - VLAN_ids to be locally bridged
- type
This property is required. String - standard (using Tunnel-Private-Group-ID, widely supported), airespace-interface-name (Airespace/Cisco). enum:
airespace-interface-name
,standard
- vlans
This property is required. Map<String> - Map between vlan_id (as string) to airespace interface names (comma-separated) or null for standard mapping
- if
dynamic_vlan.type
==standard
, property key is the Vlan ID and property value is "" - if
dynamic_vlan.type
==airespace-interface-name
, property key is the Vlan ID and property value is the Airespace Interface Name
- if
GetWlansSiteWlanHotspot20
- Domain
Names This property is required. List<string> - Enabled
This property is required. bool - Whether to enable hotspot 2.0 config
- Nai
Realms This property is required. List<string> - Operators
This property is required. List<string> - List of operators to support
- Rcois
This property is required. List<string> - Venue
Name This property is required. string - Venue name, default is site name
- Domain
Names This property is required. []string - Enabled
This property is required. bool - Whether to enable hotspot 2.0 config
- Nai
Realms This property is required. []string - Operators
This property is required. []string - List of operators to support
- Rcois
This property is required. []string - Venue
Name This property is required. string - Venue name, default is site name
- domain
Names This property is required. List<String> - enabled
This property is required. Boolean - Whether to enable hotspot 2.0 config
- nai
Realms This property is required. List<String> - operators
This property is required. List<String> - List of operators to support
- rcois
This property is required. List<String> - venue
Name This property is required. String - Venue name, default is site name
- domain
Names This property is required. string[] - enabled
This property is required. boolean - Whether to enable hotspot 2.0 config
- nai
Realms This property is required. string[] - operators
This property is required. string[] - List of operators to support
- rcois
This property is required. string[] - venue
Name This property is required. string - Venue name, default is site name
- domain_
names This property is required. Sequence[str] - enabled
This property is required. bool - Whether to enable hotspot 2.0 config
- nai_
realms This property is required. Sequence[str] - operators
This property is required. Sequence[str] - List of operators to support
- rcois
This property is required. Sequence[str] - venue_
name This property is required. str - Venue name, default is site name
- domain
Names This property is required. List<String> - enabled
This property is required. Boolean - Whether to enable hotspot 2.0 config
- nai
Realms This property is required. List<String> - operators
This property is required. List<String> - List of operators to support
- rcois
This property is required. List<String> - venue
Name This property is required. String - Venue name, default is site name
GetWlansSiteWlanInjectDhcpOption82
- Circuit
Id This property is required. string - Information to set in the
circuit_id
field of the DHCP Option 82. It is possible to use static string or the following variables (e.g.{{SSID}}:{{AP_MAC}}
):- {{AP_MAC}}
- {{AP_MAC_DASHED}}
- {{AP_MODEL}}
- {{AP_NAME}}
- {{SITE_NAME}}
- {{SSID}}
- Enabled
This property is required. bool - Whether to inject option 82 when forwarding DHCP packets
- Circuit
Id This property is required. string - Information to set in the
circuit_id
field of the DHCP Option 82. It is possible to use static string or the following variables (e.g.{{SSID}}:{{AP_MAC}}
):- {{AP_MAC}}
- {{AP_MAC_DASHED}}
- {{AP_MODEL}}
- {{AP_NAME}}
- {{SITE_NAME}}
- {{SSID}}
- Enabled
This property is required. bool - Whether to inject option 82 when forwarding DHCP packets
- circuit
Id This property is required. String - Information to set in the
circuit_id
field of the DHCP Option 82. It is possible to use static string or the following variables (e.g.{{SSID}}:{{AP_MAC}}
):- {{AP_MAC}}
- {{AP_MAC_DASHED}}
- {{AP_MODEL}}
- {{AP_NAME}}
- {{SITE_NAME}}
- {{SSID}}
- enabled
This property is required. Boolean - Whether to inject option 82 when forwarding DHCP packets
- circuit
Id This property is required. string - Information to set in the
circuit_id
field of the DHCP Option 82. It is possible to use static string or the following variables (e.g.{{SSID}}:{{AP_MAC}}
):- {{AP_MAC}}
- {{AP_MAC_DASHED}}
- {{AP_MODEL}}
- {{AP_NAME}}
- {{SITE_NAME}}
- {{SSID}}
- enabled
This property is required. boolean - Whether to inject option 82 when forwarding DHCP packets
- circuit_
id This property is required. str - Information to set in the
circuit_id
field of the DHCP Option 82. It is possible to use static string or the following variables (e.g.{{SSID}}:{{AP_MAC}}
):- {{AP_MAC}}
- {{AP_MAC_DASHED}}
- {{AP_MODEL}}
- {{AP_NAME}}
- {{SITE_NAME}}
- {{SSID}}
- enabled
This property is required. bool - Whether to inject option 82 when forwarding DHCP packets
- circuit
Id This property is required. String - Information to set in the
circuit_id
field of the DHCP Option 82. It is possible to use static string or the following variables (e.g.{{SSID}}:{{AP_MAC}}
):- {{AP_MAC}}
- {{AP_MAC_DASHED}}
- {{AP_MODEL}}
- {{AP_NAME}}
- {{SITE_NAME}}
- {{SSID}}
- enabled
This property is required. Boolean - Whether to inject option 82 when forwarding DHCP packets
GetWlansSiteWlanMistNac
- Enabled
This property is required. bool - When enabled:
auth_servers
is ignoredacct_servers
is ignoredauth_servers_*
are ignoredcoa_servers
is ignoredradsec
is ignoredcoa_enabled
is assumed
- Enabled
This property is required. bool - When enabled:
auth_servers
is ignoredacct_servers
is ignoredauth_servers_*
are ignoredcoa_servers
is ignoredradsec
is ignoredcoa_enabled
is assumed
- enabled
This property is required. Boolean - When enabled:
auth_servers
is ignoredacct_servers
is ignoredauth_servers_*
are ignoredcoa_servers
is ignoredradsec
is ignoredcoa_enabled
is assumed
- enabled
This property is required. boolean - When enabled:
auth_servers
is ignoredacct_servers
is ignoredauth_servers_*
are ignoredcoa_servers
is ignoredradsec
is ignoredcoa_enabled
is assumed
- enabled
This property is required. bool - When enabled:
auth_servers
is ignoredacct_servers
is ignoredauth_servers_*
are ignoredcoa_servers
is ignoredradsec
is ignoredcoa_enabled
is assumed
- enabled
This property is required. Boolean - When enabled:
auth_servers
is ignoredacct_servers
is ignoredauth_servers_*
are ignoredcoa_servers
is ignoredradsec
is ignoredcoa_enabled
is assumed
GetWlansSiteWlanPortal
- Allow
Wlan Id Roam This property is required. bool - Optional if
amazon_enabled
==true
. Whether to allow guest to connect to other Guest WLANs (with differentWLAN.ssid
) of same org without reauthentication (disable random_mac for seamless roaming) - Amazon
Client Id This property is required. string - Optional if
amazon_enabled
==true
. Amazon OAuth2 client id. This is optional. If not provided, it will use a default one. - Amazon
Client Secret This property is required. string - Optional if
amazon_enabled
==true
. Amazon OAuth2 client secret. If amazon_client_id was provided, provide a corresponding value. Else leave blank. - Amazon
Email Domains This property is required. List<string> - Optional if
amazon_enabled
==true
. Matches authenticated user email against provided domains. If null or [], all authenticated emails will be allowed. - Amazon
Enabled This property is required. bool - Whether amazon is enabled as a login method
- Amazon
Expire This property is required. int - Optional if
amazon_enabled
==true
. Interval for which guest remains authorized using amazon auth (in minutes), if not provided, uses expire` - Auth
This property is required. string - authentication scheme. enum:
amazon
,azure
,email
,external
,facebook
,google
,microsoft
,multi
,none
,password
,sponsor
,sso
- Azure
Client Id This property is required. string - Required if
azure_enabled
==true
. Azure active directory app client id - Azure
Client Secret This property is required. string - Required if
azure_enabled
==true
. Azure active directory app client secret - Azure
Enabled This property is required. bool - Whether Azure Active Directory is enabled as a login method
- Azure
Expire This property is required. int - Interval for which guest remains authorized using azure auth (in minutes), if not provided, uses expire`
- Azure
Tenant Id This property is required. string - Required if
azure_enabled
==true
. Azure active directory tenant id. - Broadnet
Password This property is required. string - Required if
sms_provider
==broadnet
- Broadnet
Sid This property is required. string - Required if
sms_provider
==broadnet
- Broadnet
User Id This property is required. string - Required if
sms_provider
==broadnet
- Bypass
When Cloud Down This property is required. bool - Whether to bypass the guest portal when cloud not reachable (and apply the default policies)
- Clickatell
Api Key This property is required. string - Required if
sms_provider
==clickatell
- Cross
Site This property is required. bool - Whether to allow guest to roam between WLANs (with same
WLAN.ssid
, regardless of variables) of different sites of same org without reauthentication (disable random_mac for seamless roaming) - Email
Enabled This property is required. bool - Whether email (access code verification) is enabled as a login method
- Enabled
This property is required. bool - Whether guest portal is enabled
- Expire
This property is required. int - How long to remain authorized, in minutes
- External
Portal Url This property is required. string - Required if
wlan_portal_auth
==external
. External portal URL (e.g. https://host/url) where we can append our query parameters to - Facebook
Client Id This property is required. string - Required if
facebook_enabled
==true
. Facebook OAuth2 app id. This is optional. If not provided, it will use a default one. - Facebook
Client Secret This property is required. string - Required if
facebook_enabled
==true
. Facebook OAuth2 app secret. If facebook_client_id was provided, provide a corresponding value. Else leave blank. - Facebook
Email Domains This property is required. List<string> - Optional if
facebook_enabled
==true
. Matches authenticated user email against provided domains. If null or [], all authenticated emails will be allowed. - Facebook
Enabled This property is required. bool - Whether facebook is enabled as a login method
- Facebook
Expire This property is required. int - Optional if
facebook_enabled
==true
. Interval for which guest remains authorized using facebook auth (in minutes), if not provided, uses expire` - Forward
This property is required. bool - Whether to forward the user to another URL after authorized
- Forward
Url This property is required. string - URL to forward the user to
- Google
Client Id This property is required. string - Google OAuth2 app id. This is optional. If not provided, it will use a default one.
- Google
Client Secret This property is required. string - Optional if
google_enabled
==true
. Google OAuth2 app secret. If google_client_id was provided, provide a corresponding value. Else leave blank. - Google
Email Domains This property is required. List<string> - Optional if
google_enabled
==true
. Matches authenticated user email against provided domains. If null or [], all authenticated emails will be allowed. - Google
Enabled This property is required. bool - Whether Google is enabled as login method
- Google
Expire This property is required. int - Optional if
google_enabled
==true
. Interval for which guest remains authorized using Google Auth (in minutes), if not provided, uses expire` - Gupshup
Password This property is required. string - Required if
sms_provider
==gupshup
- Gupshup
Userid This property is required. string - Required if
sms_provider
==gupshup
- Microsoft
Client Id This property is required. string - Optional if
microsoft_enabled
==true
. Microsoft 365 OAuth2 client id. This is optional. If not provided, it will use a default one. - Microsoft
Client Secret This property is required. string - Optional if
microsoft_enabled
==true
. Microsoft 365 OAuth2 client secret. If microsoft_client_id was provided, provide a corresponding value. Else leave blank. - Microsoft
Email Domains This property is required. List<string> - Optional if
microsoft_enabled
==true
. Matches authenticated user email against provided domains. If null or [], all authenticated emails will be allowed. - Microsoft
Enabled This property is required. bool - Whether microsoft 365 is enabled as a login method
- Microsoft
Expire This property is required. int - Optional if
microsoft_enabled
==true
. Interval for which guest remains authorized using microsoft auth (in minutes), if not provided, uses expire` - Passphrase
Enabled This property is required. bool - Whether password is enabled
- Passphrase
Expire This property is required. int - Optional if
passphrase_enabled
==true
. Interval for which guest remains authorized using passphrase auth (in minutes), if not provided, usesexpire
- Password
This property is required. string - Required if
passphrase_enabled
==true
. - Predefined
Sponsors Enabled This property is required. bool - Whether to show list of sponsor emails mentioned in
sponsors
object as a dropdown. If bothsponsor_notify_all
andpredefined_sponsors_enabled
are false, behaviour is acc tosponsor_email_domains
- Predefined
Sponsors Hide Email This property is required. bool - Whether to hide sponsor’s email from list of sponsors
- Privacy
This property is required. bool - Puzzel
Password This property is required. string - Required if
sms_provider
==puzzel
- Puzzel
Service Id This property is required. string - Required if
sms_provider
==puzzel
- Puzzel
Username This property is required. string - Required if
sms_provider
==puzzel
- Sms
Enabled This property is required. bool - Whether sms is enabled as a login method
- Sms
Expire This property is required. int - Optional if
sms_enabled
==true
. Interval for which guest remains authorized using sms auth (in minutes), if not provided, uses expire` - Sms
Message Format This property is required. string - Optional if
sms_enabled
==true
. SMS Message format - Sms
Provider This property is required. string - Optioanl if
sms_enabled
==true
. enum:broadnet
,clickatell
,gupshup
,manual
,puzzel
,telstra
,twilio
- Sponsor
Auto Approve This property is required. bool - Optional if
sponsor_enabled
==true
. Whether to automatically approve guest and allow sponsor to revoke guest access, needs predefined_sponsors_enabled enabled and sponsor_notify_all disabled - Sponsor
Email Domains This property is required. List<string> - List of domain allowed for sponsor email. Required if
sponsor_enabled
istrue
andsponsors
is empty. - Sponsor
Enabled This property is required. bool - Whether sponsor is enabled
- Sponsor
Expire This property is required. int - Optional if
sponsor_enabled
==true
. Interval for which guest remains authorized using sponsor auth (in minutes), if not provided, uses expire` - Sponsor
Link Validity Duration This property is required. string - Optional if
sponsor_enabled
==true
. How long to remain valid sponsored guest request approve/deny link received in email, in minutes. - Sponsor
Notify All This property is required. bool - Optional if
sponsor_enabled
==true
. whether to notify all sponsors that are mentioned insponsors
object. Bothsponsor_notify_all
andpredefined_sponsors_enabled
should be true in order to notify sponsors. If true, email sent to 10 sponsors in no particular order. - Sponsor
Status Notify This property is required. bool - Optional if
sponsor_enabled
==true
. If enabled, guest will get email about sponsor's action (approve/deny) - Sponsors
This property is required. Dictionary<string, string> - object of allowed sponsors email with name. Required if
sponsor_enabled
istrue
andsponsor_email_domains
is empty.Property key is the sponsor email, Property value is the sponsor name
- Sso
Default Role This property is required. string - Optional if
wlan_portal_auth
==sso
, default role to assign if there’s no match. By default, an assertion is treated as invalid when there’s no role matched - Sso
Forced Role This property is required. string - Optional if
wlan_portal_auth
==sso
- Sso
Idp Cert This property is required. string - Required if
wlan_portal_auth
==sso
. IDP Cert (used to verify the signed response) - Sso
Idp Sign Algo This property is required. string - Optioanl if
wlan_portal_auth
==sso
, Signing algorithm for SAML Assertion. enum:sha1
,sha256
,sha384
,sha512
- Sso
Idp Sso Url This property is required. string - Required if
wlan_portal_auth
==sso
, IDP Single-Sign-On URL - Sso
Issuer This property is required. string - Required if
wlan_portal_auth
==sso
, IDP issuer URL - Sso
Nameid Format This property is required. string - Optional if
wlan_portal_auth
==sso
. enum:email
,unspecified
- Telstra
Client Id This property is required. string - Required if
sms_provider
==telstra
, Client ID provided by Telstra - Telstra
Client Secret This property is required. string - Required if
sms_provider
==telstra
, Client secret provided by Telstra - Twilio
Auth Token This property is required. string - Required if
sms_provider
==twilio
, Auth token account with twilio account - Twilio
Phone Number This property is required. string - Required if
sms_provider
==twilio
, Twilio phone number associated with the account. See example for accepted format. - Twilio
Sid This property is required. string - Required if
sms_provider
==twilio
, Account SID provided by Twilio
- Allow
Wlan Id Roam This property is required. bool - Optional if
amazon_enabled
==true
. Whether to allow guest to connect to other Guest WLANs (with differentWLAN.ssid
) of same org without reauthentication (disable random_mac for seamless roaming) - Amazon
Client Id This property is required. string - Optional if
amazon_enabled
==true
. Amazon OAuth2 client id. This is optional. If not provided, it will use a default one. - Amazon
Client Secret This property is required. string - Optional if
amazon_enabled
==true
. Amazon OAuth2 client secret. If amazon_client_id was provided, provide a corresponding value. Else leave blank. - Amazon
Email Domains This property is required. []string - Optional if
amazon_enabled
==true
. Matches authenticated user email against provided domains. If null or [], all authenticated emails will be allowed. - Amazon
Enabled This property is required. bool - Whether amazon is enabled as a login method
- Amazon
Expire This property is required. int - Optional if
amazon_enabled
==true
. Interval for which guest remains authorized using amazon auth (in minutes), if not provided, uses expire` - Auth
This property is required. string - authentication scheme. enum:
amazon
,azure
,email
,external
,facebook
,google
,microsoft
,multi
,none
,password
,sponsor
,sso
- Azure
Client Id This property is required. string - Required if
azure_enabled
==true
. Azure active directory app client id - Azure
Client Secret This property is required. string - Required if
azure_enabled
==true
. Azure active directory app client secret - Azure
Enabled This property is required. bool - Whether Azure Active Directory is enabled as a login method
- Azure
Expire This property is required. int - Interval for which guest remains authorized using azure auth (in minutes), if not provided, uses expire`
- Azure
Tenant Id This property is required. string - Required if
azure_enabled
==true
. Azure active directory tenant id. - Broadnet
Password This property is required. string - Required if
sms_provider
==broadnet
- Broadnet
Sid This property is required. string - Required if
sms_provider
==broadnet
- Broadnet
User Id This property is required. string - Required if
sms_provider
==broadnet
- Bypass
When Cloud Down This property is required. bool - Whether to bypass the guest portal when cloud not reachable (and apply the default policies)
- Clickatell
Api Key This property is required. string - Required if
sms_provider
==clickatell
- Cross
Site This property is required. bool - Whether to allow guest to roam between WLANs (with same
WLAN.ssid
, regardless of variables) of different sites of same org without reauthentication (disable random_mac for seamless roaming) - Email
Enabled This property is required. bool - Whether email (access code verification) is enabled as a login method
- Enabled
This property is required. bool - Whether guest portal is enabled
- Expire
This property is required. int - How long to remain authorized, in minutes
- External
Portal Url This property is required. string - Required if
wlan_portal_auth
==external
. External portal URL (e.g. https://host/url) where we can append our query parameters to - Facebook
Client Id This property is required. string - Required if
facebook_enabled
==true
. Facebook OAuth2 app id. This is optional. If not provided, it will use a default one. - Facebook
Client Secret This property is required. string - Required if
facebook_enabled
==true
. Facebook OAuth2 app secret. If facebook_client_id was provided, provide a corresponding value. Else leave blank. - Facebook
Email Domains This property is required. []string - Optional if
facebook_enabled
==true
. Matches authenticated user email against provided domains. If null or [], all authenticated emails will be allowed. - Facebook
Enabled This property is required. bool - Whether facebook is enabled as a login method
- Facebook
Expire This property is required. int - Optional if
facebook_enabled
==true
. Interval for which guest remains authorized using facebook auth (in minutes), if not provided, uses expire` - Forward
This property is required. bool - Whether to forward the user to another URL after authorized
- Forward
Url This property is required. string - URL to forward the user to
- Google
Client Id This property is required. string - Google OAuth2 app id. This is optional. If not provided, it will use a default one.
- Google
Client Secret This property is required. string - Optional if
google_enabled
==true
. Google OAuth2 app secret. If google_client_id was provided, provide a corresponding value. Else leave blank. - Google
Email Domains This property is required. []string - Optional if
google_enabled
==true
. Matches authenticated user email against provided domains. If null or [], all authenticated emails will be allowed. - Google
Enabled This property is required. bool - Whether Google is enabled as login method
- Google
Expire This property is required. int - Optional if
google_enabled
==true
. Interval for which guest remains authorized using Google Auth (in minutes), if not provided, uses expire` - Gupshup
Password This property is required. string - Required if
sms_provider
==gupshup
- Gupshup
Userid This property is required. string - Required if
sms_provider
==gupshup
- Microsoft
Client Id This property is required. string - Optional if
microsoft_enabled
==true
. Microsoft 365 OAuth2 client id. This is optional. If not provided, it will use a default one. - Microsoft
Client Secret This property is required. string - Optional if
microsoft_enabled
==true
. Microsoft 365 OAuth2 client secret. If microsoft_client_id was provided, provide a corresponding value. Else leave blank. - Microsoft
Email Domains This property is required. []string - Optional if
microsoft_enabled
==true
. Matches authenticated user email against provided domains. If null or [], all authenticated emails will be allowed. - Microsoft
Enabled This property is required. bool - Whether microsoft 365 is enabled as a login method
- Microsoft
Expire This property is required. int - Optional if
microsoft_enabled
==true
. Interval for which guest remains authorized using microsoft auth (in minutes), if not provided, uses expire` - Passphrase
Enabled This property is required. bool - Whether password is enabled
- Passphrase
Expire This property is required. int - Optional if
passphrase_enabled
==true
. Interval for which guest remains authorized using passphrase auth (in minutes), if not provided, usesexpire
- Password
This property is required. string - Required if
passphrase_enabled
==true
. - Predefined
Sponsors Enabled This property is required. bool - Whether to show list of sponsor emails mentioned in
sponsors
object as a dropdown. If bothsponsor_notify_all
andpredefined_sponsors_enabled
are false, behaviour is acc tosponsor_email_domains
- Predefined
Sponsors Hide Email This property is required. bool - Whether to hide sponsor’s email from list of sponsors
- Privacy
This property is required. bool - Puzzel
Password This property is required. string - Required if
sms_provider
==puzzel
- Puzzel
Service Id This property is required. string - Required if
sms_provider
==puzzel
- Puzzel
Username This property is required. string - Required if
sms_provider
==puzzel
- Sms
Enabled This property is required. bool - Whether sms is enabled as a login method
- Sms
Expire This property is required. int - Optional if
sms_enabled
==true
. Interval for which guest remains authorized using sms auth (in minutes), if not provided, uses expire` - Sms
Message Format This property is required. string - Optional if
sms_enabled
==true
. SMS Message format - Sms
Provider This property is required. string - Optioanl if
sms_enabled
==true
. enum:broadnet
,clickatell
,gupshup
,manual
,puzzel
,telstra
,twilio
- Sponsor
Auto Approve This property is required. bool - Optional if
sponsor_enabled
==true
. Whether to automatically approve guest and allow sponsor to revoke guest access, needs predefined_sponsors_enabled enabled and sponsor_notify_all disabled - Sponsor
Email Domains This property is required. []string - List of domain allowed for sponsor email. Required if
sponsor_enabled
istrue
andsponsors
is empty. - Sponsor
Enabled This property is required. bool - Whether sponsor is enabled
- Sponsor
Expire This property is required. int - Optional if
sponsor_enabled
==true
. Interval for which guest remains authorized using sponsor auth (in minutes), if not provided, uses expire` - Sponsor
Link Validity Duration This property is required. string - Optional if
sponsor_enabled
==true
. How long to remain valid sponsored guest request approve/deny link received in email, in minutes. - Sponsor
Notify All This property is required. bool - Optional if
sponsor_enabled
==true
. whether to notify all sponsors that are mentioned insponsors
object. Bothsponsor_notify_all
andpredefined_sponsors_enabled
should be true in order to notify sponsors. If true, email sent to 10 sponsors in no particular order. - Sponsor
Status Notify This property is required. bool - Optional if
sponsor_enabled
==true
. If enabled, guest will get email about sponsor's action (approve/deny) - Sponsors
This property is required. map[string]string - object of allowed sponsors email with name. Required if
sponsor_enabled
istrue
andsponsor_email_domains
is empty.Property key is the sponsor email, Property value is the sponsor name
- Sso
Default Role This property is required. string - Optional if
wlan_portal_auth
==sso
, default role to assign if there’s no match. By default, an assertion is treated as invalid when there’s no role matched - Sso
Forced Role This property is required. string - Optional if
wlan_portal_auth
==sso
- Sso
Idp Cert This property is required. string - Required if
wlan_portal_auth
==sso
. IDP Cert (used to verify the signed response) - Sso
Idp Sign Algo This property is required. string - Optioanl if
wlan_portal_auth
==sso
, Signing algorithm for SAML Assertion. enum:sha1
,sha256
,sha384
,sha512
- Sso
Idp Sso Url This property is required. string - Required if
wlan_portal_auth
==sso
, IDP Single-Sign-On URL - Sso
Issuer This property is required. string - Required if
wlan_portal_auth
==sso
, IDP issuer URL - Sso
Nameid Format This property is required. string - Optional if
wlan_portal_auth
==sso
. enum:email
,unspecified
- Telstra
Client Id This property is required. string - Required if
sms_provider
==telstra
, Client ID provided by Telstra - Telstra
Client Secret This property is required. string - Required if
sms_provider
==telstra
, Client secret provided by Telstra - Twilio
Auth Token This property is required. string - Required if
sms_provider
==twilio
, Auth token account with twilio account - Twilio
Phone Number This property is required. string - Required if
sms_provider
==twilio
, Twilio phone number associated with the account. See example for accepted format. - Twilio
Sid This property is required. string - Required if
sms_provider
==twilio
, Account SID provided by Twilio
- allow
Wlan Id Roam This property is required. Boolean - Optional if
amazon_enabled
==true
. Whether to allow guest to connect to other Guest WLANs (with differentWLAN.ssid
) of same org without reauthentication (disable random_mac for seamless roaming) - amazon
Client Id This property is required. String - Optional if
amazon_enabled
==true
. Amazon OAuth2 client id. This is optional. If not provided, it will use a default one. - amazon
Client Secret This property is required. String - Optional if
amazon_enabled
==true
. Amazon OAuth2 client secret. If amazon_client_id was provided, provide a corresponding value. Else leave blank. - amazon
Email Domains This property is required. List<String> - Optional if
amazon_enabled
==true
. Matches authenticated user email against provided domains. If null or [], all authenticated emails will be allowed. - amazon
Enabled This property is required. Boolean - Whether amazon is enabled as a login method
- amazon
Expire This property is required. Integer - Optional if
amazon_enabled
==true
. Interval for which guest remains authorized using amazon auth (in minutes), if not provided, uses expire` - auth
This property is required. String - authentication scheme. enum:
amazon
,azure
,email
,external
,facebook
,google
,microsoft
,multi
,none
,password
,sponsor
,sso
- azure
Client Id This property is required. String - Required if
azure_enabled
==true
. Azure active directory app client id - azure
Client Secret This property is required. String - Required if
azure_enabled
==true
. Azure active directory app client secret - azure
Enabled This property is required. Boolean - Whether Azure Active Directory is enabled as a login method
- azure
Expire This property is required. Integer - Interval for which guest remains authorized using azure auth (in minutes), if not provided, uses expire`
- azure
Tenant Id This property is required. String - Required if
azure_enabled
==true
. Azure active directory tenant id. - broadnet
Password This property is required. String - Required if
sms_provider
==broadnet
- broadnet
Sid This property is required. String - Required if
sms_provider
==broadnet
- broadnet
User Id This property is required. String - Required if
sms_provider
==broadnet
- bypass
When Cloud Down This property is required. Boolean - Whether to bypass the guest portal when cloud not reachable (and apply the default policies)
- clickatell
Api Key This property is required. String - Required if
sms_provider
==clickatell
- cross
Site This property is required. Boolean - Whether to allow guest to roam between WLANs (with same
WLAN.ssid
, regardless of variables) of different sites of same org without reauthentication (disable random_mac for seamless roaming) - email
Enabled This property is required. Boolean - Whether email (access code verification) is enabled as a login method
- enabled
This property is required. Boolean - Whether guest portal is enabled
- expire
This property is required. Integer - How long to remain authorized, in minutes
- external
Portal Url This property is required. String - Required if
wlan_portal_auth
==external
. External portal URL (e.g. https://host/url) where we can append our query parameters to - facebook
Client Id This property is required. String - Required if
facebook_enabled
==true
. Facebook OAuth2 app id. This is optional. If not provided, it will use a default one. - facebook
Client Secret This property is required. String - Required if
facebook_enabled
==true
. Facebook OAuth2 app secret. If facebook_client_id was provided, provide a corresponding value. Else leave blank. - facebook
Email Domains This property is required. List<String> - Optional if
facebook_enabled
==true
. Matches authenticated user email against provided domains. If null or [], all authenticated emails will be allowed. - facebook
Enabled This property is required. Boolean - Whether facebook is enabled as a login method
- facebook
Expire This property is required. Integer - Optional if
facebook_enabled
==true
. Interval for which guest remains authorized using facebook auth (in minutes), if not provided, uses expire` - forward
This property is required. Boolean - Whether to forward the user to another URL after authorized
- forward
Url This property is required. String - URL to forward the user to
- google
Client Id This property is required. String - Google OAuth2 app id. This is optional. If not provided, it will use a default one.
- google
Client Secret This property is required. String - Optional if
google_enabled
==true
. Google OAuth2 app secret. If google_client_id was provided, provide a corresponding value. Else leave blank. - google
Email Domains This property is required. List<String> - Optional if
google_enabled
==true
. Matches authenticated user email against provided domains. If null or [], all authenticated emails will be allowed. - google
Enabled This property is required. Boolean - Whether Google is enabled as login method
- google
Expire This property is required. Integer - Optional if
google_enabled
==true
. Interval for which guest remains authorized using Google Auth (in minutes), if not provided, uses expire` - gupshup
Password This property is required. String - Required if
sms_provider
==gupshup
- gupshup
Userid This property is required. String - Required if
sms_provider
==gupshup
- microsoft
Client Id This property is required. String - Optional if
microsoft_enabled
==true
. Microsoft 365 OAuth2 client id. This is optional. If not provided, it will use a default one. - microsoft
Client Secret This property is required. String - Optional if
microsoft_enabled
==true
. Microsoft 365 OAuth2 client secret. If microsoft_client_id was provided, provide a corresponding value. Else leave blank. - microsoft
Email Domains This property is required. List<String> - Optional if
microsoft_enabled
==true
. Matches authenticated user email against provided domains. If null or [], all authenticated emails will be allowed. - microsoft
Enabled This property is required. Boolean - Whether microsoft 365 is enabled as a login method
- microsoft
Expire This property is required. Integer - Optional if
microsoft_enabled
==true
. Interval for which guest remains authorized using microsoft auth (in minutes), if not provided, uses expire` - passphrase
Enabled This property is required. Boolean - Whether password is enabled
- passphrase
Expire This property is required. Integer - Optional if
passphrase_enabled
==true
. Interval for which guest remains authorized using passphrase auth (in minutes), if not provided, usesexpire
- password
This property is required. String - Required if
passphrase_enabled
==true
. - predefined
Sponsors Enabled This property is required. Boolean - Whether to show list of sponsor emails mentioned in
sponsors
object as a dropdown. If bothsponsor_notify_all
andpredefined_sponsors_enabled
are false, behaviour is acc tosponsor_email_domains
- predefined
Sponsors Hide Email This property is required. Boolean - Whether to hide sponsor’s email from list of sponsors
- privacy
This property is required. Boolean - puzzel
Password This property is required. String - Required if
sms_provider
==puzzel
- puzzel
Service Id This property is required. String - Required if
sms_provider
==puzzel
- puzzel
Username This property is required. String - Required if
sms_provider
==puzzel
- sms
Enabled This property is required. Boolean - Whether sms is enabled as a login method
- sms
Expire This property is required. Integer - Optional if
sms_enabled
==true
. Interval for which guest remains authorized using sms auth (in minutes), if not provided, uses expire` - sms
Message Format This property is required. String - Optional if
sms_enabled
==true
. SMS Message format - sms
Provider This property is required. String - Optioanl if
sms_enabled
==true
. enum:broadnet
,clickatell
,gupshup
,manual
,puzzel
,telstra
,twilio
- sponsor
Auto Approve This property is required. Boolean - Optional if
sponsor_enabled
==true
. Whether to automatically approve guest and allow sponsor to revoke guest access, needs predefined_sponsors_enabled enabled and sponsor_notify_all disabled - sponsor
Email Domains This property is required. List<String> - List of domain allowed for sponsor email. Required if
sponsor_enabled
istrue
andsponsors
is empty. - sponsor
Enabled This property is required. Boolean - Whether sponsor is enabled
- sponsor
Expire This property is required. Integer - Optional if
sponsor_enabled
==true
. Interval for which guest remains authorized using sponsor auth (in minutes), if not provided, uses expire` - sponsor
Link Validity Duration This property is required. String - Optional if
sponsor_enabled
==true
. How long to remain valid sponsored guest request approve/deny link received in email, in minutes. - sponsor
Notify All This property is required. Boolean - Optional if
sponsor_enabled
==true
. whether to notify all sponsors that are mentioned insponsors
object. Bothsponsor_notify_all
andpredefined_sponsors_enabled
should be true in order to notify sponsors. If true, email sent to 10 sponsors in no particular order. - sponsor
Status Notify This property is required. Boolean - Optional if
sponsor_enabled
==true
. If enabled, guest will get email about sponsor's action (approve/deny) - sponsors
This property is required. Map<String,String> - object of allowed sponsors email with name. Required if
sponsor_enabled
istrue
andsponsor_email_domains
is empty.Property key is the sponsor email, Property value is the sponsor name
- sso
Default Role This property is required. String - Optional if
wlan_portal_auth
==sso
, default role to assign if there’s no match. By default, an assertion is treated as invalid when there’s no role matched - sso
Forced Role This property is required. String - Optional if
wlan_portal_auth
==sso
- sso
Idp Cert This property is required. String - Required if
wlan_portal_auth
==sso
. IDP Cert (used to verify the signed response) - sso
Idp Sign Algo This property is required. String - Optioanl if
wlan_portal_auth
==sso
, Signing algorithm for SAML Assertion. enum:sha1
,sha256
,sha384
,sha512
- sso
Idp Sso Url This property is required. String - Required if
wlan_portal_auth
==sso
, IDP Single-Sign-On URL - sso
Issuer This property is required. String - Required if
wlan_portal_auth
==sso
, IDP issuer URL - sso
Nameid Format This property is required. String - Optional if
wlan_portal_auth
==sso
. enum:email
,unspecified
- telstra
Client Id This property is required. String - Required if
sms_provider
==telstra
, Client ID provided by Telstra - telstra
Client Secret This property is required. String - Required if
sms_provider
==telstra
, Client secret provided by Telstra - twilio
Auth Token This property is required. String - Required if
sms_provider
==twilio
, Auth token account with twilio account - twilio
Phone Number This property is required. String - Required if
sms_provider
==twilio
, Twilio phone number associated with the account. See example for accepted format. - twilio
Sid This property is required. String - Required if
sms_provider
==twilio
, Account SID provided by Twilio
- allow
Wlan Id Roam This property is required. boolean - Optional if
amazon_enabled
==true
. Whether to allow guest to connect to other Guest WLANs (with differentWLAN.ssid
) of same org without reauthentication (disable random_mac for seamless roaming) - amazon
Client Id This property is required. string - Optional if
amazon_enabled
==true
. Amazon OAuth2 client id. This is optional. If not provided, it will use a default one. - amazon
Client Secret This property is required. string - Optional if
amazon_enabled
==true
. Amazon OAuth2 client secret. If amazon_client_id was provided, provide a corresponding value. Else leave blank. - amazon
Email Domains This property is required. string[] - Optional if
amazon_enabled
==true
. Matches authenticated user email against provided domains. If null or [], all authenticated emails will be allowed. - amazon
Enabled This property is required. boolean - Whether amazon is enabled as a login method
- amazon
Expire This property is required. number - Optional if
amazon_enabled
==true
. Interval for which guest remains authorized using amazon auth (in minutes), if not provided, uses expire` - auth
This property is required. string - authentication scheme. enum:
amazon
,azure
,email
,external
,facebook
,google
,microsoft
,multi
,none
,password
,sponsor
,sso
- azure
Client Id This property is required. string - Required if
azure_enabled
==true
. Azure active directory app client id - azure
Client Secret This property is required. string - Required if
azure_enabled
==true
. Azure active directory app client secret - azure
Enabled This property is required. boolean - Whether Azure Active Directory is enabled as a login method
- azure
Expire This property is required. number - Interval for which guest remains authorized using azure auth (in minutes), if not provided, uses expire`
- azure
Tenant Id This property is required. string - Required if
azure_enabled
==true
. Azure active directory tenant id. - broadnet
Password This property is required. string - Required if
sms_provider
==broadnet
- broadnet
Sid This property is required. string - Required if
sms_provider
==broadnet
- broadnet
User Id This property is required. string - Required if
sms_provider
==broadnet
- bypass
When Cloud Down This property is required. boolean - Whether to bypass the guest portal when cloud not reachable (and apply the default policies)
- clickatell
Api Key This property is required. string - Required if
sms_provider
==clickatell
- cross
Site This property is required. boolean - Whether to allow guest to roam between WLANs (with same
WLAN.ssid
, regardless of variables) of different sites of same org without reauthentication (disable random_mac for seamless roaming) - email
Enabled This property is required. boolean - Whether email (access code verification) is enabled as a login method
- enabled
This property is required. boolean - Whether guest portal is enabled
- expire
This property is required. number - How long to remain authorized, in minutes
- external
Portal Url This property is required. string - Required if
wlan_portal_auth
==external
. External portal URL (e.g. https://host/url) where we can append our query parameters to - facebook
Client Id This property is required. string - Required if
facebook_enabled
==true
. Facebook OAuth2 app id. This is optional. If not provided, it will use a default one. - facebook
Client Secret This property is required. string - Required if
facebook_enabled
==true
. Facebook OAuth2 app secret. If facebook_client_id was provided, provide a corresponding value. Else leave blank. - facebook
Email Domains This property is required. string[] - Optional if
facebook_enabled
==true
. Matches authenticated user email against provided domains. If null or [], all authenticated emails will be allowed. - facebook
Enabled This property is required. boolean - Whether facebook is enabled as a login method
- facebook
Expire This property is required. number - Optional if
facebook_enabled
==true
. Interval for which guest remains authorized using facebook auth (in minutes), if not provided, uses expire` - forward
This property is required. boolean - Whether to forward the user to another URL after authorized
- forward
Url This property is required. string - URL to forward the user to
- google
Client Id This property is required. string - Google OAuth2 app id. This is optional. If not provided, it will use a default one.
- google
Client Secret This property is required. string - Optional if
google_enabled
==true
. Google OAuth2 app secret. If google_client_id was provided, provide a corresponding value. Else leave blank. - google
Email Domains This property is required. string[] - Optional if
google_enabled
==true
. Matches authenticated user email against provided domains. If null or [], all authenticated emails will be allowed. - google
Enabled This property is required. boolean - Whether Google is enabled as login method
- google
Expire This property is required. number - Optional if
google_enabled
==true
. Interval for which guest remains authorized using Google Auth (in minutes), if not provided, uses expire` - gupshup
Password This property is required. string - Required if
sms_provider
==gupshup
- gupshup
Userid This property is required. string - Required if
sms_provider
==gupshup
- microsoft
Client Id This property is required. string - Optional if
microsoft_enabled
==true
. Microsoft 365 OAuth2 client id. This is optional. If not provided, it will use a default one. - microsoft
Client Secret This property is required. string - Optional if
microsoft_enabled
==true
. Microsoft 365 OAuth2 client secret. If microsoft_client_id was provided, provide a corresponding value. Else leave blank. - microsoft
Email Domains This property is required. string[] - Optional if
microsoft_enabled
==true
. Matches authenticated user email against provided domains. If null or [], all authenticated emails will be allowed. - microsoft
Enabled This property is required. boolean - Whether microsoft 365 is enabled as a login method
- microsoft
Expire This property is required. number - Optional if
microsoft_enabled
==true
. Interval for which guest remains authorized using microsoft auth (in minutes), if not provided, uses expire` - passphrase
Enabled This property is required. boolean - Whether password is enabled
- passphrase
Expire This property is required. number - Optional if
passphrase_enabled
==true
. Interval for which guest remains authorized using passphrase auth (in minutes), if not provided, usesexpire
- password
This property is required. string - Required if
passphrase_enabled
==true
. - predefined
Sponsors Enabled This property is required. boolean - Whether to show list of sponsor emails mentioned in
sponsors
object as a dropdown. If bothsponsor_notify_all
andpredefined_sponsors_enabled
are false, behaviour is acc tosponsor_email_domains
- predefined
Sponsors Hide Email This property is required. boolean - Whether to hide sponsor’s email from list of sponsors
- privacy
This property is required. boolean - puzzel
Password This property is required. string - Required if
sms_provider
==puzzel
- puzzel
Service Id This property is required. string - Required if
sms_provider
==puzzel
- puzzel
Username This property is required. string - Required if
sms_provider
==puzzel
- sms
Enabled This property is required. boolean - Whether sms is enabled as a login method
- sms
Expire This property is required. number - Optional if
sms_enabled
==true
. Interval for which guest remains authorized using sms auth (in minutes), if not provided, uses expire` - sms
Message Format This property is required. string - Optional if
sms_enabled
==true
. SMS Message format - sms
Provider This property is required. string - Optioanl if
sms_enabled
==true
. enum:broadnet
,clickatell
,gupshup
,manual
,puzzel
,telstra
,twilio
- sponsor
Auto Approve This property is required. boolean - Optional if
sponsor_enabled
==true
. Whether to automatically approve guest and allow sponsor to revoke guest access, needs predefined_sponsors_enabled enabled and sponsor_notify_all disabled - sponsor
Email Domains This property is required. string[] - List of domain allowed for sponsor email. Required if
sponsor_enabled
istrue
andsponsors
is empty. - sponsor
Enabled This property is required. boolean - Whether sponsor is enabled
- sponsor
Expire This property is required. number - Optional if
sponsor_enabled
==true
. Interval for which guest remains authorized using sponsor auth (in minutes), if not provided, uses expire` - sponsor
Link Validity Duration This property is required. string - Optional if
sponsor_enabled
==true
. How long to remain valid sponsored guest request approve/deny link received in email, in minutes. - sponsor
Notify All This property is required. boolean - Optional if
sponsor_enabled
==true
. whether to notify all sponsors that are mentioned insponsors
object. Bothsponsor_notify_all
andpredefined_sponsors_enabled
should be true in order to notify sponsors. If true, email sent to 10 sponsors in no particular order. - sponsor
Status Notify This property is required. boolean - Optional if
sponsor_enabled
==true
. If enabled, guest will get email about sponsor's action (approve/deny) - sponsors
This property is required. {[key: string]: string} - object of allowed sponsors email with name. Required if
sponsor_enabled
istrue
andsponsor_email_domains
is empty.Property key is the sponsor email, Property value is the sponsor name
- sso
Default Role This property is required. string - Optional if
wlan_portal_auth
==sso
, default role to assign if there’s no match. By default, an assertion is treated as invalid when there’s no role matched - sso
Forced Role This property is required. string - Optional if
wlan_portal_auth
==sso
- sso
Idp Cert This property is required. string - Required if
wlan_portal_auth
==sso
. IDP Cert (used to verify the signed response) - sso
Idp Sign Algo This property is required. string - Optioanl if
wlan_portal_auth
==sso
, Signing algorithm for SAML Assertion. enum:sha1
,sha256
,sha384
,sha512
- sso
Idp Sso Url This property is required. string - Required if
wlan_portal_auth
==sso
, IDP Single-Sign-On URL - sso
Issuer This property is required. string - Required if
wlan_portal_auth
==sso
, IDP issuer URL - sso
Nameid Format This property is required. string - Optional if
wlan_portal_auth
==sso
. enum:email
,unspecified
- telstra
Client Id This property is required. string - Required if
sms_provider
==telstra
, Client ID provided by Telstra - telstra
Client Secret This property is required. string - Required if
sms_provider
==telstra
, Client secret provided by Telstra - twilio
Auth Token This property is required. string - Required if
sms_provider
==twilio
, Auth token account with twilio account - twilio
Phone Number This property is required. string - Required if
sms_provider
==twilio
, Twilio phone number associated with the account. See example for accepted format. - twilio
Sid This property is required. string - Required if
sms_provider
==twilio
, Account SID provided by Twilio
- allow_
wlan_ id_ roam This property is required. bool - Optional if
amazon_enabled
==true
. Whether to allow guest to connect to other Guest WLANs (with differentWLAN.ssid
) of same org without reauthentication (disable random_mac for seamless roaming) - amazon_
client_ id This property is required. str - Optional if
amazon_enabled
==true
. Amazon OAuth2 client id. This is optional. If not provided, it will use a default one. - amazon_
client_ secret This property is required. str - Optional if
amazon_enabled
==true
. Amazon OAuth2 client secret. If amazon_client_id was provided, provide a corresponding value. Else leave blank. - amazon_
email_ domains This property is required. Sequence[str] - Optional if
amazon_enabled
==true
. Matches authenticated user email against provided domains. If null or [], all authenticated emails will be allowed. - amazon_
enabled This property is required. bool - Whether amazon is enabled as a login method
- amazon_
expire This property is required. int - Optional if
amazon_enabled
==true
. Interval for which guest remains authorized using amazon auth (in minutes), if not provided, uses expire` - auth
This property is required. str - authentication scheme. enum:
amazon
,azure
,email
,external
,facebook
,google
,microsoft
,multi
,none
,password
,sponsor
,sso
- azure_
client_ id This property is required. str - Required if
azure_enabled
==true
. Azure active directory app client id - azure_
client_ secret This property is required. str - Required if
azure_enabled
==true
. Azure active directory app client secret - azure_
enabled This property is required. bool - Whether Azure Active Directory is enabled as a login method
- azure_
expire This property is required. int - Interval for which guest remains authorized using azure auth (in minutes), if not provided, uses expire`
- azure_
tenant_ id This property is required. str - Required if
azure_enabled
==true
. Azure active directory tenant id. - broadnet_
password This property is required. str - Required if
sms_provider
==broadnet
- broadnet_
sid This property is required. str - Required if
sms_provider
==broadnet
- broadnet_
user_ id This property is required. str - Required if
sms_provider
==broadnet
- bypass_
when_ cloud_ down This property is required. bool - Whether to bypass the guest portal when cloud not reachable (and apply the default policies)
- clickatell_
api_ key This property is required. str - Required if
sms_provider
==clickatell
- cross_
site This property is required. bool - Whether to allow guest to roam between WLANs (with same
WLAN.ssid
, regardless of variables) of different sites of same org without reauthentication (disable random_mac for seamless roaming) - email_
enabled This property is required. bool - Whether email (access code verification) is enabled as a login method
- enabled
This property is required. bool - Whether guest portal is enabled
- expire
This property is required. int - How long to remain authorized, in minutes
- external_
portal_ url This property is required. str - Required if
wlan_portal_auth
==external
. External portal URL (e.g. https://host/url) where we can append our query parameters to - facebook_
client_ id This property is required. str - Required if
facebook_enabled
==true
. Facebook OAuth2 app id. This is optional. If not provided, it will use a default one. - facebook_
client_ secret This property is required. str - Required if
facebook_enabled
==true
. Facebook OAuth2 app secret. If facebook_client_id was provided, provide a corresponding value. Else leave blank. - facebook_
email_ domains This property is required. Sequence[str] - Optional if
facebook_enabled
==true
. Matches authenticated user email against provided domains. If null or [], all authenticated emails will be allowed. - facebook_
enabled This property is required. bool - Whether facebook is enabled as a login method
- facebook_
expire This property is required. int - Optional if
facebook_enabled
==true
. Interval for which guest remains authorized using facebook auth (in minutes), if not provided, uses expire` - forward
This property is required. bool - Whether to forward the user to another URL after authorized
- forward_
url This property is required. str - URL to forward the user to
- google_
client_ id This property is required. str - Google OAuth2 app id. This is optional. If not provided, it will use a default one.
- google_
client_ secret This property is required. str - Optional if
google_enabled
==true
. Google OAuth2 app secret. If google_client_id was provided, provide a corresponding value. Else leave blank. - google_
email_ domains This property is required. Sequence[str] - Optional if
google_enabled
==true
. Matches authenticated user email against provided domains. If null or [], all authenticated emails will be allowed. - google_
enabled This property is required. bool - Whether Google is enabled as login method
- google_
expire This property is required. int - Optional if
google_enabled
==true
. Interval for which guest remains authorized using Google Auth (in minutes), if not provided, uses expire` - gupshup_
password This property is required. str - Required if
sms_provider
==gupshup
- gupshup_
userid This property is required. str - Required if
sms_provider
==gupshup
- microsoft_
client_ id This property is required. str - Optional if
microsoft_enabled
==true
. Microsoft 365 OAuth2 client id. This is optional. If not provided, it will use a default one. - microsoft_
client_ secret This property is required. str - Optional if
microsoft_enabled
==true
. Microsoft 365 OAuth2 client secret. If microsoft_client_id was provided, provide a corresponding value. Else leave blank. - microsoft_
email_ domains This property is required. Sequence[str] - Optional if
microsoft_enabled
==true
. Matches authenticated user email against provided domains. If null or [], all authenticated emails will be allowed. - microsoft_
enabled This property is required. bool - Whether microsoft 365 is enabled as a login method
- microsoft_
expire This property is required. int - Optional if
microsoft_enabled
==true
. Interval for which guest remains authorized using microsoft auth (in minutes), if not provided, uses expire` - passphrase_
enabled This property is required. bool - Whether password is enabled
- passphrase_
expire This property is required. int - Optional if
passphrase_enabled
==true
. Interval for which guest remains authorized using passphrase auth (in minutes), if not provided, usesexpire
- password
This property is required. str - Required if
passphrase_enabled
==true
. - predefined_
sponsors_ enabled This property is required. bool - Whether to show list of sponsor emails mentioned in
sponsors
object as a dropdown. If bothsponsor_notify_all
andpredefined_sponsors_enabled
are false, behaviour is acc tosponsor_email_domains
- predefined_
sponsors_ hide_ email This property is required. bool - Whether to hide sponsor’s email from list of sponsors
- privacy
This property is required. bool - puzzel_
password This property is required. str - Required if
sms_provider
==puzzel
- puzzel_
service_ id This property is required. str - Required if
sms_provider
==puzzel
- puzzel_
username This property is required. str - Required if
sms_provider
==puzzel
- sms_
enabled This property is required. bool - Whether sms is enabled as a login method
- sms_
expire This property is required. int - Optional if
sms_enabled
==true
. Interval for which guest remains authorized using sms auth (in minutes), if not provided, uses expire` - sms_
message_ format This property is required. str - Optional if
sms_enabled
==true
. SMS Message format - sms_
provider This property is required. str - Optioanl if
sms_enabled
==true
. enum:broadnet
,clickatell
,gupshup
,manual
,puzzel
,telstra
,twilio
- sponsor_
auto_ approve This property is required. bool - Optional if
sponsor_enabled
==true
. Whether to automatically approve guest and allow sponsor to revoke guest access, needs predefined_sponsors_enabled enabled and sponsor_notify_all disabled - sponsor_
email_ domains This property is required. Sequence[str] - List of domain allowed for sponsor email. Required if
sponsor_enabled
istrue
andsponsors
is empty. - sponsor_
enabled This property is required. bool - Whether sponsor is enabled
- sponsor_
expire This property is required. int - Optional if
sponsor_enabled
==true
. Interval for which guest remains authorized using sponsor auth (in minutes), if not provided, uses expire` - sponsor_
link_ validity_ duration This property is required. str - Optional if
sponsor_enabled
==true
. How long to remain valid sponsored guest request approve/deny link received in email, in minutes. - sponsor_
notify_ all This property is required. bool - Optional if
sponsor_enabled
==true
. whether to notify all sponsors that are mentioned insponsors
object. Bothsponsor_notify_all
andpredefined_sponsors_enabled
should be true in order to notify sponsors. If true, email sent to 10 sponsors in no particular order. - sponsor_
status_ notify This property is required. bool - Optional if
sponsor_enabled
==true
. If enabled, guest will get email about sponsor's action (approve/deny) - sponsors
This property is required. Mapping[str, str] - object of allowed sponsors email with name. Required if
sponsor_enabled
istrue
andsponsor_email_domains
is empty.Property key is the sponsor email, Property value is the sponsor name
- sso_
default_ role This property is required. str - Optional if
wlan_portal_auth
==sso
, default role to assign if there’s no match. By default, an assertion is treated as invalid when there’s no role matched - sso_
forced_ role This property is required. str - Optional if
wlan_portal_auth
==sso
- sso_
idp_ cert This property is required. str - Required if
wlan_portal_auth
==sso
. IDP Cert (used to verify the signed response) - sso_
idp_ sign_ algo This property is required. str - Optioanl if
wlan_portal_auth
==sso
, Signing algorithm for SAML Assertion. enum:sha1
,sha256
,sha384
,sha512
- sso_
idp_ sso_ url This property is required. str - Required if
wlan_portal_auth
==sso
, IDP Single-Sign-On URL - sso_
issuer This property is required. str - Required if
wlan_portal_auth
==sso
, IDP issuer URL - sso_
nameid_ format This property is required. str - Optional if
wlan_portal_auth
==sso
. enum:email
,unspecified
- telstra_
client_ id This property is required. str - Required if
sms_provider
==telstra
, Client ID provided by Telstra - telstra_
client_ secret This property is required. str - Required if
sms_provider
==telstra
, Client secret provided by Telstra - twilio_
auth_ token This property is required. str - Required if
sms_provider
==twilio
, Auth token account with twilio account - twilio_
phone_ number This property is required. str - Required if
sms_provider
==twilio
, Twilio phone number associated with the account. See example for accepted format. - twilio_
sid This property is required. str - Required if
sms_provider
==twilio
, Account SID provided by Twilio
- allow
Wlan Id Roam This property is required. Boolean - Optional if
amazon_enabled
==true
. Whether to allow guest to connect to other Guest WLANs (with differentWLAN.ssid
) of same org without reauthentication (disable random_mac for seamless roaming) - amazon
Client Id This property is required. String - Optional if
amazon_enabled
==true
. Amazon OAuth2 client id. This is optional. If not provided, it will use a default one. - amazon
Client Secret This property is required. String - Optional if
amazon_enabled
==true
. Amazon OAuth2 client secret. If amazon_client_id was provided, provide a corresponding value. Else leave blank. - amazon
Email Domains This property is required. List<String> - Optional if
amazon_enabled
==true
. Matches authenticated user email against provided domains. If null or [], all authenticated emails will be allowed. - amazon
Enabled This property is required. Boolean - Whether amazon is enabled as a login method
- amazon
Expire This property is required. Number - Optional if
amazon_enabled
==true
. Interval for which guest remains authorized using amazon auth (in minutes), if not provided, uses expire` - auth
This property is required. String - authentication scheme. enum:
amazon
,azure
,email
,external
,facebook
,google
,microsoft
,multi
,none
,password
,sponsor
,sso
- azure
Client Id This property is required. String - Required if
azure_enabled
==true
. Azure active directory app client id - azure
Client Secret This property is required. String - Required if
azure_enabled
==true
. Azure active directory app client secret - azure
Enabled This property is required. Boolean - Whether Azure Active Directory is enabled as a login method
- azure
Expire This property is required. Number - Interval for which guest remains authorized using azure auth (in minutes), if not provided, uses expire`
- azure
Tenant Id This property is required. String - Required if
azure_enabled
==true
. Azure active directory tenant id. - broadnet
Password This property is required. String - Required if
sms_provider
==broadnet
- broadnet
Sid This property is required. String - Required if
sms_provider
==broadnet
- broadnet
User Id This property is required. String - Required if
sms_provider
==broadnet
- bypass
When Cloud Down This property is required. Boolean - Whether to bypass the guest portal when cloud not reachable (and apply the default policies)
- clickatell
Api Key This property is required. String - Required if
sms_provider
==clickatell
- cross
Site This property is required. Boolean - Whether to allow guest to roam between WLANs (with same
WLAN.ssid
, regardless of variables) of different sites of same org without reauthentication (disable random_mac for seamless roaming) - email
Enabled This property is required. Boolean - Whether email (access code verification) is enabled as a login method
- enabled
This property is required. Boolean - Whether guest portal is enabled
- expire
This property is required. Number - How long to remain authorized, in minutes
- external
Portal Url This property is required. String - Required if
wlan_portal_auth
==external
. External portal URL (e.g. https://host/url) where we can append our query parameters to - facebook
Client Id This property is required. String - Required if
facebook_enabled
==true
. Facebook OAuth2 app id. This is optional. If not provided, it will use a default one. - facebook
Client Secret This property is required. String - Required if
facebook_enabled
==true
. Facebook OAuth2 app secret. If facebook_client_id was provided, provide a corresponding value. Else leave blank. - facebook
Email Domains This property is required. List<String> - Optional if
facebook_enabled
==true
. Matches authenticated user email against provided domains. If null or [], all authenticated emails will be allowed. - facebook
Enabled This property is required. Boolean - Whether facebook is enabled as a login method
- facebook
Expire This property is required. Number - Optional if
facebook_enabled
==true
. Interval for which guest remains authorized using facebook auth (in minutes), if not provided, uses expire` - forward
This property is required. Boolean - Whether to forward the user to another URL after authorized
- forward
Url This property is required. String - URL to forward the user to
- google
Client Id This property is required. String - Google OAuth2 app id. This is optional. If not provided, it will use a default one.
- google
Client Secret This property is required. String - Optional if
google_enabled
==true
. Google OAuth2 app secret. If google_client_id was provided, provide a corresponding value. Else leave blank. - google
Email Domains This property is required. List<String> - Optional if
google_enabled
==true
. Matches authenticated user email against provided domains. If null or [], all authenticated emails will be allowed. - google
Enabled This property is required. Boolean - Whether Google is enabled as login method
- google
Expire This property is required. Number - Optional if
google_enabled
==true
. Interval for which guest remains authorized using Google Auth (in minutes), if not provided, uses expire` - gupshup
Password This property is required. String - Required if
sms_provider
==gupshup
- gupshup
Userid This property is required. String - Required if
sms_provider
==gupshup
- microsoft
Client Id This property is required. String - Optional if
microsoft_enabled
==true
. Microsoft 365 OAuth2 client id. This is optional. If not provided, it will use a default one. - microsoft
Client Secret This property is required. String - Optional if
microsoft_enabled
==true
. Microsoft 365 OAuth2 client secret. If microsoft_client_id was provided, provide a corresponding value. Else leave blank. - microsoft
Email Domains This property is required. List<String> - Optional if
microsoft_enabled
==true
. Matches authenticated user email against provided domains. If null or [], all authenticated emails will be allowed. - microsoft
Enabled This property is required. Boolean - Whether microsoft 365 is enabled as a login method
- microsoft
Expire This property is required. Number - Optional if
microsoft_enabled
==true
. Interval for which guest remains authorized using microsoft auth (in minutes), if not provided, uses expire` - passphrase
Enabled This property is required. Boolean - Whether password is enabled
- passphrase
Expire This property is required. Number - Optional if
passphrase_enabled
==true
. Interval for which guest remains authorized using passphrase auth (in minutes), if not provided, usesexpire
- password
This property is required. String - Required if
passphrase_enabled
==true
. - predefined
Sponsors Enabled This property is required. Boolean - Whether to show list of sponsor emails mentioned in
sponsors
object as a dropdown. If bothsponsor_notify_all
andpredefined_sponsors_enabled
are false, behaviour is acc tosponsor_email_domains
- predefined
Sponsors Hide Email This property is required. Boolean - Whether to hide sponsor’s email from list of sponsors
- privacy
This property is required. Boolean - puzzel
Password This property is required. String - Required if
sms_provider
==puzzel
- puzzel
Service Id This property is required. String - Required if
sms_provider
==puzzel
- puzzel
Username This property is required. String - Required if
sms_provider
==puzzel
- sms
Enabled This property is required. Boolean - Whether sms is enabled as a login method
- sms
Expire This property is required. Number - Optional if
sms_enabled
==true
. Interval for which guest remains authorized using sms auth (in minutes), if not provided, uses expire` - sms
Message Format This property is required. String - Optional if
sms_enabled
==true
. SMS Message format - sms
Provider This property is required. String - Optioanl if
sms_enabled
==true
. enum:broadnet
,clickatell
,gupshup
,manual
,puzzel
,telstra
,twilio
- sponsor
Auto Approve This property is required. Boolean - Optional if
sponsor_enabled
==true
. Whether to automatically approve guest and allow sponsor to revoke guest access, needs predefined_sponsors_enabled enabled and sponsor_notify_all disabled - sponsor
Email Domains This property is required. List<String> - List of domain allowed for sponsor email. Required if
sponsor_enabled
istrue
andsponsors
is empty. - sponsor
Enabled This property is required. Boolean - Whether sponsor is enabled
- sponsor
Expire This property is required. Number - Optional if
sponsor_enabled
==true
. Interval for which guest remains authorized using sponsor auth (in minutes), if not provided, uses expire` - sponsor
Link Validity Duration This property is required. String - Optional if
sponsor_enabled
==true
. How long to remain valid sponsored guest request approve/deny link received in email, in minutes. - sponsor
Notify All This property is required. Boolean - Optional if
sponsor_enabled
==true
. whether to notify all sponsors that are mentioned insponsors
object. Bothsponsor_notify_all
andpredefined_sponsors_enabled
should be true in order to notify sponsors. If true, email sent to 10 sponsors in no particular order. - sponsor
Status Notify This property is required. Boolean - Optional if
sponsor_enabled
==true
. If enabled, guest will get email about sponsor's action (approve/deny) - sponsors
This property is required. Map<String> - object of allowed sponsors email with name. Required if
sponsor_enabled
istrue
andsponsor_email_domains
is empty.Property key is the sponsor email, Property value is the sponsor name
- sso
Default Role This property is required. String - Optional if
wlan_portal_auth
==sso
, default role to assign if there’s no match. By default, an assertion is treated as invalid when there’s no role matched - sso
Forced Role This property is required. String - Optional if
wlan_portal_auth
==sso
- sso
Idp Cert This property is required. String - Required if
wlan_portal_auth
==sso
. IDP Cert (used to verify the signed response) - sso
Idp Sign Algo This property is required. String - Optioanl if
wlan_portal_auth
==sso
, Signing algorithm for SAML Assertion. enum:sha1
,sha256
,sha384
,sha512
- sso
Idp Sso Url This property is required. String - Required if
wlan_portal_auth
==sso
, IDP Single-Sign-On URL - sso
Issuer This property is required. String - Required if
wlan_portal_auth
==sso
, IDP issuer URL - sso
Nameid Format This property is required. String - Optional if
wlan_portal_auth
==sso
. enum:email
,unspecified
- telstra
Client Id This property is required. String - Required if
sms_provider
==telstra
, Client ID provided by Telstra - telstra
Client Secret This property is required. String - Required if
sms_provider
==telstra
, Client secret provided by Telstra - twilio
Auth Token This property is required. String - Required if
sms_provider
==twilio
, Auth token account with twilio account - twilio
Phone Number This property is required. String - Required if
sms_provider
==twilio
, Twilio phone number associated with the account. See example for accepted format. - twilio
Sid This property is required. String - Required if
sms_provider
==twilio
, Account SID provided by Twilio
GetWlansSiteWlanQos
GetWlansSiteWlanRadsec
- Coa
Enabled This property is required. bool - Enabled
This property is required. bool - Idle
Timeout This property is required. int - Mxcluster
Ids This property is required. List<string> - To use Org mxedges when this WLAN does not use mxtunnel, specify their mxcluster_ids. Org mxedge(s) identified by mxcluster_ids
- Proxy
Hosts This property is required. List<string> - Default is site.mxedge.radsec.proxy_hosts which must be a superset of all
wlans[*].radsec.proxy_hosts
. Whenradsec.proxy_hosts
are not used, tunnel peers (org or site mxedges) are used irrespective ofuse_site_mxedge
- Server
Name This property is required. string - Name of the server to verify (against the cacerts in Org Setting). Only if not Mist Edge.
- Servers
This property is required. List<Pulumi.Juniper Mist. Site. Inputs. Get Wlans Site Wlan Radsec Server> - List of RadSec Servers. Only if not Mist Edge.
- Use
Mxedge This property is required. bool - use mxedge(s) as RadSec Proxy
- Use
Site Mxedge This property is required. bool - To use Site mxedges when this WLAN does not use mxtunnel
- Coa
Enabled This property is required. bool - Enabled
This property is required. bool - Idle
Timeout This property is required. int - Mxcluster
Ids This property is required. []string - To use Org mxedges when this WLAN does not use mxtunnel, specify their mxcluster_ids. Org mxedge(s) identified by mxcluster_ids
- Proxy
Hosts This property is required. []string - Default is site.mxedge.radsec.proxy_hosts which must be a superset of all
wlans[*].radsec.proxy_hosts
. Whenradsec.proxy_hosts
are not used, tunnel peers (org or site mxedges) are used irrespective ofuse_site_mxedge
- Server
Name This property is required. string - Name of the server to verify (against the cacerts in Org Setting). Only if not Mist Edge.
- Servers
This property is required. []GetWlans Site Wlan Radsec Server - List of RadSec Servers. Only if not Mist Edge.
- Use
Mxedge This property is required. bool - use mxedge(s) as RadSec Proxy
- Use
Site Mxedge This property is required. bool - To use Site mxedges when this WLAN does not use mxtunnel
- coa
Enabled This property is required. Boolean - enabled
This property is required. Boolean - idle
Timeout This property is required. Integer - mxcluster
Ids This property is required. List<String> - To use Org mxedges when this WLAN does not use mxtunnel, specify their mxcluster_ids. Org mxedge(s) identified by mxcluster_ids
- proxy
Hosts This property is required. List<String> - Default is site.mxedge.radsec.proxy_hosts which must be a superset of all
wlans[*].radsec.proxy_hosts
. Whenradsec.proxy_hosts
are not used, tunnel peers (org or site mxedges) are used irrespective ofuse_site_mxedge
- server
Name This property is required. String - Name of the server to verify (against the cacerts in Org Setting). Only if not Mist Edge.
- servers
This property is required. List<GetWlans Site Wlan Radsec Server> - List of RadSec Servers. Only if not Mist Edge.
- use
Mxedge This property is required. Boolean - use mxedge(s) as RadSec Proxy
- use
Site Mxedge This property is required. Boolean - To use Site mxedges when this WLAN does not use mxtunnel
- coa
Enabled This property is required. boolean - enabled
This property is required. boolean - idle
Timeout This property is required. number - mxcluster
Ids This property is required. string[] - To use Org mxedges when this WLAN does not use mxtunnel, specify their mxcluster_ids. Org mxedge(s) identified by mxcluster_ids
- proxy
Hosts This property is required. string[] - Default is site.mxedge.radsec.proxy_hosts which must be a superset of all
wlans[*].radsec.proxy_hosts
. Whenradsec.proxy_hosts
are not used, tunnel peers (org or site mxedges) are used irrespective ofuse_site_mxedge
- server
Name This property is required. string - Name of the server to verify (against the cacerts in Org Setting). Only if not Mist Edge.
- servers
This property is required. GetWlans Site Wlan Radsec Server[] - List of RadSec Servers. Only if not Mist Edge.
- use
Mxedge This property is required. boolean - use mxedge(s) as RadSec Proxy
- use
Site Mxedge This property is required. boolean - To use Site mxedges when this WLAN does not use mxtunnel
- coa_
enabled This property is required. bool - enabled
This property is required. bool - idle_
timeout This property is required. int - mxcluster_
ids This property is required. Sequence[str] - To use Org mxedges when this WLAN does not use mxtunnel, specify their mxcluster_ids. Org mxedge(s) identified by mxcluster_ids
- proxy_
hosts This property is required. Sequence[str] - Default is site.mxedge.radsec.proxy_hosts which must be a superset of all
wlans[*].radsec.proxy_hosts
. Whenradsec.proxy_hosts
are not used, tunnel peers (org or site mxedges) are used irrespective ofuse_site_mxedge
- server_
name This property is required. str - Name of the server to verify (against the cacerts in Org Setting). Only if not Mist Edge.
- servers
This property is required. Sequence[GetWlans Site Wlan Radsec Server] - List of RadSec Servers. Only if not Mist Edge.
- use_
mxedge This property is required. bool - use mxedge(s) as RadSec Proxy
- use_
site_ mxedge This property is required. bool - To use Site mxedges when this WLAN does not use mxtunnel
- coa
Enabled This property is required. Boolean - enabled
This property is required. Boolean - idle
Timeout This property is required. Number - mxcluster
Ids This property is required. List<String> - To use Org mxedges when this WLAN does not use mxtunnel, specify their mxcluster_ids. Org mxedge(s) identified by mxcluster_ids
- proxy
Hosts This property is required. List<String> - Default is site.mxedge.radsec.proxy_hosts which must be a superset of all
wlans[*].radsec.proxy_hosts
. Whenradsec.proxy_hosts
are not used, tunnel peers (org or site mxedges) are used irrespective ofuse_site_mxedge
- server
Name This property is required. String - Name of the server to verify (against the cacerts in Org Setting). Only if not Mist Edge.
- servers
This property is required. List<Property Map> - List of RadSec Servers. Only if not Mist Edge.
- use
Mxedge This property is required. Boolean - use mxedge(s) as RadSec Proxy
- use
Site Mxedge This property is required. Boolean - To use Site mxedges when this WLAN does not use mxtunnel
GetWlansSiteWlanRadsecServer
GetWlansSiteWlanRateset
- Eht
This property is required. string - If
template
==custom
. EHT MCS bitmasks for 4 streams (16-bit for each stream, MCS0 is least significant bit) - He
This property is required. string - If
template
==custom
. HE MCS bitmasks for 4 streams (16-bit for each stream, MCS0 is least significant bit - Ht
This property is required. string - If
template
==custom
. MCS bitmasks for 4 streams (16-bit for each stream, MCS0 is least significant bit), e.g. 00ff 00f0 001f limits HT rates to MCS 0-7 for 1 stream, MCS 4-7 for 2 stream (i.e. MCS 12-15), MCS 1-5 for 3 stream (i.e. MCS 16-20) - Legacies
This property is required. List<string> - If
template
==custom
. List of supported rates (IE=1) and extended supported rates (IE=50) for custom template, append ‘b’ at the end to indicate a rate being basic/mandatory. Iftemplate
==custom
is configured and legacy does not define at least one basic rate, it will useno-legacy
default values - Min
Rssi This property is required. int - Minimum RSSI for client to connect, 0 means not enforcing
- Template
This property is required. string - Data Rates template to apply. enum:
no-legacy
: no 11bcompatible
: all, like before, default setting that Broadcom/Atheros usedlegacy-only
: disable 802.11n and 802.11achigh-density
: no 11b, no low ratescustom
: user defined
- Vht
This property is required. string - If
template
==custom
. MCS bitmasks for 4 streams (16-bit for each stream, MCS0 is least significant bit), e.g. 03ff 01ff 00ff limits VHT rates to MCS 0-9 for 1 stream, MCS 0-8 for 2 streams, and MCS 0-7 for 3 streams.
- Eht
This property is required. string - If
template
==custom
. EHT MCS bitmasks for 4 streams (16-bit for each stream, MCS0 is least significant bit) - He
This property is required. string - If
template
==custom
. HE MCS bitmasks for 4 streams (16-bit for each stream, MCS0 is least significant bit - Ht
This property is required. string - If
template
==custom
. MCS bitmasks for 4 streams (16-bit for each stream, MCS0 is least significant bit), e.g. 00ff 00f0 001f limits HT rates to MCS 0-7 for 1 stream, MCS 4-7 for 2 stream (i.e. MCS 12-15), MCS 1-5 for 3 stream (i.e. MCS 16-20) - Legacies
This property is required. []string - If
template
==custom
. List of supported rates (IE=1) and extended supported rates (IE=50) for custom template, append ‘b’ at the end to indicate a rate being basic/mandatory. Iftemplate
==custom
is configured and legacy does not define at least one basic rate, it will useno-legacy
default values - Min
Rssi This property is required. int - Minimum RSSI for client to connect, 0 means not enforcing
- Template
This property is required. string - Data Rates template to apply. enum:
no-legacy
: no 11bcompatible
: all, like before, default setting that Broadcom/Atheros usedlegacy-only
: disable 802.11n and 802.11achigh-density
: no 11b, no low ratescustom
: user defined
- Vht
This property is required. string - If
template
==custom
. MCS bitmasks for 4 streams (16-bit for each stream, MCS0 is least significant bit), e.g. 03ff 01ff 00ff limits VHT rates to MCS 0-9 for 1 stream, MCS 0-8 for 2 streams, and MCS 0-7 for 3 streams.
- eht
This property is required. String - If
template
==custom
. EHT MCS bitmasks for 4 streams (16-bit for each stream, MCS0 is least significant bit) - he
This property is required. String - If
template
==custom
. HE MCS bitmasks for 4 streams (16-bit for each stream, MCS0 is least significant bit - ht
This property is required. String - If
template
==custom
. MCS bitmasks for 4 streams (16-bit for each stream, MCS0 is least significant bit), e.g. 00ff 00f0 001f limits HT rates to MCS 0-7 for 1 stream, MCS 4-7 for 2 stream (i.e. MCS 12-15), MCS 1-5 for 3 stream (i.e. MCS 16-20) - legacies
This property is required. List<String> - If
template
==custom
. List of supported rates (IE=1) and extended supported rates (IE=50) for custom template, append ‘b’ at the end to indicate a rate being basic/mandatory. Iftemplate
==custom
is configured and legacy does not define at least one basic rate, it will useno-legacy
default values - min
Rssi This property is required. Integer - Minimum RSSI for client to connect, 0 means not enforcing
- template
This property is required. String - Data Rates template to apply. enum:
no-legacy
: no 11bcompatible
: all, like before, default setting that Broadcom/Atheros usedlegacy-only
: disable 802.11n and 802.11achigh-density
: no 11b, no low ratescustom
: user defined
- vht
This property is required. String - If
template
==custom
. MCS bitmasks for 4 streams (16-bit for each stream, MCS0 is least significant bit), e.g. 03ff 01ff 00ff limits VHT rates to MCS 0-9 for 1 stream, MCS 0-8 for 2 streams, and MCS 0-7 for 3 streams.
- eht
This property is required. string - If
template
==custom
. EHT MCS bitmasks for 4 streams (16-bit for each stream, MCS0 is least significant bit) - he
This property is required. string - If
template
==custom
. HE MCS bitmasks for 4 streams (16-bit for each stream, MCS0 is least significant bit - ht
This property is required. string - If
template
==custom
. MCS bitmasks for 4 streams (16-bit for each stream, MCS0 is least significant bit), e.g. 00ff 00f0 001f limits HT rates to MCS 0-7 for 1 stream, MCS 4-7 for 2 stream (i.e. MCS 12-15), MCS 1-5 for 3 stream (i.e. MCS 16-20) - legacies
This property is required. string[] - If
template
==custom
. List of supported rates (IE=1) and extended supported rates (IE=50) for custom template, append ‘b’ at the end to indicate a rate being basic/mandatory. Iftemplate
==custom
is configured and legacy does not define at least one basic rate, it will useno-legacy
default values - min
Rssi This property is required. number - Minimum RSSI for client to connect, 0 means not enforcing
- template
This property is required. string - Data Rates template to apply. enum:
no-legacy
: no 11bcompatible
: all, like before, default setting that Broadcom/Atheros usedlegacy-only
: disable 802.11n and 802.11achigh-density
: no 11b, no low ratescustom
: user defined
- vht
This property is required. string - If
template
==custom
. MCS bitmasks for 4 streams (16-bit for each stream, MCS0 is least significant bit), e.g. 03ff 01ff 00ff limits VHT rates to MCS 0-9 for 1 stream, MCS 0-8 for 2 streams, and MCS 0-7 for 3 streams.
- eht
This property is required. str - If
template
==custom
. EHT MCS bitmasks for 4 streams (16-bit for each stream, MCS0 is least significant bit) - he
This property is required. str - If
template
==custom
. HE MCS bitmasks for 4 streams (16-bit for each stream, MCS0 is least significant bit - ht
This property is required. str - If
template
==custom
. MCS bitmasks for 4 streams (16-bit for each stream, MCS0 is least significant bit), e.g. 00ff 00f0 001f limits HT rates to MCS 0-7 for 1 stream, MCS 4-7 for 2 stream (i.e. MCS 12-15), MCS 1-5 for 3 stream (i.e. MCS 16-20) - legacies
This property is required. Sequence[str] - If
template
==custom
. List of supported rates (IE=1) and extended supported rates (IE=50) for custom template, append ‘b’ at the end to indicate a rate being basic/mandatory. Iftemplate
==custom
is configured and legacy does not define at least one basic rate, it will useno-legacy
default values - min_
rssi This property is required. int - Minimum RSSI for client to connect, 0 means not enforcing
- template
This property is required. str - Data Rates template to apply. enum:
no-legacy
: no 11bcompatible
: all, like before, default setting that Broadcom/Atheros usedlegacy-only
: disable 802.11n and 802.11achigh-density
: no 11b, no low ratescustom
: user defined
- vht
This property is required. str - If
template
==custom
. MCS bitmasks for 4 streams (16-bit for each stream, MCS0 is least significant bit), e.g. 03ff 01ff 00ff limits VHT rates to MCS 0-9 for 1 stream, MCS 0-8 for 2 streams, and MCS 0-7 for 3 streams.
- eht
This property is required. String - If
template
==custom
. EHT MCS bitmasks for 4 streams (16-bit for each stream, MCS0 is least significant bit) - he
This property is required. String - If
template
==custom
. HE MCS bitmasks for 4 streams (16-bit for each stream, MCS0 is least significant bit - ht
This property is required. String - If
template
==custom
. MCS bitmasks for 4 streams (16-bit for each stream, MCS0 is least significant bit), e.g. 00ff 00f0 001f limits HT rates to MCS 0-7 for 1 stream, MCS 4-7 for 2 stream (i.e. MCS 12-15), MCS 1-5 for 3 stream (i.e. MCS 16-20) - legacies
This property is required. List<String> - If
template
==custom
. List of supported rates (IE=1) and extended supported rates (IE=50) for custom template, append ‘b’ at the end to indicate a rate being basic/mandatory. Iftemplate
==custom
is configured and legacy does not define at least one basic rate, it will useno-legacy
default values - min
Rssi This property is required. Number - Minimum RSSI for client to connect, 0 means not enforcing
- template
This property is required. String - Data Rates template to apply. enum:
no-legacy
: no 11bcompatible
: all, like before, default setting that Broadcom/Atheros usedlegacy-only
: disable 802.11n and 802.11achigh-density
: no 11b, no low ratescustom
: user defined
- vht
This property is required. String - If
template
==custom
. MCS bitmasks for 4 streams (16-bit for each stream, MCS0 is least significant bit), e.g. 03ff 01ff 00ff limits VHT rates to MCS 0-9 for 1 stream, MCS 0-8 for 2 streams, and MCS 0-7 for 3 streams.
GetWlansSiteWlanSchedule
- Enabled
This property is required. bool - Hours
This property is required. Pulumi.Juniper Mist. Site. Inputs. Get Wlans Site Wlan Schedule Hours - Days/Hours of operation filter, the available days (mon, tue, wed, thu, fri, sat, sun)
- Enabled
This property is required. bool - Hours
This property is required. GetWlans Site Wlan Schedule Hours - Days/Hours of operation filter, the available days (mon, tue, wed, thu, fri, sat, sun)
- enabled
This property is required. Boolean - hours
This property is required. GetWlans Site Wlan Schedule Hours - Days/Hours of operation filter, the available days (mon, tue, wed, thu, fri, sat, sun)
- enabled
This property is required. boolean - hours
This property is required. GetWlans Site Wlan Schedule Hours - Days/Hours of operation filter, the available days (mon, tue, wed, thu, fri, sat, sun)
- enabled
This property is required. bool - hours
This property is required. GetWlans Site Wlan Schedule Hours - Days/Hours of operation filter, the available days (mon, tue, wed, thu, fri, sat, sun)
- enabled
This property is required. Boolean - hours
This property is required. Property Map - Days/Hours of operation filter, the available days (mon, tue, wed, thu, fri, sat, sun)
GetWlansSiteWlanScheduleHours
- Fri
This property is required. string - Hour range of the day (e.g.
09:00-17:00
). If the hour is not defined then it's treated as 00:00-23:59. - Mon
This property is required. string - Hour range of the day (e.g.
09:00-17:00
). If the hour is not defined then it's treated as 00:00-23:59. - Sat
This property is required. string - Hour range of the day (e.g.
09:00-17:00
). If the hour is not defined then it's treated as 00:00-23:59. - Sun
This property is required. string - Hour range of the day (e.g.
09:00-17:00
). If the hour is not defined then it's treated as 00:00-23:59. - Thu
This property is required. string - Hour range of the day (e.g.
09:00-17:00
). If the hour is not defined then it's treated as 00:00-23:59. - Tue
This property is required. string - Hour range of the day (e.g.
09:00-17:00
). If the hour is not defined then it's treated as 00:00-23:59. - Wed
This property is required. string - Hour range of the day (e.g.
09:00-17:00
). If the hour is not defined then it's treated as 00:00-23:59.
- Fri
This property is required. string - Hour range of the day (e.g.
09:00-17:00
). If the hour is not defined then it's treated as 00:00-23:59. - Mon
This property is required. string - Hour range of the day (e.g.
09:00-17:00
). If the hour is not defined then it's treated as 00:00-23:59. - Sat
This property is required. string - Hour range of the day (e.g.
09:00-17:00
). If the hour is not defined then it's treated as 00:00-23:59. - Sun
This property is required. string - Hour range of the day (e.g.
09:00-17:00
). If the hour is not defined then it's treated as 00:00-23:59. - Thu
This property is required. string - Hour range of the day (e.g.
09:00-17:00
). If the hour is not defined then it's treated as 00:00-23:59. - Tue
This property is required. string - Hour range of the day (e.g.
09:00-17:00
). If the hour is not defined then it's treated as 00:00-23:59. - Wed
This property is required. string - Hour range of the day (e.g.
09:00-17:00
). If the hour is not defined then it's treated as 00:00-23:59.
- fri
This property is required. String - Hour range of the day (e.g.
09:00-17:00
). If the hour is not defined then it's treated as 00:00-23:59. - mon
This property is required. String - Hour range of the day (e.g.
09:00-17:00
). If the hour is not defined then it's treated as 00:00-23:59. - sat
This property is required. String - Hour range of the day (e.g.
09:00-17:00
). If the hour is not defined then it's treated as 00:00-23:59. - sun
This property is required. String - Hour range of the day (e.g.
09:00-17:00
). If the hour is not defined then it's treated as 00:00-23:59. - thu
This property is required. String - Hour range of the day (e.g.
09:00-17:00
). If the hour is not defined then it's treated as 00:00-23:59. - tue
This property is required. String - Hour range of the day (e.g.
09:00-17:00
). If the hour is not defined then it's treated as 00:00-23:59. - wed
This property is required. String - Hour range of the day (e.g.
09:00-17:00
). If the hour is not defined then it's treated as 00:00-23:59.
- fri
This property is required. string - Hour range of the day (e.g.
09:00-17:00
). If the hour is not defined then it's treated as 00:00-23:59. - mon
This property is required. string - Hour range of the day (e.g.
09:00-17:00
). If the hour is not defined then it's treated as 00:00-23:59. - sat
This property is required. string - Hour range of the day (e.g.
09:00-17:00
). If the hour is not defined then it's treated as 00:00-23:59. - sun
This property is required. string - Hour range of the day (e.g.
09:00-17:00
). If the hour is not defined then it's treated as 00:00-23:59. - thu
This property is required. string - Hour range of the day (e.g.
09:00-17:00
). If the hour is not defined then it's treated as 00:00-23:59. - tue
This property is required. string - Hour range of the day (e.g.
09:00-17:00
). If the hour is not defined then it's treated as 00:00-23:59. - wed
This property is required. string - Hour range of the day (e.g.
09:00-17:00
). If the hour is not defined then it's treated as 00:00-23:59.
- fri
This property is required. str - Hour range of the day (e.g.
09:00-17:00
). If the hour is not defined then it's treated as 00:00-23:59. - mon
This property is required. str - Hour range of the day (e.g.
09:00-17:00
). If the hour is not defined then it's treated as 00:00-23:59. - sat
This property is required. str - Hour range of the day (e.g.
09:00-17:00
). If the hour is not defined then it's treated as 00:00-23:59. - sun
This property is required. str - Hour range of the day (e.g.
09:00-17:00
). If the hour is not defined then it's treated as 00:00-23:59. - thu
This property is required. str - Hour range of the day (e.g.
09:00-17:00
). If the hour is not defined then it's treated as 00:00-23:59. - tue
This property is required. str - Hour range of the day (e.g.
09:00-17:00
). If the hour is not defined then it's treated as 00:00-23:59. - wed
This property is required. str - Hour range of the day (e.g.
09:00-17:00
). If the hour is not defined then it's treated as 00:00-23:59.
- fri
This property is required. String - Hour range of the day (e.g.
09:00-17:00
). If the hour is not defined then it's treated as 00:00-23:59. - mon
This property is required. String - Hour range of the day (e.g.
09:00-17:00
). If the hour is not defined then it's treated as 00:00-23:59. - sat
This property is required. String - Hour range of the day (e.g.
09:00-17:00
). If the hour is not defined then it's treated as 00:00-23:59. - sun
This property is required. String - Hour range of the day (e.g.
09:00-17:00
). If the hour is not defined then it's treated as 00:00-23:59. - thu
This property is required. String - Hour range of the day (e.g.
09:00-17:00
). If the hour is not defined then it's treated as 00:00-23:59. - tue
This property is required. String - Hour range of the day (e.g.
09:00-17:00
). If the hour is not defined then it's treated as 00:00-23:59. - wed
This property is required. String - Hour range of the day (e.g.
09:00-17:00
). If the hour is not defined then it's treated as 00:00-23:59.
Package Details
- Repository
- junipermist pulumi/pulumi-junipermist
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
mist
Terraform Provider.