updateSiteWlan
Update Site WLAN
Preferred authentication method for automation and integrations. Send the API token in the HTTP Authorization header.
Format:
Authorization: Token {apitoken}
Notes:
- An API token generated for a specific admin has the same privileges as that admin
- An API token is automatically removed if it is not used for more than 90 days
- SSO admins cannot generate admin API tokens. Use organization API tokens when scoped Org/Site privileges are needed.
In: header
Path Parameters
uuiduuidRequest Body
application/json
Request Body
Note: portal_template will be forked out of wlan objects soon. To fetch portal_template, please query portal_template_url. To update portal_template, use Wlan Portal Template.
Enable coa-immediate-update and address-change-immediate-update on the access profile.
falseHow 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
0 <= value <= 655350RADIUS accounting servers used by this WLAN
Integration settings for AirWatch device compliance on this WLAN
Only applicable when limit_bcast==true, which allows or disallows ipv6 Neighbor Discovery packets to go through
trueOnly applicable when limit_bcast==true, which allows mDNS / Bonjour packets to go through
falseOnly applicable when limit_bcast==true, which allows SSDP
falseAccess point identifiers used when apply_to==aps
Bandwidth limits for applications on this WLAN
QoS rules for application traffic on this WLAN
Scope that determines where this WLAN is applied. enum: aps, site, wxtags.
Value in
- "aps"
- "site"
- "wxtags"
Whether to enable smart arp filter
falseSettings that control client authentication for this WLAN
RADIUS authentication server selection behavior for this WLAN. enum: ordered, unordered.
"ordered"Value in
- "ordered"
- "unordered"
RADIUS authentication servers used by this WLAN. Required when auth.type==eap
Optional, up to 48 bytes, will be dynamically generated if not provided. used only for authentication servers
Optional, NAS-IP-ADDRESS to use
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.
2RADIUS 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.
5band is deprecated and kept for backward compatibility. Use bands instead
Whether to enable band_steering, this works only when band==both
falseForce dual_band capable client to connect to 5G
falseRadio bands on which this WLAN is broadcast
Default
[ "24", "5", "6"]Whether to block the clients in the blacklist (up to first 256 macs)
falseService discovery gateway settings for Bonjour traffic on this WLAN
Central web authentication settings for Cisco CWA on this WLAN
Downlink bandwidth limit applied per client
If downlink limiting per-client is enabled
falseDownlink bandwidth limit applied per client
If uplink limiting per-client is enabled
falseRADIUS Change of Authorization servers available to this WLAN
Some old WLAN drivers may not be compatible
falseTo disable Wi-Fi 7 EHT IEs
falseTo disable ht or vht rates
falsewhether to disable Message-Authenticator Check, which is used to verify the integrity of RADIUS messages, default is false (i.e. for better security)
falseWhether to disable U-APSD
falseDisable sending v2 roam notification messages
falseDisable sending v2 roam notification messages
falseWhen any of the following is true, this WLAN will be disabled
- cannot get IP
- cannot obtain default gateway
- cannot reach default gateway
falseWhether to disable this WLAN when the configured Mist tunnel is down
falseWhether to disable WMM
falseRADIUS group based DNS server rewrite settings for this WLAN
Delivery Traffic Indication Message interval for this WLAN
2Per-user PSK selection settings for this WLAN
VLAN assignment settings for 802.1X dynamic VLANs
Enable FTM (Fine-Time Measurement, 802.11mc); configures the AP as an FTM Responder (target), allowing clients to perform ranging requests against it
falseEnable AP-AP keycaching via multicast
falseBy 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
falseIf 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
falseIf this wlan is enabled
trueIf set to true, sets default fast-timers with values calculated from ‘auth_servers_timeout’ and ‘auth_server_retries’ .
falseWhether to hide SSID in beacon
falseInclude hostname inside IE in AP beacons / probe responses
falsePasspoint and Hotspot 2.0 settings for this WLAN
DHCP Option 82 insertion settings for this WLAN
Network interface or tunnel where this WLAN bridges client traffic. enum: all, eth0, eth1, eth2, eth3, mxtunnel, site_mxedge, wxtunnel.
"all"Value in
- "all"
- "eth0"
- "eth1"
- "eth2"
- "eth3"
- "mxtunnel"
- "site_mxedge"
- "wxtunnel"
Whether to stop clients to talk to each other
falseIf isolation is enabled, whether to deny clients to talk to L2 on the LAN
falseLegacy 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.
falseWhether to limit broadcast packets going to wireless (i.e. only allow certain bcast packets to go through)
falseLimit probe response base on some heuristic rules
falseMax idle time in seconds
60 <= value <= 864001800Maximum number of client connected to the SSID. 0 means unlimited
0 <= value <= 1280Juniper Mist NAC settings used by this WLAN
(deprecated, use mxtunnel_ids instead) when interface==mxtunnel, id of the Mist Tunnel
uuidMist Tunnel identifiers used when interface==mxtunnel
uuidMist Tunnel names used when interface==site_mxedge
Whether to only allow client to use DNS that we’ve learned from DHCP response
falseWhether to only allow client that we’ve learned from DHCP exchange to talk
falseGuest portal settings for this WLAN
Guest portal hostnames that clients may reach before authorization
[]Guest portal CIDR subnets that clients may reach before authorization
[]API secret (auto-generated) that can be used to sign guest authorization requests, only generated when auth is set to external
""Guest portal hostnames denied before authorization, taking precedence over allowed hostnames
[]Quality-of-service settings for WLAN client traffic
TLS-secured RADIUS transport settings for this WLAN
Data rate settings by RF band for this WLAN
When different mxcluster is on different subnet, we'd want to disconnect clients (so they'll reconnect and get new IPs)
falseFast roaming mode configured for this WLAN. enum: 11r, NONE, OKC.
"NONE"Value in
- "11r"
- "NONE"
- "OKC"
Operating schedule controlling when this WLAN is active
Whether to exclude this WLAN from SLE metrics
falseName of the SSID
Identifier of the WLAN template associated with this WLAN
uuid""If auth.type==eap or auth.type==psk, should only be set for legacy client, such as pre-2004, 802.11b devices
falseIf vlan tagging is enabled
falseDefault VLAN ID, range, or variable used when vlan_enabled==true
Pool of VLAN IDs used when vlan_enabled==true and vlan_pooling==true
Requires vlan_enabled==true to be set to true. Vlan pooling allows AP to place client on different VLAN using a deterministic algorithm
falseDownlink bandwidth limit applied per client
If downlink limiting for whole wlan is enabled
falseDownlink bandwidth limit applied per client
If uplink limiting for whole wlan is enabled
falseIdentifiers of WxLAN tags used when apply_to==wxtags
When interface=wxtunnel, id of the WXLAN Tunnel
""When interface=wxtunnel, remote tunnel identifier
""Response Body
curl -X PUT "https://example.com/api/v1/sites/000000ab-00ab-00ab-00ab-0000000000ab/wlans/000000ab-00ab-00ab-00ab-0000000000ab" \ -H "Content-Type: application/json" \ -d '{ "acct_immediate_update": false, "acct_interim_interval": 0, "acct_servers": [ { "host": "1.2.3.4", "keywrap_enabled": true, "keywrap_format": "hex", "keywrap_kek": "1122334455", "keywrap_mack": "1122334455", "port": 1813, "secret": "testing123" } ], "airwatch": { "api_key": "aHhlbGxvYXNkZmFzZGZhc2Rmc2RmCg==\\"", "console_url": "https://hs1.airwatchportals.com", "enabled": true, "password": "user1", "username": "test123" }, "allow_ipv6_ndp": true, "allow_mdns": false, "allow_ssdp": false, "ap_ids": [ "497f6eca-6276-4993-bfeb-53cbbbbe6f08" ], "app_limit": { "apps": { "dropbox": 300, "netflix": 60 }, "enabled": false, "wxtag_ids": { "f99862d9-2726-931f-7559-3dfdf5d070d3": 30 } }, "app_qos": { "apps": { "skype-business-video": { "dscp": 32, "dst_subnet": "10.2.0.0/16", "src_subnet": "10.2.0.0/16" } }, "enabled": true, "others": [ { "dscp": 32, "dst_subnet": "10.2.0.0/16", "port_ranges": "80,1024-6553", "protocol": "udp", "src_subnet": "10.2.0.0/16" } ] }, "apply_to": "site", "arp_filter": false, "auth": { "anticlog_threshold": 16, "eap_reauth": false, "enable_mac_auth": false, "key_idx": 1, "keys": [ "string" ], "multi_psk_only": false, "pairwise": [ "wpa2-ccmp" ], "private_wlan": true, "psk": "foryoureyesonly", "type": "psk", "wep_as_secondary_auth": true }, "auth_server_selection": "ordered", "auth_servers": [ { "host": "1.2.3.4", "keywrap_enabled": true, "keywrap_format": "hex", "keywrap_kek": "1122334455", "keywrap_mack": "1122334455", "port": 1812, "secret": "testing123" } ], "auth_servers_nas_id": "5c5b350e0101-nas", "auth_servers_nas_ip": "15.3.1.5", "auth_servers_retries": 5, "auth_servers_timeout": 5, "band": "string", "band_steer": false, "band_steer_force_band5": false, "bands": [ "24", "5" ], "block_blacklist_clients": false, "bonjour": { "additional_vlan_ids": "10,20", "enabled": false, "services": { "airplay": { "radius_groups": [ "teachers" ], "scope": "same_ap" } } }, "cisco_cwa": { "allowed_hostnames": [ "snapchat.com" ], "allowed_subnets": [ "63.5.3.0/24" ], "blocked_subnets": [ "192.168.0.0/16" ], "enabled": false }, "client_limit_down": 1000, "client_limit_down_enabled": false, "client_limit_up": 512, "client_limit_up_enabled": false, "coa_servers": [ { "disable_event_timestamp_check": false, "enabled": false, "ip": "1.2.3.4", "port": 3799, "secret": "testing456" } ], "disable_11ax": false, "disable_ht_vht_rates": false, "disable_uapsd": false, "disable_v1_roam_notify": false, "disable_v2_roam_notify": false, "disable_wmm": false, "dns_server_rewrite": { "enabled": false, "radius_groups": { "contractor": "172.1.1.1", "guest": "8.8.8.8" } }, "dtim": 2, "dynamic_psk": { "default_psk": "foryoureyesonly", "default_vlan_id": 999, "enabled": false, "source": "cloud_psks" }, "dynamic_vlan": { "default_vlan_id": 999, "enabled": false, "local_vlan_ids": [ 1 ], "type": "airespace-interface-name", "vlans": { "131": "default", "322": "fast,video" } }, "enable_local_keycaching": false, "enable_wireless_bridging": false, "enabled": true, "fast_dot1x_timers": false, "hide_ssid": false, "hostname_ie": false, "hotspot20": { "domain_name": [ "mist.com" ], "enabled": true, "nai_realms": [ "string" ], "operators": [ "google", "att" ], "rcoi": [ "5A03BA0000" ], "venue_name": "some_name" }, "interface": "all", "isolation": false, "l2_isolation": false, "legacy_overds": false, "limit_bcast": false, "limit_probe_response": true, "max_idletime": 1800, "mist_nac": { "enabled": false }, "no_static_dns": false, "no_static_ip": false, "ssid": "demo" }'{ "allow_ipv6_ndp": true, "allow_mdns": false, "allow_ssdp": false, "arp_filter": false, "band_steer": false, "band_steer_force_band5": false, "bands": [ "24", "5" ], "block_blacklist_clients": false, "bonjour": { "additional_vlan_ids": "10, 20", "enabled": false, "services": { "airplay": { "radius_groups": [ "teachers" ], "scope": "same_ap" } } }, "client_limit_down": 1000, "client_limit_down_enabled": false, "client_limit_up": 512, "client_limit_up_enabled": false, "disable_11ax": false, "disable_ht_vht_rates": false, "disable_uapsd": false, "disable_v1_roam_notify": false, "disable_v2_roam_notify": false, "disable_wmm": false, "dynamic_vlan": { "default_vlan_id": 999, "enabled": false, "local_vlan_ids": [ 1 ], "type": "airespace-interface-name", "vlans": { "131": "default", "322": "fast,video" } }, "enable_local_keycaching": false, "enable_wireless_bridging": false, "enabled": true, "fast_dot1x_timers": false, "hide_ssid": false, "hostname_ie": false, "ssid": "demo"}