createOrgSecurityPolicies

POST https://{{host}}/api/v1/orgs/:org_id/secpolicies

Body Parameters

ParameterTypeDescription
ssidstringthe name of the SSID
enabledbooleanif this wlan is enabled, default is True
authobjectauthentication/security policies
typestringopen / psk / wep / eap / psk-tkip / psk-wpa2-tkip, default is open
pairwiselistwhen type=psk / eap, one of more of wpa2-ccmp / wpa1-tkip / wpa1-ccmp / wpa2-tkip, default is [wpa2-ccmp]
pskstringwhen type=psk, 8-64 characters, or 64 hex characters
wep_as_secondary_authbooleanenable WEP as secondary auth
keyslistwhen 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
key_idxintwhen type=wep, 1 to 4, default is 1
multi_psk_onlybooleanwhether to only use multi_psk, default is false
private_wlanbooleanwhether private wlan is enabled. only applicable to multi_psk mode
enable_mac_authbooleanwhether to enable MAC Auth, uses the same auth_servers, default is false
eap_reauthbooleanwhether to trigger EAP reauth when the session ends, default is false
roam_modestringnone (default) / OKC / 11r
apply_tostringsite / wxtags / aps
wxtag_idslistlist of wxtag_ids
ap_idslistlist of device ids
bandstringwhich radio the wlan should apply to, both (default) / 24 / 5
band_steerbooleanwhether to enable band_steering, this works only when band==both, default is false
band_steer_force_band5booleanforce dual-band capable client to connect to 5G, default is false
isolationbooleanwhether to allow clients to talk to each other, defualt is false
arp_filterbooleanwhether to enable smart arp filter, default is false
limit_bcastbooleanwhether to list bcast (i.e. only allow certain bcast packets to go through), default is false
allow_mdnsbooleanonly applicable when limit_bcast==true, which allows mDNS / Bonjour packets to go through, default is false
allow_ipv6_ndpbooleanonly applicable when limit_bcast==true, which allows or disallows ipv6 Neighbor Discovery packets to go through, default is true
no_static_ipbooleanwhether to only allow client that we've learned from DHCP exchange to talk, default is false
no_static_dnsbooleanwhether to only allow client to use DNS that we've learned from DHCP response, default is false
enable_wireless_bridgingbooleanwhether to enable wireless bridging, which allows more broadcast packets to go through
block_blacklist_clientsbooleanwhether to block the clients in the blacklist (up to first 256 macs)
vlan_enabledbooleanif vlan tagging is enabled, default is false
vlan_idintJan-94
vlan_poolingbooleanvlan pooling allows AP to place client on different VLAN using a deterministic algorithm, default is false
vlan_idslistlist of VLAN ids
hide_ssidbooleanwhether to hide SSID in beacon, default is false
scheduleobjectWLAN operating schedule, default is disabled
hoursobjecttime ranges, the key is mon / tue / wed / thu / fri / sat / sun, the value is time range in HH:MM-HH:MM (24-hour format), the minimum resolution is 30 minute
max_idletimeintmax idle time in seconds, default is 1800. valid range is 60-86400
sle_excludedbooleanwhether to exclude this WLAN from SLE metrics, default is false

NOTE: specifically, enable_wireless_bridging allows forwarding of DHCP response to client not associated with the AP

#### RADIUS Parameters Parameter|Type|Description :-------------: |:-------------: |:-------------: Name|Type|Description auth_servers_nasid|string|optional, up to 48 bytes, will be dynamically generated if not provided. used only for authentication servers auth_servers_nasip|string|optional, NAS-IP-ADDRESS to use auth_serverstimeout|int|radius auth session timeout, default is 5 auth_serversretries|int|radius auth session retries, default is 3 authservers|list|list of RADIUS authentication servers, at least one is needed if auth type == eap, order matters where the first one is treated as primary host|string|ip / hostname of RADIUS server port|int|port of RADIUS server, default is 1812 for auth server and 1813 for acct server secret|string|secret of RADIUS server acctservers|list|list of RADIUS accounting servers, optional, order matters where the first one is treated as primary acct_interiminterval|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 coaserver|object|COA (change of authorization) server, optional disable_event_timestampcheck|boolean|whether to disable Event-Timestamp Check, which is used to replay-protection, default is false (i.e. for better security) dynamicvlan|object|for 802.1x enabled|boolean|whether to enable dynamic vlan, default is false type|string|standard (using Tunnel-Private-Group-ID, widely supported), airespace-interface-name (Airespace/Cisco) vlans|object|map between vlanid (as string) to airespace interface names (comma-separated) or null for stndard mapping default_vlan_id|int|vlanid to use when there's no match from RADIUS, default is 999 local_vlan_ids|list|vlanids to be locally bridged radsec|object|RadSec related, once enabled, auth_servers / acct_servers / coaserver will be ignored servername|string|name of the server to verify (against the cacerts in Org Setting) dns_server_rewrite|object|for radiusgroup-based DNS server (rewrite DNS request depending on the Group RADIUS server returns) radius_groups|object|map between radius_group and the desired DNS server (IPv4 only)

Airwatch Parameters

ParameterTypeDescription
airwatchobjectAirwatch related
console_urlstringconsole URL
api_keystringAPI Key
usernamestringusername
passwordstringpassword

Cisco CWA Parameters

Cisco CWA (central web authentication) required RADIUS with COA in order to work. See CWA for more details.

ParameterTypeDescription
cisco_cwaobjectCisco CWA Related
enabledbooleanwhether to enable CWA,
allowed_subnetslistlist of CIDRs
allowed_hostnameslistlist of hostnames without http(s):// (matched by substring)

QoS Parameters

ParameterTypeDescription
overwritebooleanwhether to overwrite QoS
classstringbackground / best_effort (default) / video / voice

Data Tunnels Parameters

ParameterTypeDescription
interfacestringwhere this WLAN will be connected to. all (all external ports, default) / eth0 / eth1 / wxtunnel / mxtunnel / site_mxedge
wxtunnel_idstringwhen interface=wxtunnel, id of the WXLAN Tunnel
wxtunnelremoteidstringwhen interface=wxtunnel, remote tunnel identifier
mxtunnel_idstringwhen interface=mxtunnel, id of the Mist Tunnel

Others Parameters

ParameterTypeDescription
dtimintdtim, default is 2
disable_wmmbooleanwhether to disable WMM, default is false
disable_uapsdbooleanwhether to disable U-APSD, default is false
useeapolv1booleanif auth.type=='eap' or 'psk', should only be set for legacy client, such as pre-2004, 802.11b devices
legacy_overdsbooleanlegacy 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.
hostname_iebooleaninclude hostname inside IE in AP beacons / probe responses, default is false

Data Rates Parameters

ParameterTypeDescription
ratesetobjectrateset (data rates to support)
min_rssiintMinimum RSSI for client to connect, 0 means not enforcing
templatestringno-legacy (basically no 11b and only supports 6 or 12 and up for 11a/g) / compatible (allow more, the default for now) / high-density (only 11n and 11ac) / custom
legacylistlist of supported rates (IE=1) and extended supported rates (IE=50), append 'b' at the end to indicate it being basic/mandatory
htstringMCS 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)
vhtstringMCS 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.
disable_11axbooleansome old WLAN drivers may not be compatible , default is false

Rate Limit Parameters

ParameterTypeDescription
wlanlimitup_enabledbooleanif uplink limiting for whole wlan is enabled, default is false
wlanlimitupintkbps
wlanlimitdown_enabledbooleanif downlink limiting for whole wlan is enabled, default is false
wlanlimitdownintkbps
clientlimitup_enabledbooleanif uplink limiting per-client is enabled, default is false
clientlimitupintkbps
clientlimitdown_enabledbooleanif downlink limiting per-client is enabled, default is false
clientlimitdownintkbps
app_limitobjectbandwidth limiting for apps (applies to up/down)
appsobjectmap from app key to bandwidth in kbps. app key defined in'Get Application List
wxtag_idsobjectmap from wxtag_id of Hostname Wxlan Tags to bandwidth in kbps

Request Body

{"name"=>"corporate only", "wlans"=>[{"ssid"=>"office", "band"=>"both", "auth"=>{"type"=>"psk", "pairwise"=>["wpa1-tkip", "wpa2-tkip"]}}, {"ssid"=>"office-guest", "band"=>"5", "auth"=>{"type"=>"open"}}]}