SmartZone 300 Public API Reference Guide
Overview
This reference guide describes the public APIs supported by the SmartZone 300. Use the RESTful API commands described in this guide as an alternative way to manage the controller and its managed APs (in addition to the web and command line interfaces).
All API URIs in this guide could use the below all common prefix, where {host} is the IP address of the management interface of the controller.
| Prefix Pattern | Note |
|---|---|
| https://{host}:8443/wsg/api/public | Recommend |
| https://{host}:7443/api/public | Deprecated Will be removed in the future version |
Open API document
Open API document is based on OAS 2.0 and is now a POC program, Please try it for free, click the link for the detail.
You can get the usage at https://swagger.io/, use the Swagger tools to meet your needs.
Version Matrix
SmartZone software has API support for up to 3 major API versions, according to the following matrix.
| SZ Version | API Version |
|---|---|
5.1 |
v6_0 v6_1 v7_0 v8_0 |
Common Request Header
The following parameters are required in the HTTP headers of all API requests.
| Parameter | Value |
|---|---|
| Content-Type | “application/json;charset=UTF-8” |
Common Request URI Parameters
The following parameters are required in the Request URI Parameters of all API requests (except for the logon API).
| Parameter | Value |
|---|---|
| serviceTicket | {serviceTicket} |
serviceTicket is returned as the following parameter in the response payload of the Service Ticket Logon API.
Request Header for Session
Deprecated : Will be removed in the future version, please refer to the [Common Request URI Parameters] section
The following parameters are required in the HTTP headers of all API requests (except for the logon API).
| Parameter | Value |
|---|---|
| Cookie | “JSESSIONID={JSESSIONID}” |
JSESSIONID is returned as the following parameter in the response header of the Session ID Logon API.
| Parameter | Value |
|---|---|
| Set-cookie | “JSESSIONID={JSESSIONID}; Path=/wsg; Secure” |
HTTP Responses
HTTP response status codes indicate whether a specific HTTP request has been successfully completed.
The available status codes are defined by RFC7231 and registered status codes are listed in the IANA Status Code Registry.
Ruckus Wireless Error Codes
When the server is unable to process a request, Ruckus Wireless-specific error code and message are returned in the response body. The following table describes the list of Ruckus Wireless specific error codes.
| Code | Response |
|---|---|
| 0 | Internal server error |
| 101 | Bad HTTP request |
| 102 | Bad HTTP response |
| 103 | Invalid HTTP request body |
| 104 | HTTP response body cannot be generated |
| 105 | Unsupported API version |
| 150 | Cluster not in service |
| 151 | Controller node not in service |
| 152 | Operation is not allowed because this is a standby cluster |
| 201 | No active session |
| 202 | Login denied |
| 203 | Password expired |
| 204 | Account is disabled |
| 205 | Account not found |
| 206 | Account is locked |
| 207 | User is not assigned to an admin user group |
| 211 | Insufficient administrative privileges |
| 212 | Resource access denied |
| 301 | Resource cannot be found |
| 302 | Business rule violation |
| 303 | Illegal arguments |
| 304 | Bulk operation fail |
Time Zone
| Africa/Abidjan | Africa/Accra | Africa/Addis_Ababa |
| Africa/Algiers | Africa/Asmara | Africa/Asmera |
| Africa/Bamako | Africa/Bangui | Africa/Banjul |
| Africa/Bissau | Africa/Blantyre | Africa/Brazzaville |
| Africa/Bujumbura | Africa/Cairo | Africa/Casablanca |
| Africa/Ceuta | Africa/Conakry | Africa/Dakar |
| Africa/Dar_es_Salaam | Africa/Djibouti | Africa/Douala |
| Africa/El_Aaiun | Africa/Freetown | Africa/Gaborone |
| Africa/Harare | Africa/Johannesburg | Africa/Juba |
| Africa/Kampala | Africa/Khartoum | Africa/Kigali |
| Africa/Kinshasa | Africa/Lagos | Africa/Libreville |
| Africa/Lome | Africa/Luanda | Africa/Lubumbashi |
| Africa/Lusaka | Africa/Malabo | Africa/Maputo |
| Africa/Maseru | Africa/Mbabane | Africa/Mogadishu |
| Africa/Monrovia | Africa/Nairobi | Africa/Ndjamena |
| Africa/Niamey | Africa/Nouakchott | Africa/Ouagadougou |
| Africa/Porto-Novo | Africa/Sao_Tome | Africa/Timbuktu |
| Africa/Tripoli | Africa/Tunis | Africa/Windhoek |
| America/Adak | America/Anchorage | America/Anguilla |
| America/Antigua | America/Araguaina | America/Argentina/Buenos_Aires |
| America/Argentina/Catamarca | America/Argentina/ComodRivadavia | America/Argentina/Cordoba |
| America/Argentina/Jujuy | America/Argentina/La_Rioja | America/Argentina/Mendoza |
| America/Argentina/Rio_Gallegos | America/Argentina/Salta | America/Argentina/San_Juan |
| America/Argentina/San_Luis | America/Argentina/Tucuman | America/Argentina/Ushuaia |
| America/Aruba | America/Asuncion | America/Atikokan |
| America/Atka | America/Bahia | America/Bahia_Banderas |
| America/Barbados | America/Belem | America/Belize |
| America/Blanc-Sablon | America/Boa_Vista | America/Bogota |
| America/Boise | America/Buenos_Aires | America/Cambridge_Bay |
| America/Campo_Grande | America/Cancun | America/Caracas |
| America/Catamarca | America/Cayenne | America/Cayman |
| America/Chicago | America/Chihuahua | America/Coral_Harbour |
| America/Cordoba | America/Costa_Rica | America/Creston |
| America/Cuiaba | America/Curacao | America/Danmarkshavn |
| America/Dawson | America/Dawson_Creek | America/Denver |
| America/Detroit | America/Dominica | America/Edmonton |
| America/Eirunepe | America/El_Salvador | America/Ensenada |
| America/Fort_Nelson | America/Fort_Wayne | America/Fortaleza |
| America/Glace_Bay | America/Godthab | America/Goose_Bay |
| America/Grand_Turk | America/Grenada | America/Guadeloupe |
| America/Guatemala | America/Guayaquil | America/Guyana |
| America/Halifax | America/Havana | America/Hermosillo |
| America/Indiana/Indianapolis | America/Indiana/Knox | America/Indiana/Marengo |
| America/Indiana/Petersburg | America/Indiana/Tell_City | America/Indiana/Vevay |
| America/Indiana/Vincennes | America/Indiana/Winamac | America/Indianapolis |
| America/Inuvik | America/Iqaluit | America/Jamaica |
| America/Jujuy | America/Juneau | America/Kentucky/Louisville |
| America/Kentucky/Monticello | America/Knox_IN | America/Kralendijk |
| America/La_Paz | America/Lima | America/Los_Angeles |
| America/Louisville | America/Lower_Princes | America/Maceio |
| America/Managua | America/Manaus | America/Marigot |
| America/Martinique | America/Matamoros | America/Mazatlan |
| America/Mendoza | America/Menominee | America/Merida |
| America/Metlakatla | America/Mexico_City | America/Miquelon |
| America/Moncton | America/Monterrey | America/Montevideo |
| America/Montreal | America/Montserrat | America/Nassau |
| America/New_York | America/Nipigon | America/Nome |
| America/Noronha | America/North_Dakota/Beulah | America/North_Dakota/Center |
| America/North_Dakota/New_Salem | America/Ojinaga | America/Panama |
| America/Pangnirtung | America/Paramaribo | America/Phoenix |
| America/Port-au-Prince | America/Port_of_Spain | America/Porto_Acre |
| America/Porto_Velho | America/Puerto_Rico | America/Rainy_River |
| America/Rankin_Inlet | America/Recife | America/Regina |
| America/Resolute | America/Rio_Branco | America/Rosario |
| America/Santa_Isabel | America/Santarem | America/Santiago |
| America/Santo_Domingo | America/Sao_Paulo | America/Scoresbysund |
| America/Shiprock | America/Sitka | America/St_Barthelemy |
| America/St_Johns | America/St_Kitts | America/St_Lucia |
| America/St_Thomas | America/St_Vincent | America/Swift_Current |
| America/Tegucigalpa | America/Thule | America/Thunder_Bay |
| America/Tijuana | America/Toronto | America/Tortola |
| America/Vancouver | America/Virgin | America/Whitehorse |
| America/Winnipeg | America/Yakutat | America/Yellowknife |
| Antarctica/Casey | Antarctica/Davis | Antarctica/DumontDUrville |
| Antarctica/Macquarie | Antarctica/Mawson | Antarctica/McMurdo |
| Antarctica/Palmer | Antarctica/Rothera | Antarctica/South_Pole |
| Antarctica/Syowa | Antarctica/Troll | Antarctica/Vostok |
| Arctic/Longyearbyen | Asia/Aden | Asia/Almaty |
| Asia/Amman | Asia/Anadyr | Asia/Aqtau |
| Asia/Aqtobe | Asia/Ashgabat | Asia/Ashkhabad |
| Asia/Atyrau | Asia/Baghdad | Asia/Bahrain |
| Asia/Baku | Asia/Bangkok | Asia/Barnaul |
| Asia/Beirut | Asia/Bishkek | Asia/Brunei |
| Asia/Calcutta | Asia/Chita | Asia/Choibalsan |
| Asia/Chongqing | Asia/Chungking | Asia/Colombo |
| Asia/Dacca | Asia/Damascus | Asia/Dhaka |
| Asia/Dili | Asia/Dubai | Asia/Dushanbe |
| Asia/Famagusta | Asia/Gaza | Asia/Harbin |
| Asia/Hebron | Asia/Ho_Chi_Minh | Asia/Hong_Kong |
| Asia/Hovd | Asia/Irkutsk | Asia/Istanbul |
| Asia/Jakarta | Asia/Jayapura | Asia/Jerusalem |
| Asia/Kabul | Asia/Kamchatka | Asia/Karachi |
| Asia/Kashgar | Asia/Kathmandu | Asia/Katmandu |
| Asia/Khandyga | Asia/Kolkata | Asia/Krasnoyarsk |
| Asia/Kuala_Lumpur | Asia/Kuching | Asia/Kuwait |
| Asia/Macao | Asia/Macau | Asia/Magadan |
| Asia/Makassar | Asia/Manila | Asia/Muscat |
| Asia/Nicosia | Asia/Novokuznetsk | Asia/Novosibirsk |
| Asia/Omsk | Asia/Oral | Asia/Phnom_Penh |
| Asia/Pontianak | Asia/Pyongyang | Asia/Qatar |
| Asia/Qyzylorda | Asia/Rangoon | Asia/Riyadh |
| Asia/Saigon | Asia/Sakhalin | Asia/Samarkand |
| Asia/Seoul | Asia/Shanghai | Asia/Singapore |
| Asia/Srednekolymsk | Asia/Taipei | Asia/Tashkent |
| Asia/Tbilisi | Asia/Tehran | Asia/Tel_Aviv |
| Asia/Thimbu | Asia/Thimphu | Asia/Tokyo |
| Asia/Tomsk | Asia/Ujung_Pandang | Asia/Ulaanbaatar |
| Asia/Ulan_Bator | Asia/Urumqi | Asia/Ust-Nera |
| Asia/Vientiane | Asia/Vladivostok | Asia/Yakutsk |
| Asia/Yangon | Asia/Yekaterinburg | Asia/Yerevan |
| Atlantic/Azores | Atlantic/Bermuda | Atlantic/Canary |
| Atlantic/Cape_Verde | Atlantic/Faeroe | Atlantic/Faroe |
| Atlantic/Jan_Mayen | Atlantic/Madeira | Atlantic/Reykjavik |
| Atlantic/South_Georgia | Atlantic/St_Helena | Atlantic/Stanley |
| Australia/ACT | Australia/Adelaide | Australia/Brisbane |
| Australia/Broken_Hill | Australia/Canberra | Australia/Currie |
| Australia/Darwin | Australia/Eucla | Australia/Hobart |
| Australia/LHI | Australia/Lindeman | Australia/Lord_Howe |
| Australia/Melbourne | Australia/NSW | Australia/North |
| Australia/Perth | Australia/Queensland | Australia/South |
| Australia/Sydney | Australia/Tasmania | Australia/Victoria |
| Australia/West | Australia/Yancowinna | Brazil/Acre |
| Brazil/DeNoronha | Brazil/East | Brazil/West |
| CET | CST6CDT | Canada/Atlantic |
| Canada/Central | Canada/East-Saskatchewan | Canada/Eastern |
| Canada/Mountain | Canada/Newfoundland | Canada/Pacific |
| Canada/Saskatchewan | Canada/Yukon | Chile/Continental |
| Chile/EasterIsland | Cuba | EET |
| EST5EDT | Egypt | Eire |
| Europe/Amsterdam | Europe/Andorra | Europe/Astrakhan |
| Europe/Athens | Europe/Belfast | Europe/Belgrade |
| Europe/Berlin | Europe/Bratislava | Europe/Brussels |
| Europe/Bucharest | Europe/Budapest | Europe/Busingen |
| Europe/Chisinau | Europe/Copenhagen | Europe/Dublin |
| Europe/Gibraltar | Europe/Guernsey | Europe/Helsinki |
| Europe/Isle_of_Man | Europe/Istanbul | Europe/Jersey |
| Europe/Kaliningrad | Europe/Kiev | Europe/Kirov |
| Europe/Lisbon | Europe/Ljubljana | Europe/London |
| Europe/Luxembourg | Europe/Madrid | Europe/Malta |
| Europe/Mariehamn | Europe/Minsk | Europe/Monaco |
| Europe/Moscow | Europe/Nicosia | Europe/Oslo |
| Europe/Paris | Europe/Podgorica | Europe/Prague |
| Europe/Riga | Europe/Rome | Europe/Samara |
| Europe/San_Marino | Europe/Sarajevo | Europe/Saratov |
| Europe/Simferopol | Europe/Skopje | Europe/Sofia |
| Europe/Stockholm | Europe/Tallinn | Europe/Tirane |
| Europe/Tiraspol | Europe/Ulyanovsk | Europe/Uzhgorod |
| Europe/Vaduz | Europe/Vatican | Europe/Vienna |
| Europe/Vilnius | Europe/Volgograd | Europe/Warsaw |
| Europe/Zagreb | Europe/Zaporozhye | Europe/Zurich |
| GB | GB-Eire | GMT |
| GMT0 | Greenwich | Hongkong |
| Iceland | Indian/Antananarivo | Indian/Chagos |
| Indian/Christmas | Indian/Cocos | Indian/Comoro |
| Indian/Kerguelen | Indian/Mahe | Indian/Maldives |
| Indian/Mauritius | Indian/Mayotte | Indian/Reunion |
| Iran | Israel | Jamaica |
| Kwajalein | Libya | MET |
| MST7MDT | Mexico/BajaNorte | Mexico/BajaSur |
| Mexico/General | NZ | NZ-CHAT |
| Navajo | PRC | PST8PDT |
| Pacific/Apia | Pacific/Auckland | Pacific/Bougainville |
| Pacific/Chatham | Pacific/Chuuk | Pacific/Easter |
| Pacific/Efate | Pacific/Enderbury | Pacific/Fakaofo |
| Pacific/Fiji | Pacific/Funafuti | Pacific/Galapagos |
| Pacific/Gambier | Pacific/Guadalcanal | Pacific/Guam |
| Pacific/Honolulu | Pacific/Johnston | Pacific/Kiritimati |
| Pacific/Kosrae | Pacific/Kwajalein | Pacific/Majuro |
| Pacific/Marquesas | Pacific/Midway | Pacific/Nauru |
| Pacific/Niue | Pacific/Norfolk | Pacific/Noumea |
| Pacific/Pago_Pago | Pacific/Palau | Pacific/Pitcairn |
| Pacific/Pohnpei | Pacific/Ponape | Pacific/Port_Moresby |
| Pacific/Rarotonga | Pacific/Saipan | Pacific/Samoa |
| Pacific/Tahiti | Pacific/Tarawa | Pacific/Tongatapu |
| Pacific/Truk | Pacific/Wake | Pacific/Wallis |
| Pacific/Yap | Poland | Portugal |
| ROK | Turkey | UCT |
| US/Alaska | US/Aleutian | US/Arizona |
| US/Central | US/East-Indiana | US/Eastern |
| US/Hawaii | US/Indiana-Starke | US/Michigan |
| US/Mountain | US/Pacific | US/Pacific-New |
| US/Samoa | UTC | Universal |
| W-SU | WET | Zulu |
| EST | HST | MST |
| ACT | AET | AGT |
| ART | AST | BET |
| BST | CAT | CNT |
| CST | CTT | EAT |
| ECT | IET | IST |
| JST | MIT | NET |
| NST | PLT | PNT |
| PRT | PST | SST |
| VST |
Usage for Query Criteria
For further information on how to use the query criteria. Please click the link for the detail.
Not Support URIs
Due to the feature has been changed the design. There below URIs are no longer support in all API version as below.
- Accounting Service
| Remove |
|---|
PATCH /services/acct/radius/{id}/standbySecondary |
DELETE /services/acct/radius/{id}/standbySecondary |
- Authentication Service
| Remove |
|---|
PATCH /services/auth/radius/{id}/standbySecondary |
DELETE /services/auth/radius/{id}/standbySecondary |
- Zone AAA
| Remove |
|---|
PATCH /rkszones/{zoneId}/aaa/radius/{id}/standbySecondary |
DELETE /rkszones/{zoneId}/aaa/radius/{id}/standbySecondary |
GET /rkszones/{zoneId}/aaa/accounting |
GET /rkszones/{zoneId}/aaa/accounting/{id} |
POST /rkszones/{zoneId}/aaa/accounting |
PATCH /rkszones/{zoneId}/aaa/accounting/{id} |
PATCH /rkszones/{zoneId}/aaa/accounting/{id}/primary |
PATCH /rkszones/{zoneId}/aaa/accounting/{id}/secondary |
Delete /rkszones/{zoneId}/aaa/accounting/{id}/secondary |
Delete /rkszones/{zoneId}/aaa/accounting/{id} |
PATCH /rkszones/{zoneId}/aaa/accounting/{id}/standbyPrimary |
DELETE /rkszones/{zoneId}/aaa/accounting/{id}/standbyPrimary |
PATCH /rkszones/{zoneId}/aaa/accounting/{id}/standbySecondary |
DELETE /rkszones/{zoneId}/aaa/accounting/{id}/standbySecondary |
Change Logs
-
What’s New
- AP Group
- Disable rogue AP report threshold override
- Disable rogue AP aggressiveness mode override
- Disable rogue AP jamming threshold override
- Access Point Configuration
- Disable rogue AP report threshold override
- Disable rogue AP aggressiveness mode override
- Disable rogue AP jamming threshold override
- Event and Alarm
- Retrieve Alarm Summary
- Retrieve Event Summary
- Application Visibility Control
- Application Policy V2 Retrieve
- Application Policy V2 Create
- Application Policy V2 Modify
- Application Policy V2 Modify applicationRules
- Application Policy V2 Delete
- Application Policy V2 Multiple Delete
- Upload File
- Current Signature Package Info
- Application Categories
- Applications
- Application Policy V2 Retrieve List
- Data Plane Operational
- Switchover DP
- GDPR
- Execute a GDPR report action
- Portal Detection and Suppression Profile
- Retrieve portal detection and suppression profile List
- Create portal detection and suppression profile
- Get portal detection and suppression profile list
- Get portal detection and suppression profile by profile’s ID
- Modify portal detection and suppression profile by profile’s ID
- Modify portal detection and suppression profile by profile’s ID
- Delete portal detection and suppression profile by profile’s ID
- Delete multiple portal detection and suppression profiles
- Hotspot 2.0 Wi-Fi Operator Profile
- Modify Entire
- Query With Filter
- Retrieve Guest Access Profile List
- Real Time Location Service Profile
- Get RTLS Profile by profile’s ID
- Get RTLS Profile by zone ID
- Delete RTLS Profile by profile’s ID
- Create RTLS Profile
- Modify RTLS Profile by profile’s ID
- Split Tunnel Profile
- Query Split Tunnel Profiles
- Get Split Tunnel Profiles
- Get Split Tunnel Profile
- Create Split Tunnel Profile
- Modify Split Tunnel Profile
- Modify Entire Split Tunnel Profile
- Delete Split Tunnel Profile
- Traffic Class Profile
- Retrieve
- Create
- Retrieve List
- Modify
- Delete
- Bulk Delete
- AP Group
-
What’s Deprecated
- Access Point Operational
- Retrieve Alarm Summary
- Retrieve Event List
- Retrieve Event Summary
- Retrieve Alarm List
- Query With Filter
- Retrieve Guess Access Profile List
- Access Point Operational
-
Changes
- AP Group
- Retrieve
- attributes added (rogueApReportThreshold,rogueApAggressivenessMode,rogueApJammingThreshold)
- Create
- attributes added (location,locationAdditionalInfo,altitude,latitude,longitude,wifi24,wifi50,protectionMode24,wlanGroup24,wlanGroup50,locationBasedService,clientAdmissionControl24,clientAdmissionControl50,venueProfile,autoChannelSelection24,autoChannelSelection50,channelEvaluationInterval,apMgmtVlan,awsVenue,recoverySsid,rogueApReportThreshold,rogueApAggressivenessMode,rogueApJammingThreshold,directedMulticastFromWiredClientEnabled,directedMulticastFromWirelessClientEnabled,directedMulticastFromNetworkEnabled)
- Retrieve Default AP Group
- attributes added (rogueApReportThreshold,rogueApAggressivenessMode,rogueApJammingThreshold)
- Modify
- attributes added (rogueApReportThreshold,rogueApAggressivenessMode,rogueApJammingThreshold)
- Modify Recovery SSID Override
- attributes added (rogueApReportThreshold,rogueApAggressivenessMode,rogueApJammingThreshold)
- Retrieve
- Access Point Configuration
- Retrieve
- attributes added (rogueApReportThreshold,rogueApAggressivenessMode,rogueApJammingThreshold)
- Modify Recovery SSID Override
- attributes added (rogueApReportThreshold,rogueApAggressivenessMode,rogueApJammingThreshold)
- Modify User Location Info
- attributes added (rogueApReportThreshold,rogueApAggressivenessMode,rogueApJammingThreshold)
- Modify
- attributes added (rogueApReportThreshold,rogueApAggressivenessMode,rogueApJammingThreshold)
- Retrieve
- Access Point Operational
- Retrieve Operational Information
- attributes added (locationAdditionalInfo,altitude)
- Switchover AP
- attributes added (clusterName,zoneIdList,deleteRecord)
- Retrieve Operational Information
- Cluster Management
- Get current cluster state
- attributes added (clusterName)
- Update Cluster Redundancy
- attributes added (clusterRedundancyType,activeClusterList,interval,dateOfMonth,dayOfWeek,minute)
- Get Cluster Redundancy
- attributes added (clusterRedundancyType,activeClusterList,interval,dateOfMonth,dayOfWeek,minute)
- Get current cluster state
- System
- Retrieve Devices Summary
- attributes added (maxApOfCluster,maxSwitchOfCluster,totalApCapacity,totalSwitchCapacity,totalRemainingApCapacity,totalRemainingSwitchCapacity,aps,switches,totalAps)
- attributes remove (capacityMode)
- Retrieve Devices Summary
- User Traffic Profile
- Retrieve - User Traffic Profile
- attributes added (qmAppPolicyId)
- Create - User Traffic Profile
- attributes added (qmAppPolicyId)
- Modify - User Traffic Profile
- attributes added (qmAppPolicyId)
- Retrieve - User Traffic Profile
- Authentication Profile
- Retrieve
- attributes added (isContainDirectoryService)
- Retrieve
- Hotspot Profile
- Retrieve
- attributes added (trafficClassProfileId,signatureSigningKey,internalNode)
- Create Internal
- attributes added (trafficClassProfileId,signatureSigningKey,internalNode)
- Create External
- attributes added (trafficClassProfileId,signatureSigningKey,internalNode)
- Create Smart Client Only
- attributes added (trafficClassProfileId,signatureSigningKey,internalNode)
- Modify
- attributes added (trafficClassProfileId,signatureSigningKey,internalNode)
- Retrieve
- Authentication Service
- Retrieve - RADIUS Authentication Service
- attributes remove (standbySecondary)
- Create - RADIUS Authentication Service
- attributes remove (standbySecondary)
- Modify - RADIUS Authentication Service
- attributes remove (standbySecondary)
- Modify Standby Primary RADIUS Server of Authentication Service
- attributes remove (standbySecondary)
- Retrieve - RADIUS Authentication Service
- Accounting Service
- Retrieve - RADIUS Accounting Service
- attributes remove (standbySecondary)
- Create - RADIUS Accounting Service
- attributes remove (standbySecondary)
- Modify - RADIUS Accounting Service
- attributes remove (standbySecondary)
- Modify Standby Primary RADIUS Server of Accounting Service
- attributes remove (standbySecondary)
- Retrieve - RADIUS Accounting Service
- SCG User
- Get SCG user
- attributes added (passwordExpiration,passwordReuse,sessionIdle)
- Update SCG user
- attributes added (passwordExpiration,passwordReuse,sessionIdle)
- Add SCG user
- attributes added (passwordExpiration,passwordReuse,sessionIdle)
- Get SCG user
- SCG User Group
- Get SCG user group
- attributes added (isFactoryDefault)
- Add SCG user group
- attributes added (isFactoryDefault)
- Get SCG user group
- WLAN
- Create - Standard Open
- attributes added (flexiVpnProfile,splitTunnelProfileId,portalDetectionProfileId)
- attributes remove (bypassCNA)
- Create - 802.1X
- attributes added (flexiVpnProfile,splitTunnelProfileId,portalDetectionProfileId)
- attributes remove (bypassCNA)
- Create - 802.1X with MAC Address
- attributes added (flexiVpnProfile,splitTunnelProfileId,portalDetectionProfileId)
- attributes remove (bypassCNA)
- Create - MAC Auth
- attributes added (flexiVpnProfile,splitTunnelProfileId,portalDetectionProfileId)
- attributes remove (bypassCNA)
- Create - Hotspot
- attributes added (flexiVpnProfile,splitTunnelProfileId,portalDetectionProfileId)
- Create - Hotspot + MAC bypass
- attributes added (flexiVpnProfile,splitTunnelProfileId,portalDetectionProfileId)
- Create - Hotspot + 802.1X
- attributes added (flexiVpnProfile,splitTunnelProfileId,portalDetectionProfileId)
- Create - Wechat
- attributes added (splitTunnelProfileId,portalDetectionProfileId)
- attributes remove (bypassCNA)
- Create - Guest Access
- attributes added (flexiVpnProfile,splitTunnelProfileId,portalDetectionProfileId)
- Create - Web Auth
- attributes added (flexiVpnProfile,splitTunnelProfileId,portalDetectionProfileId)
- Create - Hotspot 2.0
- attributes added (splitTunnelProfileId,portalDetectionProfileId)
- attributes remove (bypassCNA)
- Create - Hotspot 2.0 Open
- attributes added (splitTunnelProfileId,portalDetectionProfileId)
- attributes remove (bypassCNA)
- Create - Hotspot 2.0 OSEN
- attributes added (splitTunnelProfileId,portalDetectionProfileId)
- attributes remove (bypassCNA)
- Modify
- attributes added (splitTunnelProfileId,portalDetectionProfileId)
- Modify Advanced Options
- attributes added (clientIsolationUnicastEnabled,clientIsolationMulticastEnabled,clientIsolationAutoVrrpEnabled,ndProxyEnabled,suppressNsEnabled,raProxyEnabled,rsraGuardEnabled,raThrottlingEnabled,maxAllowedRA,raInterval,antiSpoofingEnabled,arpRequestRateLimit,dhcpRequestRateLimit,authRssiThr,assocRssiThr,oceEnabled,oceBroadcastProbeResponseDelay,oceRssiBasedAssociationRejectionThreshold)
- Modify Entire
- attributes added (splitTunnelProfileId,portalDetectionProfileId)
- Retrieve
- attributes added (flexiVpnProfile,bssid,splitTunnelProfileId,portalDetectionProfileId)
- Create - Standard Open
- Ruckus Wireless AP Zone
- Change the Zone’s IPsec Profiles
- attributes added (loadBalancingMethod,rogueApReportThreshold,rogueApAggressivenessMode,rogueApJammingDetection,rogueApJammingThreshold,healthCheckSitesEnabled,healthCheckSites)
- Create Zone of IPv6
- attributes added (loadBalancingMethod,rogueApReportThreshold,rogueApAggressivenessMode,rogueApJammingDetection,rogueApJammingThreshold,healthCheckSitesEnabled,healthCheckSites)
- Create Zone of Dual
- attributes added (loadBalancingMethod,rogueApReportThreshold,rogueApAggressivenessMode,rogueApJammingDetection,rogueApJammingThreshold,healthCheckSitesEnabled,healthCheckSites)
- Modify entire zone
- attributes added (loadBalancingMethod,rogueApReportThreshold,rogueApAggressivenessMode,rogueApJammingDetection,rogueApJammingThreshold,healthCheckSitesEnabled,healthCheckSites)
- Retrieve
- attributes added (loadBalancingMethod,rogueApReportThreshold,rogueApAggressivenessMode,rogueApJammingDetection,rogueApJammingThreshold,healthCheckSitesEnabled,healthCheckSites)
- Modify
- attributes added (loadBalancingMethod,rogueApReportThreshold,rogueApAggressivenessMode,rogueApJammingDetection,rogueApJammingThreshold,healthCheckSitesEnabled,healthCheckSites)
- Create Zone
- attributes added (loadBalancingMethod,rogueApReportThreshold,rogueApAggressivenessMode,rogueApJammingDetection,rogueApJammingThreshold,healthCheckSitesEnabled,healthCheckSites)
- Change the Zone’s IPsec Profiles
- Zone AAA
- Create - RADIUS
- attributes remove (standbySecondary)
- Retrieve - RADIUS
- attributes remove (standbySecondary)
- Modify Entire - RADIUS
- attributes remove (standbySecondary)
- Modify - RADIUS
- attributes remove (standbySecondary)
- Modify - Primary Server of RADIUS for Standby Cluster
- attributes remove (standbySecondary)
- Create - RADIUS
- Ethernet Port Profile
- Retrieve - Ethernet Port Porfile
- attributes added (antiSpoofingEnabled,arpRequestRateLimit,dhcpRequestRateLimit)
- Create - Ethernet Port Porfile
- attributes added (antiSpoofingEnabled,arpRequestRateLimit,dhcpRequestRateLimit)
- Modify - Ethernet Port Porfile
- attributes added (antiSpoofingEnabled,arpRequestRateLimit,dhcpRequestRateLimit)
- Retrieve - Ethernet Port Porfile
- Hotspot Service
- Retrieve
- attributes added (trafficClassProfileId,signatureSigningKey,internalNode)
- Create Internal
- attributes added (trafficClassProfileId,signatureSigningKey,internalNode)
- Create External
- attributes added (trafficClassProfileId,signatureSigningKey,internalNode)
- Create Smart Client Only
- attributes added (trafficClassProfileId,signatureSigningKey,internalNode)
- Modify
- attributes added (trafficClassProfileId,signatureSigningKey,internalNode)
- Retrieve
- Web Authentication
- Create
- attributes added (redirect)
- Create
- AP Group
API Information ¶
Logon ¶
Service Ticket ¶
Logon ¶
POST/v8_0/serviceTicket
Use this API command to log on to the controller and acquire a valid service ticket.
Body
{
"username": "admin",
"password": "admin!234"
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"username": {
"description": "Logon user name",
"type": "string"
},
"password": {
"description": "Logon password",
"type": "string"
}
},
"required": [
"username",
"password"
]
}200Body
{
"controllerVersion": "5.0.0.0.451",
"serviceTicket": "ST-8-fZbanC02T6zpzvMFZocF-neil50-451"
}Schema
{
"type": "object",
"properties": {
"controllerVersion": {
"type": "string"
},
"serviceTicket": {
"description": "Logon authentication successful, the server generates a service ticket",
"type": "string"
}
}
} Logoff ¶
DELETE/v8_0/serviceTicket
Use this API command to log off of the controller.
- serviceTicket
string(required)
200Session ID ¶
Logon ¶
POST/v8_0/session
Use this API command to log on to the controller and acquire a valid logon session.
Body
{
"username": "admin",
"password": "admin!234",
"timeZoneUtcOffset": "+08:00"
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"username": {
"description": "Logon user name",
"type": "string"
},
"password": {
"description": "Logon password",
"type": "string"
},
"timeZoneUtcOffset": {
"description": "Local timezone of the client, offset to UTC",
"type": "string",
"enum": [
"-12:00",
"-11:00",
"-10:00",
"-09:30",
"-09:00",
"-08:00",
"-07:00",
"-06:00",
"-05:00",
"-04:30",
"-04:00",
"-03:30",
"-03:00",
"-02:00",
"-01:00",
"+00:00",
"-00:00",
"±00:00",
"+01:00",
"+02:00",
"+03:00",
"+03:30",
"+04:00",
"+04:30",
"+05:00",
"+05:30",
"+05:45",
"+06:00",
"+06:30",
"+07:00",
"+08:00",
"+08:45",
"+09:00",
"+09:30",
"+10:00",
"+10:30",
"+11:00",
"+11:30",
"+12:00",
"+12:45",
"+13:00",
"+14:00"
]
}
},
"required": [
"username",
"password"
]
}200Body
{
"controllerVersion": "1"
}Schema
{
"type": "object",
"properties": {
"controllerVersion": {
"type": "string"
}
}
} Retrieve ¶
GET/v8_0/session
Use this API command to retrieve information about the current logon session.
200Body
{
"cpId": "DEV_BLADE_UUID",
"domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
"adminRoleId": "69962d35-9447-41a1-aff5-facf1e85c674",
"mvnoId": "839f87c6-d116-497e-afce-aa8157abd30c",
"adminId": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25",
"clientIp": "172.18.193.1",
"apiVersions": [
"1_0"
],
"timeZoneUtcOffset": 0
}Schema
{
"type": "object",
"properties": {
"cpId": {
"type": "string"
},
"domainId": {
"type": "string"
},
"adminRoleId": {
"type": "string"
},
"mvnoId": {
"type": "string"
},
"adminId": {
"type": "string"
},
"clientIp": {
"type": "string"
},
"apiVersions": {
"description": "API version supported by the client",
"type": "array",
"items": {
"type": "string"
}
},
"timeZoneUtcOffset": {
"type": "integer"
}
}
}Ruckus Wireless AP Zone ¶
Retrieve DHCP/NAT service configuration within Domain ¶
POST/v8_0/rkszones/services/dhcpSiteConfig/query
Use this API command to modify DHCP/NAT service configuration of Domain. Please click the link for the usage of Query Cirteria.
Body
{
"filters": [
{
"type": "DOMAIN",
"value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
}
],
"fullTextSearch": {
"type": "AND",
"value": ""
},
"attributes": [
"*"
]
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"filters": {
"description": "Filters used to select specific resource scope",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Group type",
"type": "string",
"enum": [
"SYSTEM",
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"SWITCH_GROUP"
]
},
"value": {
"description": "Group ID",
"type": "string"
},
"operator": {
"description": "Operator for filtering",
"type": "string",
"enum": [
"eq"
]
}
},
"required": [
"type",
"value"
]
}
},
"extraFilters": {
"description": "\"AND\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"type": "string",
"enum": [
"VERSION"
]
},
"value": {
"description": "Value for filtering",
"type": "string"
},
"operator": {
"description": "Operator for filtering",
"type": "string",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
},
"required": [
"type",
"value"
]
}
},
"options": {
"description": "Specified feature required information.",
"type": "object",
"additionalProperties": false,
"properties": {
"zone_ipmode": {
"description": "List the zones only with the specified IP Mode.",
"type": "string",
"enum": [
"IPV4",
"IPV6",
"IPV4_IPV6"
]
},
"includeSharedResources": {
"description": "Include the resources of parent domain as well while querying.",
"type": "boolean"
}
}
},
"extraTimeRange": {
"description": "Specified data time range of selection",
"type": "object",
"additionalProperties": false,
"properties": {
"start": {
"description": "start time for collecting data",
"type": "number"
},
"end": {
"description": "end time for collecting data",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
},
"field": {
"description": "time field for collecting data",
"type": "string",
"enum": [
"insertionTime"
]
}
}
},
"fullTextSearch": {
"description": "Specified search string",
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Search logic operator",
"type": "string",
"enum": [
"AND",
"OR"
]
},
"value": {
"description": "Text or number to search",
"type": "string"
},
"fields": {
"description": "Specific fields to search",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"attributes": {
"description": "Get specific columns only",
"type": "array",
"items": {
"type": "string"
}
},
"sortInfo": {
"description": "About sorting",
"type": "object",
"additionalProperties": false,
"properties": {
"sortColumn": {
"type": "string"
},
"dir": {
"type": "string",
"enum": [
"ASC",
"DESC"
]
}
}
},
"page": {
"description": "Page number to get",
"type": "integer",
"minimum": 1
},
"limit": {
"description": "Size of one page",
"type": "integer",
"minimum": 1
},
"expandDomains": {
"description": "Whether to expand domains into sub domains/ zones or not",
"type": "boolean"
},
"criteria": {
"description": "Add backward compatibility for UI framework",
"type": "string"
},
"query": {
"description": "Add backward compatibility for UI framework",
"type": "string"
}
}
}200Body
{
"totalCount": 2,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"zoneName": "Default Zone",
"siteEnabled": false,
"dwpdEnabled": false,
"manualSelect": false,
"siteMode": "EnableOnEachAPs",
"siteProfiles": [],
"siteAps": []
},
{
"zoneName": "zoneK",
"siteEnabled": true,
"dwpdEnabled": false,
"manualSelect": false,
"siteMode": "EnableOnEachAPs",
"siteProfiles": [
{
"id": "c1b60951-eeb6-11e6-850a-525400f698b4",
"zoneId": "fce48fb7-8b89-49f6-8ce5-f52aecfc81ff",
"name": "P01",
"description": "",
"vlanId": 10,
"subnetNetworkIp": "192.168.10.0",
"subnetMask": "255.255.255.0",
"poolStartIp": "192.168.10.1",
"poolEndIp": "192.168.10.100",
"primaryDnsIp": "",
"secondaryDnsIp": "",
"leaseTimeHours": 0,
"leaseTimeMinutes": 5
}
],
"siteAps": [
{
"apMac": "EC:8C:A2:01:C5:B0",
"apServerEnabled": true,
"apServerPrimary": true,
"apServerIp": "192.168.10.1",
"apGatewayIp": "192.168.10.1",
"apName": "RuckusAP",
"apStatus": "Offline"
}
]
}
]
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"totalCount": {
"type": "integer"
},
"hasMore": {
"type": "boolean"
},
"firstIndex": {
"type": "integer"
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"zoneName": {
"description": "DHCP Service Zone Name",
"type": "string"
},
"siteEnabled": {
"description": "DHCP Service Enabling Status",
"type": "boolean"
},
"dwpdEnabled": {
"description": "DHCP Service Dynamic WAN Port Detection",
"type": "boolean"
},
"manualSelect": {
"description": "DHCP Service AP Selection Mode",
"type": "boolean"
},
"siteMode": {
"description": "DHCP Service mode",
"type": "string",
"enum": [
"EnableOnEachAPs",
"EnableOnMultipleAPs",
"EnableOnHierarchicalAPs"
]
},
"eth0ProfileId": {
"type": "integer"
},
"eth1ProfileId": {
"type": "integer"
},
"siteAps": {
"type": "array",
"items": {
"type": "object",
"description": "DHCP Site selected APs",
"additionalProperties": false,
"properties": {
"apMac": {
"type": "string"
},
"apName": {
"type": "string"
},
"apStatus": {
"type": "string",
"enum": [
"Online",
"Offline",
"Flagged"
]
},
"apServerEnabled": {
"type": "boolean"
},
"apServerPrimary": {
"type": "boolean"
},
"apServerIp": {
"type": "string"
},
"apGatewayIp": {
"type": "string"
}
}
}
},
"siteProfiles": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"zoneId": {
"description": "Zone Id of DHCP Profile",
"type": "string"
},
"id": {
"description": "Identifier of the DHCP Profile",
"type": "string"
},
"name": {
"description": "Name of the DHCP Profile",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the DHCP Profile",
"type": [
"string",
"null"
],
"maxLength": 64
},
"vlanId": {
"description": "VLAN ID of the DHCP Profile",
"type": "integer",
"minimum": 1,
"maximum": 4094
},
"subnetNetworkIp": {
"description": "Subnet Network IP of the DHCP Profile",
"type": "string"
},
"subnetMask": {
"description": "Subnet Mask of the DHCP Profile",
"type": "string"
},
"poolStartIp": {
"description": "Pool Starting IP of the DHCP Profile",
"type": "string"
},
"poolEndIp": {
"description": "Pool Ending IP of the DHCP Profile",
"type": "string"
},
"primaryDnsIp": {
"description": "Primany DNS IP of the DHCP Profile",
"type": "string"
},
"secondaryDnsIp": {
"description": "Secondary DNS IP of the DHCP Profile",
"type": "string"
},
"leaseTimeHours": {
"description": "Lease time in hours of the DHCP Profile",
"type": "integer",
"minimum": 0,
"maximum": 24
},
"leaseTimeMinutes": {
"description": "Lease time in minutes of the DHCP Profile",
"type": "integer",
"minimum": 0,
"maximum": 59
}
}
}
}
}
}
}
}
}Retrieve DHCP/NAT service IP assignment ¶
POST/v8_0/rkszones/{zoneId}/dhcpSite/dhcpSiteConfig/doAssignIp
Use this API command to get the DHCP/NAT service IP assignment when selecting with “Enable on Multiple APs”. In the Manually Select AP mode (the manualSelect is true), the body should contain the selected APs (include the siteAps array). Otherwise, there is no need to include the selected APs in the Auto Select AP mode (see samples).
Body
‧ Sample : Assign IP for DHCP Service of EnableOnMultipleAPs with Manually Select AP
{
"siteEnabled" : true,
"dwpdEnabled" : false,
"manualSelect" : true,
"siteMode" : "EnableOnMultipleAPs",
"siteAps" : [ {
"apMac" : "38:FF:36:00:0E:10",
"apServerEnabled" : true,
"apServerPrimary" : true
}, {
"apMac" : "58:FF:36:00:0E:20",
"apServerEnabled" : true,
"apServerPrimary" : true
} ],
"siteProfileIds" : [ "75e26590-547f-11e6-9ca7-5a095364c13c", "869bb532-547f-11e6-9ca7-5a095364c13c" ]
}
‧ Sample : Assign IP for DHCP Service of EnableOnMultipleAPs with Auto Select AP
{
"siteEnabled" : true,
"dwpdEnabled" : false,
"manualSelect" : false,
"siteMode" : "EnableOnMultipleAPs",
"siteProfileIds" : [ "75e26590-547f-11e6-9ca7-5a095364c13c", "869bb532-547f-11e6-9ca7-5a095364c13c" ]
}Schema
{
"description" : "DHCP Service Assign IP For Server and Gateway",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"siteEnabled" : {
"description" : "DHCP Service Enabling Status",
"type" : "boolean"
},
"dwpdEnabled" : {
"description" : "DHCP Service Dynamic WAN Port Detection",
"type" : "boolean"
},
"manualSelect" : {
"description" : "DHCP Service AP Selection Mode. This value is effective when the siteMode is EnableOnMultipleAPs.",
"type" : "boolean"
},
"siteMode" : {
"description" : "DHCP Service mode",
"type" : "string",
"enum" : [ "EnableOnEachAPs", "EnableOnMultipleAPs", "EnableOnHierarchicalAPs" ]
},
"siteAps" : {
"type" : "array",
"items" : {
"type" : "object",
"description" : "DHCP Site selected APs. The content is effective when the siteMode is EnableOnMultipleAPs.",
"additionalProperties" : false,
"properties" : {
"apMac" : {
"type" : "string"
},
"apServerEnabled" : {
"type" : "boolean"
},
"apServerPrimary" : {
"type" : "boolean"
}
}
}
},
"siteProfileIds" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
}
}200Body
{
"zoneName": "zoneK",
"siteEnabled": true,
"dwpdEnabled": false,
"manualSelect": true,
"siteMode": "EnableOnMultipleAPs",
"siteAps": [
{
"apMac": "38:FF:36:00:0E:20",
"apServerEnabled": true,
"apGatewayEnabled": true
},
{
"apMac": "58:FF:36:00:0E:20",
"apServerEnabled": true,
"apGatewayEnabled": true
}
],
"siteProfiles": [
"75e26590-547f-11e6-9ca7-5a095364c13c",
"869bb532-547f-11e6-9ca7-5a095364c13c"
]
}Schema
{
"description": "DHCP Site Configuration in Zone",
"type": "object",
"additionalProperties": false,
"properties": {
"zoneName": {
"description": "DHCP Service Zone Name",
"type": "string"
},
"siteEnabled": {
"description": "DHCP Service Enabling Status",
"type": "boolean"
},
"dwpdEnabled": {
"description": "DHCP Service Dynamic WAN Port Detection",
"type": "boolean"
},
"manualSelect": {
"description": "DHCP Service AP Selection Mode",
"type": "boolean"
},
"siteMode": {
"description": "DHCP Service mode",
"type": "string",
"enum": [
"EnableOnEachAPs",
"EnableOnMultipleAPs",
"EnableOnHierarchicalAPs"
]
},
"eth0ProfileId": {
"type": "integer"
},
"eth1ProfileId": {
"type": "integer"
},
"siteAps": {
"type": "array",
"items": {
"type": "object",
"description": "DHCP Site selected APs",
"additionalProperties": false,
"properties": {
"apMac": {
"type": "string"
},
"apName": {
"type": "string"
},
"apStatus": {
"type": "string",
"enum": [
"Online",
"Offline",
"Flagged"
]
},
"apServerEnabled": {
"type": "boolean"
},
"apServerPrimary": {
"type": "boolean"
},
"apServerIp": {
"type": "string"
},
"apGatewayIp": {
"type": "string"
}
}
}
},
"siteProfiles": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"zoneId": {
"description": "Zone Id of DHCP Profile",
"type": "string"
},
"id": {
"description": "Identifier of the DHCP Profile",
"type": "string"
},
"name": {
"description": "Name of the DHCP Profile",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the DHCP Profile",
"type": [
"string",
"null"
],
"maxLength": 64
},
"vlanId": {
"description": "VLAN ID of the DHCP Profile",
"type": "integer",
"minimum": 1,
"maximum": 4094
},
"subnetNetworkIp": {
"description": "Subnet Network IP of the DHCP Profile",
"type": "string"
},
"subnetMask": {
"description": "Subnet Mask of the DHCP Profile",
"type": "string"
},
"poolStartIp": {
"description": "Pool Starting IP of the DHCP Profile",
"type": "string"
},
"poolEndIp": {
"description": "Pool Ending IP of the DHCP Profile",
"type": "string"
},
"primaryDnsIp": {
"description": "Primany DNS IP of the DHCP Profile",
"type": "string"
},
"secondaryDnsIp": {
"description": "Secondary DNS IP of the DHCP Profile",
"type": "string"
},
"leaseTimeHours": {
"description": "Lease time in hours of the DHCP Profile",
"type": "integer",
"minimum": 0,
"maximum": 24
},
"leaseTimeMinutes": {
"description": "Lease time in minutes of the DHCP Profile",
"type": "integer",
"minimum": 0,
"maximum": 59
}
}
}
}
}
}Modify AP Latency Interval ¶
PATCH/v8_0/rkszones/{id}/apLatencyInterval
Modify AP Latency Interval of a zone.
Body
{
"pingEnabled": true
}Schema
{
"description": "AP latency interval",
"type": "object",
"additionalProperties": false,
"properties": {
"pingEnabled": {
"description": "AP ping latency enabled",
"type": "boolean"
}
}
}204Change the Zone's Ruckus GRE Tunnel Profile ¶
PATCH/v8_0/rkszones/{id}/ruckusGreTunnelProfile
Use this API command to change the Zone’s Ruckus GRE Tunnel Profile.
Body
{
"domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
"zoneAffinityProfileId": "3fd9aa91-df65-11e7-98e1-08002748d78e",
"name": "modifyZoneName",
"description": "description Zone",
"countryCode": "US",
"timezone": {
"systemTimezone": "America/Whitehorse"
},
"login": {
"apLoginName": "admin",
"apLoginPassword": "admin!234"
},
"mesh": {
"ssid": "meshSSID",
"passphrase": "passphrase"
},
"dfsChannelEnabled": false,
"wifi24": {
"txPower": "Full",
"channelWidth": 20,
"channel": 0,
"channelRange": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11
]
},
"wifi50": {
"txPower": "-1dB",
"channelWidth": 40,
"indoorChannel": 0,
"outdoorChannel": 0,
"indoorChannelRange": [
36,
40,
44,
48,
149,
153,
157,
161
],
"outdoorChannelRange": [
149,
153,
157,
161
]
},
"protectionMode24": "CTS_ONLY",
"syslog": {
"address": "1.1.1.1",
"port": 514,
"facility": "Local0",
"priority": "Error"
},
"smartMonitor": {
"intervalInSec": 10,
"retryThreshold": 3
},
"nodeAffinityProfile": null,
"venueProfile": null,
"locationBasedService": null,
"channelModeEnabled": false,
"bonjourFencingPolicy": null,
"tunnelType": "RuckusGRE",
"tunnelProfile": {
"id": "f5b92938-aa4e-4d02-90ea-273799ff689b",
"name": "Default Tunnel Profile"
},
"clientAdmissionControl24": {
"maxRadioLoadPercent": 70,
"minClientCount": 10,
"minClientThroughputMbps": 10
},
"clientAdmissionControl50": {
"maxRadioLoadPercent": 70,
"minClientCount": 10,
"minClientThroughputMbps": 10
},
"backgroundScanning24": {
"frequencyInSec": 20
},
"backgroundScanning50": {
"frequencyInSec": 20
},
"clientLoadBalancing24": {
"adjacentRadioThreshold": 12
},
"clientLoadBalancing50": {
"adjacentRadioThreshold": 12
},
"bandBalancing": {
"wifi24Percentage": 10
},
"loadBalancingMethod": "BASED_ON_CLIENT_COUNT",
"rogue": {
"reportType": "All",
"maliciousTypes": null,
"protectionEnabled": true
},
"dosBarringEnable": 0,
"dosBarringPeriod": 60,
"dosBarringThreshold": 5,
"dosBarringCheckPeriod": 30,
"apRebootTimeout": {
"gatewayLossTimeoutInSec": 1800,
"serverLossTimeoutInSec": 7200
},
"location": "location",
"locationAdditionalInfo": "locationAdditionalInfo",
"latitude": 23,
"longitude": 23,
"vlanOverlappingEnabled": false,
"autoChannelSelection24": {
"channelSelectMode": "ChannelFly",
"channelFlyMtbc": 480
},
"autoChannelSelection50": {
"channelSelectMode": "BackgroundScanning",
"channelFlyMtbc": 480
},
"channelEvaluationInterval": 777,
"apMgmtVlan": {
"id": 1,
"mode": "KEEP"
},
"apLatencyInterval": {
"pingEnabled": true
},
"ipsecProfile": {
"id": "ipsecProfileId",
"name": "ipsecProfileName"
},
"altitude": {
"altitudeUnit": "meters",
"altitudeValue": 1
},
"bonjourFencingPolicyEnabled": false,
"snmpAgent": {
"apSnmpEnabled": true,
"snmpV2Agent": [
{
"communityName": "v2Agent",
"notificationEnabled": true,
"readEnabled": true,
"writeEnabled": true,
"notificationType": "TRAP",
"notificationTarget": [
{
"address": "172.19.16.20",
"port": 161
}
]
}
],
"snmpV3Agent": [
{
"userName": "v3Agent",
"authProtocol": "MD5",
"authPassword": "admin!234",
"privProtocol": "DES",
"privPassword": "admin!234",
"notificationEnabled": true,
"readEnabled": true,
"writeEnabled": true,
"notificationType": "TRAP",
"notificationTarget": [
{
"address": "172.19.16.20",
"port": 161
}
]
}
]
},
"recoverySsid": {
"recoverySsidEnabled": true
},
"dhcpSiteConfig": {
"siteEnabled": true,
"siteMode": "EnableOnEachAPs",
"siteProfileIds": [
"75e26590-547f-11e6-9ca7-5a095364c13c",
"869bb532-547f-11e6-9ca7-5a095364c13c"
]
},
"rogueApReportThreshold": 40,
"rogueApAggressivenessMode": 2,
"rogueApJammingDetection": true,
"rogueApJammingThreshold": 40,
"directedMulticastFromWiredClientEnabled": true,
"directedMulticastFromWirelessClientEnabled": true,
"directedMulticastFromNetworkEnabled": false,
"healthCheckSitesEnabled": true,
"healthCheckSites": [
"www.google.com",
"www.live.com:443",
"www.github.com:443",
"source.codeaurora.org:443",
"www.wikipedia.com"
],
"ruckusGreTunnelProfile": {
"id": "f5b92938-aa4e-4d02-90ea-273799ff689b",
"name": "Default Tunnel Profile"
},
"softGreTunnelProflies": [
{
"id": "5a2e41b0-df53-11e7-98e1-08002748d78e",
"name": "softGre1",
"aaaAffinityEnabled": true
},
{
"id": "7803e411-df53-11e7-98e1-08002748d78e",
"name": "softGre2",
"aaaAffinityEnabled": true
}
],
"ipsecProfiles": [
{
"id": "3fd9aa91-df65-11e7-98e1-08002748d78e",
"name": "ipsec1"
}
],
"sshTunnelEncryption": "AES128"
}Schema
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"domainId" : {
"description" : "Identifier of the management domain to which the zone belongs",
"type" : "string"
},
"zoneAffinityProfileId" : {
"description" : "Identifier of the ZoneAffinityProfile",
"type" : "string"
},
"name" : {
"description" : "Name of the zone",
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$"
},
"description" : {
"description" : "Description of the zone",
"type" : [ "string", "null" ],
"maxLength" : 64
},
"countryCode" : {
"description" : "Country code of the zone",
"type" : "string"
},
"timezone" : {
"description" : "Either systemTimezone or customizedTimezone must be specified",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"systemTimezone" : {
"description" : "System defined time zone, please refer to the “Overview > Time Zone” list",
"type" : "string"
},
"customizedTimezone" : {
"description" : "User defined time zone",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"abbreviation" : {
"description" : "Time zone abbreviation",
"type" : "string",
"pattern" : "^[a-zA-Z]{3,4}$"
},
"gmtOffset" : {
"description" : "GMT offset",
"type" : "integer",
"minimum" : -11,
"maximum" : 14
},
"gmtOffsetMinute" : {
"description" : "GMT offset minute",
"type" : "integer",
"minimum" : 0,
"maximum" : 59
},
"start" : {
"description" : "Daylight saving time start",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"month" : {
"description" : "Month when daylight saving time begins",
"type" : "integer",
"enum" : [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ]
},
"week" : {
"description" : "Week of the month (1 for the first week, 2 for the second week, and so on)",
"type" : "integer",
"enum" : [ 1, 2, 3, 4, 5 ]
},
"day" : {
"description" : "Day of the week (0 for Sunday, 1 for Monday, 2 for Tuesday, and so on)",
"type" : "integer",
"enum" : [ 0, 1, 2, 3, 4, 5, 6 ]
},
"hour" : {
"description" : "Hour of the day",
"type" : "integer",
"minimum" : 0,
"maximum" : 23
}
},
"required" : [ "month", "week", "day", "hour" ]
},
"end" : {
"description" : "Daylight saving time end",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"month" : {
"description" : "Month when daylight saving time begins",
"type" : "integer",
"enum" : [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ]
},
"week" : {
"description" : "Week of the month (1 for the first week, 2 for the second week, and so on)",
"type" : "integer",
"enum" : [ 1, 2, 3, 4, 5 ]
},
"day" : {
"description" : "Day of the week (0 for Sunday, 1 for Monday, 2 for Tuesday, and so on)",
"type" : "integer",
"enum" : [ 0, 1, 2, 3, 4, 5, 6 ]
},
"hour" : {
"description" : "Hour of the day",
"type" : "integer",
"minimum" : 0,
"maximum" : 23
}
},
"required" : [ "month", "week", "day", "hour" ]
}
},
"required" : [ "abbreviation", "gmtOffset", "gmtOffsetMinute" ]
}
}
},
"login" : {
"description" : "AP administrator account",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"apLoginName" : {
"description" : "User name of the AP administrator",
"type" : "string",
"maxLength" : 64,
"pattern" : "^((?!\$\()[!-_a-~]){1,64}$"
},
"apLoginPassword" : {
"description" : "Password of the AP administrator",
"type" : "string",
"maxLength" : 64,
"pattern" : ".*(?=.{8,})(?=.*[a-zA-Z])(?=.*[0-9])(?=.*[_`~!@#$%^&*\(\)\[\]\{\}|;:'\",.\<>\/?=+-]).*"
}
},
"required" : [ "apLoginName", "apLoginPassword" ]
},
"mesh" : {
"description" : "Mesh configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"ssid" : {
"description" : "SSID of the mesh network",
"type" : "string"
},
"passphrase" : {
"description" : "Passphrase for the mesh network",
"type" : "string"
},
"meshRadioIdx" : {
"description" : "Mesh radio index",
"type" : "string",
"enum" : [ "Radio24G", "Radio5G" ]
},
"zeroTouchStatus" : {
"type" : "boolean"
}
}
},
"dfsChannelEnabled" : {
"description" : "DFS Channel enabled configuration of the zone, only for the US country code .",
"type" : "boolean"
},
"cbandChannelEnabled" : {
"description" : "5.8Ghz channels enabled configuration of the zone.",
"type" : "boolean"
},
"cbandChannelLicenseEnabled" : {
"description" : "5.8Ghz channels license enabled configuration of the zone.",
"type" : "boolean"
},
"wifi24" : {
"description" : "AP 2.4GHz radio configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"autoCellSizing" : {
"description" : "Auto Cell Sizing",
"type" : "boolean"
},
"txPower" : {
"description" : "Transmission power",
"type" : "string",
"enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ]
},
"channelWidth" : {
"description" : "Channel width. Zero (0) means Auto.",
"type" : "integer",
"enum" : [ 0, 20, 40 ]
},
"channel" : {
"description" : "Channel number",
"type" : "integer"
},
"channelRange" : {
"description" : "Channel range options",
"type" : "array",
"items" : {
"type" : "integer"
}
}
}
},
"wifi50" : {
"description" : "AP 5GHz radio configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"autoCellSizing" : {
"description" : "Auto Cell Sizing",
"type" : "boolean"
},
"txPower" : {
"description" : "Transmission power",
"type" : "string",
"enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ]
},
"channelWidth" : {
"description" : "Channel width. Zero (0) means Auto. 8080 means 80+80MHz",
"type" : "integer",
"enum" : [ 0, 20, 40, 80, 8080, 160 ]
},
"indoorChannel" : {
"description" : "Channel number for Indoor AP",
"type" : "integer"
},
"outdoorChannel" : {
"description" : "Channel number for Outdoor AP",
"type" : "integer"
},
"indoorSecondaryChannel" : {
"description" : "Secondary channel number for Indoor AP (channelWidth is 80+80MHz only)",
"type" : "integer"
},
"outdoorSecondaryChannel" : {
"description" : "Secondary channel number for outdoor AP (channelWidth is 80+80MHz only)",
"type" : "integer"
},
"indoorChannelRange" : {
"description" : "Channel range options for Indoor AP",
"type" : "array",
"items" : {
"type" : "integer"
}
},
"outdoorChannelRange" : {
"description" : "Channel range options for outdoor AP",
"type" : "array",
"items" : {
"type" : "integer"
}
}
}
},
"protectionMode24" : {
"description" : "AP 2.4GHz Protection mode configuration of the zone.",
"type" : "string",
"enum" : [ "NONE", "CTS_ONLY", "RTS_CTS" ]
},
"syslog" : {
"description" : "Syslog configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"flowLevel" : {
"description" : "Flow Level of the syslog",
"type" : "string",
"enum" : [ "GENERAL_LOGS", "CLIENT_FLOW", "ALL" ]
},
"address" : {
"description" : "Address of the syslog server.",
"type" : "string"
},
"port" : {
"description" : "Port number of the syslog server",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
},
"protocol" : {
"description" : "Protocol of the syslog server",
"type" : "string",
"enum" : [ "IPPROTO_TCP", "IPPROTO_UDP" ]
},
"secondaryAddress" : {
"description" : "Secondary Server Address of the syslog server",
"type" : "string"
},
"secondaryPort" : {
"description" : "Secondary Server Port of the syslog server",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
},
"secondaryProtocol" : {
"description" : "Secondary Server Protocol of the syslog server",
"type" : "string",
"enum" : [ "IPPROTO_TCP", "IPPROTO_UDP" ]
},
"facility" : {
"description" : "Facility of the syslog server",
"type" : "string",
"enum" : [ "Keep_Original", "Local0", "Local1", "Local2", "Local3", "Local4", "Local5", "Local6", "Local7" ]
},
"priority" : {
"description" : "Priority of the log messages",
"type" : "string",
"enum" : [ "Emergency", "Alert", "Critical", "Error", "Warning", "Notice", "Info", "All" ]
}
}
},
"smartMonitor" : {
"description" : "Smart monitor configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"intervalInSec" : {
"description" : "Interval in seconds. This is required if smartMonitor is enabled",
"type" : "integer",
"minimum" : 5,
"maximum" : 60
},
"retryThreshold" : {
"description" : "Retry threshold. This is required if smartMonitor is enabled",
"type" : "integer",
"minimum" : 1,
"maximum" : 10
}
}
},
"clientAdmissionControl24" : {
"description" : "AP client admission control 2.4GHz radio configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"maxRadioLoadPercent" : {
"description" : "Maximum radio load percentage.",
"type" : "integer",
"minimum" : 50,
"maximum" : 100
},
"minClientCount" : {
"description" : "Minimum client count number.",
"type" : "integer",
"minimum" : 0,
"maximum" : 100
},
"minClientThroughputMbps" : {
"description" : "Minimum client throughput in Mbps.",
"type" : "number",
"minimum" : 0,
"maximum" : 100
}
}
},
"clientAdmissionControl50" : {
"description" : "AP client admission control 5GHz radio configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"maxRadioLoadPercent" : {
"description" : "Maximum radio load percentage.",
"type" : "integer",
"minimum" : 50,
"maximum" : 100
},
"minClientCount" : {
"description" : "Minimum client count number.",
"type" : "integer",
"minimum" : 0,
"maximum" : 100
},
"minClientThroughputMbps" : {
"description" : "Minimum client throughput in Mbps.",
"type" : "number",
"minimum" : 0,
"maximum" : 100
}
}
},
"channelModeEnabled" : {
"description" : "Channel mode configuration of the zone.",
"type" : "boolean"
},
"tunnelType" : {
"description" : "Tunnel type configuration of the zone. No_Tunneled is for IPv6 mode",
"type" : "string",
"enum" : [ "No_Tunneled", "RuckusGRE", "SoftGRE", "SoftGREIpsec" ]
},
"tunnelProfile" : {
"description" : "Tunnel type configuration of the zone.",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"backgroundScanning24" : {
"description" : "Background scanning on 2.4GHz radio configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"frequencyInSec" : {
"description" : "Frequency in second",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
}
}
},
"backgroundScanning50" : {
"description" : "Background scanning on 5GHz radio configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"frequencyInSec" : {
"description" : "Frequency in second",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
}
}
},
"clientLoadBalancing24" : {
"description" : "Client load balancing on 2.4GHz radio configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"adjacentRadioThreshold" : {
"description" : "Adjacent radio threshold",
"type" : "integer",
"minimum" : 1,
"maximum" : 100
}
}
},
"clientLoadBalancing50" : {
"description" : "Client load balancing on 5GHz radio configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"adjacentRadioThreshold" : {
"description" : "Adjacent radio threshold",
"type" : "integer",
"minimum" : 1,
"maximum" : 100
}
}
},
"bandBalancing" : {
"description" : "Band balancing configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"mode" : {
"description" : "Band Balancing Mode: BASIC-Withholds probe and authentication responses at connetcion time in heavily loaded band to balance clients to the other band, PROACTIVE-Uses BASIC functionality and actively rebalances clients via 802.11v BTM, STRICT-Uses PROACTIVE functionality and forcefully rebalances clients via 802.11v BTM",
"type" : "string",
"enum" : [ "BASIC", "PROACTIVE", "STRICT" ]
},
"wifi24Percentage" : {
"description" : "Percentage of client load on 2.4GHz radio band",
"type" : "integer",
"minimum" : 0,
"maximum" : 100
}
}
},
"loadBalancingMethod" : {
"type" : "string",
"enum" : [ "BASED_ON_CLIENT_COUNT", "BASED_ON_CAPACITY", "OFF" ]
},
"rogue" : {
"description" : "Rogue AP detection configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"reportType" : {
"description" : "Report type",
"type" : "string",
"enum" : [ "All", "Malicious" ]
},
"maliciousTypes" : {
"description" : "Malicious type when reportType is Malicious",
"type" : [ "array", "null" ],
"items" : {
"type" : "string",
"enum" : [ "SSIDSpoofing", "SameNetwork", "MACSpoofing" ]
}
},
"protectionEnabled" : {
"description" : "Protection enabled",
"type" : "boolean"
}
}
},
"dosBarringEnable" : {
"description" : "Enable DoS Protection(Barring UE) of the zone.",
"type" : "integer"
},
"dosBarringPeriod" : {
"description" : "DoS Protection(Barring UE) blocking period of the zone.",
"type" : "integer"
},
"dosBarringThreshold" : {
"description" : "DoS Protection(Barring UE) threshold of the zone.",
"type" : "integer"
},
"dosBarringCheckPeriod" : {
"description" : "DoS Protection(Barring UE) check period of the zone.",
"type" : "integer"
},
"locationBasedService" : {
"description" : "Location based service configuration of the zone.",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"apRebootTimeout" : {
"description" : "AP reboot timeout of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"gatewayLossTimeoutInSec" : {
"description" : "Gateway loss timeout in second",
"type" : "integer",
"enum" : [ 0, 1800, 3600, 5400, 7200, 9000, 10800, 12600, 14400, 16200, 18000, 19800, 23400, 25200, 27000, 28800, 30600, 32400, 34200, 36000, 37800, 39600, 41400, 43200, 45000, 46800, 48600, 50400, 52200, 54000, 55800, 57600, 59400, 61200, 63000, 64800, 66600, 68400, 70200, 72000, 73800, 75600, 77400, 79200, 81000, 82800, 84600, 86400 ]
},
"serverLossTimeoutInSec" : {
"description" : "Server loss timeout in second",
"type" : "integer",
"enum" : [ 0, 7200, 14400, 21600, 28800, 36000, 43200, 50400, 57600, 64800, 72000, 79200, 86400 ]
}
}
},
"location" : {
"description" : "Location of the zone.",
"type" : "string"
},
"locationAdditionalInfo" : {
"description" : "Location additional info of the zone.",
"type" : "string",
"pattern" : "^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
},
"altitude" : {
"description" : "GPS Altitude",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"altitudeUnit" : {
"description" : "altitude unit",
"type" : "string",
"enum" : [ "meters", "floor" ]
},
"altitudeValue" : {
"description" : "altitude value",
"type" : "integer"
}
}
},
"latitude" : {
"description" : "Latitude coordinate (in decimal format) of the zone",
"type" : "number"
},
"longitude" : {
"description" : "Longitude coordinate (in decimal format) of the zone",
"type" : "number"
},
"vlanOverlappingEnabled" : {
"description" : "VLAN pooling overlapping of the zone",
"type" : "boolean"
},
"nodeAffinityProfile" : {
"description" : "Node affinity profile of the zone.",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"venueProfile" : {
"description" : "Venue profile configuration of the zone.",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"autoChannelSelection24" : {
"description" : "client load balancing on Radio 2.4G, auto channel selection mode",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"channelSelectMode" : {
"description" : "Channel Select Mode",
"type" : "string",
"enum" : [ "None", "BackgroundScanning", "ChannelFly" ]
},
"channelFlyMtbc" : {
"description" : "ChannelFly MTBC",
"type" : "integer",
"minimum" : 100,
"maximum" : 1440
}
}
},
"autoChannelSelection50" : {
"description" : "client load balancing on Radio 5G, auto channel selection mode",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"channelSelectMode" : {
"description" : "Channel Select Mode",
"type" : "string",
"enum" : [ "None", "BackgroundScanning", "ChannelFly" ]
},
"channelFlyMtbc" : {
"description" : "ChannelFly MTBC",
"type" : "integer",
"minimum" : 100,
"maximum" : 1440
}
}
},
"channelEvaluationInterval" : {
"description" : "channel evaluation Interval of the zone",
"type" : "integer",
"minimum" : 60,
"maximum" : 3600
},
"apMgmtVlan" : {
"description" : "ap Management Vlan of the zone",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"mode" : {
"description" : "Vlan Mode of the zone",
"type" : "string",
"enum" : [ "KEEP", "USER_DEFINED" ]
},
"id" : {
"description" : "Vlan id of the zone",
"type" : "integer"
}
}
},
"apLatencyInterval" : {
"description" : "AP latency interval",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"pingEnabled" : {
"description" : "AP ping latency enabled",
"type" : "boolean"
}
}
},
"ipsecProfile" : {
"description" : "ipsec profile configuration of the Zone.",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"ipv6TrafficFilterEnabled" : {
"description" : "IPv6 Traffic filtering on the AP",
"type" : "integer"
},
"bonjourFencingPolicyEnabled" : {
"description" : "Enable Bonjour Fencing Policy on the AP",
"type" : "boolean"
},
"bonjourFencingPolicy" : {
"description" : "Bonjour Fencing Policy on the AP",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"dhcpSiteConfig" : {
"description" : "DHCP Site Configuration in Zone",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"siteEnabled" : {
"description" : "DHCP Service Enabling Status",
"type" : "boolean"
},
"dwpdEnabled" : {
"description" : "DHCP Service Dynamic WAN Port Detection",
"type" : "boolean"
},
"manualSelect" : {
"description" : "DHCP Service AP Selection Mode. This value is effective when the siteMode is EnableOnMultipleAPs.",
"type" : "boolean"
},
"siteMode" : {
"description" : "DHCP Service mode",
"type" : "string",
"enum" : [ "EnableOnEachAPs", "EnableOnMultipleAPs", "EnableOnHierarchicalAPs" ]
},
"eth0ProfileId" : {
"type" : "integer"
},
"eth1ProfileId" : {
"type" : "integer"
},
"siteAps" : {
"type" : "array",
"items" : {
"type" : "object",
"description" : "DHCP Site selected APs. The content is effective when the siteMode is EnableOnMultipleAPs.",
"additionalProperties" : false,
"properties" : {
"apMac" : {
"type" : "string"
},
"apName" : {
"type" : "string"
},
"apStatus" : {
"type" : "string",
"enum" : [ "Online", "Offline", "Flagged" ]
},
"apServerEnabled" : {
"type" : "boolean"
},
"apServerPrimary" : {
"type" : "boolean"
},
"apServerIp" : {
"type" : [ "string", "null" ]
},
"apGatewayIp" : {
"type" : "string"
}
}
}
},
"siteProfileIds" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
}
},
"snmpAgent" : {
"description" : "AP SNMP Options",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"apSnmpEnabled" : {
"description" : "Enable AP SNMP",
"type" : "boolean"
},
"snmpV2Agent" : {
"description" : "Community List of the SNMP V2 Agent.",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"communityName" : {
"description" : "name of the SNMP Community.",
"type" : "string"
},
"readEnabled" : {
"description" : "read privilege of the SNMP Coummunity",
"type" : "boolean"
},
"writeEnabled" : {
"description" : "write privilege of the SNMP Coummunity",
"type" : "boolean"
},
"notificationEnabled" : {
"description" : "notification privilege of the SNMP Coummunity",
"type" : "boolean"
},
"notificationType" : {
"description" : "type of the notification privilege",
"type" : "string",
"enum" : [ "TRAP", "INFORM" ]
},
"notificationTarget" : {
"description" : "Trap List of the SNMP Coummunity",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"address" : {
"description" : "address of the SNMP Trap",
"type" : "string"
},
"port" : {
"description" : "port number of the SNMP Trap",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
}
},
"required" : [ "address", "port" ]
}
}
},
"required" : [ "communityName" ]
}
},
"snmpV3Agent" : {
"description" : "User List of the SNMP V3 Agent.",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"userName" : {
"description" : "name of the SNMP User.",
"type" : "string"
},
"authProtocol" : {
"description" : "authProtocol of the SNMP User.",
"type" : "string",
"enum" : [ "NONE", "MD5", "SHA" ]
},
"authPassword" : {
"description" : "authPassword of the SNMP User.",
"type" : "string",
"minLength" : 8
},
"privProtocol" : {
"description" : "privProtocol of the SNMP User.",
"type" : "string",
"enum" : [ "NONE", "DES", "AES" ]
},
"privPassword" : {
"description" : "privPassword of the SNMP User.",
"type" : "string",
"minLength" : 8
},
"readEnabled" : {
"description" : "read privilege of the SNMP User",
"type" : "boolean"
},
"writeEnabled" : {
"description" : "write privilege of the SNMP User",
"type" : "boolean"
},
"notificationEnabled" : {
"description" : "notification privilege of the SNMP User",
"type" : "boolean"
},
"notificationType" : {
"description" : "type of the notification privilege",
"type" : "string",
"enum" : [ "TRAP", "INFORM" ]
},
"notificationTarget" : {
"description" : "Trap List of the SNMP User",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"address" : {
"description" : "address of the SNMP Trap",
"type" : "string"
},
"port" : {
"description" : "port number of the SNMP Trap",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
}
},
"required" : [ "address", "port" ]
}
}
},
"required" : [ "userName" ]
}
}
}
},
"recoverySsid" : {
"description" : "Recovery SSID",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"recoverySsidEnabled" : {
"description" : "recovery ssid enable/disable",
"type" : "boolean"
}
}
},
"clusterRedundancyEnabled" : {
"description" : "Enable Cluster redundancy on zone",
"type" : "boolean"
},
"rogueApReportThreshold" : {
"description" : "Rogue AP report will leave out all entries that have signal strength lower than this threshold.",
"type" : "integer"
},
"rogueApAggressivenessMode" : {
"description" : "Adjust the frequency interval to de-authenticate rogue APs.",
"type" : "integer"
},
"rogueApJammingDetection" : {
"description" : "Enable jamming detection.",
"type" : "boolean"
},
"rogueApJammingThreshold" : {
"type" : "integer"
},
"directedMulticastFromWiredClientEnabled" : {
"description" : "Directed multicast from wired client.",
"type" : "boolean"
},
"directedMulticastFromWirelessClientEnabled" : {
"description" : "Directed multicast from wireless client.",
"type" : "boolean"
},
"directedMulticastFromNetworkEnabled" : {
"description" : "Directed multicast from network.",
"type" : "boolean"
},
"healthCheckSitesEnabled" : {
"description" : "Enabled Health Check Sites. ",
"type" : "boolean"
},
"healthCheckSites" : {
"description" : "Health Check Sites.",
"type" : "array",
"items" : {
"type" : "string"
}
},
"ruckusGreTunnelProfile" : {
"description" : "Ruckus GRE Profile for Multiple Tunnel (Start from SZ 5.0)",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"softGreTunnelProflies" : {
"description" : "SoftGRE Profiles for Multiple Tunnel (Start from SZ 5.0)",
"type" : "array",
"items" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"aaaAffinityEnabled" : {
"type" : "boolean"
}
}
}
},
"ipsecProfiles" : {
"description" : "Ipsec profile for Multiple Tunnel (Start from SZ 5.0)",
"type" : "array",
"items" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
}
},
"sshTunnelEncryption" : {
"type" : "string",
"enum" : [ "AES128", "AES256" ]
}
}
}204Change the Zone's SoftGRE Tunnel Profiles ¶
PATCH/v8_0/rkszones/{id}/softGreTunnelProflies
Use this API command to change the Zone’s SoftGRE tunnel profiles.
Body
{
"domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
"zoneAffinityProfileId": "3fd9aa91-df65-11e7-98e1-08002748d78e",
"name": "modifyZoneName",
"description": "description Zone",
"countryCode": "US",
"timezone": {
"systemTimezone": "America/Whitehorse"
},
"login": {
"apLoginName": "admin",
"apLoginPassword": "admin!234"
},
"mesh": {
"ssid": "meshSSID",
"passphrase": "passphrase"
},
"dfsChannelEnabled": false,
"wifi24": {
"txPower": "Full",
"channelWidth": 20,
"channel": 0,
"channelRange": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11
]
},
"wifi50": {
"txPower": "-1dB",
"channelWidth": 40,
"indoorChannel": 0,
"outdoorChannel": 0,
"indoorChannelRange": [
36,
40,
44,
48,
149,
153,
157,
161
],
"outdoorChannelRange": [
149,
153,
157,
161
]
},
"protectionMode24": "CTS_ONLY",
"syslog": {
"address": "1.1.1.1",
"port": 514,
"facility": "Local0",
"priority": "Error"
},
"smartMonitor": {
"intervalInSec": 10,
"retryThreshold": 3
},
"nodeAffinityProfile": null,
"venueProfile": null,
"locationBasedService": null,
"channelModeEnabled": false,
"bonjourFencingPolicy": null,
"tunnelType": "RuckusGRE",
"tunnelProfile": {
"id": "f5b92938-aa4e-4d02-90ea-273799ff689b",
"name": "Default Tunnel Profile"
},
"clientAdmissionControl24": {
"maxRadioLoadPercent": 70,
"minClientCount": 10,
"minClientThroughputMbps": 10
},
"clientAdmissionControl50": {
"maxRadioLoadPercent": 70,
"minClientCount": 10,
"minClientThroughputMbps": 10
},
"backgroundScanning24": {
"frequencyInSec": 20
},
"backgroundScanning50": {
"frequencyInSec": 20
},
"clientLoadBalancing24": {
"adjacentRadioThreshold": 12
},
"clientLoadBalancing50": {
"adjacentRadioThreshold": 12
},
"bandBalancing": {
"wifi24Percentage": 10
},
"loadBalancingMethod": "BASED_ON_CLIENT_COUNT",
"rogue": {
"reportType": "All",
"maliciousTypes": null,
"protectionEnabled": true
},
"dosBarringEnable": 0,
"dosBarringPeriod": 60,
"dosBarringThreshold": 5,
"dosBarringCheckPeriod": 30,
"apRebootTimeout": {
"gatewayLossTimeoutInSec": 1800,
"serverLossTimeoutInSec": 7200
},
"location": "location",
"locationAdditionalInfo": "locationAdditionalInfo",
"latitude": 23,
"longitude": 23,
"vlanOverlappingEnabled": false,
"autoChannelSelection24": {
"channelSelectMode": "ChannelFly",
"channelFlyMtbc": 480
},
"autoChannelSelection50": {
"channelSelectMode": "BackgroundScanning",
"channelFlyMtbc": 480
},
"channelEvaluationInterval": 777,
"apMgmtVlan": {
"id": 1,
"mode": "KEEP"
},
"apLatencyInterval": {
"pingEnabled": true
},
"ipsecProfile": {
"id": "ipsecProfileId",
"name": "ipsecProfileName"
},
"altitude": {
"altitudeUnit": "meters",
"altitudeValue": 1
},
"bonjourFencingPolicyEnabled": false,
"snmpAgent": {
"apSnmpEnabled": true,
"snmpV2Agent": [
{
"communityName": "v2Agent",
"notificationEnabled": true,
"readEnabled": true,
"writeEnabled": true,
"notificationType": "TRAP",
"notificationTarget": [
{
"address": "172.19.16.20",
"port": 161
}
]
}
],
"snmpV3Agent": [
{
"userName": "v3Agent",
"authProtocol": "MD5",
"authPassword": "admin!234",
"privProtocol": "DES",
"privPassword": "admin!234",
"notificationEnabled": true,
"readEnabled": true,
"writeEnabled": true,
"notificationType": "TRAP",
"notificationTarget": [
{
"address": "172.19.16.20",
"port": 161
}
]
}
]
},
"recoverySsid": {
"recoverySsidEnabled": true
},
"dhcpSiteConfig": {
"siteEnabled": true,
"siteMode": "EnableOnEachAPs",
"siteProfileIds": [
"75e26590-547f-11e6-9ca7-5a095364c13c",
"869bb532-547f-11e6-9ca7-5a095364c13c"
]
},
"rogueApReportThreshold": 40,
"rogueApAggressivenessMode": 2,
"rogueApJammingDetection": true,
"rogueApJammingThreshold": 40,
"directedMulticastFromWiredClientEnabled": true,
"directedMulticastFromWirelessClientEnabled": true,
"directedMulticastFromNetworkEnabled": false,
"healthCheckSitesEnabled": true,
"healthCheckSites": [
"www.google.com",
"www.live.com:443",
"www.github.com:443",
"source.codeaurora.org:443",
"www.wikipedia.com"
],
"ruckusGreTunnelProfile": {
"id": "f5b92938-aa4e-4d02-90ea-273799ff689b",
"name": "Default Tunnel Profile"
},
"softGreTunnelProflies": [
{
"id": "5a2e41b0-df53-11e7-98e1-08002748d78e",
"name": "softGre1",
"aaaAffinityEnabled": true
},
{
"id": "7803e411-df53-11e7-98e1-08002748d78e",
"name": "softGre2",
"aaaAffinityEnabled": true
}
],
"ipsecProfiles": [
{
"id": "3fd9aa91-df65-11e7-98e1-08002748d78e",
"name": "ipsec1"
}
],
"sshTunnelEncryption": "AES128"
}Schema
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"domainId" : {
"description" : "Identifier of the management domain to which the zone belongs",
"type" : "string"
},
"zoneAffinityProfileId" : {
"description" : "Identifier of the ZoneAffinityProfile",
"type" : "string"
},
"name" : {
"description" : "Name of the zone",
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$"
},
"description" : {
"description" : "Description of the zone",
"type" : [ "string", "null" ],
"maxLength" : 64
},
"countryCode" : {
"description" : "Country code of the zone",
"type" : "string"
},
"timezone" : {
"description" : "Either systemTimezone or customizedTimezone must be specified",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"systemTimezone" : {
"description" : "System defined time zone, please refer to the “Overview > Time Zone” list",
"type" : "string"
},
"customizedTimezone" : {
"description" : "User defined time zone",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"abbreviation" : {
"description" : "Time zone abbreviation",
"type" : "string",
"pattern" : "^[a-zA-Z]{3,4}$"
},
"gmtOffset" : {
"description" : "GMT offset",
"type" : "integer",
"minimum" : -11,
"maximum" : 14
},
"gmtOffsetMinute" : {
"description" : "GMT offset minute",
"type" : "integer",
"minimum" : 0,
"maximum" : 59
},
"start" : {
"description" : "Daylight saving time start",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"month" : {
"description" : "Month when daylight saving time begins",
"type" : "integer",
"enum" : [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ]
},
"week" : {
"description" : "Week of the month (1 for the first week, 2 for the second week, and so on)",
"type" : "integer",
"enum" : [ 1, 2, 3, 4, 5 ]
},
"day" : {
"description" : "Day of the week (0 for Sunday, 1 for Monday, 2 for Tuesday, and so on)",
"type" : "integer",
"enum" : [ 0, 1, 2, 3, 4, 5, 6 ]
},
"hour" : {
"description" : "Hour of the day",
"type" : "integer",
"minimum" : 0,
"maximum" : 23
}
},
"required" : [ "month", "week", "day", "hour" ]
},
"end" : {
"description" : "Daylight saving time end",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"month" : {
"description" : "Month when daylight saving time begins",
"type" : "integer",
"enum" : [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ]
},
"week" : {
"description" : "Week of the month (1 for the first week, 2 for the second week, and so on)",
"type" : "integer",
"enum" : [ 1, 2, 3, 4, 5 ]
},
"day" : {
"description" : "Day of the week (0 for Sunday, 1 for Monday, 2 for Tuesday, and so on)",
"type" : "integer",
"enum" : [ 0, 1, 2, 3, 4, 5, 6 ]
},
"hour" : {
"description" : "Hour of the day",
"type" : "integer",
"minimum" : 0,
"maximum" : 23
}
},
"required" : [ "month", "week", "day", "hour" ]
}
},
"required" : [ "abbreviation", "gmtOffset", "gmtOffsetMinute" ]
}
}
},
"login" : {
"description" : "AP administrator account",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"apLoginName" : {
"description" : "User name of the AP administrator",
"type" : "string",
"maxLength" : 64,
"pattern" : "^((?!\$\()[!-_a-~]){1,64}$"
},
"apLoginPassword" : {
"description" : "Password of the AP administrator",
"type" : "string",
"maxLength" : 64,
"pattern" : ".*(?=.{8,})(?=.*[a-zA-Z])(?=.*[0-9])(?=.*[_`~!@#$%^&*\(\)\[\]\{\}|;:'\",.\<>\/?=+-]).*"
}
},
"required" : [ "apLoginName", "apLoginPassword" ]
},
"mesh" : {
"description" : "Mesh configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"ssid" : {
"description" : "SSID of the mesh network",
"type" : "string"
},
"passphrase" : {
"description" : "Passphrase for the mesh network",
"type" : "string"
},
"meshRadioIdx" : {
"description" : "Mesh radio index",
"type" : "string",
"enum" : [ "Radio24G", "Radio5G" ]
},
"zeroTouchStatus" : {
"type" : "boolean"
}
}
},
"dfsChannelEnabled" : {
"description" : "DFS Channel enabled configuration of the zone, only for the US country code .",
"type" : "boolean"
},
"cbandChannelEnabled" : {
"description" : "5.8Ghz channels enabled configuration of the zone.",
"type" : "boolean"
},
"cbandChannelLicenseEnabled" : {
"description" : "5.8Ghz channels license enabled configuration of the zone.",
"type" : "boolean"
},
"wifi24" : {
"description" : "AP 2.4GHz radio configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"autoCellSizing" : {
"description" : "Auto Cell Sizing",
"type" : "boolean"
},
"txPower" : {
"description" : "Transmission power",
"type" : "string",
"enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ]
},
"channelWidth" : {
"description" : "Channel width. Zero (0) means Auto.",
"type" : "integer",
"enum" : [ 0, 20, 40 ]
},
"channel" : {
"description" : "Channel number",
"type" : "integer"
},
"channelRange" : {
"description" : "Channel range options",
"type" : "array",
"items" : {
"type" : "integer"
}
}
}
},
"wifi50" : {
"description" : "AP 5GHz radio configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"autoCellSizing" : {
"description" : "Auto Cell Sizing",
"type" : "boolean"
},
"txPower" : {
"description" : "Transmission power",
"type" : "string",
"enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ]
},
"channelWidth" : {
"description" : "Channel width. Zero (0) means Auto. 8080 means 80+80MHz",
"type" : "integer",
"enum" : [ 0, 20, 40, 80, 8080, 160 ]
},
"indoorChannel" : {
"description" : "Channel number for Indoor AP",
"type" : "integer"
},
"outdoorChannel" : {
"description" : "Channel number for Outdoor AP",
"type" : "integer"
},
"indoorSecondaryChannel" : {
"description" : "Secondary channel number for Indoor AP (channelWidth is 80+80MHz only)",
"type" : "integer"
},
"outdoorSecondaryChannel" : {
"description" : "Secondary channel number for outdoor AP (channelWidth is 80+80MHz only)",
"type" : "integer"
},
"indoorChannelRange" : {
"description" : "Channel range options for Indoor AP",
"type" : "array",
"items" : {
"type" : "integer"
}
},
"outdoorChannelRange" : {
"description" : "Channel range options for outdoor AP",
"type" : "array",
"items" : {
"type" : "integer"
}
}
}
},
"protectionMode24" : {
"description" : "AP 2.4GHz Protection mode configuration of the zone.",
"type" : "string",
"enum" : [ "NONE", "CTS_ONLY", "RTS_CTS" ]
},
"syslog" : {
"description" : "Syslog configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"flowLevel" : {
"description" : "Flow Level of the syslog",
"type" : "string",
"enum" : [ "GENERAL_LOGS", "CLIENT_FLOW", "ALL" ]
},
"address" : {
"description" : "Address of the syslog server.",
"type" : "string"
},
"port" : {
"description" : "Port number of the syslog server",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
},
"protocol" : {
"description" : "Protocol of the syslog server",
"type" : "string",
"enum" : [ "IPPROTO_TCP", "IPPROTO_UDP" ]
},
"secondaryAddress" : {
"description" : "Secondary Server Address of the syslog server",
"type" : "string"
},
"secondaryPort" : {
"description" : "Secondary Server Port of the syslog server",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
},
"secondaryProtocol" : {
"description" : "Secondary Server Protocol of the syslog server",
"type" : "string",
"enum" : [ "IPPROTO_TCP", "IPPROTO_UDP" ]
},
"facility" : {
"description" : "Facility of the syslog server",
"type" : "string",
"enum" : [ "Keep_Original", "Local0", "Local1", "Local2", "Local3", "Local4", "Local5", "Local6", "Local7" ]
},
"priority" : {
"description" : "Priority of the log messages",
"type" : "string",
"enum" : [ "Emergency", "Alert", "Critical", "Error", "Warning", "Notice", "Info", "All" ]
}
}
},
"smartMonitor" : {
"description" : "Smart monitor configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"intervalInSec" : {
"description" : "Interval in seconds. This is required if smartMonitor is enabled",
"type" : "integer",
"minimum" : 5,
"maximum" : 60
},
"retryThreshold" : {
"description" : "Retry threshold. This is required if smartMonitor is enabled",
"type" : "integer",
"minimum" : 1,
"maximum" : 10
}
}
},
"clientAdmissionControl24" : {
"description" : "AP client admission control 2.4GHz radio configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"maxRadioLoadPercent" : {
"description" : "Maximum radio load percentage.",
"type" : "integer",
"minimum" : 50,
"maximum" : 100
},
"minClientCount" : {
"description" : "Minimum client count number.",
"type" : "integer",
"minimum" : 0,
"maximum" : 100
},
"minClientThroughputMbps" : {
"description" : "Minimum client throughput in Mbps.",
"type" : "number",
"minimum" : 0,
"maximum" : 100
}
}
},
"clientAdmissionControl50" : {
"description" : "AP client admission control 5GHz radio configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"maxRadioLoadPercent" : {
"description" : "Maximum radio load percentage.",
"type" : "integer",
"minimum" : 50,
"maximum" : 100
},
"minClientCount" : {
"description" : "Minimum client count number.",
"type" : "integer",
"minimum" : 0,
"maximum" : 100
},
"minClientThroughputMbps" : {
"description" : "Minimum client throughput in Mbps.",
"type" : "number",
"minimum" : 0,
"maximum" : 100
}
}
},
"channelModeEnabled" : {
"description" : "Channel mode configuration of the zone.",
"type" : "boolean"
},
"tunnelType" : {
"description" : "Tunnel type configuration of the zone. No_Tunneled is for IPv6 mode",
"type" : "string",
"enum" : [ "No_Tunneled", "RuckusGRE", "SoftGRE", "SoftGREIpsec" ]
},
"tunnelProfile" : {
"description" : "Tunnel type configuration of the zone.",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"backgroundScanning24" : {
"description" : "Background scanning on 2.4GHz radio configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"frequencyInSec" : {
"description" : "Frequency in second",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
}
}
},
"backgroundScanning50" : {
"description" : "Background scanning on 5GHz radio configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"frequencyInSec" : {
"description" : "Frequency in second",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
}
}
},
"clientLoadBalancing24" : {
"description" : "Client load balancing on 2.4GHz radio configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"adjacentRadioThreshold" : {
"description" : "Adjacent radio threshold",
"type" : "integer",
"minimum" : 1,
"maximum" : 100
}
}
},
"clientLoadBalancing50" : {
"description" : "Client load balancing on 5GHz radio configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"adjacentRadioThreshold" : {
"description" : "Adjacent radio threshold",
"type" : "integer",
"minimum" : 1,
"maximum" : 100
}
}
},
"bandBalancing" : {
"description" : "Band balancing configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"mode" : {
"description" : "Band Balancing Mode: BASIC-Withholds probe and authentication responses at connetcion time in heavily loaded band to balance clients to the other band, PROACTIVE-Uses BASIC functionality and actively rebalances clients via 802.11v BTM, STRICT-Uses PROACTIVE functionality and forcefully rebalances clients via 802.11v BTM",
"type" : "string",
"enum" : [ "BASIC", "PROACTIVE", "STRICT" ]
},
"wifi24Percentage" : {
"description" : "Percentage of client load on 2.4GHz radio band",
"type" : "integer",
"minimum" : 0,
"maximum" : 100
}
}
},
"loadBalancingMethod" : {
"type" : "string",
"enum" : [ "BASED_ON_CLIENT_COUNT", "BASED_ON_CAPACITY", "OFF" ]
},
"rogue" : {
"description" : "Rogue AP detection configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"reportType" : {
"description" : "Report type",
"type" : "string",
"enum" : [ "All", "Malicious" ]
},
"maliciousTypes" : {
"description" : "Malicious type when reportType is Malicious",
"type" : [ "array", "null" ],
"items" : {
"type" : "string",
"enum" : [ "SSIDSpoofing", "SameNetwork", "MACSpoofing" ]
}
},
"protectionEnabled" : {
"description" : "Protection enabled",
"type" : "boolean"
}
}
},
"dosBarringEnable" : {
"description" : "Enable DoS Protection(Barring UE) of the zone.",
"type" : "integer"
},
"dosBarringPeriod" : {
"description" : "DoS Protection(Barring UE) blocking period of the zone.",
"type" : "integer"
},
"dosBarringThreshold" : {
"description" : "DoS Protection(Barring UE) threshold of the zone.",
"type" : "integer"
},
"dosBarringCheckPeriod" : {
"description" : "DoS Protection(Barring UE) check period of the zone.",
"type" : "integer"
},
"locationBasedService" : {
"description" : "Location based service configuration of the zone.",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"apRebootTimeout" : {
"description" : "AP reboot timeout of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"gatewayLossTimeoutInSec" : {
"description" : "Gateway loss timeout in second",
"type" : "integer",
"enum" : [ 0, 1800, 3600, 5400, 7200, 9000, 10800, 12600, 14400, 16200, 18000, 19800, 23400, 25200, 27000, 28800, 30600, 32400, 34200, 36000, 37800, 39600, 41400, 43200, 45000, 46800, 48600, 50400, 52200, 54000, 55800, 57600, 59400, 61200, 63000, 64800, 66600, 68400, 70200, 72000, 73800, 75600, 77400, 79200, 81000, 82800, 84600, 86400 ]
},
"serverLossTimeoutInSec" : {
"description" : "Server loss timeout in second",
"type" : "integer",
"enum" : [ 0, 7200, 14400, 21600, 28800, 36000, 43200, 50400, 57600, 64800, 72000, 79200, 86400 ]
}
}
},
"location" : {
"description" : "Location of the zone.",
"type" : "string"
},
"locationAdditionalInfo" : {
"description" : "Location additional info of the zone.",
"type" : "string",
"pattern" : "^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
},
"altitude" : {
"description" : "GPS Altitude",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"altitudeUnit" : {
"description" : "altitude unit",
"type" : "string",
"enum" : [ "meters", "floor" ]
},
"altitudeValue" : {
"description" : "altitude value",
"type" : "integer"
}
}
},
"latitude" : {
"description" : "Latitude coordinate (in decimal format) of the zone",
"type" : "number"
},
"longitude" : {
"description" : "Longitude coordinate (in decimal format) of the zone",
"type" : "number"
},
"vlanOverlappingEnabled" : {
"description" : "VLAN pooling overlapping of the zone",
"type" : "boolean"
},
"nodeAffinityProfile" : {
"description" : "Node affinity profile of the zone.",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"venueProfile" : {
"description" : "Venue profile configuration of the zone.",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"autoChannelSelection24" : {
"description" : "client load balancing on Radio 2.4G, auto channel selection mode",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"channelSelectMode" : {
"description" : "Channel Select Mode",
"type" : "string",
"enum" : [ "None", "BackgroundScanning", "ChannelFly" ]
},
"channelFlyMtbc" : {
"description" : "ChannelFly MTBC",
"type" : "integer",
"minimum" : 100,
"maximum" : 1440
}
}
},
"autoChannelSelection50" : {
"description" : "client load balancing on Radio 5G, auto channel selection mode",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"channelSelectMode" : {
"description" : "Channel Select Mode",
"type" : "string",
"enum" : [ "None", "BackgroundScanning", "ChannelFly" ]
},
"channelFlyMtbc" : {
"description" : "ChannelFly MTBC",
"type" : "integer",
"minimum" : 100,
"maximum" : 1440
}
}
},
"channelEvaluationInterval" : {
"description" : "channel evaluation Interval of the zone",
"type" : "integer",
"minimum" : 60,
"maximum" : 3600
},
"apMgmtVlan" : {
"description" : "ap Management Vlan of the zone",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"mode" : {
"description" : "Vlan Mode of the zone",
"type" : "string",
"enum" : [ "KEEP", "USER_DEFINED" ]
},
"id" : {
"description" : "Vlan id of the zone",
"type" : "integer"
}
}
},
"apLatencyInterval" : {
"description" : "AP latency interval",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"pingEnabled" : {
"description" : "AP ping latency enabled",
"type" : "boolean"
}
}
},
"ipsecProfile" : {
"description" : "ipsec profile configuration of the Zone.",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"ipv6TrafficFilterEnabled" : {
"description" : "IPv6 Traffic filtering on the AP",
"type" : "integer"
},
"bonjourFencingPolicyEnabled" : {
"description" : "Enable Bonjour Fencing Policy on the AP",
"type" : "boolean"
},
"bonjourFencingPolicy" : {
"description" : "Bonjour Fencing Policy on the AP",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"dhcpSiteConfig" : {
"description" : "DHCP Site Configuration in Zone",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"siteEnabled" : {
"description" : "DHCP Service Enabling Status",
"type" : "boolean"
},
"dwpdEnabled" : {
"description" : "DHCP Service Dynamic WAN Port Detection",
"type" : "boolean"
},
"manualSelect" : {
"description" : "DHCP Service AP Selection Mode. This value is effective when the siteMode is EnableOnMultipleAPs.",
"type" : "boolean"
},
"siteMode" : {
"description" : "DHCP Service mode",
"type" : "string",
"enum" : [ "EnableOnEachAPs", "EnableOnMultipleAPs", "EnableOnHierarchicalAPs" ]
},
"eth0ProfileId" : {
"type" : "integer"
},
"eth1ProfileId" : {
"type" : "integer"
},
"siteAps" : {
"type" : "array",
"items" : {
"type" : "object",
"description" : "DHCP Site selected APs. The content is effective when the siteMode is EnableOnMultipleAPs.",
"additionalProperties" : false,
"properties" : {
"apMac" : {
"type" : "string"
},
"apName" : {
"type" : "string"
},
"apStatus" : {
"type" : "string",
"enum" : [ "Online", "Offline", "Flagged" ]
},
"apServerEnabled" : {
"type" : "boolean"
},
"apServerPrimary" : {
"type" : "boolean"
},
"apServerIp" : {
"type" : [ "string", "null" ]
},
"apGatewayIp" : {
"type" : "string"
}
}
}
},
"siteProfileIds" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
}
},
"snmpAgent" : {
"description" : "AP SNMP Options",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"apSnmpEnabled" : {
"description" : "Enable AP SNMP",
"type" : "boolean"
},
"snmpV2Agent" : {
"description" : "Community List of the SNMP V2 Agent.",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"communityName" : {
"description" : "name of the SNMP Community.",
"type" : "string"
},
"readEnabled" : {
"description" : "read privilege of the SNMP Coummunity",
"type" : "boolean"
},
"writeEnabled" : {
"description" : "write privilege of the SNMP Coummunity",
"type" : "boolean"
},
"notificationEnabled" : {
"description" : "notification privilege of the SNMP Coummunity",
"type" : "boolean"
},
"notificationType" : {
"description" : "type of the notification privilege",
"type" : "string",
"enum" : [ "TRAP", "INFORM" ]
},
"notificationTarget" : {
"description" : "Trap List of the SNMP Coummunity",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"address" : {
"description" : "address of the SNMP Trap",
"type" : "string"
},
"port" : {
"description" : "port number of the SNMP Trap",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
}
},
"required" : [ "address", "port" ]
}
}
},
"required" : [ "communityName" ]
}
},
"snmpV3Agent" : {
"description" : "User List of the SNMP V3 Agent.",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"userName" : {
"description" : "name of the SNMP User.",
"type" : "string"
},
"authProtocol" : {
"description" : "authProtocol of the SNMP User.",
"type" : "string",
"enum" : [ "NONE", "MD5", "SHA" ]
},
"authPassword" : {
"description" : "authPassword of the SNMP User.",
"type" : "string",
"minLength" : 8
},
"privProtocol" : {
"description" : "privProtocol of the SNMP User.",
"type" : "string",
"enum" : [ "NONE", "DES", "AES" ]
},
"privPassword" : {
"description" : "privPassword of the SNMP User.",
"type" : "string",
"minLength" : 8
},
"readEnabled" : {
"description" : "read privilege of the SNMP User",
"type" : "boolean"
},
"writeEnabled" : {
"description" : "write privilege of the SNMP User",
"type" : "boolean"
},
"notificationEnabled" : {
"description" : "notification privilege of the SNMP User",
"type" : "boolean"
},
"notificationType" : {
"description" : "type of the notification privilege",
"type" : "string",
"enum" : [ "TRAP", "INFORM" ]
},
"notificationTarget" : {
"description" : "Trap List of the SNMP User",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"address" : {
"description" : "address of the SNMP Trap",
"type" : "string"
},
"port" : {
"description" : "port number of the SNMP Trap",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
}
},
"required" : [ "address", "port" ]
}
}
},
"required" : [ "userName" ]
}
}
}
},
"recoverySsid" : {
"description" : "Recovery SSID",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"recoverySsidEnabled" : {
"description" : "recovery ssid enable/disable",
"type" : "boolean"
}
}
},
"clusterRedundancyEnabled" : {
"description" : "Enable Cluster redundancy on zone",
"type" : "boolean"
},
"rogueApReportThreshold" : {
"description" : "Rogue AP report will leave out all entries that have signal strength lower than this threshold.",
"type" : "integer"
},
"rogueApAggressivenessMode" : {
"description" : "Adjust the frequency interval to de-authenticate rogue APs.",
"type" : "integer"
},
"rogueApJammingDetection" : {
"description" : "Enable jamming detection.",
"type" : "boolean"
},
"rogueApJammingThreshold" : {
"type" : "integer"
},
"directedMulticastFromWiredClientEnabled" : {
"description" : "Directed multicast from wired client.",
"type" : "boolean"
},
"directedMulticastFromWirelessClientEnabled" : {
"description" : "Directed multicast from wireless client.",
"type" : "boolean"
},
"directedMulticastFromNetworkEnabled" : {
"description" : "Directed multicast from network.",
"type" : "boolean"
},
"healthCheckSitesEnabled" : {
"description" : "Enabled Health Check Sites. ",
"type" : "boolean"
},
"healthCheckSites" : {
"description" : "Health Check Sites.",
"type" : "array",
"items" : {
"type" : "string"
}
},
"ruckusGreTunnelProfile" : {
"description" : "Ruckus GRE Profile for Multiple Tunnel (Start from SZ 5.0)",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"softGreTunnelProflies" : {
"description" : "SoftGRE Profiles for Multiple Tunnel (Start from SZ 5.0)",
"type" : "array",
"items" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"aaaAffinityEnabled" : {
"type" : "boolean"
}
}
}
},
"ipsecProfiles" : {
"description" : "Ipsec profile for Multiple Tunnel (Start from SZ 5.0)",
"type" : "array",
"items" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
}
},
"sshTunnelEncryption" : {
"type" : "string",
"enum" : [ "AES128", "AES256" ]
}
}
}204Change the Zone's IPsec Profiles ¶
PATCH/v8_0/rkszones/{id}/ipsecProfiles
Use this API command to change the Zone’s IPsec profiles.
Body
{
"domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
"zoneAffinityProfileId": "3fd9aa91-df65-11e7-98e1-08002748d78e",
"name": "modifyZoneName",
"description": "description Zone",
"countryCode": "US",
"timezone": {
"systemTimezone": "America/Whitehorse"
},
"login": {
"apLoginName": "admin",
"apLoginPassword": "admin!234"
},
"mesh": {
"ssid": "meshSSID",
"passphrase": "passphrase"
},
"dfsChannelEnabled": false,
"wifi24": {
"txPower": "Full",
"channelWidth": 20,
"channel": 0,
"channelRange": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11
]
},
"wifi50": {
"txPower": "-1dB",
"channelWidth": 40,
"indoorChannel": 0,
"outdoorChannel": 0,
"indoorChannelRange": [
36,
40,
44,
48,
149,
153,
157,
161
],
"outdoorChannelRange": [
149,
153,
157,
161
]
},
"protectionMode24": "CTS_ONLY",
"syslog": {
"address": "1.1.1.1",
"port": 514,
"facility": "Local0",
"priority": "Error"
},
"smartMonitor": {
"intervalInSec": 10,
"retryThreshold": 3
},
"nodeAffinityProfile": null,
"venueProfile": null,
"locationBasedService": null,
"channelModeEnabled": false,
"bonjourFencingPolicy": null,
"tunnelType": "RuckusGRE",
"tunnelProfile": {
"id": "f5b92938-aa4e-4d02-90ea-273799ff689b",
"name": "Default Tunnel Profile"
},
"clientAdmissionControl24": {
"maxRadioLoadPercent": 70,
"minClientCount": 10,
"minClientThroughputMbps": 10
},
"clientAdmissionControl50": {
"maxRadioLoadPercent": 70,
"minClientCount": 10,
"minClientThroughputMbps": 10
},
"backgroundScanning24": {
"frequencyInSec": 20
},
"backgroundScanning50": {
"frequencyInSec": 20
},
"clientLoadBalancing24": {
"adjacentRadioThreshold": 12
},
"clientLoadBalancing50": {
"adjacentRadioThreshold": 12
},
"bandBalancing": {
"wifi24Percentage": 10
},
"loadBalancingMethod": "BASED_ON_CLIENT_COUNT",
"rogue": {
"reportType": "All",
"maliciousTypes": null,
"protectionEnabled": true
},
"dosBarringEnable": 0,
"dosBarringPeriod": 60,
"dosBarringThreshold": 5,
"dosBarringCheckPeriod": 30,
"apRebootTimeout": {
"gatewayLossTimeoutInSec": 1800,
"serverLossTimeoutInSec": 7200
},
"location": "location",
"locationAdditionalInfo": "locationAdditionalInfo",
"latitude": 23,
"longitude": 23,
"vlanOverlappingEnabled": false,
"autoChannelSelection24": {
"channelSelectMode": "ChannelFly",
"channelFlyMtbc": 480
},
"autoChannelSelection50": {
"channelSelectMode": "BackgroundScanning",
"channelFlyMtbc": 480
},
"channelEvaluationInterval": 777,
"apMgmtVlan": {
"id": 1,
"mode": "KEEP"
},
"apLatencyInterval": {
"pingEnabled": true
},
"ipsecProfile": {
"id": "ipsecProfileId",
"name": "ipsecProfileName"
},
"altitude": {
"altitudeUnit": "meters",
"altitudeValue": 1
},
"bonjourFencingPolicyEnabled": false,
"snmpAgent": {
"apSnmpEnabled": true,
"snmpV2Agent": [
{
"communityName": "v2Agent",
"notificationEnabled": true,
"readEnabled": true,
"writeEnabled": true,
"notificationType": "TRAP",
"notificationTarget": [
{
"address": "172.19.16.20",
"port": 161
}
]
}
],
"snmpV3Agent": [
{
"userName": "v3Agent",
"authProtocol": "MD5",
"authPassword": "admin!234",
"privProtocol": "DES",
"privPassword": "admin!234",
"notificationEnabled": true,
"readEnabled": true,
"writeEnabled": true,
"notificationType": "TRAP",
"notificationTarget": [
{
"address": "172.19.16.20",
"port": 161
}
]
}
]
},
"recoverySsid": {
"recoverySsidEnabled": true
},
"dhcpSiteConfig": {
"siteEnabled": true,
"siteMode": "EnableOnEachAPs",
"siteProfileIds": [
"75e26590-547f-11e6-9ca7-5a095364c13c",
"869bb532-547f-11e6-9ca7-5a095364c13c"
]
},
"rogueApReportThreshold": 40,
"rogueApAggressivenessMode": 2,
"rogueApJammingDetection": true,
"rogueApJammingThreshold": 40,
"directedMulticastFromWiredClientEnabled": true,
"directedMulticastFromWirelessClientEnabled": true,
"directedMulticastFromNetworkEnabled": false,
"healthCheckSitesEnabled": true,
"healthCheckSites": [
"www.google.com",
"www.live.com:443",
"www.github.com:443",
"source.codeaurora.org:443",
"www.wikipedia.com"
],
"ruckusGreTunnelProfile": {
"id": "f5b92938-aa4e-4d02-90ea-273799ff689b",
"name": "Default Tunnel Profile"
},
"softGreTunnelProflies": [
{
"id": "5a2e41b0-df53-11e7-98e1-08002748d78e",
"name": "softGre1",
"aaaAffinityEnabled": true
},
{
"id": "7803e411-df53-11e7-98e1-08002748d78e",
"name": "softGre2",
"aaaAffinityEnabled": true
}
],
"ipsecProfiles": [
{
"id": "3fd9aa91-df65-11e7-98e1-08002748d78e",
"name": "ipsec1"
}
],
"sshTunnelEncryption": "AES128"
}Schema
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"domainId" : {
"description" : "Identifier of the management domain to which the zone belongs",
"type" : "string"
},
"zoneAffinityProfileId" : {
"description" : "Identifier of the ZoneAffinityProfile",
"type" : "string"
},
"name" : {
"description" : "Name of the zone",
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$"
},
"description" : {
"description" : "Description of the zone",
"type" : [ "string", "null" ],
"maxLength" : 64
},
"countryCode" : {
"description" : "Country code of the zone",
"type" : "string"
},
"timezone" : {
"description" : "Either systemTimezone or customizedTimezone must be specified",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"systemTimezone" : {
"description" : "System defined time zone, please refer to the “Overview > Time Zone” list",
"type" : "string"
},
"customizedTimezone" : {
"description" : "User defined time zone",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"abbreviation" : {
"description" : "Time zone abbreviation",
"type" : "string",
"pattern" : "^[a-zA-Z]{3,4}$"
},
"gmtOffset" : {
"description" : "GMT offset",
"type" : "integer",
"minimum" : -11,
"maximum" : 14
},
"gmtOffsetMinute" : {
"description" : "GMT offset minute",
"type" : "integer",
"minimum" : 0,
"maximum" : 59
},
"start" : {
"description" : "Daylight saving time start",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"month" : {
"description" : "Month when daylight saving time begins",
"type" : "integer",
"enum" : [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ]
},
"week" : {
"description" : "Week of the month (1 for the first week, 2 for the second week, and so on)",
"type" : "integer",
"enum" : [ 1, 2, 3, 4, 5 ]
},
"day" : {
"description" : "Day of the week (0 for Sunday, 1 for Monday, 2 for Tuesday, and so on)",
"type" : "integer",
"enum" : [ 0, 1, 2, 3, 4, 5, 6 ]
},
"hour" : {
"description" : "Hour of the day",
"type" : "integer",
"minimum" : 0,
"maximum" : 23
}
},
"required" : [ "month", "week", "day", "hour" ]
},
"end" : {
"description" : "Daylight saving time end",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"month" : {
"description" : "Month when daylight saving time begins",
"type" : "integer",
"enum" : [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ]
},
"week" : {
"description" : "Week of the month (1 for the first week, 2 for the second week, and so on)",
"type" : "integer",
"enum" : [ 1, 2, 3, 4, 5 ]
},
"day" : {
"description" : "Day of the week (0 for Sunday, 1 for Monday, 2 for Tuesday, and so on)",
"type" : "integer",
"enum" : [ 0, 1, 2, 3, 4, 5, 6 ]
},
"hour" : {
"description" : "Hour of the day",
"type" : "integer",
"minimum" : 0,
"maximum" : 23
}
},
"required" : [ "month", "week", "day", "hour" ]
}
},
"required" : [ "abbreviation", "gmtOffset", "gmtOffsetMinute" ]
}
}
},
"login" : {
"description" : "AP administrator account",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"apLoginName" : {
"description" : "User name of the AP administrator",
"type" : "string",
"maxLength" : 64,
"pattern" : "^((?!\$\()[!-_a-~]){1,64}$"
},
"apLoginPassword" : {
"description" : "Password of the AP administrator",
"type" : "string",
"maxLength" : 64,
"pattern" : ".*(?=.{8,})(?=.*[a-zA-Z])(?=.*[0-9])(?=.*[_`~!@#$%^&*\(\)\[\]\{\}|;:'\",.\<>\/?=+-]).*"
}
},
"required" : [ "apLoginName", "apLoginPassword" ]
},
"mesh" : {
"description" : "Mesh configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"ssid" : {
"description" : "SSID of the mesh network",
"type" : "string"
},
"passphrase" : {
"description" : "Passphrase for the mesh network",
"type" : "string"
},
"meshRadioIdx" : {
"description" : "Mesh radio index",
"type" : "string",
"enum" : [ "Radio24G", "Radio5G" ]
},
"zeroTouchStatus" : {
"type" : "boolean"
}
}
},
"dfsChannelEnabled" : {
"description" : "DFS Channel enabled configuration of the zone, only for the US country code .",
"type" : "boolean"
},
"cbandChannelEnabled" : {
"description" : "5.8Ghz channels enabled configuration of the zone.",
"type" : "boolean"
},
"cbandChannelLicenseEnabled" : {
"description" : "5.8Ghz channels license enabled configuration of the zone.",
"type" : "boolean"
},
"wifi24" : {
"description" : "AP 2.4GHz radio configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"autoCellSizing" : {
"description" : "Auto Cell Sizing",
"type" : "boolean"
},
"txPower" : {
"description" : "Transmission power",
"type" : "string",
"enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ]
},
"channelWidth" : {
"description" : "Channel width. Zero (0) means Auto.",
"type" : "integer",
"enum" : [ 0, 20, 40 ]
},
"channel" : {
"description" : "Channel number",
"type" : "integer"
},
"channelRange" : {
"description" : "Channel range options",
"type" : "array",
"items" : {
"type" : "integer"
}
}
}
},
"wifi50" : {
"description" : "AP 5GHz radio configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"autoCellSizing" : {
"description" : "Auto Cell Sizing",
"type" : "boolean"
},
"txPower" : {
"description" : "Transmission power",
"type" : "string",
"enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ]
},
"channelWidth" : {
"description" : "Channel width. Zero (0) means Auto. 8080 means 80+80MHz",
"type" : "integer",
"enum" : [ 0, 20, 40, 80, 8080, 160 ]
},
"indoorChannel" : {
"description" : "Channel number for Indoor AP",
"type" : "integer"
},
"outdoorChannel" : {
"description" : "Channel number for Outdoor AP",
"type" : "integer"
},
"indoorSecondaryChannel" : {
"description" : "Secondary channel number for Indoor AP (channelWidth is 80+80MHz only)",
"type" : "integer"
},
"outdoorSecondaryChannel" : {
"description" : "Secondary channel number for outdoor AP (channelWidth is 80+80MHz only)",
"type" : "integer"
},
"indoorChannelRange" : {
"description" : "Channel range options for Indoor AP",
"type" : "array",
"items" : {
"type" : "integer"
}
},
"outdoorChannelRange" : {
"description" : "Channel range options for outdoor AP",
"type" : "array",
"items" : {
"type" : "integer"
}
}
}
},
"protectionMode24" : {
"description" : "AP 2.4GHz Protection mode configuration of the zone.",
"type" : "string",
"enum" : [ "NONE", "CTS_ONLY", "RTS_CTS" ]
},
"syslog" : {
"description" : "Syslog configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"flowLevel" : {
"description" : "Flow Level of the syslog",
"type" : "string",
"enum" : [ "GENERAL_LOGS", "CLIENT_FLOW", "ALL" ]
},
"address" : {
"description" : "Address of the syslog server.",
"type" : "string"
},
"port" : {
"description" : "Port number of the syslog server",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
},
"protocol" : {
"description" : "Protocol of the syslog server",
"type" : "string",
"enum" : [ "IPPROTO_TCP", "IPPROTO_UDP" ]
},
"secondaryAddress" : {
"description" : "Secondary Server Address of the syslog server",
"type" : "string"
},
"secondaryPort" : {
"description" : "Secondary Server Port of the syslog server",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
},
"secondaryProtocol" : {
"description" : "Secondary Server Protocol of the syslog server",
"type" : "string",
"enum" : [ "IPPROTO_TCP", "IPPROTO_UDP" ]
},
"facility" : {
"description" : "Facility of the syslog server",
"type" : "string",
"enum" : [ "Keep_Original", "Local0", "Local1", "Local2", "Local3", "Local4", "Local5", "Local6", "Local7" ]
},
"priority" : {
"description" : "Priority of the log messages",
"type" : "string",
"enum" : [ "Emergency", "Alert", "Critical", "Error", "Warning", "Notice", "Info", "All" ]
}
}
},
"smartMonitor" : {
"description" : "Smart monitor configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"intervalInSec" : {
"description" : "Interval in seconds. This is required if smartMonitor is enabled",
"type" : "integer",
"minimum" : 5,
"maximum" : 60
},
"retryThreshold" : {
"description" : "Retry threshold. This is required if smartMonitor is enabled",
"type" : "integer",
"minimum" : 1,
"maximum" : 10
}
}
},
"clientAdmissionControl24" : {
"description" : "AP client admission control 2.4GHz radio configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"maxRadioLoadPercent" : {
"description" : "Maximum radio load percentage.",
"type" : "integer",
"minimum" : 50,
"maximum" : 100
},
"minClientCount" : {
"description" : "Minimum client count number.",
"type" : "integer",
"minimum" : 0,
"maximum" : 100
},
"minClientThroughputMbps" : {
"description" : "Minimum client throughput in Mbps.",
"type" : "number",
"minimum" : 0,
"maximum" : 100
}
}
},
"clientAdmissionControl50" : {
"description" : "AP client admission control 5GHz radio configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"maxRadioLoadPercent" : {
"description" : "Maximum radio load percentage.",
"type" : "integer",
"minimum" : 50,
"maximum" : 100
},
"minClientCount" : {
"description" : "Minimum client count number.",
"type" : "integer",
"minimum" : 0,
"maximum" : 100
},
"minClientThroughputMbps" : {
"description" : "Minimum client throughput in Mbps.",
"type" : "number",
"minimum" : 0,
"maximum" : 100
}
}
},
"channelModeEnabled" : {
"description" : "Channel mode configuration of the zone.",
"type" : "boolean"
},
"tunnelType" : {
"description" : "Tunnel type configuration of the zone. No_Tunneled is for IPv6 mode",
"type" : "string",
"enum" : [ "No_Tunneled", "RuckusGRE", "SoftGRE", "SoftGREIpsec" ]
},
"tunnelProfile" : {
"description" : "Tunnel type configuration of the zone.",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"backgroundScanning24" : {
"description" : "Background scanning on 2.4GHz radio configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"frequencyInSec" : {
"description" : "Frequency in second",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
}
}
},
"backgroundScanning50" : {
"description" : "Background scanning on 5GHz radio configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"frequencyInSec" : {
"description" : "Frequency in second",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
}
}
},
"clientLoadBalancing24" : {
"description" : "Client load balancing on 2.4GHz radio configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"adjacentRadioThreshold" : {
"description" : "Adjacent radio threshold",
"type" : "integer",
"minimum" : 1,
"maximum" : 100
}
}
},
"clientLoadBalancing50" : {
"description" : "Client load balancing on 5GHz radio configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"adjacentRadioThreshold" : {
"description" : "Adjacent radio threshold",
"type" : "integer",
"minimum" : 1,
"maximum" : 100
}
}
},
"bandBalancing" : {
"description" : "Band balancing configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"mode" : {
"description" : "Band Balancing Mode: BASIC-Withholds probe and authentication responses at connetcion time in heavily loaded band to balance clients to the other band, PROACTIVE-Uses BASIC functionality and actively rebalances clients via 802.11v BTM, STRICT-Uses PROACTIVE functionality and forcefully rebalances clients via 802.11v BTM",
"type" : "string",
"enum" : [ "BASIC", "PROACTIVE", "STRICT" ]
},
"wifi24Percentage" : {
"description" : "Percentage of client load on 2.4GHz radio band",
"type" : "integer",
"minimum" : 0,
"maximum" : 100
}
}
},
"loadBalancingMethod" : {
"type" : "string",
"enum" : [ "BASED_ON_CLIENT_COUNT", "BASED_ON_CAPACITY", "OFF" ]
},
"rogue" : {
"description" : "Rogue AP detection configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"reportType" : {
"description" : "Report type",
"type" : "string",
"enum" : [ "All", "Malicious" ]
},
"maliciousTypes" : {
"description" : "Malicious type when reportType is Malicious",
"type" : [ "array", "null" ],
"items" : {
"type" : "string",
"enum" : [ "SSIDSpoofing", "SameNetwork", "MACSpoofing" ]
}
},
"protectionEnabled" : {
"description" : "Protection enabled",
"type" : "boolean"
}
}
},
"dosBarringEnable" : {
"description" : "Enable DoS Protection(Barring UE) of the zone.",
"type" : "integer"
},
"dosBarringPeriod" : {
"description" : "DoS Protection(Barring UE) blocking period of the zone.",
"type" : "integer"
},
"dosBarringThreshold" : {
"description" : "DoS Protection(Barring UE) threshold of the zone.",
"type" : "integer"
},
"dosBarringCheckPeriod" : {
"description" : "DoS Protection(Barring UE) check period of the zone.",
"type" : "integer"
},
"locationBasedService" : {
"description" : "Location based service configuration of the zone.",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"apRebootTimeout" : {
"description" : "AP reboot timeout of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"gatewayLossTimeoutInSec" : {
"description" : "Gateway loss timeout in second",
"type" : "integer",
"enum" : [ 0, 1800, 3600, 5400, 7200, 9000, 10800, 12600, 14400, 16200, 18000, 19800, 23400, 25200, 27000, 28800, 30600, 32400, 34200, 36000, 37800, 39600, 41400, 43200, 45000, 46800, 48600, 50400, 52200, 54000, 55800, 57600, 59400, 61200, 63000, 64800, 66600, 68400, 70200, 72000, 73800, 75600, 77400, 79200, 81000, 82800, 84600, 86400 ]
},
"serverLossTimeoutInSec" : {
"description" : "Server loss timeout in second",
"type" : "integer",
"enum" : [ 0, 7200, 14400, 21600, 28800, 36000, 43200, 50400, 57600, 64800, 72000, 79200, 86400 ]
}
}
},
"location" : {
"description" : "Location of the zone.",
"type" : "string"
},
"locationAdditionalInfo" : {
"description" : "Location additional info of the zone.",
"type" : "string",
"pattern" : "^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
},
"altitude" : {
"description" : "GPS Altitude",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"altitudeUnit" : {
"description" : "altitude unit",
"type" : "string",
"enum" : [ "meters", "floor" ]
},
"altitudeValue" : {
"description" : "altitude value",
"type" : "integer"
}
}
},
"latitude" : {
"description" : "Latitude coordinate (in decimal format) of the zone",
"type" : "number"
},
"longitude" : {
"description" : "Longitude coordinate (in decimal format) of the zone",
"type" : "number"
},
"vlanOverlappingEnabled" : {
"description" : "VLAN pooling overlapping of the zone",
"type" : "boolean"
},
"nodeAffinityProfile" : {
"description" : "Node affinity profile of the zone.",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"venueProfile" : {
"description" : "Venue profile configuration of the zone.",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"autoChannelSelection24" : {
"description" : "client load balancing on Radio 2.4G, auto channel selection mode",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"channelSelectMode" : {
"description" : "Channel Select Mode",
"type" : "string",
"enum" : [ "None", "BackgroundScanning", "ChannelFly" ]
},
"channelFlyMtbc" : {
"description" : "ChannelFly MTBC",
"type" : "integer",
"minimum" : 100,
"maximum" : 1440
}
}
},
"autoChannelSelection50" : {
"description" : "client load balancing on Radio 5G, auto channel selection mode",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"channelSelectMode" : {
"description" : "Channel Select Mode",
"type" : "string",
"enum" : [ "None", "BackgroundScanning", "ChannelFly" ]
},
"channelFlyMtbc" : {
"description" : "ChannelFly MTBC",
"type" : "integer",
"minimum" : 100,
"maximum" : 1440
}
}
},
"channelEvaluationInterval" : {
"description" : "channel evaluation Interval of the zone",
"type" : "integer",
"minimum" : 60,
"maximum" : 3600
},
"apMgmtVlan" : {
"description" : "ap Management Vlan of the zone",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"mode" : {
"description" : "Vlan Mode of the zone",
"type" : "string",
"enum" : [ "KEEP", "USER_DEFINED" ]
},
"id" : {
"description" : "Vlan id of the zone",
"type" : "integer"
}
}
},
"apLatencyInterval" : {
"description" : "AP latency interval",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"pingEnabled" : {
"description" : "AP ping latency enabled",
"type" : "boolean"
}
}
},
"ipsecProfile" : {
"description" : "ipsec profile configuration of the Zone.",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"ipv6TrafficFilterEnabled" : {
"description" : "IPv6 Traffic filtering on the AP",
"type" : "integer"
},
"bonjourFencingPolicyEnabled" : {
"description" : "Enable Bonjour Fencing Policy on the AP",
"type" : "boolean"
},
"bonjourFencingPolicy" : {
"description" : "Bonjour Fencing Policy on the AP",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"dhcpSiteConfig" : {
"description" : "DHCP Site Configuration in Zone",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"siteEnabled" : {
"description" : "DHCP Service Enabling Status",
"type" : "boolean"
},
"dwpdEnabled" : {
"description" : "DHCP Service Dynamic WAN Port Detection",
"type" : "boolean"
},
"manualSelect" : {
"description" : "DHCP Service AP Selection Mode. This value is effective when the siteMode is EnableOnMultipleAPs.",
"type" : "boolean"
},
"siteMode" : {
"description" : "DHCP Service mode",
"type" : "string",
"enum" : [ "EnableOnEachAPs", "EnableOnMultipleAPs", "EnableOnHierarchicalAPs" ]
},
"eth0ProfileId" : {
"type" : "integer"
},
"eth1ProfileId" : {
"type" : "integer"
},
"siteAps" : {
"type" : "array",
"items" : {
"type" : "object",
"description" : "DHCP Site selected APs. The content is effective when the siteMode is EnableOnMultipleAPs.",
"additionalProperties" : false,
"properties" : {
"apMac" : {
"type" : "string"
},
"apName" : {
"type" : "string"
},
"apStatus" : {
"type" : "string",
"enum" : [ "Online", "Offline", "Flagged" ]
},
"apServerEnabled" : {
"type" : "boolean"
},
"apServerPrimary" : {
"type" : "boolean"
},
"apServerIp" : {
"type" : [ "string", "null" ]
},
"apGatewayIp" : {
"type" : "string"
}
}
}
},
"siteProfileIds" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
}
},
"snmpAgent" : {
"description" : "AP SNMP Options",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"apSnmpEnabled" : {
"description" : "Enable AP SNMP",
"type" : "boolean"
},
"snmpV2Agent" : {
"description" : "Community List of the SNMP V2 Agent.",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"communityName" : {
"description" : "name of the SNMP Community.",
"type" : "string"
},
"readEnabled" : {
"description" : "read privilege of the SNMP Coummunity",
"type" : "boolean"
},
"writeEnabled" : {
"description" : "write privilege of the SNMP Coummunity",
"type" : "boolean"
},
"notificationEnabled" : {
"description" : "notification privilege of the SNMP Coummunity",
"type" : "boolean"
},
"notificationType" : {
"description" : "type of the notification privilege",
"type" : "string",
"enum" : [ "TRAP", "INFORM" ]
},
"notificationTarget" : {
"description" : "Trap List of the SNMP Coummunity",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"address" : {
"description" : "address of the SNMP Trap",
"type" : "string"
},
"port" : {
"description" : "port number of the SNMP Trap",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
}
},
"required" : [ "address", "port" ]
}
}
},
"required" : [ "communityName" ]
}
},
"snmpV3Agent" : {
"description" : "User List of the SNMP V3 Agent.",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"userName" : {
"description" : "name of the SNMP User.",
"type" : "string"
},
"authProtocol" : {
"description" : "authProtocol of the SNMP User.",
"type" : "string",
"enum" : [ "NONE", "MD5", "SHA" ]
},
"authPassword" : {
"description" : "authPassword of the SNMP User.",
"type" : "string",
"minLength" : 8
},
"privProtocol" : {
"description" : "privProtocol of the SNMP User.",
"type" : "string",
"enum" : [ "NONE", "DES", "AES" ]
},
"privPassword" : {
"description" : "privPassword of the SNMP User.",
"type" : "string",
"minLength" : 8
},
"readEnabled" : {
"description" : "read privilege of the SNMP User",
"type" : "boolean"
},
"writeEnabled" : {
"description" : "write privilege of the SNMP User",
"type" : "boolean"
},
"notificationEnabled" : {
"description" : "notification privilege of the SNMP User",
"type" : "boolean"
},
"notificationType" : {
"description" : "type of the notification privilege",
"type" : "string",
"enum" : [ "TRAP", "INFORM" ]
},
"notificationTarget" : {
"description" : "Trap List of the SNMP User",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"address" : {
"description" : "address of the SNMP Trap",
"type" : "string"
},
"port" : {
"description" : "port number of the SNMP Trap",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
}
},
"required" : [ "address", "port" ]
}
}
},
"required" : [ "userName" ]
}
}
}
},
"recoverySsid" : {
"description" : "Recovery SSID",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"recoverySsidEnabled" : {
"description" : "recovery ssid enable/disable",
"type" : "boolean"
}
}
},
"clusterRedundancyEnabled" : {
"description" : "Enable Cluster redundancy on zone",
"type" : "boolean"
},
"rogueApReportThreshold" : {
"description" : "Rogue AP report will leave out all entries that have signal strength lower than this threshold.",
"type" : "integer"
},
"rogueApAggressivenessMode" : {
"description" : "Adjust the frequency interval to de-authenticate rogue APs.",
"type" : "integer"
},
"rogueApJammingDetection" : {
"description" : "Enable jamming detection.",
"type" : "boolean"
},
"rogueApJammingThreshold" : {
"type" : "integer"
},
"directedMulticastFromWiredClientEnabled" : {
"description" : "Directed multicast from wired client.",
"type" : "boolean"
},
"directedMulticastFromWirelessClientEnabled" : {
"description" : "Directed multicast from wireless client.",
"type" : "boolean"
},
"directedMulticastFromNetworkEnabled" : {
"description" : "Directed multicast from network.",
"type" : "boolean"
},
"healthCheckSitesEnabled" : {
"description" : "Enabled Health Check Sites. ",
"type" : "boolean"
},
"healthCheckSites" : {
"description" : "Health Check Sites.",
"type" : "array",
"items" : {
"type" : "string"
}
},
"ruckusGreTunnelProfile" : {
"description" : "Ruckus GRE Profile for Multiple Tunnel (Start from SZ 5.0)",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"softGreTunnelProflies" : {
"description" : "SoftGRE Profiles for Multiple Tunnel (Start from SZ 5.0)",
"type" : "array",
"items" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"aaaAffinityEnabled" : {
"type" : "boolean"
}
}
}
},
"ipsecProfiles" : {
"description" : "Ipsec profile for Multiple Tunnel (Start from SZ 5.0)",
"type" : "array",
"items" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
}
},
"sshTunnelEncryption" : {
"type" : "string",
"enum" : [ "AES128", "AES256" ]
}
}
}204Retrieve List ¶
GET/v8_0/rkszones
Use this API command to retrieve the list of Ruckus Wireless AP zones that belong to a domain.
- index
string(optional)The index of the first entry to be retrieved. Default: 0
- listSize
string(optional)The maximum number of entries to be retrieved. Default: 100
- domainId
string(optional)The domain ID. Default: current logon domain ID
200Body
{
"totalCount": 2,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"id": "zoneUUID",
"name": "zoneName"
},
{
"id": "zoneUUID2",
"name": "zoneName2"
}
]
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"totalCount": {
"type": "integer"
},
"hasMore": {
"type": "boolean"
},
"firstIndex": {
"type": "integer"
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the zone",
"type": "string"
},
"name": {
"description": "Name of the zone",
"type": "string"
},
"serviceName": {
"description": "Name of the zone",
"type": "string"
}
}
}
}
}
}Clear Mesh Configuration ¶
Disable Syslog ¶
DELETE/v8_0/rkszones/{id}/syslog
Use this API command to disable syslog configuration for APs that belong to a zone.
204Disable Smart Monitor ¶
DELETE/v8_0/rkszones/{id}/smartMonitor
Use this API command to disable smart monitor for APs that belong to a zone.
204Disable Client Admission Control 2.4G ¶
DELETE/v8_0/rkszones/{id}/clientAdmissionControl24
Use this API command to disable client admission control 2.4GHz radio configuration for APs that belong to a zone.
204Disable Client Admission Control 5G ¶
DELETE/v8_0/rkszones/{id}/clientAdmissionControl50
Use this API command to disable client admission control 5GHz radio configuration for APs that belong to a zone.
204Disable Background Scanning 2.4G ¶
DELETE/v8_0/rkszones/{id}/backgroundScanning24
Use this API command to disable background scanning 2.4GHz radio configuration for APs that belong to a zone.
204Disable Background Scanning 5G ¶
DELETE/v8_0/rkszones/{id}/backgroundScanning50
Use this API command to disable background scanning 5GHz radio configuration for APs that belong to a zone.
204Disable Client Load Balancing 2.4G ¶
DELETE/v8_0/rkszones/{id}/clientLoadBalancing24
Use this API command to disable client load balancing 2.4GHz radio configuration for APs that belong to a zone.
204Disable Client Load Balancing 5G ¶
DELETE/v8_0/rkszones/{id}/clientLoadBalancing50
Use this API command to disable client load balancing 5GHz radio configuration for APs that belong to a zone.
204Disable Band Balancing ¶
DELETE/v8_0/rkszones/{id}/bandBalancing
Use this API command to disable band balancing for APs that belong to a zone.
204Clear Hotspot2.0 Venue Profile ¶
DELETE/v8_0/rkszones/{id}/venueProfile
Use this API command to clear Hotspot 2.0 venue profile for APs that belong to a zone.
204Disable Rogue ¶
DELETE/v8_0/rkszones/{id}/rogue
Use this API command to disable rogue AP detection for APs that belong to a zone.
204Disable Location Based Service ¶
DELETE/v8_0/rkszones/{id}/locationBasedService
Use this API command to disable location based service for APs that belong to a zone.
204Disable Altitude ¶
DELETE/v8_0/rkszones/{id}/altitude
Use this API command to disable altitude configuration of zone.
204Clear AP SNMP Options ¶
DELETE/v8_0/rkszones/{id}/snmpAgent
Use this API command to clear SNMPv2 and SNMPv3 agent that belong to a zone.
204Clear zone recovery SSID ¶
DELETE/v8_0/rkszones/{id}/recoverySsid
Use this API command to clear recovery ssid setting of a zone.
204Create Zone of IPv6 ¶
POST/v8_0/rkszones/ipv6
Use this API command to create a new Ruckus Wireless AP zone of IPv6.
Body
{
"domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
"name": "createZoneName",
"description": "description Zone",
"countryCode": "US",
"timezone": {
"customizedTimezone": {
"abbreviation": "TPE",
"gmtOffset": 0,
"gmtOffsetMinute": 0
}
},
"login": {
"apLoginName": "admin",
"apLoginPassword": "admin!234"
},
"dfsChannelEnabled": false,
"wifi24": {
"txPower": "Full",
"channelWidth": 20,
"channel": 0,
"channelRange": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11
]
},
"wifi50": {
"txPower": "-1dB",
"channelWidth": 40,
"indoorChannel": 0,
"outdoorChannel": 0,
"indoorChannelRange": [
36,
40,
44,
48,
149,
153,
157,
161
],
"outdoorChannelRange": [
149,
153,
157,
161
]
},
"protectionMode24": "CTS_ONLY",
"syslog": {
"flowLevel": "GENERAL_LOGS",
"address": "1.1.1.1",
"port": 514,
"protocol": "IPPROTO_TCP",
"secondaryAddress": "2.2.2.2",
"secondaryPort": 514,
"secondaryProtocol": "IPPROTO_TCP",
"facility": "Local0",
"priority": "Error"
},
"smartMonitor": {
"intervalInSec": 10,
"retryThreshold": 3
},
"channelModeEnabled": false,
"tunnelType": "RuckusGRE",
"backgroundScanning24": {
"frequencyInSec": 20
},
"backgroundScanning50": {
"frequencyInSec": 20
},
"clientLoadBalancing24": {
"adjacentRadioThreshold": 12
},
"clientLoadBalancing50": {
"adjacentRadioThreshold": 12
},
"bandBalancing": {
"wifi24Percentage": 10
},
"loadBalancingMethod": "BASED_ON_CLIENT_COUNT",
"rogue": {
"reportType": "All",
"maliciousTypes": null,
"protectionEnabled": true
},
"dosBarringEnable": 0,
"dosBarringPeriod": 60,
"dosBarringThreshold": 5,
"dosBarringCheckPeriod": 30,
"apRebootTimeout": {
"gatewayLossTimeoutInSec": 1800,
"serverLossTimeoutInSec": 7200
},
"location": "location",
"locationAdditionalInfo": "locationAdditionalInfo",
"latitude": 23,
"longitude": 23,
"vlanOverlappingEnabled": false,
"autoChannelSelection24": {
"channelSelectMode": "ChannelFly",
"channelFlyMtbc": 480
},
"autoChannelSelection50": {
"channelSelectMode": "BackgroundScanning",
"channelFlyMtbc": 480
},
"channelEvaluationInterval": 777,
"apMgmtVlan": {
"id": 1,
"mode": "KEEP"
},
"apLatencyInterval": {
"pingEnabled": true
},
"ipsecProfile": {
"id": "ipsecProfileId",
"name": "ipsecProfileName"
},
"altitude": {
"altitudeUnit": "meters",
"altitudeValue": 1
},
"bonjourFencingPolicyEnabled": false,
"snmpAgent": {
"apSnmpEnabled": true,
"snmpV2Agent": [
{
"communityName": "v2Agent",
"notificationEnabled": true,
"readEnabled": true,
"writeEnabled": true,
"notificationType": "TRAP",
"notificationTarget": [
{
"address": "172.19.16.20",
"port": 161
}
]
}
],
"snmpV3Agent": [
{
"userName": "v3Agent",
"authProtocol": "MD5",
"authPassword": "admin!234",
"privProtocol": "DES",
"privPassword": "admin!234",
"notificationEnabled": true,
"readEnabled": true,
"writeEnabled": true,
"notificationType": "TRAP",
"notificationTarget": [
{
"address": "172.19.16.20",
"port": 161
}
]
}
]
},
"recoverySsid": {
"recoverySsidEnabled": true
},
"dhcpSiteConfig": {
"siteEnabled": true,
"siteMode": "EnableOnEachAPs",
"siteProfileIds": [
"75e26590-547f-11e6-9ca7-5a095364c13c",
"869bb532-547f-11e6-9ca7-5a095364c13c"
]
},
"rogueApReportThreshold": 40,
"rogueApAggressivenessMode": 2,
"rogueApJammingDetection": true,
"rogueApJammingThreshold": 40,
"directedMulticastFromWiredClientEnabled": true,
"directedMulticastFromWirelessClientEnabled": true,
"directedMulticastFromNetworkEnabled": false,
"healthCheckSitesEnabled": true,
"healthCheckSites": [
"www.google.com",
"www.live.com:443",
"www.github.com:443",
"source.codeaurora.org:443",
"www.wikipedia.com"
],
"ruckusGreTunnelProfile": {
"id": "f5b92938-aa4e-4d02-90ea-273799ff689b",
"name": "Default Tunnel Profile"
},
"softGreTunnelProflies": [
{
"id": "5a2e41b0-df53-11e7-98e1-08002748d78e",
"name": "softGre1",
"aaaAffinityEnabled": false
},
{
"id": "7803e411-df53-11e7-98e1-08002748d78e",
"name": "softGre2",
"aaaAffinityEnabled": true
},
{
"id": "664de4f1-df53-11e7-98e1-08002748d78e",
"name": "softGre3",
"aaaAffinityEnabled": false
}
],
"ipsecProfiles": [
{
"id": "3fd9aa91-df65-11e7-98e1-08002748d78e",
"name": "ipsec1"
},
{
"id": "832aa331-df65-11e7-98e1-08002748d78e",
"name": "ipsec2"
}
],
"sshTunnelEncryption": "AES128"
}Schema
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"domainId" : {
"description" : "Identifier of the management domain to which the zone belongs",
"type" : "string"
},
"name" : {
"description" : "Name of the zone",
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$"
},
"description" : {
"description" : "Description of the zone",
"type" : [ "string", "null" ],
"maxLength" : 64
},
"version" : {
"description" : "AP firmware version of the zone",
"type" : "string",
"pattern" : "^\d+\.\d+\.\d+\.\d+\.\d+$"
},
"countryCode" : {
"description" : "Country code of the zone",
"type" : "string"
},
"login" : {
"description" : "AP administrator account",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"apLoginName" : {
"description" : "User name of the AP administrator",
"type" : "string",
"maxLength" : 64,
"pattern" : "^((?!\$\()[!-_a-~]){1,64}$"
},
"apLoginPassword" : {
"description" : "Password of the AP administrator",
"type" : "string",
"maxLength" : 64,
"pattern" : ".*(?=.{8,})(?=.*[a-zA-Z])(?=.*[0-9])(?=.*[_`~!@#$%^&*\(\)\[\]\{\}|;:'\",.\<>\/?=+-]).*"
}
},
"required" : [ "apLoginName", "apLoginPassword" ]
},
"timezone" : {
"description" : "Either systemTimezone or customizedTimezone must be specified",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"systemTimezone" : {
"description" : "System defined time zone, please refer to the “Overview > Time Zone” list",
"type" : "string"
},
"customizedTimezone" : {
"description" : "User defined time zone",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"abbreviation" : {
"description" : "Time zone abbreviation",
"type" : "string",
"pattern" : "^[a-zA-Z]{3,4}$"
},
"gmtOffset" : {
"description" : "GMT offset",
"type" : "integer",
"minimum" : -11,
"maximum" : 14
},
"gmtOffsetMinute" : {
"description" : "GMT offset minute",
"type" : "integer",
"minimum" : 0,
"maximum" : 59
},
"start" : {
"description" : "Daylight saving time start",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"month" : {
"description" : "Month when daylight saving time begins",
"type" : "integer",
"enum" : [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ]
},
"week" : {
"description" : "Week of the month (1 for the first week, 2 for the second week, and so on)",
"type" : "integer",
"enum" : [ 1, 2, 3, 4, 5 ]
},
"day" : {
"description" : "Day of the week (0 for Sunday, 1 for Monday, 2 for Tuesday, and so on)",
"type" : "integer",
"enum" : [ 0, 1, 2, 3, 4, 5, 6 ]
},
"hour" : {
"description" : "Hour of the day",
"type" : "integer",
"minimum" : 0,
"maximum" : 23
}
},
"required" : [ "month", "week", "day", "hour" ]
},
"end" : {
"description" : "Daylight saving time end",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"month" : {
"description" : "Month when daylight saving time begins",
"type" : "integer",
"enum" : [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ]
},
"week" : {
"description" : "Week of the month (1 for the first week, 2 for the second week, and so on)",
"type" : "integer",
"enum" : [ 1, 2, 3, 4, 5 ]
},
"day" : {
"description" : "Day of the week (0 for Sunday, 1 for Monday, 2 for Tuesday, and so on)",
"type" : "integer",
"enum" : [ 0, 1, 2, 3, 4, 5, 6 ]
},
"hour" : {
"description" : "Hour of the day",
"type" : "integer",
"minimum" : 0,
"maximum" : 23
}
},
"required" : [ "month", "week", "day", "hour" ]
}
},
"required" : [ "abbreviation", "gmtOffset", "gmtOffsetMinute" ]
}
}
},
"mesh" : {
"description" : "Mesh configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"ssid" : {
"description" : "SSID of the mesh network",
"type" : "string"
},
"passphrase" : {
"description" : "Passphrase for the mesh network",
"type" : "string"
},
"meshRadioIdx" : {
"description" : "Mesh radio index",
"type" : "string",
"enum" : [ "Radio24G", "Radio5G" ],
"default" : "Radio5G"
},
"zeroTouchStatus" : {
"type" : "boolean"
}
}
},
"dfsChannelEnabled" : {
"description" : "DFS Channel enabled configuration of the zone, only for the US country code .",
"type" : "boolean",
"default" : false
},
"cbandChannelEnabled" : {
"description" : "5.8Ghz channels enabled configuration of the zone.",
"type" : "boolean",
"default" : false
},
"cbandChannelLicenseEnabled" : {
"description" : "5.8Ghz channels license enabled configuration of the zone.",
"type" : "boolean",
"default" : false
},
"wifi24" : {
"description" : "AP 2.4GHz radio configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"autoCellSizing" : {
"description" : "Auto Cell Sizing",
"type" : "boolean"
},
"txPower" : {
"description" : "Transmission power",
"type" : "string",
"enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
"default" : "Full"
},
"channelWidth" : {
"description" : "Channel width. Zero (0) means Auto.",
"type" : "integer",
"enum" : [ 0, 20, 40 ],
"default" : 0
},
"channel" : {
"description" : "Channel number",
"type" : "integer"
},
"channelRange" : {
"description" : "Channel range options",
"type" : "array",
"items" : {
"type" : "integer"
}
}
}
},
"wifi50" : {
"description" : "AP 5GHz radio configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"autoCellSizing" : {
"description" : "Auto Cell Sizing",
"type" : "boolean"
},
"txPower" : {
"description" : "Transmission power",
"type" : "string",
"enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
"default" : "Full"
},
"channelWidth" : {
"description" : "Channel width. Zero (0) means Auto. 8080 means 80+80MHz",
"type" : "integer",
"enum" : [ 0, 20, 40, 80, 8080, 160 ],
"default" : 0
},
"indoorChannel" : {
"description" : "Channel number for Indoor AP",
"type" : "integer"
},
"outdoorChannel" : {
"description" : "Channel number for Outdoor AP",
"type" : "integer"
},
"indoorSecondaryChannel" : {
"description" : "Secondary channel number for Indoor AP (channelWidth is 80+80MHz only)",
"type" : "integer"
},
"outdoorSecondaryChannel" : {
"description" : "Secondary channel number for outdoor AP (channelWidth is 80+80MHz only)",
"type" : "integer"
},
"indoorChannelRange" : {
"description" : "Channel range options for Indoor AP",
"type" : "array",
"items" : {
"type" : "integer"
}
},
"outdoorChannelRange" : {
"description" : "Channel range options for outdoor AP",
"type" : "array",
"items" : {
"type" : "integer"
}
}
}
},
"protectionMode24" : {
"description" : "AP 2.4GHz Protection mode configuration of the zone.",
"type" : "string",
"enum" : [ "NONE", "CTS_ONLY", "RTS_CTS" ],
"default" : "RTS_CTS"
},
"syslog" : {
"description" : "Syslog configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"flowLevel" : {
"description" : "Flow Level of the syslog",
"type" : "string",
"enum" : [ "GENERAL_LOGS", "CLIENT_FLOW", "ALL" ],
"default" : "GENERAL_LOGS"
},
"address" : {
"description" : "Address of the syslog server.",
"type" : "string"
},
"port" : {
"description" : "Port number of the syslog server",
"type" : "integer",
"default" : 514,
"minimum" : 1,
"maximum" : 65535
},
"protocol" : {
"description" : "Protocol of the syslog server",
"type" : "string",
"enum" : [ "IPPROTO_TCP", "IPPROTO_UDP" ],
"default" : "IPPROTO_TCP"
},
"secondaryAddress" : {
"description" : "Secondary Server Address of the syslog server",
"type" : "string"
},
"secondaryPort" : {
"description" : "Secondary Server Port of the syslog server",
"type" : "integer",
"default" : 514,
"minimum" : 1,
"maximum" : 65535
},
"secondaryProtocol" : {
"description" : "Secondary Server Protocol of the syslog server",
"type" : "string",
"enum" : [ "IPPROTO_TCP", "IPPROTO_UDP" ],
"default" : "IPPROTO_TCP"
},
"facility" : {
"description" : "Facility of the syslog server",
"type" : "string",
"enum" : [ "Keep_Original", "Local0", "Local1", "Local2", "Local3", "Local4", "Local5", "Local6", "Local7" ],
"default" : "Keep_Original"
},
"priority" : {
"description" : "Priority of the log messages",
"type" : "string",
"enum" : [ "Emergency", "Alert", "Critical", "Error", "Warning", "Notice", "Info", "All" ],
"default" : "Error"
}
}
},
"smartMonitor" : {
"description" : "Smart monitor configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"intervalInSec" : {
"description" : "Interval in seconds. This is required if smartMonitor is enabled",
"type" : "integer",
"default" : 10,
"minimum" : 5,
"maximum" : 60
},
"retryThreshold" : {
"description" : "Retry threshold. This is required if smartMonitor is enabled",
"type" : "integer",
"default" : 3,
"minimum" : 1,
"maximum" : 10
}
}
},
"clientAdmissionControl24" : {
"description" : "AP client admission control 2.4GHz radio configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"maxRadioLoadPercent" : {
"description" : "Maximum radio load percentage.",
"type" : "integer",
"default" : 75,
"minimum" : 50,
"maximum" : 100
},
"minClientCount" : {
"description" : "Minimum client count number.",
"type" : "integer",
"default" : 10,
"minimum" : 0,
"maximum" : 100
},
"minClientThroughputMbps" : {
"description" : "Minimum client throughput in Mbps.",
"type" : "number",
"default" : 0,
"minimum" : 0,
"maximum" : 100
}
}
},
"clientAdmissionControl50" : {
"description" : "AP client admission control 5GHz radio configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"maxRadioLoadPercent" : {
"description" : "Maximum radio load percentage.",
"type" : "integer",
"default" : 75,
"minimum" : 50,
"maximum" : 100
},
"minClientCount" : {
"description" : "Minimum client count number.",
"type" : "integer",
"default" : 10,
"minimum" : 0,
"maximum" : 100
},
"minClientThroughputMbps" : {
"description" : "Minimum client throughput in Mbps.",
"type" : "number",
"default" : 0,
"minimum" : 0,
"maximum" : 100
}
}
},
"channelModeEnabled" : {
"description" : "Channel mode configuration of the zone.",
"type" : "boolean",
"default" : false
},
"tunnelType" : {
"description" : "Tunnel type configuration of the zone. No_Tunneled is for IPv6 mode",
"type" : "string",
"enum" : [ "No_Tunneled", "RuckusGRE", "SoftGRE", "SoftGREIpsec" ],
"default" : "RuckusGRE"
},
"tunnelProfile" : {
"description" : "Tunnel type configuration of the zone.",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"backgroundScanning24" : {
"description" : "Background scanning on 2.4GHz radio configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"frequencyInSec" : {
"description" : "Frequency in second",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535,
"default" : 20
}
}
},
"backgroundScanning50" : {
"description" : "Background scanning on 5GHz radio configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"frequencyInSec" : {
"description" : "Frequency in second",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535,
"default" : 20
}
}
},
"clientLoadBalancing24" : {
"description" : "Client load balancing on 2.4GHz radio configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"adjacentRadioThreshold" : {
"description" : "Adjacent radio threshold",
"type" : "integer",
"minimum" : 1,
"maximum" : 100
}
}
},
"clientLoadBalancing50" : {
"description" : "Client load balancing on 5GHz radio configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"adjacentRadioThreshold" : {
"description" : "Adjacent radio threshold",
"type" : "integer",
"minimum" : 1,
"maximum" : 100
}
}
},
"bandBalancing" : {
"description" : "Band balancing configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"mode" : {
"description" : "Band Balancing Mode: BASIC-Withholds probe and authentication responses at connetcion time in heavily loaded band to balance clients to the other band, PROACTIVE-Uses BASIC functionality and actively rebalances clients via 802.11v BTM, STRICT-Uses PROACTIVE functionality and forcefully rebalances clients via 802.11v BTM",
"type" : "string",
"enum" : [ "BASIC", "PROACTIVE", "STRICT" ],
"default" : "BASIC"
},
"wifi24Percentage" : {
"description" : "Percentage of client load on 2.4GHz radio band",
"type" : "integer",
"minimum" : 0,
"maximum" : 100,
"default" : 25
}
}
},
"loadBalancingMethod" : {
"type" : "string",
"enum" : [ "BASED_ON_CLIENT_COUNT", "BASED_ON_CAPACITY", "OFF" ],
"default" : "BASED_ON_CLIENT_COUNT"
},
"rogue" : {
"description" : "Rogue AP detection configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"reportType" : {
"description" : "Report type",
"type" : "string",
"enum" : [ "All", "Malicious" ]
},
"maliciousTypes" : {
"description" : "Malicious type when reportType is Malicious",
"type" : [ "array", "null" ],
"items" : {
"type" : "string",
"enum" : [ "SSIDSpoofing", "SameNetwork", "MACSpoofing" ]
}
},
"protectionEnabled" : {
"description" : "Protection enabled",
"type" : "boolean"
}
}
},
"dosBarringEnable" : {
"description" : "Enable DoS Protection(Barring UE) of the zone.",
"type" : "integer"
},
"dosBarringPeriod" : {
"description" : "DoS Protection(Barring UE) blocking period of the zone.",
"type" : "integer",
"default" : 60
},
"dosBarringThreshold" : {
"description" : "DoS Protection(Barring UE) threshold of the zone.",
"type" : "integer",
"default" : 5
},
"dosBarringCheckPeriod" : {
"description" : "DoS Protection(Barring UE) check period of the zone.",
"type" : "integer",
"default" : 30
},
"locationBasedService" : {
"description" : "Location based service configuration of the zone.",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"apRebootTimeout" : {
"description" : "AP reboot timeout of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"gatewayLossTimeoutInSec" : {
"description" : "Gateway loss timeout in second",
"type" : "integer",
"enum" : [ 0, 1800, 3600, 5400, 7200, 9000, 10800, 12600, 14400, 16200, 18000, 19800, 23400, 25200, 27000, 28800, 30600, 32400, 34200, 36000, 37800, 39600, 41400, 43200, 45000, 46800, 48600, 50400, 52200, 54000, 55800, 57600, 59400, 61200, 63000, 64800, 66600, 68400, 70200, 72000, 73800, 75600, 77400, 79200, 81000, 82800, 84600, 86400 ],
"default" : 1800
},
"serverLossTimeoutInSec" : {
"description" : "Server loss timeout in second",
"type" : "integer",
"enum" : [ 0, 7200, 14400, 21600, 28800, 36000, 43200, 50400, 57600, 64800, 72000, 79200, 86400 ],
"default" : 7200
}
}
},
"location" : {
"description" : "Location of the zone.",
"type" : "string"
},
"locationAdditionalInfo" : {
"description" : "Location additional info of the zone.",
"type" : "string",
"pattern" : "^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
},
"altitude" : {
"description" : "GPS Altitude",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"altitudeUnit" : {
"description" : "altitude unit",
"type" : "string",
"enum" : [ "meters", "floor" ],
"default" : "meters"
},
"altitudeValue" : {
"description" : "altitude value",
"type" : "integer"
}
}
},
"latitude" : {
"description" : "Latitude coordinate (in decimal format) of the zone",
"type" : "number"
},
"longitude" : {
"description" : "Longitude coordinate (in decimal format) of the zone",
"type" : "number"
},
"vlanOverlappingEnabled" : {
"description" : "VLAN pooling overlapping of the zone",
"type" : "boolean"
},
"nodeAffinityProfile" : {
"description" : "Node affinity profile of the zone.",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"venueProfile" : {
"description" : "Venue profile configuration of the zone.",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"autoChannelSelection24" : {
"description" : "client load balancing on Radio 2.4G, auto channel selection mode",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"channelSelectMode" : {
"description" : "Channel Select Mode",
"type" : "string",
"enum" : [ "None", "BackgroundScanning", "ChannelFly" ],
"default" : "BackgroundScanning"
},
"channelFlyMtbc" : {
"description" : "ChannelFly MTBC",
"type" : "integer",
"default" : 480,
"minimum" : 100,
"maximum" : 1440
}
}
},
"autoChannelSelection50" : {
"description" : "client load balancing on Radio 5G, auto channel selection mode",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"channelSelectMode" : {
"description" : "Channel Select Mode",
"type" : "string",
"enum" : [ "None", "BackgroundScanning", "ChannelFly" ],
"default" : "BackgroundScanning"
},
"channelFlyMtbc" : {
"description" : "ChannelFly MTBC",
"type" : "integer",
"default" : 480,
"minimum" : 100,
"maximum" : 1440
}
}
},
"channelEvaluationInterval" : {
"description" : "channel evaluation Interval of the zone",
"type" : "integer",
"default" : 600,
"minimum" : 60,
"maximum" : 3600
},
"apMgmtVlan" : {
"description" : "ap Management Vlan of the zone",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"mode" : {
"description" : "Vlan Mode of the zone",
"type" : "string",
"enum" : [ "KEEP", "USER_DEFINED" ],
"default" : "KEEP"
},
"id" : {
"description" : "Vlan id of the zone",
"type" : "integer",
"default" : "1"
}
}
},
"apLatencyInterval" : {
"description" : "AP latency interval",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"pingEnabled" : {
"description" : "AP ping latency enabled",
"type" : "boolean",
"default" : true
}
}
},
"ipsecProfile" : {
"description" : "ipsec profile configuration of the Zone.",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"ipv6TrafficFilterEnabled" : {
"description" : "IPv6 Traffic filtering on the AP",
"type" : "integer"
},
"bonjourFencingPolicyEnabled" : {
"description" : "Enable Bonjour Fencing Policy on the AP",
"type" : "boolean"
},
"bonjourFencingPolicy" : {
"description" : "Bonjour Fencing Policy on the AP",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"dhcpSiteConfig" : {
"description" : "DHCP Site Configuration in Zone",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"siteEnabled" : {
"description" : "DHCP Service Enabling Status",
"type" : "boolean"
},
"dwpdEnabled" : {
"description" : "DHCP Service Dynamic WAN Port Detection",
"type" : "boolean"
},
"manualSelect" : {
"description" : "DHCP Service AP Selection Mode. This value is effective when the siteMode is EnableOnMultipleAPs.",
"type" : "boolean"
},
"siteMode" : {
"description" : "DHCP Service mode",
"type" : "string",
"enum" : [ "EnableOnEachAPs", "EnableOnMultipleAPs", "EnableOnHierarchicalAPs" ]
},
"eth0ProfileId" : {
"type" : "integer"
},
"eth1ProfileId" : {
"type" : "integer"
},
"siteAps" : {
"type" : "array",
"items" : {
"type" : "object",
"description" : "DHCP Site selected APs. The content is effective when the siteMode is EnableOnMultipleAPs.",
"additionalProperties" : false,
"properties" : {
"apMac" : {
"type" : "string"
},
"apName" : {
"type" : "string"
},
"apStatus" : {
"type" : "string",
"enum" : [ "Online", "Offline", "Flagged" ]
},
"apServerEnabled" : {
"type" : "boolean"
},
"apServerPrimary" : {
"type" : "boolean"
},
"apServerIp" : {
"type" : [ "string", "null" ]
},
"apGatewayIp" : {
"type" : "string"
}
}
}
},
"siteProfileIds" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
}
},
"snmpAgent" : {
"description" : "AP SNMP Options",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"apSnmpEnabled" : {
"description" : "Enable AP SNMP",
"type" : "boolean"
},
"snmpV2Agent" : {
"description" : "Community List of the SNMP V2 Agent.",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"communityName" : {
"description" : "name of the SNMP Community.",
"type" : "string"
},
"readEnabled" : {
"description" : "read privilege of the SNMP Coummunity",
"type" : "boolean"
},
"writeEnabled" : {
"description" : "write privilege of the SNMP Coummunity",
"type" : "boolean"
},
"notificationEnabled" : {
"description" : "notification privilege of the SNMP Coummunity",
"type" : "boolean"
},
"notificationType" : {
"description" : "type of the notification privilege",
"type" : "string",
"enum" : [ "TRAP", "INFORM" ]
},
"notificationTarget" : {
"description" : "Trap List of the SNMP Coummunity",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"address" : {
"description" : "address of the SNMP Trap",
"type" : "string"
},
"port" : {
"description" : "port number of the SNMP Trap",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
}
},
"required" : [ "address", "port" ]
}
}
},
"required" : [ "communityName" ]
}
},
"snmpV3Agent" : {
"description" : "User List of the SNMP V3 Agent.",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"userName" : {
"description" : "name of the SNMP User.",
"type" : "string"
},
"authProtocol" : {
"description" : "authProtocol of the SNMP User.",
"type" : "string",
"enum" : [ "NONE", "MD5", "SHA" ]
},
"authPassword" : {
"description" : "authPassword of the SNMP User.",
"type" : "string",
"minLength" : 8
},
"privProtocol" : {
"description" : "privProtocol of the SNMP User.",
"type" : "string",
"enum" : [ "NONE", "DES", "AES" ]
},
"privPassword" : {
"description" : "privPassword of the SNMP User.",
"type" : "string",
"minLength" : 8
},
"readEnabled" : {
"description" : "read privilege of the SNMP User",
"type" : "boolean"
},
"writeEnabled" : {
"description" : "write privilege of the SNMP User",
"type" : "boolean"
},
"notificationEnabled" : {
"description" : "notification privilege of the SNMP User",
"type" : "boolean"
},
"notificationType" : {
"description" : "type of the notification privilege",
"type" : "string",
"enum" : [ "TRAP", "INFORM" ]
},
"notificationTarget" : {
"description" : "Trap List of the SNMP User",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"address" : {
"description" : "address of the SNMP Trap",
"type" : "string"
},
"port" : {
"description" : "port number of the SNMP Trap",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
}
},
"required" : [ "address", "port" ]
}
}
},
"required" : [ "userName" ]
}
}
}
},
"recoverySsid" : {
"description" : "Recovery SSID",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"recoverySsidEnabled" : {
"description" : "recovery ssid enable/disable",
"type" : "boolean"
}
}
},
"clusterRedundancyEnabled" : {
"description" : "Enable Cluster redundancy on zone.",
"type" : "boolean",
"default" : false
},
"rogueApReportThreshold" : {
"description" : "Rogue AP report will leave out all entries that have signal strength lower than this threshold.",
"type" : "integer"
},
"rogueApAggressivenessMode" : {
"description" : "Adjust the frequency interval to de-authenticate rogue APs.",
"type" : "integer"
},
"rogueApJammingDetection" : {
"description" : "Enable jamming detection.",
"type" : "boolean",
"default" : false
},
"rogueApJammingThreshold" : {
"type" : "integer"
},
"directedMulticastFromWiredClientEnabled" : {
"description" : "Directed multicast from wired client.",
"type" : "boolean",
"default" : true
},
"directedMulticastFromWirelessClientEnabled" : {
"description" : "Directed multicast from wireless client.",
"type" : "boolean",
"default" : true
},
"directedMulticastFromNetworkEnabled" : {
"description" : "Directed multicast from network.",
"type" : "boolean",
"default" : true
},
"healthCheckSitesEnabled" : {
"description" : "Enabled Health Check Sites. ",
"type" : "boolean",
"default" : false
},
"healthCheckSites" : {
"description" : "Health Check Sites.",
"type" : "array",
"items" : {
"type" : "string"
}
},
"ruckusGreTunnelProfile" : {
"description" : "Ruckus GRE Profile for Multiple Tunnel (Start from SZ 5.0)",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"softGreTunnelProflies" : {
"description" : "SoftGRE Profiles for Multiple Tunnel (Start from SZ 5.0)",
"type" : "array",
"items" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"aaaAffinityEnabled" : {
"type" : "boolean"
}
}
}
},
"ipsecProfiles" : {
"description" : "Ipsec profile for Multiple Tunnel (Start from SZ 5.0)",
"type" : "array",
"items" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
}
},
"sshTunnelEncryption" : {
"type" : "string",
"enum" : [ "AES128", "AES256" ],
"default" : "AES128"
}
},
"required" : [ "name", "login" ]
}201Body
{
"id": "zoneUUID"
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
}
}
}Create Zone of Dual ¶
POST/v8_0/rkszones/dual
Use this API command to create a new Ruckus Wireless AP zone of IPv4/IPv6.
Body
{
"domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
"name": "createZoneName",
"description": "description Zone",
"countryCode": "US",
"timezone": {
"customizedTimezone": {
"abbreviation": "TPE",
"gmtOffset": 0,
"gmtOffsetMinute": 0
}
},
"login": {
"apLoginName": "admin",
"apLoginPassword": "admin!234"
},
"dfsChannelEnabled": false,
"wifi24": {
"txPower": "Full",
"channelWidth": 20,
"channel": 0,
"channelRange": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11
]
},
"wifi50": {
"txPower": "-1dB",
"channelWidth": 40,
"indoorChannel": 0,
"outdoorChannel": 0,
"indoorChannelRange": [
36,
40,
44,
48,
149,
153,
157,
161
],
"outdoorChannelRange": [
149,
153,
157,
161
]
},
"protectionMode24": "CTS_ONLY",
"syslog": {
"flowLevel": "GENERAL_LOGS",
"address": "1.1.1.1",
"port": 514,
"protocol": "IPPROTO_TCP",
"secondaryAddress": "2.2.2.2",
"secondaryPort": 514,
"secondaryProtocol": "IPPROTO_TCP",
"facility": "Local0",
"priority": "Error"
},
"smartMonitor": {
"intervalInSec": 10,
"retryThreshold": 3
},
"channelModeEnabled": false,
"tunnelType": "RuckusGRE",
"backgroundScanning24": {
"frequencyInSec": 20
},
"backgroundScanning50": {
"frequencyInSec": 20
},
"clientLoadBalancing24": {
"adjacentRadioThreshold": 12
},
"clientLoadBalancing50": {
"adjacentRadioThreshold": 12
},
"bandBalancing": {
"wifi24Percentage": 10
},
"loadBalancingMethod": "BASED_ON_CLIENT_COUNT",
"rogue": {
"reportType": "All",
"maliciousTypes": null,
"protectionEnabled": true
},
"dosBarringEnable": 0,
"dosBarringPeriod": 60,
"dosBarringThreshold": 5,
"dosBarringCheckPeriod": 30,
"apRebootTimeout": {
"gatewayLossTimeoutInSec": 1800,
"serverLossTimeoutInSec": 7200
},
"location": "location",
"locationAdditionalInfo": "locationAdditionalInfo",
"latitude": 23,
"longitude": 23,
"vlanOverlappingEnabled": false,
"autoChannelSelection24": {
"channelSelectMode": "ChannelFly",
"channelFlyMtbc": 480
},
"autoChannelSelection50": {
"channelSelectMode": "BackgroundScanning",
"channelFlyMtbc": 480
},
"channelEvaluationInterval": 777,
"apMgmtVlan": {
"id": 1,
"mode": "KEEP"
},
"apLatencyInterval": {
"pingEnabled": true
},
"ipsecProfile": {
"id": "ipsecProfileId",
"name": "ipsecProfileName"
},
"altitude": {
"altitudeUnit": "meters",
"altitudeValue": 1
},
"bonjourFencingPolicyEnabled": false,
"snmpAgent": {
"apSnmpEnabled": true,
"snmpV2Agent": [
{
"communityName": "v2Agent",
"notificationEnabled": true,
"readEnabled": true,
"writeEnabled": true,
"notificationType": "TRAP",
"notificationTarget": [
{
"address": "172.19.16.20",
"port": 161
}
]
}
],
"snmpV3Agent": [
{
"userName": "v3Agent",
"authProtocol": "MD5",
"authPassword": "admin!234",
"privProtocol": "DES",
"privPassword": "admin!234",
"notificationEnabled": true,
"readEnabled": true,
"writeEnabled": true,
"notificationType": "TRAP",
"notificationTarget": [
{
"address": "172.19.16.20",
"port": 161
}
]
}
]
},
"recoverySsid": {
"recoverySsidEnabled": true
},
"dhcpSiteConfig": {
"siteEnabled": true,
"siteMode": "EnableOnEachAPs",
"siteProfileIds": [
"75e26590-547f-11e6-9ca7-5a095364c13c",
"869bb532-547f-11e6-9ca7-5a095364c13c"
]
},
"rogueApReportThreshold": 40,
"rogueApAggressivenessMode": 2,
"rogueApJammingDetection": true,
"rogueApJammingThreshold": 40,
"directedMulticastFromWiredClientEnabled": true,
"directedMulticastFromWirelessClientEnabled": true,
"directedMulticastFromNetworkEnabled": false,
"healthCheckSitesEnabled": true,
"healthCheckSites": [
"www.google.com",
"www.live.com:443",
"www.github.com:443",
"source.codeaurora.org:443",
"www.wikipedia.com"
],
"ruckusGreTunnelProfile": {
"id": "f5b92938-aa4e-4d02-90ea-273799ff689b",
"name": "Default Tunnel Profile"
},
"softGreTunnelProflies": [
{
"id": "5a2e41b0-df53-11e7-98e1-08002748d78e",
"name": "softGre1",
"aaaAffinityEnabled": false
},
{
"id": "7803e411-df53-11e7-98e1-08002748d78e",
"name": "softGre2",
"aaaAffinityEnabled": true
},
{
"id": "664de4f1-df53-11e7-98e1-08002748d78e",
"name": "softGre3",
"aaaAffinityEnabled": false
}
],
"ipsecProfiles": [
{
"id": "3fd9aa91-df65-11e7-98e1-08002748d78e",
"name": "ipsec1"
},
{
"id": "832aa331-df65-11e7-98e1-08002748d78e",
"name": "ipsec2"
}
],
"sshTunnelEncryption": "AES128"
}Schema
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"domainId" : {
"description" : "Identifier of the management domain to which the zone belongs",
"type" : "string"
},
"name" : {
"description" : "Name of the zone",
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$"
},
"description" : {
"description" : "Description of the zone",
"type" : [ "string", "null" ],
"maxLength" : 64
},
"version" : {
"description" : "AP firmware version of the zone",
"type" : "string",
"pattern" : "^\d+\.\d+\.\d+\.\d+\.\d+$"
},
"countryCode" : {
"description" : "Country code of the zone",
"type" : "string"
},
"login" : {
"description" : "AP administrator account",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"apLoginName" : {
"description" : "User name of the AP administrator",
"type" : "string",
"maxLength" : 64,
"pattern" : "^((?!\$\()[!-_a-~]){1,64}$"
},
"apLoginPassword" : {
"description" : "Password of the AP administrator",
"type" : "string",
"maxLength" : 64,
"pattern" : ".*(?=.{8,})(?=.*[a-zA-Z])(?=.*[0-9])(?=.*[_`~!@#$%^&*\(\)\[\]\{\}|;:'\",.\<>\/?=+-]).*"
}
},
"required" : [ "apLoginName", "apLoginPassword" ]
},
"timezone" : {
"description" : "Either systemTimezone or customizedTimezone must be specified",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"systemTimezone" : {
"description" : "System defined time zone, please refer to the “Overview > Time Zone” list",
"type" : "string"
},
"customizedTimezone" : {
"description" : "User defined time zone",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"abbreviation" : {
"description" : "Time zone abbreviation",
"type" : "string",
"pattern" : "^[a-zA-Z]{3,4}$"
},
"gmtOffset" : {
"description" : "GMT offset",
"type" : "integer",
"minimum" : -11,
"maximum" : 14
},
"gmtOffsetMinute" : {
"description" : "GMT offset minute",
"type" : "integer",
"minimum" : 0,
"maximum" : 59
},
"start" : {
"description" : "Daylight saving time start",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"month" : {
"description" : "Month when daylight saving time begins",
"type" : "integer",
"enum" : [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ]
},
"week" : {
"description" : "Week of the month (1 for the first week, 2 for the second week, and so on)",
"type" : "integer",
"enum" : [ 1, 2, 3, 4, 5 ]
},
"day" : {
"description" : "Day of the week (0 for Sunday, 1 for Monday, 2 for Tuesday, and so on)",
"type" : "integer",
"enum" : [ 0, 1, 2, 3, 4, 5, 6 ]
},
"hour" : {
"description" : "Hour of the day",
"type" : "integer",
"minimum" : 0,
"maximum" : 23
}
},
"required" : [ "month", "week", "day", "hour" ]
},
"end" : {
"description" : "Daylight saving time end",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"month" : {
"description" : "Month when daylight saving time begins",
"type" : "integer",
"enum" : [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ]
},
"week" : {
"description" : "Week of the month (1 for the first week, 2 for the second week, and so on)",
"type" : "integer",
"enum" : [ 1, 2, 3, 4, 5 ]
},
"day" : {
"description" : "Day of the week (0 for Sunday, 1 for Monday, 2 for Tuesday, and so on)",
"type" : "integer",
"enum" : [ 0, 1, 2, 3, 4, 5, 6 ]
},
"hour" : {
"description" : "Hour of the day",
"type" : "integer",
"minimum" : 0,
"maximum" : 23
}
},
"required" : [ "month", "week", "day", "hour" ]
}
},
"required" : [ "abbreviation", "gmtOffset", "gmtOffsetMinute" ]
}
}
},
"mesh" : {
"description" : "Mesh configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"ssid" : {
"description" : "SSID of the mesh network",
"type" : "string"
},
"passphrase" : {
"description" : "Passphrase for the mesh network",
"type" : "string"
},
"meshRadioIdx" : {
"description" : "Mesh radio index",
"type" : "string",
"enum" : [ "Radio24G", "Radio5G" ],
"default" : "Radio5G"
},
"zeroTouchStatus" : {
"type" : "boolean"
}
}
},
"dfsChannelEnabled" : {
"description" : "DFS Channel enabled configuration of the zone, only for the US country code .",
"type" : "boolean",
"default" : false
},
"cbandChannelEnabled" : {
"description" : "5.8Ghz channels enabled configuration of the zone.",
"type" : "boolean",
"default" : false
},
"cbandChannelLicenseEnabled" : {
"description" : "5.8Ghz channels license enabled configuration of the zone.",
"type" : "boolean",
"default" : false
},
"wifi24" : {
"description" : "AP 2.4GHz radio configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"autoCellSizing" : {
"description" : "Auto Cell Sizing",
"type" : "boolean"
},
"txPower" : {
"description" : "Transmission power",
"type" : "string",
"enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
"default" : "Full"
},
"channelWidth" : {
"description" : "Channel width. Zero (0) means Auto.",
"type" : "integer",
"enum" : [ 0, 20, 40 ],
"default" : 0
},
"channel" : {
"description" : "Channel number",
"type" : "integer"
},
"channelRange" : {
"description" : "Channel range options",
"type" : "array",
"items" : {
"type" : "integer"
}
}
}
},
"wifi50" : {
"description" : "AP 5GHz radio configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"autoCellSizing" : {
"description" : "Auto Cell Sizing",
"type" : "boolean"
},
"txPower" : {
"description" : "Transmission power",
"type" : "string",
"enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
"default" : "Full"
},
"channelWidth" : {
"description" : "Channel width. Zero (0) means Auto. 8080 means 80+80MHz",
"type" : "integer",
"enum" : [ 0, 20, 40, 80, 8080, 160 ],
"default" : 0
},
"indoorChannel" : {
"description" : "Channel number for Indoor AP",
"type" : "integer"
},
"outdoorChannel" : {
"description" : "Channel number for Outdoor AP",
"type" : "integer"
},
"indoorSecondaryChannel" : {
"description" : "Secondary channel number for Indoor AP (channelWidth is 80+80MHz only)",
"type" : "integer"
},
"outdoorSecondaryChannel" : {
"description" : "Secondary channel number for outdoor AP (channelWidth is 80+80MHz only)",
"type" : "integer"
},
"indoorChannelRange" : {
"description" : "Channel range options for Indoor AP",
"type" : "array",
"items" : {
"type" : "integer"
}
},
"outdoorChannelRange" : {
"description" : "Channel range options for outdoor AP",
"type" : "array",
"items" : {
"type" : "integer"
}
}
}
},
"protectionMode24" : {
"description" : "AP 2.4GHz Protection mode configuration of the zone.",
"type" : "string",
"enum" : [ "NONE", "CTS_ONLY", "RTS_CTS" ],
"default" : "RTS_CTS"
},
"syslog" : {
"description" : "Syslog configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"flowLevel" : {
"description" : "Flow Level of the syslog",
"type" : "string",
"enum" : [ "GENERAL_LOGS", "CLIENT_FLOW", "ALL" ],
"default" : "GENERAL_LOGS"
},
"address" : {
"description" : "Address of the syslog server.",
"type" : "string"
},
"port" : {
"description" : "Port number of the syslog server",
"type" : "integer",
"default" : 514,
"minimum" : 1,
"maximum" : 65535
},
"protocol" : {
"description" : "Protocol of the syslog server",
"type" : "string",
"enum" : [ "IPPROTO_TCP", "IPPROTO_UDP" ],
"default" : "IPPROTO_TCP"
},
"secondaryAddress" : {
"description" : "Secondary Server Address of the syslog server",
"type" : "string"
},
"secondaryPort" : {
"description" : "Secondary Server Port of the syslog server",
"type" : "integer",
"default" : 514,
"minimum" : 1,
"maximum" : 65535
},
"secondaryProtocol" : {
"description" : "Secondary Server Protocol of the syslog server",
"type" : "string",
"enum" : [ "IPPROTO_TCP", "IPPROTO_UDP" ],
"default" : "IPPROTO_TCP"
},
"facility" : {
"description" : "Facility of the syslog server",
"type" : "string",
"enum" : [ "Keep_Original", "Local0", "Local1", "Local2", "Local3", "Local4", "Local5", "Local6", "Local7" ],
"default" : "Keep_Original"
},
"priority" : {
"description" : "Priority of the log messages",
"type" : "string",
"enum" : [ "Emergency", "Alert", "Critical", "Error", "Warning", "Notice", "Info", "All" ],
"default" : "Error"
}
}
},
"smartMonitor" : {
"description" : "Smart monitor configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"intervalInSec" : {
"description" : "Interval in seconds. This is required if smartMonitor is enabled",
"type" : "integer",
"default" : 10,
"minimum" : 5,
"maximum" : 60
},
"retryThreshold" : {
"description" : "Retry threshold. This is required if smartMonitor is enabled",
"type" : "integer",
"default" : 3,
"minimum" : 1,
"maximum" : 10
}
}
},
"clientAdmissionControl24" : {
"description" : "AP client admission control 2.4GHz radio configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"maxRadioLoadPercent" : {
"description" : "Maximum radio load percentage.",
"type" : "integer",
"default" : 75,
"minimum" : 50,
"maximum" : 100
},
"minClientCount" : {
"description" : "Minimum client count number.",
"type" : "integer",
"default" : 10,
"minimum" : 0,
"maximum" : 100
},
"minClientThroughputMbps" : {
"description" : "Minimum client throughput in Mbps.",
"type" : "number",
"default" : 0,
"minimum" : 0,
"maximum" : 100
}
}
},
"clientAdmissionControl50" : {
"description" : "AP client admission control 5GHz radio configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"maxRadioLoadPercent" : {
"description" : "Maximum radio load percentage.",
"type" : "integer",
"default" : 75,
"minimum" : 50,
"maximum" : 100
},
"minClientCount" : {
"description" : "Minimum client count number.",
"type" : "integer",
"default" : 10,
"minimum" : 0,
"maximum" : 100
},
"minClientThroughputMbps" : {
"description" : "Minimum client throughput in Mbps.",
"type" : "number",
"default" : 0,
"minimum" : 0,
"maximum" : 100
}
}
},
"channelModeEnabled" : {
"description" : "Channel mode configuration of the zone.",
"type" : "boolean",
"default" : false
},
"tunnelType" : {
"description" : "Tunnel type configuration of the zone. No_Tunneled is for IPv6 mode",
"type" : "string",
"enum" : [ "No_Tunneled", "RuckusGRE", "SoftGRE", "SoftGREIpsec" ],
"default" : "RuckusGRE"
},
"tunnelProfile" : {
"description" : "Tunnel type configuration of the zone.",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"backgroundScanning24" : {
"description" : "Background scanning on 2.4GHz radio configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"frequencyInSec" : {
"description" : "Frequency in second",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535,
"default" : 20
}
}
},
"backgroundScanning50" : {
"description" : "Background scanning on 5GHz radio configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"frequencyInSec" : {
"description" : "Frequency in second",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535,
"default" : 20
}
}
},
"clientLoadBalancing24" : {
"description" : "Client load balancing on 2.4GHz radio configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"adjacentRadioThreshold" : {
"description" : "Adjacent radio threshold",
"type" : "integer",
"minimum" : 1,
"maximum" : 100
}
}
},
"clientLoadBalancing50" : {
"description" : "Client load balancing on 5GHz radio configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"adjacentRadioThreshold" : {
"description" : "Adjacent radio threshold",
"type" : "integer",
"minimum" : 1,
"maximum" : 100
}
}
},
"bandBalancing" : {
"description" : "Band balancing configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"mode" : {
"description" : "Band Balancing Mode: BASIC-Withholds probe and authentication responses at connetcion time in heavily loaded band to balance clients to the other band, PROACTIVE-Uses BASIC functionality and actively rebalances clients via 802.11v BTM, STRICT-Uses PROACTIVE functionality and forcefully rebalances clients via 802.11v BTM",
"type" : "string",
"enum" : [ "BASIC", "PROACTIVE", "STRICT" ],
"default" : "BASIC"
},
"wifi24Percentage" : {
"description" : "Percentage of client load on 2.4GHz radio band",
"type" : "integer",
"minimum" : 0,
"maximum" : 100,
"default" : 25
}
}
},
"loadBalancingMethod" : {
"type" : "string",
"enum" : [ "BASED_ON_CLIENT_COUNT", "BASED_ON_CAPACITY", "OFF" ],
"default" : "BASED_ON_CLIENT_COUNT"
},
"rogue" : {
"description" : "Rogue AP detection configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"reportType" : {
"description" : "Report type",
"type" : "string",
"enum" : [ "All", "Malicious" ]
},
"maliciousTypes" : {
"description" : "Malicious type when reportType is Malicious",
"type" : [ "array", "null" ],
"items" : {
"type" : "string",
"enum" : [ "SSIDSpoofing", "SameNetwork", "MACSpoofing" ]
}
},
"protectionEnabled" : {
"description" : "Protection enabled",
"type" : "boolean"
}
}
},
"dosBarringEnable" : {
"description" : "Enable DoS Protection(Barring UE) of the zone.",
"type" : "integer"
},
"dosBarringPeriod" : {
"description" : "DoS Protection(Barring UE) blocking period of the zone.",
"type" : "integer",
"default" : 60
},
"dosBarringThreshold" : {
"description" : "DoS Protection(Barring UE) threshold of the zone.",
"type" : "integer",
"default" : 5
},
"dosBarringCheckPeriod" : {
"description" : "DoS Protection(Barring UE) check period of the zone.",
"type" : "integer",
"default" : 30
},
"locationBasedService" : {
"description" : "Location based service configuration of the zone.",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"apRebootTimeout" : {
"description" : "AP reboot timeout of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"gatewayLossTimeoutInSec" : {
"description" : "Gateway loss timeout in second",
"type" : "integer",
"enum" : [ 0, 1800, 3600, 5400, 7200, 9000, 10800, 12600, 14400, 16200, 18000, 19800, 23400, 25200, 27000, 28800, 30600, 32400, 34200, 36000, 37800, 39600, 41400, 43200, 45000, 46800, 48600, 50400, 52200, 54000, 55800, 57600, 59400, 61200, 63000, 64800, 66600, 68400, 70200, 72000, 73800, 75600, 77400, 79200, 81000, 82800, 84600, 86400 ],
"default" : 1800
},
"serverLossTimeoutInSec" : {
"description" : "Server loss timeout in second",
"type" : "integer",
"enum" : [ 0, 7200, 14400, 21600, 28800, 36000, 43200, 50400, 57600, 64800, 72000, 79200, 86400 ],
"default" : 7200
}
}
},
"location" : {
"description" : "Location of the zone.",
"type" : "string"
},
"locationAdditionalInfo" : {
"description" : "Location additional info of the zone.",
"type" : "string",
"pattern" : "^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
},
"altitude" : {
"description" : "GPS Altitude",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"altitudeUnit" : {
"description" : "altitude unit",
"type" : "string",
"enum" : [ "meters", "floor" ],
"default" : "meters"
},
"altitudeValue" : {
"description" : "altitude value",
"type" : "integer"
}
}
},
"latitude" : {
"description" : "Latitude coordinate (in decimal format) of the zone",
"type" : "number"
},
"longitude" : {
"description" : "Longitude coordinate (in decimal format) of the zone",
"type" : "number"
},
"vlanOverlappingEnabled" : {
"description" : "VLAN pooling overlapping of the zone",
"type" : "boolean"
},
"nodeAffinityProfile" : {
"description" : "Node affinity profile of the zone.",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"venueProfile" : {
"description" : "Venue profile configuration of the zone.",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"autoChannelSelection24" : {
"description" : "client load balancing on Radio 2.4G, auto channel selection mode",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"channelSelectMode" : {
"description" : "Channel Select Mode",
"type" : "string",
"enum" : [ "None", "BackgroundScanning", "ChannelFly" ],
"default" : "BackgroundScanning"
},
"channelFlyMtbc" : {
"description" : "ChannelFly MTBC",
"type" : "integer",
"default" : 480,
"minimum" : 100,
"maximum" : 1440
}
}
},
"autoChannelSelection50" : {
"description" : "client load balancing on Radio 5G, auto channel selection mode",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"channelSelectMode" : {
"description" : "Channel Select Mode",
"type" : "string",
"enum" : [ "None", "BackgroundScanning", "ChannelFly" ],
"default" : "BackgroundScanning"
},
"channelFlyMtbc" : {
"description" : "ChannelFly MTBC",
"type" : "integer",
"default" : 480,
"minimum" : 100,
"maximum" : 1440
}
}
},
"channelEvaluationInterval" : {
"description" : "channel evaluation Interval of the zone",
"type" : "integer",
"default" : 600,
"minimum" : 60,
"maximum" : 3600
},
"apMgmtVlan" : {
"description" : "ap Management Vlan of the zone",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"mode" : {
"description" : "Vlan Mode of the zone",
"type" : "string",
"enum" : [ "KEEP", "USER_DEFINED" ],
"default" : "KEEP"
},
"id" : {
"description" : "Vlan id of the zone",
"type" : "integer",
"default" : "1"
}
}
},
"apLatencyInterval" : {
"description" : "AP latency interval",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"pingEnabled" : {
"description" : "AP ping latency enabled",
"type" : "boolean",
"default" : true
}
}
},
"ipsecProfile" : {
"description" : "ipsec profile configuration of the Zone.",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"ipv6TrafficFilterEnabled" : {
"description" : "IPv6 Traffic filtering on the AP",
"type" : "integer"
},
"bonjourFencingPolicyEnabled" : {
"description" : "Enable Bonjour Fencing Policy on the AP",
"type" : "boolean"
},
"bonjourFencingPolicy" : {
"description" : "Bonjour Fencing Policy on the AP",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"dhcpSiteConfig" : {
"description" : "DHCP Site Configuration in Zone",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"siteEnabled" : {
"description" : "DHCP Service Enabling Status",
"type" : "boolean"
},
"dwpdEnabled" : {
"description" : "DHCP Service Dynamic WAN Port Detection",
"type" : "boolean"
},
"manualSelect" : {
"description" : "DHCP Service AP Selection Mode. This value is effective when the siteMode is EnableOnMultipleAPs.",
"type" : "boolean"
},
"siteMode" : {
"description" : "DHCP Service mode",
"type" : "string",
"enum" : [ "EnableOnEachAPs", "EnableOnMultipleAPs", "EnableOnHierarchicalAPs" ]
},
"eth0ProfileId" : {
"type" : "integer"
},
"eth1ProfileId" : {
"type" : "integer"
},
"siteAps" : {
"type" : "array",
"items" : {
"type" : "object",
"description" : "DHCP Site selected APs. The content is effective when the siteMode is EnableOnMultipleAPs.",
"additionalProperties" : false,
"properties" : {
"apMac" : {
"type" : "string"
},
"apName" : {
"type" : "string"
},
"apStatus" : {
"type" : "string",
"enum" : [ "Online", "Offline", "Flagged" ]
},
"apServerEnabled" : {
"type" : "boolean"
},
"apServerPrimary" : {
"type" : "boolean"
},
"apServerIp" : {
"type" : [ "string", "null" ]
},
"apGatewayIp" : {
"type" : "string"
}
}
}
},
"siteProfileIds" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
}
},
"snmpAgent" : {
"description" : "AP SNMP Options",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"apSnmpEnabled" : {
"description" : "Enable AP SNMP",
"type" : "boolean"
},
"snmpV2Agent" : {
"description" : "Community List of the SNMP V2 Agent.",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"communityName" : {
"description" : "name of the SNMP Community.",
"type" : "string"
},
"readEnabled" : {
"description" : "read privilege of the SNMP Coummunity",
"type" : "boolean"
},
"writeEnabled" : {
"description" : "write privilege of the SNMP Coummunity",
"type" : "boolean"
},
"notificationEnabled" : {
"description" : "notification privilege of the SNMP Coummunity",
"type" : "boolean"
},
"notificationType" : {
"description" : "type of the notification privilege",
"type" : "string",
"enum" : [ "TRAP", "INFORM" ]
},
"notificationTarget" : {
"description" : "Trap List of the SNMP Coummunity",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"address" : {
"description" : "address of the SNMP Trap",
"type" : "string"
},
"port" : {
"description" : "port number of the SNMP Trap",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
}
},
"required" : [ "address", "port" ]
}
}
},
"required" : [ "communityName" ]
}
},
"snmpV3Agent" : {
"description" : "User List of the SNMP V3 Agent.",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"userName" : {
"description" : "name of the SNMP User.",
"type" : "string"
},
"authProtocol" : {
"description" : "authProtocol of the SNMP User.",
"type" : "string",
"enum" : [ "NONE", "MD5", "SHA" ]
},
"authPassword" : {
"description" : "authPassword of the SNMP User.",
"type" : "string",
"minLength" : 8
},
"privProtocol" : {
"description" : "privProtocol of the SNMP User.",
"type" : "string",
"enum" : [ "NONE", "DES", "AES" ]
},
"privPassword" : {
"description" : "privPassword of the SNMP User.",
"type" : "string",
"minLength" : 8
},
"readEnabled" : {
"description" : "read privilege of the SNMP User",
"type" : "boolean"
},
"writeEnabled" : {
"description" : "write privilege of the SNMP User",
"type" : "boolean"
},
"notificationEnabled" : {
"description" : "notification privilege of the SNMP User",
"type" : "boolean"
},
"notificationType" : {
"description" : "type of the notification privilege",
"type" : "string",
"enum" : [ "TRAP", "INFORM" ]
},
"notificationTarget" : {
"description" : "Trap List of the SNMP User",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"address" : {
"description" : "address of the SNMP Trap",
"type" : "string"
},
"port" : {
"description" : "port number of the SNMP Trap",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
}
},
"required" : [ "address", "port" ]
}
}
},
"required" : [ "userName" ]
}
}
}
},
"recoverySsid" : {
"description" : "Recovery SSID",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"recoverySsidEnabled" : {
"description" : "recovery ssid enable/disable",
"type" : "boolean"
}
}
},
"clusterRedundancyEnabled" : {
"description" : "Enable Cluster redundancy on zone.",
"type" : "boolean",
"default" : false
},
"rogueApReportThreshold" : {
"description" : "Rogue AP report will leave out all entries that have signal strength lower than this threshold.",
"type" : "integer"
},
"rogueApAggressivenessMode" : {
"description" : "Adjust the frequency interval to de-authenticate rogue APs.",
"type" : "integer"
},
"rogueApJammingDetection" : {
"description" : "Enable jamming detection.",
"type" : "boolean",
"default" : false
},
"rogueApJammingThreshold" : {
"type" : "integer"
},
"directedMulticastFromWiredClientEnabled" : {
"description" : "Directed multicast from wired client.",
"type" : "boolean",
"default" : true
},
"directedMulticastFromWirelessClientEnabled" : {
"description" : "Directed multicast from wireless client.",
"type" : "boolean",
"default" : true
},
"directedMulticastFromNetworkEnabled" : {
"description" : "Directed multicast from network.",
"type" : "boolean",
"default" : true
},
"healthCheckSitesEnabled" : {
"description" : "Enabled Health Check Sites. ",
"type" : "boolean",
"default" : false
},
"healthCheckSites" : {
"description" : "Health Check Sites.",
"type" : "array",
"items" : {
"type" : "string"
}
},
"ruckusGreTunnelProfile" : {
"description" : "Ruckus GRE Profile for Multiple Tunnel (Start from SZ 5.0)",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"softGreTunnelProflies" : {
"description" : "SoftGRE Profiles for Multiple Tunnel (Start from SZ 5.0)",
"type" : "array",
"items" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"aaaAffinityEnabled" : {
"type" : "boolean"
}
}
}
},
"ipsecProfiles" : {
"description" : "Ipsec profile for Multiple Tunnel (Start from SZ 5.0)",
"type" : "array",
"items" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
}
},
"sshTunnelEncryption" : {
"type" : "string",
"enum" : [ "AES128", "AES256" ],
"default" : "AES128"
}
},
"required" : [ "name", "login" ]
}201Body
{
"id": "zoneUUID"
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
}
}
}Modify entire zone ¶
PUT/v8_0/rkszones/{id}
Use this API command to modify entire information of a zone.
Body
{
"domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
"zoneAffinityProfileId": "3fd9aa91-df65-11e7-98e1-08002748d78e",
"name": "modifyZoneName",
"description": "description Zone",
"countryCode": "US",
"timezone": {
"systemTimezone": "America/Whitehorse"
},
"login": {
"apLoginName": "admin",
"apLoginPassword": "admin!234"
},
"mesh": {
"ssid": "meshSSID",
"passphrase": "passphrase"
},
"dfsChannelEnabled": false,
"wifi24": {
"txPower": "Full",
"channelWidth": 20,
"channel": 0,
"channelRange": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11
]
},
"wifi50": {
"txPower": "-1dB",
"channelWidth": 40,
"indoorChannel": 0,
"outdoorChannel": 0,
"indoorChannelRange": [
36,
40,
44,
48,
149,
153,
157,
161
],
"outdoorChannelRange": [
149,
153,
157,
161
]
},
"protectionMode24": "CTS_ONLY",
"syslog": {
"address": "1.1.1.1",
"port": 514,
"facility": "Local0",
"priority": "Error"
},
"smartMonitor": {
"intervalInSec": 10,
"retryThreshold": 3
},
"nodeAffinityProfile": null,
"venueProfile": null,
"locationBasedService": null,
"channelModeEnabled": false,
"bonjourFencingPolicy": null,
"tunnelType": "RuckusGRE",
"tunnelProfile": {
"id": "f5b92938-aa4e-4d02-90ea-273799ff689b",
"name": "Default Tunnel Profile"
},
"clientAdmissionControl24": {
"maxRadioLoadPercent": 70,
"minClientCount": 10,
"minClientThroughputMbps": 10
},
"clientAdmissionControl50": {
"maxRadioLoadPercent": 70,
"minClientCount": 10,
"minClientThroughputMbps": 10
},
"backgroundScanning24": {
"frequencyInSec": 20
},
"backgroundScanning50": {
"frequencyInSec": 20
},
"clientLoadBalancing24": {
"adjacentRadioThreshold": 12
},
"clientLoadBalancing50": {
"adjacentRadioThreshold": 12
},
"bandBalancing": {
"wifi24Percentage": 10
},
"loadBalancingMethod": "BASED_ON_CLIENT_COUNT",
"rogue": {
"reportType": "All",
"maliciousTypes": null,
"protectionEnabled": true
},
"dosBarringEnable": 0,
"dosBarringPeriod": 60,
"dosBarringThreshold": 5,
"dosBarringCheckPeriod": 30,
"apRebootTimeout": {
"gatewayLossTimeoutInSec": 1800,
"serverLossTimeoutInSec": 7200
},
"location": "location",
"locationAdditionalInfo": "locationAdditionalInfo",
"latitude": 23,
"longitude": 23,
"vlanOverlappingEnabled": false,
"autoChannelSelection24": {
"channelSelectMode": "ChannelFly",
"channelFlyMtbc": 480
},
"autoChannelSelection50": {
"channelSelectMode": "BackgroundScanning",
"channelFlyMtbc": 480
},
"channelEvaluationInterval": 777,
"apMgmtVlan": {
"id": 1,
"mode": "KEEP"
},
"apLatencyInterval": {
"pingEnabled": true
},
"ipsecProfile": {
"id": "ipsecProfileId",
"name": "ipsecProfileName"
},
"altitude": {
"altitudeUnit": "meters",
"altitudeValue": 1
},
"bonjourFencingPolicyEnabled": false,
"snmpAgent": {
"apSnmpEnabled": true,
"snmpV2Agent": [
{
"communityName": "v2Agent",
"notificationEnabled": true,
"readEnabled": true,
"writeEnabled": true,
"notificationType": "TRAP",
"notificationTarget": [
{
"address": "172.19.16.20",
"port": 161
}
]
}
],
"snmpV3Agent": [
{
"userName": "v3Agent",
"authProtocol": "MD5",
"authPassword": "admin!234",
"privProtocol": "DES",
"privPassword": "admin!234",
"notificationEnabled": true,
"readEnabled": true,
"writeEnabled": true,
"notificationType": "TRAP",
"notificationTarget": [
{
"address": "172.19.16.20",
"port": 161
}
]
}
]
},
"recoverySsid": {
"recoverySsidEnabled": true
},
"dhcpSiteConfig": {
"siteEnabled": true,
"siteMode": "EnableOnEachAPs",
"siteProfileIds": [
"75e26590-547f-11e6-9ca7-5a095364c13c",
"869bb532-547f-11e6-9ca7-5a095364c13c"
]
},
"rogueApReportThreshold": 40,
"rogueApAggressivenessMode": 2,
"rogueApJammingDetection": true,
"rogueApJammingThreshold": 40,
"directedMulticastFromWiredClientEnabled": true,
"directedMulticastFromWirelessClientEnabled": true,
"directedMulticastFromNetworkEnabled": false,
"healthCheckSitesEnabled": true,
"healthCheckSites": [
"www.google.com",
"www.live.com:443",
"www.github.com:443",
"source.codeaurora.org:443",
"www.wikipedia.com"
],
"ruckusGreTunnelProfile": {
"id": "f5b92938-aa4e-4d02-90ea-273799ff689b",
"name": "Default Tunnel Profile"
},
"softGreTunnelProflies": [
{
"id": "5a2e41b0-df53-11e7-98e1-08002748d78e",
"name": "softGre1",
"aaaAffinityEnabled": true
},
{
"id": "7803e411-df53-11e7-98e1-08002748d78e",
"name": "softGre2",
"aaaAffinityEnabled": true
}
],
"ipsecProfiles": [
{
"id": "3fd9aa91-df65-11e7-98e1-08002748d78e",
"name": "ipsec1"
}
],
"sshTunnelEncryption": "AES128"
}Schema
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"domainId" : {
"description" : "Identifier of the management domain to which the zone belongs",
"type" : "string"
},
"zoneAffinityProfileId" : {
"description" : "Identifier of the ZoneAffinityProfile",
"type" : "string"
},
"name" : {
"description" : "Name of the zone",
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$"
},
"description" : {
"description" : "Description of the zone",
"type" : [ "string", "null" ],
"maxLength" : 64
},
"countryCode" : {
"description" : "Country code of the zone",
"type" : "string"
},
"timezone" : {
"description" : "Either systemTimezone or customizedTimezone must be specified",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"systemTimezone" : {
"description" : "System defined time zone, please refer to the “Overview > Time Zone” list",
"type" : "string"
},
"customizedTimezone" : {
"description" : "User defined time zone",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"abbreviation" : {
"description" : "Time zone abbreviation",
"type" : "string",
"pattern" : "^[a-zA-Z]{3,4}$"
},
"gmtOffset" : {
"description" : "GMT offset",
"type" : "integer",
"minimum" : -11,
"maximum" : 14
},
"gmtOffsetMinute" : {
"description" : "GMT offset minute",
"type" : "integer",
"minimum" : 0,
"maximum" : 59
},
"start" : {
"description" : "Daylight saving time start",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"month" : {
"description" : "Month when daylight saving time begins",
"type" : "integer",
"enum" : [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ]
},
"week" : {
"description" : "Week of the month (1 for the first week, 2 for the second week, and so on)",
"type" : "integer",
"enum" : [ 1, 2, 3, 4, 5 ]
},
"day" : {
"description" : "Day of the week (0 for Sunday, 1 for Monday, 2 for Tuesday, and so on)",
"type" : "integer",
"enum" : [ 0, 1, 2, 3, 4, 5, 6 ]
},
"hour" : {
"description" : "Hour of the day",
"type" : "integer",
"minimum" : 0,
"maximum" : 23
}
},
"required" : [ "month", "week", "day", "hour" ]
},
"end" : {
"description" : "Daylight saving time end",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"month" : {
"description" : "Month when daylight saving time begins",
"type" : "integer",
"enum" : [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ]
},
"week" : {
"description" : "Week of the month (1 for the first week, 2 for the second week, and so on)",
"type" : "integer",
"enum" : [ 1, 2, 3, 4, 5 ]
},
"day" : {
"description" : "Day of the week (0 for Sunday, 1 for Monday, 2 for Tuesday, and so on)",
"type" : "integer",
"enum" : [ 0, 1, 2, 3, 4, 5, 6 ]
},
"hour" : {
"description" : "Hour of the day",
"type" : "integer",
"minimum" : 0,
"maximum" : 23
}
},
"required" : [ "month", "week", "day", "hour" ]
}
},
"required" : [ "abbreviation", "gmtOffset", "gmtOffsetMinute" ]
}
}
},
"login" : {
"description" : "AP administrator account",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"apLoginName" : {
"description" : "User name of the AP administrator",
"type" : "string",
"maxLength" : 64,
"pattern" : "^((?!\$\()[!-_a-~]){1,64}$"
},
"apLoginPassword" : {
"description" : "Password of the AP administrator",
"type" : "string",
"maxLength" : 64,
"pattern" : ".*(?=.{8,})(?=.*[a-zA-Z])(?=.*[0-9])(?=.*[_`~!@#$%^&*\(\)\[\]\{\}|;:'\",.\<>\/?=+-]).*"
}
},
"required" : [ "apLoginName", "apLoginPassword" ]
},
"mesh" : {
"description" : "Mesh configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"ssid" : {
"description" : "SSID of the mesh network",
"type" : "string"
},
"passphrase" : {
"description" : "Passphrase for the mesh network",
"type" : "string"
},
"meshRadioIdx" : {
"description" : "Mesh radio index",
"type" : "string",
"enum" : [ "Radio24G", "Radio5G" ]
},
"zeroTouchStatus" : {
"type" : "boolean"
}
}
},
"dfsChannelEnabled" : {
"description" : "DFS Channel enabled configuration of the zone, only for the US country code .",
"type" : "boolean"
},
"cbandChannelEnabled" : {
"description" : "5.8Ghz channels enabled configuration of the zone.",
"type" : "boolean"
},
"cbandChannelLicenseEnabled" : {
"description" : "5.8Ghz channels license enabled configuration of the zone.",
"type" : "boolean"
},
"wifi24" : {
"description" : "AP 2.4GHz radio configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"autoCellSizing" : {
"description" : "Auto Cell Sizing",
"type" : "boolean"
},
"txPower" : {
"description" : "Transmission power",
"type" : "string",
"enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ]
},
"channelWidth" : {
"description" : "Channel width. Zero (0) means Auto.",
"type" : "integer",
"enum" : [ 0, 20, 40 ]
},
"channel" : {
"description" : "Channel number",
"type" : "integer"
},
"channelRange" : {
"description" : "Channel range options",
"type" : "array",
"items" : {
"type" : "integer"
}
}
}
},
"wifi50" : {
"description" : "AP 5GHz radio configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"autoCellSizing" : {
"description" : "Auto Cell Sizing",
"type" : "boolean"
},
"txPower" : {
"description" : "Transmission power",
"type" : "string",
"enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ]
},
"channelWidth" : {
"description" : "Channel width. Zero (0) means Auto. 8080 means 80+80MHz",
"type" : "integer",
"enum" : [ 0, 20, 40, 80, 8080, 160 ]
},
"indoorChannel" : {
"description" : "Channel number for Indoor AP",
"type" : "integer"
},
"outdoorChannel" : {
"description" : "Channel number for Outdoor AP",
"type" : "integer"
},
"indoorSecondaryChannel" : {
"description" : "Secondary channel number for Indoor AP (channelWidth is 80+80MHz only)",
"type" : "integer"
},
"outdoorSecondaryChannel" : {
"description" : "Secondary channel number for outdoor AP (channelWidth is 80+80MHz only)",
"type" : "integer"
},
"indoorChannelRange" : {
"description" : "Channel range options for Indoor AP",
"type" : "array",
"items" : {
"type" : "integer"
}
},
"outdoorChannelRange" : {
"description" : "Channel range options for outdoor AP",
"type" : "array",
"items" : {
"type" : "integer"
}
}
}
},
"protectionMode24" : {
"description" : "AP 2.4GHz Protection mode configuration of the zone.",
"type" : "string",
"enum" : [ "NONE", "CTS_ONLY", "RTS_CTS" ]
},
"syslog" : {
"description" : "Syslog configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"flowLevel" : {
"description" : "Flow Level of the syslog",
"type" : "string",
"enum" : [ "GENERAL_LOGS", "CLIENT_FLOW", "ALL" ]
},
"address" : {
"description" : "Address of the syslog server.",
"type" : "string"
},
"port" : {
"description" : "Port number of the syslog server",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
},
"protocol" : {
"description" : "Protocol of the syslog server",
"type" : "string",
"enum" : [ "IPPROTO_TCP", "IPPROTO_UDP" ]
},
"secondaryAddress" : {
"description" : "Secondary Server Address of the syslog server",
"type" : "string"
},
"secondaryPort" : {
"description" : "Secondary Server Port of the syslog server",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
},
"secondaryProtocol" : {
"description" : "Secondary Server Protocol of the syslog server",
"type" : "string",
"enum" : [ "IPPROTO_TCP", "IPPROTO_UDP" ]
},
"facility" : {
"description" : "Facility of the syslog server",
"type" : "string",
"enum" : [ "Keep_Original", "Local0", "Local1", "Local2", "Local3", "Local4", "Local5", "Local6", "Local7" ]
},
"priority" : {
"description" : "Priority of the log messages",
"type" : "string",
"enum" : [ "Emergency", "Alert", "Critical", "Error", "Warning", "Notice", "Info", "All" ]
}
}
},
"smartMonitor" : {
"description" : "Smart monitor configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"intervalInSec" : {
"description" : "Interval in seconds. This is required if smartMonitor is enabled",
"type" : "integer",
"minimum" : 5,
"maximum" : 60
},
"retryThreshold" : {
"description" : "Retry threshold. This is required if smartMonitor is enabled",
"type" : "integer",
"minimum" : 1,
"maximum" : 10
}
}
},
"clientAdmissionControl24" : {
"description" : "AP client admission control 2.4GHz radio configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"maxRadioLoadPercent" : {
"description" : "Maximum radio load percentage.",
"type" : "integer",
"minimum" : 50,
"maximum" : 100
},
"minClientCount" : {
"description" : "Minimum client count number.",
"type" : "integer",
"minimum" : 0,
"maximum" : 100
},
"minClientThroughputMbps" : {
"description" : "Minimum client throughput in Mbps.",
"type" : "number",
"minimum" : 0,
"maximum" : 100
}
}
},
"clientAdmissionControl50" : {
"description" : "AP client admission control 5GHz radio configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"maxRadioLoadPercent" : {
"description" : "Maximum radio load percentage.",
"type" : "integer",
"minimum" : 50,
"maximum" : 100
},
"minClientCount" : {
"description" : "Minimum client count number.",
"type" : "integer",
"minimum" : 0,
"maximum" : 100
},
"minClientThroughputMbps" : {
"description" : "Minimum client throughput in Mbps.",
"type" : "number",
"minimum" : 0,
"maximum" : 100
}
}
},
"channelModeEnabled" : {
"description" : "Channel mode configuration of the zone.",
"type" : "boolean"
},
"tunnelType" : {
"description" : "Tunnel type configuration of the zone. No_Tunneled is for IPv6 mode",
"type" : "string",
"enum" : [ "No_Tunneled", "RuckusGRE", "SoftGRE", "SoftGREIpsec" ]
},
"tunnelProfile" : {
"description" : "Tunnel type configuration of the zone.",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"backgroundScanning24" : {
"description" : "Background scanning on 2.4GHz radio configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"frequencyInSec" : {
"description" : "Frequency in second",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
}
}
},
"backgroundScanning50" : {
"description" : "Background scanning on 5GHz radio configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"frequencyInSec" : {
"description" : "Frequency in second",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
}
}
},
"clientLoadBalancing24" : {
"description" : "Client load balancing on 2.4GHz radio configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"adjacentRadioThreshold" : {
"description" : "Adjacent radio threshold",
"type" : "integer",
"minimum" : 1,
"maximum" : 100
}
}
},
"clientLoadBalancing50" : {
"description" : "Client load balancing on 5GHz radio configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"adjacentRadioThreshold" : {
"description" : "Adjacent radio threshold",
"type" : "integer",
"minimum" : 1,
"maximum" : 100
}
}
},
"bandBalancing" : {
"description" : "Band balancing configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"mode" : {
"description" : "Band Balancing Mode: BASIC-Withholds probe and authentication responses at connetcion time in heavily loaded band to balance clients to the other band, PROACTIVE-Uses BASIC functionality and actively rebalances clients via 802.11v BTM, STRICT-Uses PROACTIVE functionality and forcefully rebalances clients via 802.11v BTM",
"type" : "string",
"enum" : [ "BASIC", "PROACTIVE", "STRICT" ]
},
"wifi24Percentage" : {
"description" : "Percentage of client load on 2.4GHz radio band",
"type" : "integer",
"minimum" : 0,
"maximum" : 100
}
}
},
"loadBalancingMethod" : {
"type" : "string",
"enum" : [ "BASED_ON_CLIENT_COUNT", "BASED_ON_CAPACITY", "OFF" ]
},
"rogue" : {
"description" : "Rogue AP detection configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"reportType" : {
"description" : "Report type",
"type" : "string",
"enum" : [ "All", "Malicious" ]
},
"maliciousTypes" : {
"description" : "Malicious type when reportType is Malicious",
"type" : [ "array", "null" ],
"items" : {
"type" : "string",
"enum" : [ "SSIDSpoofing", "SameNetwork", "MACSpoofing" ]
}
},
"protectionEnabled" : {
"description" : "Protection enabled",
"type" : "boolean"
}
}
},
"dosBarringEnable" : {
"description" : "Enable DoS Protection(Barring UE) of the zone.",
"type" : "integer"
},
"dosBarringPeriod" : {
"description" : "DoS Protection(Barring UE) blocking period of the zone.",
"type" : "integer"
},
"dosBarringThreshold" : {
"description" : "DoS Protection(Barring UE) threshold of the zone.",
"type" : "integer"
},
"dosBarringCheckPeriod" : {
"description" : "DoS Protection(Barring UE) check period of the zone.",
"type" : "integer"
},
"locationBasedService" : {
"description" : "Location based service configuration of the zone.",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"apRebootTimeout" : {
"description" : "AP reboot timeout of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"gatewayLossTimeoutInSec" : {
"description" : "Gateway loss timeout in second",
"type" : "integer",
"enum" : [ 0, 1800, 3600, 5400, 7200, 9000, 10800, 12600, 14400, 16200, 18000, 19800, 23400, 25200, 27000, 28800, 30600, 32400, 34200, 36000, 37800, 39600, 41400, 43200, 45000, 46800, 48600, 50400, 52200, 54000, 55800, 57600, 59400, 61200, 63000, 64800, 66600, 68400, 70200, 72000, 73800, 75600, 77400, 79200, 81000, 82800, 84600, 86400 ]
},
"serverLossTimeoutInSec" : {
"description" : "Server loss timeout in second",
"type" : "integer",
"enum" : [ 0, 7200, 14400, 21600, 28800, 36000, 43200, 50400, 57600, 64800, 72000, 79200, 86400 ]
}
}
},
"location" : {
"description" : "Location of the zone.",
"type" : "string"
},
"locationAdditionalInfo" : {
"description" : "Location additional info of the zone.",
"type" : "string",
"pattern" : "^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
},
"altitude" : {
"description" : "GPS Altitude",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"altitudeUnit" : {
"description" : "altitude unit",
"type" : "string",
"enum" : [ "meters", "floor" ]
},
"altitudeValue" : {
"description" : "altitude value",
"type" : "integer"
}
}
},
"latitude" : {
"description" : "Latitude coordinate (in decimal format) of the zone",
"type" : "number"
},
"longitude" : {
"description" : "Longitude coordinate (in decimal format) of the zone",
"type" : "number"
},
"vlanOverlappingEnabled" : {
"description" : "VLAN pooling overlapping of the zone",
"type" : "boolean"
},
"nodeAffinityProfile" : {
"description" : "Node affinity profile of the zone.",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"venueProfile" : {
"description" : "Venue profile configuration of the zone.",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"autoChannelSelection24" : {
"description" : "client load balancing on Radio 2.4G, auto channel selection mode",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"channelSelectMode" : {
"description" : "Channel Select Mode",
"type" : "string",
"enum" : [ "None", "BackgroundScanning", "ChannelFly" ]
},
"channelFlyMtbc" : {
"description" : "ChannelFly MTBC",
"type" : "integer",
"minimum" : 100,
"maximum" : 1440
}
}
},
"autoChannelSelection50" : {
"description" : "client load balancing on Radio 5G, auto channel selection mode",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"channelSelectMode" : {
"description" : "Channel Select Mode",
"type" : "string",
"enum" : [ "None", "BackgroundScanning", "ChannelFly" ]
},
"channelFlyMtbc" : {
"description" : "ChannelFly MTBC",
"type" : "integer",
"minimum" : 100,
"maximum" : 1440
}
}
},
"channelEvaluationInterval" : {
"description" : "channel evaluation Interval of the zone",
"type" : "integer",
"minimum" : 60,
"maximum" : 3600
},
"apMgmtVlan" : {
"description" : "ap Management Vlan of the zone",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"mode" : {
"description" : "Vlan Mode of the zone",
"type" : "string",
"enum" : [ "KEEP", "USER_DEFINED" ]
},
"id" : {
"description" : "Vlan id of the zone",
"type" : "integer"
}
}
},
"apLatencyInterval" : {
"description" : "AP latency interval",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"pingEnabled" : {
"description" : "AP ping latency enabled",
"type" : "boolean"
}
}
},
"ipsecProfile" : {
"description" : "ipsec profile configuration of the Zone.",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"ipv6TrafficFilterEnabled" : {
"description" : "IPv6 Traffic filtering on the AP",
"type" : "integer"
},
"bonjourFencingPolicyEnabled" : {
"description" : "Enable Bonjour Fencing Policy on the AP",
"type" : "boolean"
},
"bonjourFencingPolicy" : {
"description" : "Bonjour Fencing Policy on the AP",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"dhcpSiteConfig" : {
"description" : "DHCP Site Configuration in Zone",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"siteEnabled" : {
"description" : "DHCP Service Enabling Status",
"type" : "boolean"
},
"dwpdEnabled" : {
"description" : "DHCP Service Dynamic WAN Port Detection",
"type" : "boolean"
},
"manualSelect" : {
"description" : "DHCP Service AP Selection Mode. This value is effective when the siteMode is EnableOnMultipleAPs.",
"type" : "boolean"
},
"siteMode" : {
"description" : "DHCP Service mode",
"type" : "string",
"enum" : [ "EnableOnEachAPs", "EnableOnMultipleAPs", "EnableOnHierarchicalAPs" ]
},
"eth0ProfileId" : {
"type" : "integer"
},
"eth1ProfileId" : {
"type" : "integer"
},
"siteAps" : {
"type" : "array",
"items" : {
"type" : "object",
"description" : "DHCP Site selected APs. The content is effective when the siteMode is EnableOnMultipleAPs.",
"additionalProperties" : false,
"properties" : {
"apMac" : {
"type" : "string"
},
"apName" : {
"type" : "string"
},
"apStatus" : {
"type" : "string",
"enum" : [ "Online", "Offline", "Flagged" ]
},
"apServerEnabled" : {
"type" : "boolean"
},
"apServerPrimary" : {
"type" : "boolean"
},
"apServerIp" : {
"type" : [ "string", "null" ]
},
"apGatewayIp" : {
"type" : "string"
}
}
}
},
"siteProfileIds" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
}
},
"snmpAgent" : {
"description" : "AP SNMP Options",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"apSnmpEnabled" : {
"description" : "Enable AP SNMP",
"type" : "boolean"
},
"snmpV2Agent" : {
"description" : "Community List of the SNMP V2 Agent.",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"communityName" : {
"description" : "name of the SNMP Community.",
"type" : "string"
},
"readEnabled" : {
"description" : "read privilege of the SNMP Coummunity",
"type" : "boolean"
},
"writeEnabled" : {
"description" : "write privilege of the SNMP Coummunity",
"type" : "boolean"
},
"notificationEnabled" : {
"description" : "notification privilege of the SNMP Coummunity",
"type" : "boolean"
},
"notificationType" : {
"description" : "type of the notification privilege",
"type" : "string",
"enum" : [ "TRAP", "INFORM" ]
},
"notificationTarget" : {
"description" : "Trap List of the SNMP Coummunity",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"address" : {
"description" : "address of the SNMP Trap",
"type" : "string"
},
"port" : {
"description" : "port number of the SNMP Trap",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
}
},
"required" : [ "address", "port" ]
}
}
},
"required" : [ "communityName" ]
}
},
"snmpV3Agent" : {
"description" : "User List of the SNMP V3 Agent.",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"userName" : {
"description" : "name of the SNMP User.",
"type" : "string"
},
"authProtocol" : {
"description" : "authProtocol of the SNMP User.",
"type" : "string",
"enum" : [ "NONE", "MD5", "SHA" ]
},
"authPassword" : {
"description" : "authPassword of the SNMP User.",
"type" : "string",
"minLength" : 8
},
"privProtocol" : {
"description" : "privProtocol of the SNMP User.",
"type" : "string",
"enum" : [ "NONE", "DES", "AES" ]
},
"privPassword" : {
"description" : "privPassword of the SNMP User.",
"type" : "string",
"minLength" : 8
},
"readEnabled" : {
"description" : "read privilege of the SNMP User",
"type" : "boolean"
},
"writeEnabled" : {
"description" : "write privilege of the SNMP User",
"type" : "boolean"
},
"notificationEnabled" : {
"description" : "notification privilege of the SNMP User",
"type" : "boolean"
},
"notificationType" : {
"description" : "type of the notification privilege",
"type" : "string",
"enum" : [ "TRAP", "INFORM" ]
},
"notificationTarget" : {
"description" : "Trap List of the SNMP User",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"address" : {
"description" : "address of the SNMP Trap",
"type" : "string"
},
"port" : {
"description" : "port number of the SNMP Trap",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
}
},
"required" : [ "address", "port" ]
}
}
},
"required" : [ "userName" ]
}
}
}
},
"recoverySsid" : {
"description" : "Recovery SSID",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"recoverySsidEnabled" : {
"description" : "recovery ssid enable/disable",
"type" : "boolean"
}
}
},
"clusterRedundancyEnabled" : {
"description" : "Enable Cluster redundancy on zone",
"type" : "boolean"
},
"rogueApReportThreshold" : {
"description" : "Rogue AP report will leave out all entries that have signal strength lower than this threshold.",
"type" : "integer"
},
"rogueApAggressivenessMode" : {
"description" : "Adjust the frequency interval to de-authenticate rogue APs.",
"type" : "integer"
},
"rogueApJammingDetection" : {
"description" : "Enable jamming detection.",
"type" : "boolean"
},
"rogueApJammingThreshold" : {
"type" : "integer"
},
"directedMulticastFromWiredClientEnabled" : {
"description" : "Directed multicast from wired client.",
"type" : "boolean"
},
"directedMulticastFromWirelessClientEnabled" : {
"description" : "Directed multicast from wireless client.",
"type" : "boolean"
},
"directedMulticastFromNetworkEnabled" : {
"description" : "Directed multicast from network.",
"type" : "boolean"
},
"healthCheckSitesEnabled" : {
"description" : "Enabled Health Check Sites. ",
"type" : "boolean"
},
"healthCheckSites" : {
"description" : "Health Check Sites.",
"type" : "array",
"items" : {
"type" : "string"
}
},
"ruckusGreTunnelProfile" : {
"description" : "Ruckus GRE Profile for Multiple Tunnel (Start from SZ 5.0)",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"softGreTunnelProflies" : {
"description" : "SoftGRE Profiles for Multiple Tunnel (Start from SZ 5.0)",
"type" : "array",
"items" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"aaaAffinityEnabled" : {
"type" : "boolean"
}
}
}
},
"ipsecProfiles" : {
"description" : "Ipsec profile for Multiple Tunnel (Start from SZ 5.0)",
"type" : "array",
"items" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
}
},
"sshTunnelEncryption" : {
"type" : "string",
"enum" : [ "AES128", "AES256" ]
}
}
}204Retrieve Mesh Configuration ¶
GET/v8_0/rkszones/{id}/mesh
Use this API command to retrieve the mesh configuration of a zone.
200Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"ssid": {
"description": "SSID of the mesh network",
"type": "string"
},
"passphrase": {
"description": "Passphrase for the mesh network",
"type": "string"
},
"meshRadioIdx": {
"description": "Mesh radio index",
"type": "string",
"enum": [
"Radio24G",
"Radio5G"
],
"default": "Radio5G"
},
"zeroTouchStatus": {
"type": "boolean"
}
}
}Delete IPsec Profiles ¶
DELETE/v8_0/rkszones/{id}/softGreTunnelProflies
Use this API command to Delete IPsec profiles.
204Delete IPsec Profiles ¶
Retrieve AP Model ¶
GET/v8_0/rkszones/{zoneId}/apmodel/{model}
Use this API command to retrieve AP model specific configuration that belong to a zone.
200Body
{
"ledStatusEnabled": true,
"lldp": {
"enabled": true,
"advertiseIntervalInSec": 30,
"holdTimeInSec": 120,
"managementIPTLVEnabled": false
},
"cellularSettings": {
"mobileAPName": "internet",
"mobileAPName2": "internet",
"simCardUsage": 0,
"select3g4g": 0,
"select3g4g2": 0,
"dataRoaming": 1,
"dataRoaming2": 1,
"wanConnection": 0,
"wanRecoveryTimer": 60
},
"ledMode": null,
"internalHeaterEnabled": null,
"poeOutPortEnabled": null,
"usbPowerEnable": true,
"poeModeSetting": "Auto",
"poeTxChain": 2,
"radioBand": null,
"externalAntenna24": null,
"externalAntenna50": null,
"lanPorts": [
{
"portName": "LAN1",
"enabled": false,
"ethPortProfile": null
},
{
"portName": "LAN2",
"enabled": true,
"ethPortProfile": {
"id": "0",
"name": "Default Trunk Port"
}
},
{
"portName": "LAN3",
"enabled": true,
"ethPortProfile": {
"id": "1",
"name": "Default Access Port"
}
}
]
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"ledStatusEnabled": {
"type": [
"boolean",
"null"
]
},
"lldp": {
"type": "object",
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean",
"default": true
},
"advertiseIntervalInSec": {
"type": [
"integer",
"null"
],
"minimum": 1,
"maximum": 300
},
"holdTimeInSec": {
"type": [
"integer",
"null"
],
"minimum": 60,
"maximum": 1200
},
"managementIPTLVEnabled": {
"type": [
"boolean",
"null"
]
}
},
"required": [
"enabled"
]
},
"cellularSettings": {
"type": "object",
"additionalProperties": false,
"properties": {
"mobileAPName": {
"type": [
"string",
"null"
],
"maxLength": 100,
"pattern": "^([!-?A-~]([!-?A-~]){0,62}[!-?A-~]|[!-?A-~]{1,1})$"
},
"mobileAPName2": {
"type": [
"string",
"null"
],
"maxLength": 100,
"pattern": "^([!-?A-~]([!-?A-~]){0,62}[!-?A-~]|[!-?A-~]{1,1})$"
},
"simCardUsage": {
"type": [
"integer",
"null"
],
"minimum": 0,
"maximum": 2
},
"select3g4g": {
"type": "integer",
"minimum": 0,
"maximum": 2
},
"select3g4g2": {
"type": "integer",
"minimum": 0,
"maximum": 2
},
"dataRoaming": {
"type": [
"integer",
"null"
],
"minimum": 0,
"maximum": 1
},
"dataRoaming2": {
"type": [
"integer",
"null"
],
"minimum": 0,
"maximum": 1
},
"wanConnection": {
"type": "integer",
"minimum": 0,
"maximum": 3
},
"wanRecoveryTimer": {
"type": "integer",
"minimum": 10,
"maximum": 300
}
},
"required": [
"select3g4g",
"select3g4g2",
"wanConnection",
"wanRecoveryTimer"
]
},
"ledMode": {
"type": [
"string",
"null"
],
"enum": [
null,
"CableModem",
"AccessPoint",
"CableModem_AccessPoint",
"CableModem_AccessPoint_DEFAULT",
"ActiveSurgeProtector",
"ActiveSurgeProtector_ModemOnline_DEFAULT",
"Off"
]
},
"internalHeaterEnabled": {
"type": [
"boolean",
"null"
]
},
"poeOutPortEnabled": {
"type": [
"boolean",
"null"
]
},
"usbPowerEnable": {
"type": [
"boolean",
"null"
]
},
"poeModeSetting": {
"type": [
"string",
"null"
],
"enum": [
null,
"Auto",
"_802_3af",
"_802_3at",
"_802_3atPlus"
]
},
"poeTxChain": {
"description": "Option to use 1, 2 or 4 Tx chains while AP power source is 802.3af PoE",
"default": 2,
"type": [
"integer",
"null"
]
},
"radioBand": {
"description": "Band switch between 2.4GHz and 5GHz is provided in single radio AP ZF-7321, ZF-7321-U, and ZF-7441.",
"type": [
"string",
"null"
],
"enum": [
null,
"2.4GHz",
"5GHz"
]
},
"externalAntenna24": {
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"dbi": {
"type": [
"integer",
"null"
],
"minimum": 0,
"maximum": 90
},
"chainMask": {
"type": [
"string",
"null"
],
"enum": [
null,
"Two",
"Three"
]
}
},
"required": [
"enabled"
]
},
"externalAntenna50": {
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"dbi": {
"type": [
"integer",
"null"
],
"minimum": 0,
"maximum": 90
},
"chainMask": {
"type": [
"string",
"null"
],
"enum": [
null,
"Two",
"Three"
]
}
},
"required": [
"enabled"
]
},
"lanPorts": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"portName": {
"type": "string",
"enum": [
"LAN1",
"LAN2",
"LAN3",
"LAN4",
"LAN5"
]
},
"enabled": {
"type": "boolean"
},
"ethPortProfile": {
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"required": [
"portName",
"enabled"
]
}
}
}
}Modify AP Model ¶
PUT/v8_0/rkszones/{zoneId}/apmodel/{model}
Use this API command to modify the AP model specific configuration that belong to a zone.
Body
{
"ledStatusEnabled": true,
"lldp": {
"enabled": true,
"advertiseIntervalInSec": 30,
"holdTimeInSec": 120,
"managementIPTLVEnabled": false
},
"cellularSettings": {
"mobileAPName": "internet",
"mobileAPName2": "internet",
"simCardUsage": 0,
"select3g4g": 0,
"select3g4g2": 0,
"dataRoaming": 1,
"dataRoaming2": 1,
"wanConnection": 0,
"wanRecoveryTimer": 60
},
"ledMode": null,
"internalHeaterEnabled": null,
"poeOutPortEnabled": null,
"usbPowerEnable": true,
"poeModeSetting": "Auto",
"poeTxChain": 2,
"radioBand": null,
"externalAntenna24": null,
"externalAntenna50": null,
"lanPorts": [
{
"portName": "LAN1",
"enabled": false,
"ethPortProfile": null
},
{
"portName": "LAN2",
"enabled": true,
"ethPortProfile": {
"id": "0",
"name": "Default Trunk Port"
}
},
{
"portName": "LAN3",
"enabled": true,
"ethPortProfile": {
"id": "1",
"name": "Default Access Port"
}
}
]
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"ledStatusEnabled": {
"type": [
"boolean",
"null"
]
},
"lldp": {
"type": "object",
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"advertiseIntervalInSec": {
"type": [
"integer",
"null"
],
"minimum": 1,
"maximum": 300
},
"holdTimeInSec": {
"type": [
"integer",
"null"
],
"minimum": 60,
"maximum": 1200
},
"managementIPTLVEnabled": {
"type": [
"boolean",
"null"
]
}
},
"required": [
"enabled"
]
},
"cellularSettings": {
"type": "object",
"additionalProperties": false,
"properties": {
"mobileAPName": {
"type": [
"string",
"null"
],
"maxLength": 100,
"pattern": "^([!-?A-~]([!-?A-~]){0,62}[!-?A-~]|[!-?A-~]{1,1})$"
},
"mobileAPName2": {
"type": [
"string",
"null"
],
"maxLength": 100,
"pattern": "^([!-?A-~]([!-?A-~]){0,62}[!-?A-~]|[!-?A-~]{1,1})$"
},
"simCardUsage": {
"type": [
"integer",
"null"
],
"minimum": 0,
"maximum": 2
},
"select3g4g": {
"type": "integer",
"minimum": 0,
"maximum": 2
},
"select3g4g2": {
"type": "integer",
"minimum": 0,
"maximum": 2
},
"dataRoaming": {
"type": [
"integer",
"null"
],
"minimum": 0,
"maximum": 1
},
"dataRoaming2": {
"type": [
"integer",
"null"
],
"minimum": 0,
"maximum": 1
},
"wanConnection": {
"type": "integer",
"minimum": 0,
"maximum": 3
},
"wanRecoveryTimer": {
"type": "integer",
"minimum": 10,
"maximum": 300
}
},
"required": [
"select3g4g",
"select3g4g2",
"wanConnection",
"wanRecoveryTimer"
]
},
"ledMode": {
"type": [
"string",
"null"
],
"enum": [
null,
"CableModem",
"AccessPoint",
"CableModem_AccessPoint",
"CableModem_AccessPoint_DEFAULT",
"ActiveSurgeProtector",
"ActiveSurgeProtector_ModemOnline_DEFAULT",
"Off"
]
},
"internalHeaterEnabled": {
"type": [
"boolean",
"null"
]
},
"poeOutPortEnabled": {
"type": [
"boolean",
"null"
]
},
"usbPowerEnable": {
"type": [
"boolean",
"null"
]
},
"poeModeSetting": {
"type": [
"string",
"null"
],
"enum": [
null,
"Auto",
"_802_3af",
"_802_3at",
"_802_3atPlus"
]
},
"poeTxChain": {
"description": "Option to use 1, 2 or 4 Tx chains while AP power source is 802.3af PoE",
"type": [
"integer",
"null"
]
},
"radioBand": {
"description": "Band switch between 2.4GHz and 5GHz is provided in single radio AP ZF-7321, ZF-7321-U, and ZF-7441.",
"type": [
"string",
"null"
],
"enum": [
null,
"2.4GHz",
"5GHz"
]
},
"externalAntenna24": {
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"dbi": {
"type": [
"integer",
"null"
],
"minimum": 0,
"maximum": 90
},
"chainMask": {
"type": [
"string",
"null"
],
"enum": [
null,
"Two",
"Three"
]
}
},
"required": [
"enabled"
]
},
"externalAntenna50": {
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"dbi": {
"type": [
"integer",
"null"
],
"minimum": 0,
"maximum": 90
},
"chainMask": {
"type": [
"string",
"null"
],
"enum": [
null,
"Two",
"Three"
]
}
},
"required": [
"enabled"
]
},
"lanPorts": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"portName": {
"type": "string",
"enum": [
"LAN1",
"LAN2",
"LAN3",
"LAN4",
"LAN5"
]
},
"enabled": {
"type": "boolean"
},
"ethPortProfile": {
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"required": [
"portName",
"enabled"
]
}
}
}
}204Retrieve AP Model Common Attribute ¶
GET/v8_0/rkszones/{zoneId}/apmodel/{model}/commonAttribute
Use this API command to retrieve AP model common attribute that belong to a zone.
200Body
{
"nonEditablePorts": [
2
],
"isAllowDisableExtAnt": null,
"nonVisiblePorts": [
2
],
"hasScanRadio": null,
"hasCablemodem": true,
"hasGps": false,
"isDualRadio": true,
"isOutdoor": false,
"maxChannelization24G": 40,
"maxChannelization5G": 80,
"maxClientsUpper": 256,
"maxWlanNum24G": 15,
"maxWlanNum5G": 16,
"noAvc": false,
"noMesh": false,
"reserved5GWlanForMesh": 3,
"support11AC": true,
"supportChannelization160": null,
"supportAPUsbSoftwarePackage": null,
"supportBandSwitch": false,
"supportBonjour": true,
"supportIpsec": false,
"supportLBS": true,
"supportResetCablemodem": true,
"allowDfsCountry": "US",
"ram": 512,
"numOfCores": 4,
"cpuFrequency": 600,
"scalingFactor": 1,
"capabilityScore": 75
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"nonEditablePorts": {
"type": "array",
"items": {
"type": "integer"
}
},
"isAllowDisableExtAnt": {
"type": [
"boolean",
"null"
]
},
"nonVisiblePorts": {
"type": "array",
"items": {
"type": "integer"
}
},
"hasScanRadio": {
"type": [
"boolean",
"null"
]
},
"hasCablemodem": {
"type": [
"boolean",
"null"
]
},
"hasGps": {
"type": [
"boolean",
"null"
]
},
"isDualRadio": {
"type": [
"boolean",
"null"
]
},
"isOutdoor": {
"type": [
"boolean",
"null"
]
},
"maxChannelization24G": {
"type": "integer"
},
"maxChannelization5G": {
"type": "integer"
},
"maxClientsUpper": {
"type": "integer"
},
"maxWlanNum24G": {
"type": "integer"
},
"maxWlanNum5G": {
"type": "integer"
},
"noAvc": {
"type": [
"boolean",
"null"
]
},
"noMesh": {
"type": [
"boolean",
"null"
]
},
"reserved5GWlanForMesh": {
"type": "integer"
},
"support11AC": {
"type": [
"boolean",
"null"
]
},
"supportChannelization160": {
"type": [
"boolean",
"null"
]
},
"supportAPUsbSoftwarePackage": {
"type": [
"boolean",
"null"
]
},
"supportBandSwitch": {
"type": [
"boolean",
"null"
]
},
"supportBonjour": {
"type": [
"boolean",
"null"
]
},
"supportIpsec": {
"type": [
"boolean",
"null"
]
},
"supportLBS": {
"type": [
"boolean",
"null"
]
},
"supportResetCablemodem": {
"type": [
"boolean",
"null"
]
},
"allowDfsCountry": {
"type": "string"
},
"ram": {
"type": "integer"
},
"numOfCores": {
"type": "integer"
},
"cpuFrequency": {
"type": "integer"
},
"scalingFactor": {
"type": "integer"
},
"capabilityScore": {
"type": "number"
}
}
}Retrieve AP Firmware List ¶
GET/v8_0/rkszones/{zoneId}/apFirmware
Use this API command to retrieve AP Firmware the list that belong to a zone.
200Body
{
"totalCount": 2,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"firmwareVersion": "3.4.0.101.492",
"unsupportedApModelSummary": [
{
"model": "R300",
"amount": 1
}
],
"supported": false
},
{
"firmwareVersion": "3.4.0.101.505",
"unsupportedApModelSummary": [],
"supported": true
}
]
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"totalCount": {
"type": "integer"
},
"hasMore": {
"type": "boolean"
},
"firstIndex": {
"type": "integer"
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"firmwareVersion": {
"description": "version of the AP firmare",
"type": "string"
},
"unsupportedApModelSummary": {
"description": "summary of the AP Model is unsupported for AP firmware version.",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"model": {
"description": "name of the AP Model",
"type": "string"
},
"amount": {
"description": "amount of the AP Model",
"type": "integer"
}
}
}
},
"supported": {
"description": "version of the AP firmare is supported for Upgrade or Downgrade.",
"type": "boolean"
}
}
}
}
}
}Change AP Firmware ¶
PUT/v8_0/rkszones/{zoneId}/apFirmware
Use this API command to change the AP Firmware that belong to a zone.
Body
{
"firmwareVersion": "3.4.0.101.25"
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"firmwareVersion": {
"description": "new version of the AP firmare",
"type": "string"
}
}
}204Get Available GRE Tunnel Profiles. ¶
GET/v8_0/rkszones/{zoneId}/availableTunnelProfiles
Get available GRE tunnel profiles of this Zone.
200Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"totalCount": {
"type": "integer"
},
"hasMore": {
"type": "boolean"
},
"firstIndex": {
"type": "integer"
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Tunnel Profile ID",
"type": "string"
},
"name": {
"description": "Tunnel Profile Name",
"type": "string"
},
"tunnelType": {
"description": "Tunnel Profile Type (\"RuckusGRE\", \"SoftGRE\",or \"Ipsec\")",
"type": "string",
"enum": [
"RuckusGRE",
"SoftGRE",
"Ipsec"
]
},
"ipMode": {
"description": "Tunnel Profile's IP Mode",
"type": "string",
"enum": [
"IPV4",
"IPV6",
"IPV4_IPV6"
]
},
"aaaAffinityEnabled": {
"description": "Enable AAA affinity (Soft GRE only)",
"type": "boolean"
}
}
}
}
}
}Get available IPSec Tunnel Profiles. ¶
GET/v8_0/rkszones/{zoneId}/availableIpsecProfiles
Get available IPSec tunnel profiles of this Zone.
200Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"totalCount": {
"type": "integer"
},
"hasMore": {
"type": "boolean"
},
"firstIndex": {
"type": "integer"
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Tunnel Profile ID",
"type": "string"
},
"name": {
"description": "Tunnel Profile Name",
"type": "string"
},
"tunnelType": {
"description": "Tunnel Profile Type (\"RuckusGRE\", \"SoftGRE\",or \"Ipsec\")",
"type": "string",
"enum": [
"RuckusGRE",
"SoftGRE",
"Ipsec"
]
},
"ipMode": {
"description": "Tunnel Profile's IP Mode",
"type": "string",
"enum": [
"IPV4",
"IPV6",
"IPV4_IPV6"
]
},
"aaaAffinityEnabled": {
"description": "Enable AAA affinity (Soft GRE only)",
"type": "boolean"
}
}
}
}
}
}Retrieve ¶
GET/v8_0/rkszones/{id}
Use this API command to retrieve Ruckus Wireless AP zones configuration.
200Body
{
"id": "ad5ffab1-b3ed-4b36-b054-bc723a977dbb",
"domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
"name": "public-api-zone-ipv6",
"description": null,
"countryCode": "US",
"version": "3.1.0.0.55",
"timezone": {
"systemTimezone": "UTC",
"customizedTimezone": null
},
"ipMode": "IPV6",
"login": {
"apLoginName": "admin",
"apLoginPassword": "admin!234"
},
"mesh": {
"ssid": "meshSSID",
"passphrase": "passphrase"
},
"dfsChannelEnabled": false,
"cbandChannelEnabled": false,
"cbandChannelLicenseEnabled": false,
"wifi24": {
"txPower": "Full",
"channelWidth": 20,
"channel": 0,
"channelRange": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11
],
"availableChannelRange": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11
]
},
"wifi50": {
"txPower": "-1dB",
"channelWidth": 40,
"indoorChannel": 0,
"outdoorChannel": 0,
"indoorChannelRange": [
36,
40,
44,
48,
149,
153,
157,
161
],
"outdoorChannelRange": [
149,
153,
157,
161
],
"availableIndoorChannelRange": [
36,
40,
44,
48,
149,
153,
157,
161
],
"availableOutdoorChannelRange": [
149,
153,
157,
161
]
},
"protectionMode24": "CTS_ONLY",
"syslog": null,
"smartMonitor": null,
"clientAdmissionControl24": null,
"clientAdmissionControl50": null,
"channelModeEnabled": false,
"tunnelType": "No_Tunneled",
"tunnelProfile": null,
"backgroundScanning24": null,
"backgroundScanning50": null,
"clientLoadBalancing24": null,
"clientLoadBalancing50": null,
"bandBalancing": null,
"loadBalancingMethod": null,
"rogue": null,
"dosBarringEnable": 0,
"dosBarringPeriod": 60,
"dosBarringThreshold": 5,
"dosBarringCheckPeriod": 30,
"locationBasedService": null,
"apRebootTimeout": {
"gatewayLossTimeoutInSec": 1800,
"serverLossTimeoutInSec": 7200
},
"location": null,
"locationAdditionalInfo": null,
"latitude": null,
"longitude": null,
"vlanOverlappingEnabled": false,
"nodeAffinityProfile": null,
"venueProfile": null,
"autoChannelSelection24": {
"channelSelectMode": "ChannelFly",
"channelFlyMtbc": 480
},
"autoChannelSelection50": {
"channelSelectMode": "BackgroundScanning",
"channelFlyMtbc": 480
},
"channelEvaluationInterval": 777,
"apMgmtVlan": {
"id": 1,
"mode": "KEEP"
},
"ipsecProfile": {
"id": "ipsecProfileId",
"name": "ipsecProfileName"
},
"bonjourFencingPolicyEnabled": true,
"bonjourFencingPolicy": {
"id": "bonjourFencingPolicyId",
"name": "bonjourFencingPolicyName"
},
"recoverySsid": {
"recoverySsidEnabled": true
},
"dhcpSiteConfig": {
"zoneName": "zoneK",
"siteEnabled": true,
"dwpdEnabled": false,
"manualSelect": true,
"siteMode": "EnableOnMultipleAPs",
"siteAps": [
{
"apMac": "38:FF:36:00:0E:10",
"apServerEnabled": true,
"apServerPrimary": true
},
{
"apMac": "58:FF:36:00:0E:20",
"apServerEnabled": true,
"apServerPrimary": true
}
],
"siteProfileIds": [
"75e26590-547f-11e6-9ca7-5a095364c13c",
"869bb532-547f-11e6-9ca7-5a095364c13c"
]
},
"snmpAgent": {
"apSnmpEnabled": true,
"snmpV2Agent": [
{
"communityName": "v2Agent",
"notificationEnabled": true,
"readEnabled": true,
"writeEnabled": true,
"notificationType": "TRAP",
"notificationTarget": [
{
"address": "172.19.16.20",
"port": 161
}
]
}
],
"snmpV3Agent": [
{
"userName": "v3Agent",
"authProtocol": "MD5",
"authPassword": "admin!234",
"privProtocol": "DES",
"privPassword": "admin!234",
"notificationEnabled": true,
"readEnabled": true,
"writeEnabled": true,
"notificationType": "TRAP",
"notificationTarget": [
{
"address": "172.19.16.20",
"port": 161
}
]
}
]
},
"rogueApReportThreshold": 40,
"rogueApAggressivenessMode": 2,
"rogueApJammingDetection": true,
"rogueApJammingThreshold": 40,
"directedMulticastFromWiredClientEnabled": true,
"directedMulticastFromWirelessClientEnabled": true,
"directedMulticastFromNetworkEnabled": false,
"healthCheckSitesEnabled": true,
"healthCheckSites": [
"www.google.com",
"www.live.com:443",
"www.github.com:443",
"source.codeaurora.org:443",
"www.wikipedia.com"
],
"ruckusGreTunnelProfile": {
"id": "f5b92938-aa4e-4d02-90ea-273799ff689b",
"name": "Default Tunnel Profile"
},
"softGreTunnelProflies": [
{
"id": "5a2e41b0-df53-11e7-98e1-08002748d78e",
"name": "softGre1",
"aaaAffinityEnabled": true
},
{
"id": "7803e411-df53-11e7-98e1-08002748d78e",
"name": "softGre2",
"aaaAffinityEnabled": true
}
],
"ipsecProfiles": [
{
"id": "3fd9aa91-df65-11e7-98e1-08002748d78e",
"name": "ipsec1"
}
],
"sshTunnelEncryption": "AES128"
}Schema
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Identifier of the zone",
"type" : "string"
},
"domainId" : {
"description" : "Identifier of the management domain to which the zone belongs",
"type" : "string"
},
"name" : {
"description" : "Name of the zone",
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$"
},
"description" : {
"description" : "Description of the zone",
"type" : [ "string", "null" ],
"maxLength" : 64
},
"version" : {
"description" : "AP firmware version of the zone",
"type" : "string",
"pattern" : "^\d+\.\d+\.\d+\.\d+\.\d+$"
},
"countryCode" : {
"description" : "Country code of the zone",
"type" : "string"
},
"timezone" : {
"description" : "Either systemTimezone or customizedTimezone must be specified",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"systemTimezone" : {
"description" : "System defined time zone, please refer to the “Overview > Time Zone” list",
"type" : "string"
},
"customizedTimezone" : {
"description" : "User defined time zone",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"abbreviation" : {
"description" : "Time zone abbreviation",
"type" : "string",
"pattern" : "^[a-zA-Z]{3,4}$"
},
"gmtOffset" : {
"description" : "GMT offset",
"type" : "integer",
"minimum" : -11,
"maximum" : 14
},
"gmtOffsetMinute" : {
"description" : "GMT offset minute",
"type" : "integer",
"minimum" : 0,
"maximum" : 59
},
"start" : {
"description" : "Daylight saving time start",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"month" : {
"description" : "Month when daylight saving time begins",
"type" : "integer",
"enum" : [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ]
},
"week" : {
"description" : "Week of the month (1 for the first week, 2 for the second week, and so on)",
"type" : "integer",
"enum" : [ 1, 2, 3, 4, 5 ]
},
"day" : {
"description" : "Day of the week (0 for Sunday, 1 for Monday, 2 for Tuesday, and so on)",
"type" : "integer",
"enum" : [ 0, 1, 2, 3, 4, 5, 6 ]
},
"hour" : {
"description" : "Hour of the day",
"type" : "integer",
"minimum" : 0,
"maximum" : 23
}
},
"required" : [ "month", "week", "day", "hour" ]
},
"end" : {
"description" : "Daylight saving time end",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"month" : {
"description" : "Month when daylight saving time begins",
"type" : "integer",
"enum" : [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ]
},
"week" : {
"description" : "Week of the month (1 for the first week, 2 for the second week, and so on)",
"type" : "integer",
"enum" : [ 1, 2, 3, 4, 5 ]
},
"day" : {
"description" : "Day of the week (0 for Sunday, 1 for Monday, 2 for Tuesday, and so on)",
"type" : "integer",
"enum" : [ 0, 1, 2, 3, 4, 5, 6 ]
},
"hour" : {
"description" : "Hour of the day",
"type" : "integer",
"minimum" : 0,
"maximum" : 23
}
},
"required" : [ "month", "week", "day", "hour" ]
}
},
"required" : [ "abbreviation", "gmtOffset", "gmtOffsetMinute" ]
}
}
},
"login" : {
"description" : "AP administrator account",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"apLoginName" : {
"description" : "User name of the AP administrator",
"type" : "string",
"maxLength" : 64,
"pattern" : "^((?!\$\()[!-_a-~]){1,64}$"
},
"apLoginPassword" : {
"description" : "Password of the AP administrator",
"type" : "string",
"maxLength" : 64,
"pattern" : ".*(?=.{8,})(?=.*[a-zA-Z])(?=.*[0-9])(?=.*[_`~!@#$%^&*\(\)\[\]\{\}|;:'\",.\<>\/?=+-]).*"
}
},
"required" : [ "apLoginName", "apLoginPassword" ]
},
"ipMode" : {
"description" : "IP mode of the zone",
"type" : "string",
"enum" : [ "IPV4", "IPV6", "IPV4_IPV6" ]
},
"mesh" : {
"description" : "Mesh configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"ssid" : {
"description" : "SSID of the mesh network",
"type" : "string"
},
"passphrase" : {
"description" : "Passphrase for the mesh network",
"type" : "string"
},
"meshRadioIdx" : {
"description" : "Mesh radio index",
"type" : "string",
"enum" : [ "Radio24G", "Radio5G" ],
"default" : "Radio5G"
},
"zeroTouchStatus" : {
"type" : "boolean"
}
}
},
"dfsChannelEnabled" : {
"description" : "DFS Channel enabled configuration of the zone, only for the US country code .",
"type" : "boolean"
},
"cbandChannelEnabled" : {
"description" : "5.8Ghz channels enabled configuration of the zone.",
"type" : "boolean"
},
"cbandChannelLicenseEnabled" : {
"description" : "5.8Ghz channels license enabled configuration of the zone.",
"type" : "boolean"
},
"wifi24" : {
"description" : "AP 2.4GHz radio configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"autoCellSizing" : {
"description" : "Auto Cell Sizing",
"type" : "boolean"
},
"txPower" : {
"description" : "Transmission power",
"type" : "string",
"enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
"default" : "Full"
},
"channelWidth" : {
"description" : "Channel width. Zero (0) means Auto.",
"type" : "integer",
"enum" : [ 0, 20, 40 ]
},
"channel" : {
"description" : "Channel number",
"type" : "integer"
},
"channelRange" : {
"description" : "Channel range options",
"type" : "array",
"items" : {
"type" : "integer"
}
},
"availableChannelRange" : {
"description" : "Available channel range options",
"type" : "array",
"items" : {
"type" : "integer"
}
}
}
},
"wifi50" : {
"description" : "AP 5GHz radio configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"autoCellSizing" : {
"description" : "Auto Cell Sizing",
"type" : "boolean"
},
"txPower" : {
"description" : "Transmission power",
"type" : "string",
"enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
"default" : "Full"
},
"channelWidth" : {
"description" : "Channel width. Zero (0) means Auto. 8080 means 80+80MHz",
"type" : "integer",
"enum" : [ 0, 20, 40, 80, 8080, 160 ]
},
"indoorChannel" : {
"description" : "Channel number for Indoor AP",
"type" : "integer"
},
"outdoorChannel" : {
"description" : "Channel number for Outdoor AP",
"type" : "integer"
},
"indoorSecondaryChannel" : {
"description" : "Secondary channel number for Indoor AP (channelWidth is 80+80MHz only)",
"type" : "integer"
},
"outdoorSecondaryChannel" : {
"description" : "Secondary channel number for outdoor AP (channelWidth is 80+80MHz only)",
"type" : "integer"
},
"indoorChannelRange" : {
"description" : "Channel range options for Indoor AP",
"type" : "array",
"items" : {
"type" : "integer"
}
},
"outdoorChannelRange" : {
"description" : "Channel range options for outdoor AP",
"type" : "array",
"items" : {
"type" : "integer"
}
},
"availableIndoorChannelRange" : {
"description" : "Available channel range options",
"type" : "array",
"items" : {
"type" : "integer"
}
},
"availableOutdoorChannelRange" : {
"description" : "Available channel range options",
"type" : "array",
"items" : {
"type" : "integer"
}
}
}
},
"protectionMode24" : {
"description" : "AP 2.4GHz Protection mode configuration of the zone.",
"type" : "string",
"enum" : [ "NONE", "CTS_ONLY", "RTS_CTS" ],
"default" : "RTS_CTS"
},
"syslog" : {
"description" : "Syslog configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"flowLevel" : {
"description" : "Flow Level of the syslog",
"type" : "string",
"enum" : [ "GENERAL_LOGS", "CLIENT_FLOW", "ALL" ],
"default" : "GENERAL_LOGS"
},
"address" : {
"description" : "Address of the syslog server.",
"type" : "string"
},
"port" : {
"description" : "Port number of the syslog server",
"type" : "integer",
"default" : 514,
"minimum" : 1,
"maximum" : 65535
},
"protocol" : {
"description" : "Protocol of the syslog server",
"type" : "string",
"enum" : [ "IPPROTO_TCP", "IPPROTO_UDP" ],
"default" : "IPPROTO_TCP"
},
"secondaryAddress" : {
"description" : "Secondary Server Address of the syslog server",
"type" : "string"
},
"secondaryPort" : {
"description" : "Secondary Server Port of the syslog server",
"type" : "integer",
"default" : 514,
"minimum" : 1,
"maximum" : 65535
},
"secondaryProtocol" : {
"description" : "Secondary Server Protocol of the syslog server",
"type" : "string",
"enum" : [ "IPPROTO_TCP", "IPPROTO_UDP" ],
"default" : "IPPROTO_TCP"
},
"facility" : {
"description" : "Facility of the syslog server",
"type" : "string",
"enum" : [ "Keep_Original", "Local0", "Local1", "Local2", "Local3", "Local4", "Local5", "Local6", "Local7" ],
"default" : "Keep_Original"
},
"priority" : {
"description" : "Priority of the log messages",
"type" : "string",
"enum" : [ "Emergency", "Alert", "Critical", "Error", "Warning", "Notice", "Info", "All" ],
"default" : "Error"
}
}
},
"smartMonitor" : {
"description" : "Smart monitor configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"intervalInSec" : {
"description" : "Interval in seconds. This is required if smartMonitor is enabled",
"type" : "integer",
"default" : 10,
"minimum" : 5,
"maximum" : 60
},
"retryThreshold" : {
"description" : "Retry threshold. This is required if smartMonitor is enabled",
"type" : "integer",
"default" : 3,
"minimum" : 1,
"maximum" : 10
}
}
},
"clientAdmissionControl24" : {
"description" : "AP client admission control 2.4GHz radio configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"maxRadioLoadPercent" : {
"description" : "Maximum radio load percentage.",
"type" : "integer",
"default" : 75,
"minimum" : 50,
"maximum" : 100
},
"minClientCount" : {
"description" : "Minimum client count number.",
"type" : "integer",
"default" : 10,
"minimum" : 0,
"maximum" : 100
},
"minClientThroughputMbps" : {
"description" : "Minimum client throughput in Mbps.",
"type" : "number",
"default" : 0,
"minimum" : 0,
"maximum" : 100
}
}
},
"clientAdmissionControl50" : {
"description" : "AP client admission control 5GHz radio configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"maxRadioLoadPercent" : {
"description" : "Maximum radio load percentage.",
"type" : "integer",
"default" : 75,
"minimum" : 50,
"maximum" : 100
},
"minClientCount" : {
"description" : "Minimum client count number.",
"type" : "integer",
"default" : 10,
"minimum" : 0,
"maximum" : 100
},
"minClientThroughputMbps" : {
"description" : "Minimum client throughput in Mbps.",
"type" : "number",
"default" : 0,
"minimum" : 0,
"maximum" : 100
}
}
},
"channelModeEnabled" : {
"description" : "Channel mode configuration of the zone.",
"type" : "boolean"
},
"tunnelType" : {
"description" : "Tunnel type configuration of the zone. No_Tunneled is for IPv6 mode",
"type" : "string",
"enum" : [ "No_Tunneled", "RuckusGRE", "SoftGRE", "SoftGREIpsec" ],
"default" : "RuckusGRE"
},
"tunnelProfile" : {
"description" : "Tunnel type configuration of the zone.",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"backgroundScanning24" : {
"description" : "Background scanning on 2.4GHz radio configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"frequencyInSec" : {
"description" : "Frequency in second",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535,
"default" : 20
}
}
},
"backgroundScanning50" : {
"description" : "Background scanning on 5GHz radio configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"frequencyInSec" : {
"description" : "Frequency in second",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535,
"default" : 20
}
}
},
"clientLoadBalancing24" : {
"description" : "Client load balancing on 2.4GHz radio configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"adjacentRadioThreshold" : {
"description" : "Adjacent radio threshold",
"type" : "integer",
"minimum" : 1,
"maximum" : 100
}
}
},
"clientLoadBalancing50" : {
"description" : "Client load balancing on 5GHz radio configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"adjacentRadioThreshold" : {
"description" : "Adjacent radio threshold",
"type" : "integer",
"minimum" : 1,
"maximum" : 100
}
}
},
"bandBalancing" : {
"description" : "Band balancing configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"mode" : {
"description" : "Band Balancing Mode: BASIC-Withholds probe and authentication responses at connetcion time in heavily loaded band to balance clients to the other band, PROACTIVE-Uses BASIC functionality and actively rebalances clients via 802.11v BTM, STRICT-Uses PROACTIVE functionality and forcefully rebalances clients via 802.11v BTM",
"type" : "string",
"enum" : [ "BASIC", "PROACTIVE", "STRICT" ],
"default" : "BASIC"
},
"wifi24Percentage" : {
"description" : "Percentage of client load on 2.4GHz radio band",
"type" : "integer",
"minimum" : 0,
"maximum" : 100,
"default" : 25
}
}
},
"loadBalancingMethod" : {
"type" : "string",
"enum" : [ "BASED_ON_CLIENT_COUNT", "BASED_ON_CAPACITY", "OFF" ],
"default" : "BASED_ON_CLIENT_COUNT"
},
"rogue" : {
"description" : "Rogue AP detection configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"reportType" : {
"description" : "Report type",
"type" : "string",
"enum" : [ "All", "Malicious" ]
},
"maliciousTypes" : {
"description" : "Malicious type when reportType is Malicious",
"type" : [ "array", "null" ],
"items" : {
"type" : "string",
"enum" : [ "SSIDSpoofing", "SameNetwork", "MACSpoofing" ]
}
},
"protectionEnabled" : {
"description" : "Protection enabled",
"type" : "boolean"
}
}
},
"dosBarringEnable" : {
"description" : "Enable DoS Protection(Barring UE) of the zone.",
"type" : "integer"
},
"dosBarringPeriod" : {
"description" : "DoS Protection(Barring UE) blocking period of the zone.",
"type" : "integer"
},
"dosBarringThreshold" : {
"description" : "DoS Protection(Barring UE) threshold of the zone.",
"type" : "integer"
},
"dosBarringCheckPeriod" : {
"description" : "DoS Protection(Barring UE) check period of the zone.",
"type" : "integer"
},
"locationBasedService" : {
"description" : "Location based service configuration of the zone.",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"apRebootTimeout" : {
"description" : "AP reboot timeout of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"gatewayLossTimeoutInSec" : {
"description" : "Gateway loss timeout in second",
"type" : "integer",
"enum" : [ 0, 1800, 3600, 5400, 7200, 9000, 10800, 12600, 14400, 16200, 18000, 19800, 23400, 25200, 27000, 28800, 30600, 32400, 34200, 36000, 37800, 39600, 41400, 43200, 45000, 46800, 48600, 50400, 52200, 54000, 55800, 57600, 59400, 61200, 63000, 64800, 66600, 68400, 70200, 72000, 73800, 75600, 77400, 79200, 81000, 82800, 84600, 86400 ],
"default" : 1800
},
"serverLossTimeoutInSec" : {
"description" : "Server loss timeout in second",
"type" : "integer",
"enum" : [ 0, 7200, 14400, 21600, 28800, 36000, 43200, 50400, 57600, 64800, 72000, 79200, 86400 ],
"default" : 7200
}
}
},
"location" : {
"description" : "Location of the Zone.",
"type" : "string"
},
"locationAdditionalInfo" : {
"description" : "Location additional info of the zone.",
"type" : "string",
"pattern" : "^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
},
"altitude" : {
"description" : "GPS Altitude",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"altitudeUnit" : {
"description" : "altitude unit",
"type" : "string",
"enum" : [ "meters", "floor" ],
"default" : "meters"
},
"altitudeValue" : {
"description" : "altitude value",
"type" : "integer"
}
}
},
"latitude" : {
"description" : "Latitude coordinate (in decimal format) of the zone",
"type" : "number"
},
"longitude" : {
"description" : "Longitude coordinate (in decimal format) of the zone",
"type" : "number"
},
"vlanOverlappingEnabled" : {
"description" : "VLAN pooling overlapping of the zone",
"type" : "boolean"
},
"nodeAffinityProfile" : {
"description" : "Node affinity profile of the zone.",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"venueProfile" : {
"description" : "venue profile configuration of the Zone.",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"autoChannelSelection24" : {
"description" : "client load balancing on Radio 2.4G, auto channel selection mode",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"channelSelectMode" : {
"description" : "Channel Select Mode",
"type" : "string",
"enum" : [ "None", "BackgroundScanning", "ChannelFly" ],
"default" : "BackgroundScanning"
},
"channelFlyMtbc" : {
"description" : "ChannelFly MTBC",
"type" : "integer",
"default" : 480,
"minimum" : 100,
"maximum" : 1440
}
}
},
"autoChannelSelection50" : {
"description" : "client load balancing on Radio 5G, auto channel selection mode",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"channelSelectMode" : {
"description" : "Channel Select Mode",
"type" : "string",
"enum" : [ "None", "BackgroundScanning", "ChannelFly" ],
"default" : "BackgroundScanning"
},
"channelFlyMtbc" : {
"description" : "ChannelFly MTBC",
"type" : "integer",
"default" : 480,
"minimum" : 100,
"maximum" : 1440
}
}
},
"channelEvaluationInterval" : {
"description" : "channel evaluation Interval of the zone",
"type" : "integer",
"default" : 600,
"minimum" : 60,
"maximum" : 3600
},
"apMgmtVlan" : {
"description" : "ap Management Vlan of the zone",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"mode" : {
"description" : "Vlan Mode of the zone",
"type" : "string",
"enum" : [ "KEEP", "USER_DEFINED" ],
"default" : "KEEP"
},
"id" : {
"description" : "Vlan id of the zone",
"type" : "integer",
"default" : "1"
}
}
},
"apLatencyInterval" : {
"description" : "AP latency interval",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"pingEnabled" : {
"description" : "AP ping latency enabled",
"type" : "boolean",
"default" : true
}
}
},
"ipsecProfile" : {
"description" : "ipsec profile configuration of the Zone.",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"ipv6TrafficFilterEnabled" : {
"description" : "IPv6 Traffic filtering on the AP",
"type" : "integer"
},
"bonjourFencingPolicyEnabled" : {
"description" : "Enable Bonjour Fencing Policy on the AP",
"type" : "boolean"
},
"bonjourFencingPolicy" : {
"description" : "Bonjour Fencing Policy on the AP",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"dhcpSiteConfig" : {
"description" : "DHCP Site Configuration in Zone",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"siteEnabled" : {
"description" : "DHCP Service Enabling Status",
"type" : "boolean"
},
"dwpdEnabled" : {
"description" : "DHCP Service Dynamic WAN Port Detection",
"type" : "boolean"
},
"manualSelect" : {
"description" : "DHCP Service AP Selection Mode. This value is effective when the siteMode is EnableOnMultipleAPs.",
"type" : "boolean"
},
"siteMode" : {
"description" : "DHCP Service mode",
"type" : "string",
"enum" : [ "EnableOnEachAPs", "EnableOnMultipleAPs", "EnableOnHierarchicalAPs" ]
},
"eth0ProfileId" : {
"type" : "integer"
},
"eth1ProfileId" : {
"type" : "integer"
},
"siteAps" : {
"type" : "array",
"items" : {
"type" : "object",
"description" : "DHCP Site selected APs. The content is effective when the siteMode is EnableOnMultipleAPs.",
"additionalProperties" : false,
"properties" : {
"apMac" : {
"type" : "string"
},
"apName" : {
"type" : "string"
},
"apStatus" : {
"type" : "string",
"enum" : [ "Online", "Offline", "Flagged" ]
},
"apServerEnabled" : {
"type" : "boolean"
},
"apServerPrimary" : {
"type" : "boolean"
},
"apServerIp" : {
"type" : [ "string", "null" ]
},
"apGatewayIp" : {
"type" : "string"
}
}
}
},
"siteProfileIds" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
}
},
"snmpAgent" : {
"description" : "AP SNMP Options",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"apSnmpEnabled" : {
"description" : "Enable AP SNMP",
"type" : "boolean"
},
"snmpV2Agent" : {
"description" : "Community List of the SNMP V2 Agent.",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"communityName" : {
"description" : "name of the SNMP Community.",
"type" : "string"
},
"readEnabled" : {
"description" : "read privilege of the SNMP Coummunity",
"type" : "boolean"
},
"writeEnabled" : {
"description" : "write privilege of the SNMP Coummunity",
"type" : "boolean"
},
"notificationEnabled" : {
"description" : "notification privilege of the SNMP Coummunity",
"type" : "boolean"
},
"notificationType" : {
"description" : "type of the notification privilege",
"type" : "string",
"enum" : [ "TRAP", "INFORM" ]
},
"notificationTarget" : {
"description" : "Trap List of the SNMP Coummunity",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"address" : {
"description" : "address of the SNMP Trap",
"type" : "string"
},
"port" : {
"description" : "port number of the SNMP Trap",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
}
},
"required" : [ "address", "port" ]
}
}
},
"required" : [ "communityName" ]
}
},
"snmpV3Agent" : {
"description" : "User List of the SNMP V3 Agent.",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"userName" : {
"description" : "name of the SNMP User.",
"type" : "string"
},
"authProtocol" : {
"description" : "authProtocol of the SNMP User.",
"type" : "string",
"enum" : [ "NONE", "MD5", "SHA" ]
},
"authPassword" : {
"description" : "authPassword of the SNMP User.",
"type" : "string",
"minLength" : 8
},
"privProtocol" : {
"description" : "privProtocol of the SNMP User.",
"type" : "string",
"enum" : [ "NONE", "DES", "AES" ]
},
"privPassword" : {
"description" : "privPassword of the SNMP User.",
"type" : "string",
"minLength" : 8
},
"readEnabled" : {
"description" : "read privilege of the SNMP User",
"type" : "boolean"
},
"writeEnabled" : {
"description" : "write privilege of the SNMP User",
"type" : "boolean"
},
"notificationEnabled" : {
"description" : "notification privilege of the SNMP User",
"type" : "boolean"
},
"notificationType" : {
"description" : "type of the notification privilege",
"type" : "string",
"enum" : [ "TRAP", "INFORM" ]
},
"notificationTarget" : {
"description" : "Trap List of the SNMP User",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"address" : {
"description" : "address of the SNMP Trap",
"type" : "string"
},
"port" : {
"description" : "port number of the SNMP Trap",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
}
},
"required" : [ "address", "port" ]
}
}
},
"required" : [ "userName" ]
}
}
}
},
"recoverySsid" : {
"description" : "Recovery SSID",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"recoverySsidEnabled" : {
"description" : "recovery ssid enable/disable",
"type" : "boolean"
}
}
},
"clusterRedundancyEnabled" : {
"description" : "Enable Cluster redundancy on zone",
"type" : "boolean"
},
"rogueApReportThreshold" : {
"description" : "Rogue AP report will leave out all entries that have signal strength lower than this threshold.",
"type" : "integer"
},
"rogueApAggressivenessMode" : {
"description" : "Adjust the frequency interval to de-authenticate rogue APs.",
"type" : "integer"
},
"rogueApJammingDetection" : {
"description" : "Enable jamming detection.",
"type" : "boolean"
},
"rogueApJammingThreshold" : {
"type" : "integer"
},
"directedMulticastFromWiredClientEnabled" : {
"description" : "Directed multicast from wired client.",
"type" : "boolean"
},
"directedMulticastFromWirelessClientEnabled" : {
"description" : "Directed multicast from wireless client.",
"type" : "boolean"
},
"directedMulticastFromNetworkEnabled" : {
"description" : "Directed multicast from network.",
"type" : "boolean"
},
"healthCheckSitesEnabled" : {
"description" : "Enabled Health Check Sites. ",
"type" : "boolean",
"default" : false
},
"healthCheckSites" : {
"description" : "Health Check Sites.",
"type" : "array",
"items" : {
"type" : "string"
}
},
"ruckusGreTunnelProfile" : {
"description" : "Ruckus GRE Profile for Multiple Tunnel (Start from SZ 5.0)",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"softGreTunnelProflies" : {
"description" : "SoftGRE Profiles for Multiple Tunnel (Start from SZ 5.0)",
"type" : "array",
"items" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"aaaAffinityEnabled" : {
"type" : "boolean"
}
}
}
},
"ipsecProfiles" : {
"description" : "Ipsec profile for Multiple Tunnel (Start from SZ 5.0)",
"type" : "array",
"items" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
}
},
"sshTunnelEncryption" : {
"type" : "string",
"enum" : [ "AES128", "AES256" ]
}
}
}Modify Mesh Configuration ¶
PATCH/v8_0/rkszones/{id}/mesh
Use this API command to enable mesh networking or update the mesh configuration.
Body
{
"ssid": "meshSSID",
"passphrase": "passphrase"
}Schema
{
"description": "Mesh configuration of the zone.",
"type": "object",
"additionalProperties": false,
"properties": {
"ssid": {
"description": "SSID of the mesh network",
"type": "string"
},
"passphrase": {
"description": "Passphrase for the mesh network",
"type": "string"
},
"meshRadioIdx": {
"description": "Mesh radio index",
"type": "string",
"enum": [
"Radio24G",
"Radio5G"
]
},
"zeroTouchStatus": {
"type": "boolean"
}
}
}204Modify ¶
PATCH/v8_0/rkszones/{id}
Use this API command to modify the basic information of a zone.
Body
{
"domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
"zoneAffinityProfileId": "3fd9aa91-df65-11e7-98e1-08002748d78e",
"name": "modifyZoneName",
"description": "description Zone",
"countryCode": "US",
"timezone": {
"systemTimezone": "America/Whitehorse"
},
"login": {
"apLoginName": "admin",
"apLoginPassword": "admin!234"
},
"mesh": {
"ssid": "meshSSID",
"passphrase": "passphrase"
},
"dfsChannelEnabled": false,
"wifi24": {
"txPower": "Full",
"channelWidth": 20,
"channel": 0,
"channelRange": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11
]
},
"wifi50": {
"txPower": "-1dB",
"channelWidth": 40,
"indoorChannel": 0,
"outdoorChannel": 0,
"indoorChannelRange": [
36,
40,
44,
48,
149,
153,
157,
161
],
"outdoorChannelRange": [
149,
153,
157,
161
]
},
"protectionMode24": "CTS_ONLY",
"syslog": {
"address": "1.1.1.1",
"port": 514,
"facility": "Local0",
"priority": "Error"
},
"smartMonitor": {
"intervalInSec": 10,
"retryThreshold": 3
},
"nodeAffinityProfile": null,
"venueProfile": null,
"locationBasedService": null,
"channelModeEnabled": false,
"bonjourFencingPolicy": null,
"tunnelType": "RuckusGRE",
"tunnelProfile": {
"id": "f5b92938-aa4e-4d02-90ea-273799ff689b",
"name": "Default Tunnel Profile"
},
"clientAdmissionControl24": {
"maxRadioLoadPercent": 70,
"minClientCount": 10,
"minClientThroughputMbps": 10
},
"clientAdmissionControl50": {
"maxRadioLoadPercent": 70,
"minClientCount": 10,
"minClientThroughputMbps": 10
},
"backgroundScanning24": {
"frequencyInSec": 20
},
"backgroundScanning50": {
"frequencyInSec": 20
},
"clientLoadBalancing24": {
"adjacentRadioThreshold": 12
},
"clientLoadBalancing50": {
"adjacentRadioThreshold": 12
},
"bandBalancing": {
"wifi24Percentage": 10
},
"loadBalancingMethod": "BASED_ON_CLIENT_COUNT",
"rogue": {
"reportType": "All",
"maliciousTypes": null,
"protectionEnabled": true
},
"dosBarringEnable": 0,
"dosBarringPeriod": 60,
"dosBarringThreshold": 5,
"dosBarringCheckPeriod": 30,
"apRebootTimeout": {
"gatewayLossTimeoutInSec": 1800,
"serverLossTimeoutInSec": 7200
},
"location": "location",
"locationAdditionalInfo": "locationAdditionalInfo",
"latitude": 23,
"longitude": 23,
"vlanOverlappingEnabled": false,
"autoChannelSelection24": {
"channelSelectMode": "ChannelFly",
"channelFlyMtbc": 480
},
"autoChannelSelection50": {
"channelSelectMode": "BackgroundScanning",
"channelFlyMtbc": 480
},
"channelEvaluationInterval": 777,
"apMgmtVlan": {
"id": 1,
"mode": "KEEP"
},
"apLatencyInterval": {
"pingEnabled": true
},
"ipsecProfile": {
"id": "ipsecProfileId",
"name": "ipsecProfileName"
},
"altitude": {
"altitudeUnit": "meters",
"altitudeValue": 1
},
"bonjourFencingPolicyEnabled": false,
"snmpAgent": {
"apSnmpEnabled": true,
"snmpV2Agent": [
{
"communityName": "v2Agent",
"notificationEnabled": true,
"readEnabled": true,
"writeEnabled": true,
"notificationType": "TRAP",
"notificationTarget": [
{
"address": "172.19.16.20",
"port": 161
}
]
}
],
"snmpV3Agent": [
{
"userName": "v3Agent",
"authProtocol": "MD5",
"authPassword": "admin!234",
"privProtocol": "DES",
"privPassword": "admin!234",
"notificationEnabled": true,
"readEnabled": true,
"writeEnabled": true,
"notificationType": "TRAP",
"notificationTarget": [
{
"address": "172.19.16.20",
"port": 161
}
]
}
]
},
"recoverySsid": {
"recoverySsidEnabled": true
},
"dhcpSiteConfig": {
"siteEnabled": true,
"siteMode": "EnableOnEachAPs",
"siteProfileIds": [
"75e26590-547f-11e6-9ca7-5a095364c13c",
"869bb532-547f-11e6-9ca7-5a095364c13c"
]
},
"rogueApReportThreshold": 40,
"rogueApAggressivenessMode": 2,
"rogueApJammingDetection": true,
"rogueApJammingThreshold": 40,
"directedMulticastFromWiredClientEnabled": true,
"directedMulticastFromWirelessClientEnabled": true,
"directedMulticastFromNetworkEnabled": false,
"healthCheckSitesEnabled": true,
"healthCheckSites": [
"www.google.com",
"www.live.com:443",
"www.github.com:443",
"source.codeaurora.org:443",
"www.wikipedia.com"
],
"ruckusGreTunnelProfile": {
"id": "f5b92938-aa4e-4d02-90ea-273799ff689b",
"name": "Default Tunnel Profile"
},
"softGreTunnelProflies": [
{
"id": "5a2e41b0-df53-11e7-98e1-08002748d78e",
"name": "softGre1",
"aaaAffinityEnabled": true
},
{
"id": "7803e411-df53-11e7-98e1-08002748d78e",
"name": "softGre2",
"aaaAffinityEnabled": true
}
],
"ipsecProfiles": [
{
"id": "3fd9aa91-df65-11e7-98e1-08002748d78e",
"name": "ipsec1"
}
],
"sshTunnelEncryption": "AES128"
}Schema
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"domainId" : {
"description" : "Identifier of the management domain to which the zone belongs",
"type" : "string"
},
"zoneAffinityProfileId" : {
"description" : "Identifier of the ZoneAffinityProfile",
"type" : "string"
},
"name" : {
"description" : "Name of the zone",
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$"
},
"description" : {
"description" : "Description of the zone",
"type" : [ "string", "null" ],
"maxLength" : 64
},
"countryCode" : {
"description" : "Country code of the zone",
"type" : "string"
},
"timezone" : {
"description" : "Either systemTimezone or customizedTimezone must be specified",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"systemTimezone" : {
"description" : "System defined time zone, please refer to the “Overview > Time Zone” list",
"type" : "string"
},
"customizedTimezone" : {
"description" : "User defined time zone",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"abbreviation" : {
"description" : "Time zone abbreviation",
"type" : "string",
"pattern" : "^[a-zA-Z]{3,4}$"
},
"gmtOffset" : {
"description" : "GMT offset",
"type" : "integer",
"minimum" : -11,
"maximum" : 14
},
"gmtOffsetMinute" : {
"description" : "GMT offset minute",
"type" : "integer",
"minimum" : 0,
"maximum" : 59
},
"start" : {
"description" : "Daylight saving time start",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"month" : {
"description" : "Month when daylight saving time begins",
"type" : "integer",
"enum" : [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ]
},
"week" : {
"description" : "Week of the month (1 for the first week, 2 for the second week, and so on)",
"type" : "integer",
"enum" : [ 1, 2, 3, 4, 5 ]
},
"day" : {
"description" : "Day of the week (0 for Sunday, 1 for Monday, 2 for Tuesday, and so on)",
"type" : "integer",
"enum" : [ 0, 1, 2, 3, 4, 5, 6 ]
},
"hour" : {
"description" : "Hour of the day",
"type" : "integer",
"minimum" : 0,
"maximum" : 23
}
},
"required" : [ "month", "week", "day", "hour" ]
},
"end" : {
"description" : "Daylight saving time end",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"month" : {
"description" : "Month when daylight saving time begins",
"type" : "integer",
"enum" : [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ]
},
"week" : {
"description" : "Week of the month (1 for the first week, 2 for the second week, and so on)",
"type" : "integer",
"enum" : [ 1, 2, 3, 4, 5 ]
},
"day" : {
"description" : "Day of the week (0 for Sunday, 1 for Monday, 2 for Tuesday, and so on)",
"type" : "integer",
"enum" : [ 0, 1, 2, 3, 4, 5, 6 ]
},
"hour" : {
"description" : "Hour of the day",
"type" : "integer",
"minimum" : 0,
"maximum" : 23
}
},
"required" : [ "month", "week", "day", "hour" ]
}
},
"required" : [ "abbreviation", "gmtOffset", "gmtOffsetMinute" ]
}
}
},
"login" : {
"description" : "AP administrator account",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"apLoginName" : {
"description" : "User name of the AP administrator",
"type" : "string",
"maxLength" : 64,
"pattern" : "^((?!\$\()[!-_a-~]){1,64}$"
},
"apLoginPassword" : {
"description" : "Password of the AP administrator",
"type" : "string",
"maxLength" : 64,
"pattern" : ".*(?=.{8,})(?=.*[a-zA-Z])(?=.*[0-9])(?=.*[_`~!@#$%^&*\(\)\[\]\{\}|;:'\",.\<>\/?=+-]).*"
}
},
"required" : [ "apLoginName", "apLoginPassword" ]
},
"mesh" : {
"description" : "Mesh configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"ssid" : {
"description" : "SSID of the mesh network",
"type" : "string"
},
"passphrase" : {
"description" : "Passphrase for the mesh network",
"type" : "string"
},
"meshRadioIdx" : {
"description" : "Mesh radio index",
"type" : "string",
"enum" : [ "Radio24G", "Radio5G" ]
},
"zeroTouchStatus" : {
"type" : "boolean"
}
}
},
"dfsChannelEnabled" : {
"description" : "DFS Channel enabled configuration of the zone, only for the US country code .",
"type" : "boolean"
},
"cbandChannelEnabled" : {
"description" : "5.8Ghz channels enabled configuration of the zone.",
"type" : "boolean"
},
"cbandChannelLicenseEnabled" : {
"description" : "5.8Ghz channels license enabled configuration of the zone.",
"type" : "boolean"
},
"wifi24" : {
"description" : "AP 2.4GHz radio configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"autoCellSizing" : {
"description" : "Auto Cell Sizing",
"type" : "boolean"
},
"txPower" : {
"description" : "Transmission power",
"type" : "string",
"enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ]
},
"channelWidth" : {
"description" : "Channel width. Zero (0) means Auto.",
"type" : "integer",
"enum" : [ 0, 20, 40 ]
},
"channel" : {
"description" : "Channel number",
"type" : "integer"
},
"channelRange" : {
"description" : "Channel range options",
"type" : "array",
"items" : {
"type" : "integer"
}
}
}
},
"wifi50" : {
"description" : "AP 5GHz radio configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"autoCellSizing" : {
"description" : "Auto Cell Sizing",
"type" : "boolean"
},
"txPower" : {
"description" : "Transmission power",
"type" : "string",
"enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ]
},
"channelWidth" : {
"description" : "Channel width. Zero (0) means Auto. 8080 means 80+80MHz",
"type" : "integer",
"enum" : [ 0, 20, 40, 80, 8080, 160 ]
},
"indoorChannel" : {
"description" : "Channel number for Indoor AP",
"type" : "integer"
},
"outdoorChannel" : {
"description" : "Channel number for Outdoor AP",
"type" : "integer"
},
"indoorSecondaryChannel" : {
"description" : "Secondary channel number for Indoor AP (channelWidth is 80+80MHz only)",
"type" : "integer"
},
"outdoorSecondaryChannel" : {
"description" : "Secondary channel number for outdoor AP (channelWidth is 80+80MHz only)",
"type" : "integer"
},
"indoorChannelRange" : {
"description" : "Channel range options for Indoor AP",
"type" : "array",
"items" : {
"type" : "integer"
}
},
"outdoorChannelRange" : {
"description" : "Channel range options for outdoor AP",
"type" : "array",
"items" : {
"type" : "integer"
}
}
}
},
"protectionMode24" : {
"description" : "AP 2.4GHz Protection mode configuration of the zone.",
"type" : "string",
"enum" : [ "NONE", "CTS_ONLY", "RTS_CTS" ]
},
"syslog" : {
"description" : "Syslog configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"flowLevel" : {
"description" : "Flow Level of the syslog",
"type" : "string",
"enum" : [ "GENERAL_LOGS", "CLIENT_FLOW", "ALL" ]
},
"address" : {
"description" : "Address of the syslog server.",
"type" : "string"
},
"port" : {
"description" : "Port number of the syslog server",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
},
"protocol" : {
"description" : "Protocol of the syslog server",
"type" : "string",
"enum" : [ "IPPROTO_TCP", "IPPROTO_UDP" ]
},
"secondaryAddress" : {
"description" : "Secondary Server Address of the syslog server",
"type" : "string"
},
"secondaryPort" : {
"description" : "Secondary Server Port of the syslog server",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
},
"secondaryProtocol" : {
"description" : "Secondary Server Protocol of the syslog server",
"type" : "string",
"enum" : [ "IPPROTO_TCP", "IPPROTO_UDP" ]
},
"facility" : {
"description" : "Facility of the syslog server",
"type" : "string",
"enum" : [ "Keep_Original", "Local0", "Local1", "Local2", "Local3", "Local4", "Local5", "Local6", "Local7" ]
},
"priority" : {
"description" : "Priority of the log messages",
"type" : "string",
"enum" : [ "Emergency", "Alert", "Critical", "Error", "Warning", "Notice", "Info", "All" ]
}
}
},
"smartMonitor" : {
"description" : "Smart monitor configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"intervalInSec" : {
"description" : "Interval in seconds. This is required if smartMonitor is enabled",
"type" : "integer",
"minimum" : 5,
"maximum" : 60
},
"retryThreshold" : {
"description" : "Retry threshold. This is required if smartMonitor is enabled",
"type" : "integer",
"minimum" : 1,
"maximum" : 10
}
}
},
"clientAdmissionControl24" : {
"description" : "AP client admission control 2.4GHz radio configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"maxRadioLoadPercent" : {
"description" : "Maximum radio load percentage.",
"type" : "integer",
"minimum" : 50,
"maximum" : 100
},
"minClientCount" : {
"description" : "Minimum client count number.",
"type" : "integer",
"minimum" : 0,
"maximum" : 100
},
"minClientThroughputMbps" : {
"description" : "Minimum client throughput in Mbps.",
"type" : "number",
"minimum" : 0,
"maximum" : 100
}
}
},
"clientAdmissionControl50" : {
"description" : "AP client admission control 5GHz radio configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"maxRadioLoadPercent" : {
"description" : "Maximum radio load percentage.",
"type" : "integer",
"minimum" : 50,
"maximum" : 100
},
"minClientCount" : {
"description" : "Minimum client count number.",
"type" : "integer",
"minimum" : 0,
"maximum" : 100
},
"minClientThroughputMbps" : {
"description" : "Minimum client throughput in Mbps.",
"type" : "number",
"minimum" : 0,
"maximum" : 100
}
}
},
"channelModeEnabled" : {
"description" : "Channel mode configuration of the zone.",
"type" : "boolean"
},
"tunnelType" : {
"description" : "Tunnel type configuration of the zone. No_Tunneled is for IPv6 mode",
"type" : "string",
"enum" : [ "No_Tunneled", "RuckusGRE", "SoftGRE", "SoftGREIpsec" ]
},
"tunnelProfile" : {
"description" : "Tunnel type configuration of the zone.",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"backgroundScanning24" : {
"description" : "Background scanning on 2.4GHz radio configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"frequencyInSec" : {
"description" : "Frequency in second",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
}
}
},
"backgroundScanning50" : {
"description" : "Background scanning on 5GHz radio configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"frequencyInSec" : {
"description" : "Frequency in second",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
}
}
},
"clientLoadBalancing24" : {
"description" : "Client load balancing on 2.4GHz radio configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"adjacentRadioThreshold" : {
"description" : "Adjacent radio threshold",
"type" : "integer",
"minimum" : 1,
"maximum" : 100
}
}
},
"clientLoadBalancing50" : {
"description" : "Client load balancing on 5GHz radio configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"adjacentRadioThreshold" : {
"description" : "Adjacent radio threshold",
"type" : "integer",
"minimum" : 1,
"maximum" : 100
}
}
},
"bandBalancing" : {
"description" : "Band balancing configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"mode" : {
"description" : "Band Balancing Mode: BASIC-Withholds probe and authentication responses at connetcion time in heavily loaded band to balance clients to the other band, PROACTIVE-Uses BASIC functionality and actively rebalances clients via 802.11v BTM, STRICT-Uses PROACTIVE functionality and forcefully rebalances clients via 802.11v BTM",
"type" : "string",
"enum" : [ "BASIC", "PROACTIVE", "STRICT" ]
},
"wifi24Percentage" : {
"description" : "Percentage of client load on 2.4GHz radio band",
"type" : "integer",
"minimum" : 0,
"maximum" : 100
}
}
},
"loadBalancingMethod" : {
"type" : "string",
"enum" : [ "BASED_ON_CLIENT_COUNT", "BASED_ON_CAPACITY", "OFF" ]
},
"rogue" : {
"description" : "Rogue AP detection configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"reportType" : {
"description" : "Report type",
"type" : "string",
"enum" : [ "All", "Malicious" ]
},
"maliciousTypes" : {
"description" : "Malicious type when reportType is Malicious",
"type" : [ "array", "null" ],
"items" : {
"type" : "string",
"enum" : [ "SSIDSpoofing", "SameNetwork", "MACSpoofing" ]
}
},
"protectionEnabled" : {
"description" : "Protection enabled",
"type" : "boolean"
}
}
},
"dosBarringEnable" : {
"description" : "Enable DoS Protection(Barring UE) of the zone.",
"type" : "integer"
},
"dosBarringPeriod" : {
"description" : "DoS Protection(Barring UE) blocking period of the zone.",
"type" : "integer"
},
"dosBarringThreshold" : {
"description" : "DoS Protection(Barring UE) threshold of the zone.",
"type" : "integer"
},
"dosBarringCheckPeriod" : {
"description" : "DoS Protection(Barring UE) check period of the zone.",
"type" : "integer"
},
"locationBasedService" : {
"description" : "Location based service configuration of the zone.",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"apRebootTimeout" : {
"description" : "AP reboot timeout of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"gatewayLossTimeoutInSec" : {
"description" : "Gateway loss timeout in second",
"type" : "integer",
"enum" : [ 0, 1800, 3600, 5400, 7200, 9000, 10800, 12600, 14400, 16200, 18000, 19800, 23400, 25200, 27000, 28800, 30600, 32400, 34200, 36000, 37800, 39600, 41400, 43200, 45000, 46800, 48600, 50400, 52200, 54000, 55800, 57600, 59400, 61200, 63000, 64800, 66600, 68400, 70200, 72000, 73800, 75600, 77400, 79200, 81000, 82800, 84600, 86400 ]
},
"serverLossTimeoutInSec" : {
"description" : "Server loss timeout in second",
"type" : "integer",
"enum" : [ 0, 7200, 14400, 21600, 28800, 36000, 43200, 50400, 57600, 64800, 72000, 79200, 86400 ]
}
}
},
"location" : {
"description" : "Location of the zone.",
"type" : "string"
},
"locationAdditionalInfo" : {
"description" : "Location additional info of the zone.",
"type" : "string",
"pattern" : "^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
},
"altitude" : {
"description" : "GPS Altitude",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"altitudeUnit" : {
"description" : "altitude unit",
"type" : "string",
"enum" : [ "meters", "floor" ]
},
"altitudeValue" : {
"description" : "altitude value",
"type" : "integer"
}
}
},
"latitude" : {
"description" : "Latitude coordinate (in decimal format) of the zone",
"type" : "number"
},
"longitude" : {
"description" : "Longitude coordinate (in decimal format) of the zone",
"type" : "number"
},
"vlanOverlappingEnabled" : {
"description" : "VLAN pooling overlapping of the zone",
"type" : "boolean"
},
"nodeAffinityProfile" : {
"description" : "Node affinity profile of the zone.",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"venueProfile" : {
"description" : "Venue profile configuration of the zone.",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"autoChannelSelection24" : {
"description" : "client load balancing on Radio 2.4G, auto channel selection mode",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"channelSelectMode" : {
"description" : "Channel Select Mode",
"type" : "string",
"enum" : [ "None", "BackgroundScanning", "ChannelFly" ]
},
"channelFlyMtbc" : {
"description" : "ChannelFly MTBC",
"type" : "integer",
"minimum" : 100,
"maximum" : 1440
}
}
},
"autoChannelSelection50" : {
"description" : "client load balancing on Radio 5G, auto channel selection mode",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"channelSelectMode" : {
"description" : "Channel Select Mode",
"type" : "string",
"enum" : [ "None", "BackgroundScanning", "ChannelFly" ]
},
"channelFlyMtbc" : {
"description" : "ChannelFly MTBC",
"type" : "integer",
"minimum" : 100,
"maximum" : 1440
}
}
},
"channelEvaluationInterval" : {
"description" : "channel evaluation Interval of the zone",
"type" : "integer",
"minimum" : 60,
"maximum" : 3600
},
"apMgmtVlan" : {
"description" : "ap Management Vlan of the zone",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"mode" : {
"description" : "Vlan Mode of the zone",
"type" : "string",
"enum" : [ "KEEP", "USER_DEFINED" ]
},
"id" : {
"description" : "Vlan id of the zone",
"type" : "integer"
}
}
},
"apLatencyInterval" : {
"description" : "AP latency interval",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"pingEnabled" : {
"description" : "AP ping latency enabled",
"type" : "boolean"
}
}
},
"ipsecProfile" : {
"description" : "ipsec profile configuration of the Zone.",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"ipv6TrafficFilterEnabled" : {
"description" : "IPv6 Traffic filtering on the AP",
"type" : "integer"
},
"bonjourFencingPolicyEnabled" : {
"description" : "Enable Bonjour Fencing Policy on the AP",
"type" : "boolean"
},
"bonjourFencingPolicy" : {
"description" : "Bonjour Fencing Policy on the AP",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"dhcpSiteConfig" : {
"description" : "DHCP Site Configuration in Zone",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"siteEnabled" : {
"description" : "DHCP Service Enabling Status",
"type" : "boolean"
},
"dwpdEnabled" : {
"description" : "DHCP Service Dynamic WAN Port Detection",
"type" : "boolean"
},
"manualSelect" : {
"description" : "DHCP Service AP Selection Mode. This value is effective when the siteMode is EnableOnMultipleAPs.",
"type" : "boolean"
},
"siteMode" : {
"description" : "DHCP Service mode",
"type" : "string",
"enum" : [ "EnableOnEachAPs", "EnableOnMultipleAPs", "EnableOnHierarchicalAPs" ]
},
"eth0ProfileId" : {
"type" : "integer"
},
"eth1ProfileId" : {
"type" : "integer"
},
"siteAps" : {
"type" : "array",
"items" : {
"type" : "object",
"description" : "DHCP Site selected APs. The content is effective when the siteMode is EnableOnMultipleAPs.",
"additionalProperties" : false,
"properties" : {
"apMac" : {
"type" : "string"
},
"apName" : {
"type" : "string"
},
"apStatus" : {
"type" : "string",
"enum" : [ "Online", "Offline", "Flagged" ]
},
"apServerEnabled" : {
"type" : "boolean"
},
"apServerPrimary" : {
"type" : "boolean"
},
"apServerIp" : {
"type" : [ "string", "null" ]
},
"apGatewayIp" : {
"type" : "string"
}
}
}
},
"siteProfileIds" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
}
},
"snmpAgent" : {
"description" : "AP SNMP Options",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"apSnmpEnabled" : {
"description" : "Enable AP SNMP",
"type" : "boolean"
},
"snmpV2Agent" : {
"description" : "Community List of the SNMP V2 Agent.",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"communityName" : {
"description" : "name of the SNMP Community.",
"type" : "string"
},
"readEnabled" : {
"description" : "read privilege of the SNMP Coummunity",
"type" : "boolean"
},
"writeEnabled" : {
"description" : "write privilege of the SNMP Coummunity",
"type" : "boolean"
},
"notificationEnabled" : {
"description" : "notification privilege of the SNMP Coummunity",
"type" : "boolean"
},
"notificationType" : {
"description" : "type of the notification privilege",
"type" : "string",
"enum" : [ "TRAP", "INFORM" ]
},
"notificationTarget" : {
"description" : "Trap List of the SNMP Coummunity",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"address" : {
"description" : "address of the SNMP Trap",
"type" : "string"
},
"port" : {
"description" : "port number of the SNMP Trap",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
}
},
"required" : [ "address", "port" ]
}
}
},
"required" : [ "communityName" ]
}
},
"snmpV3Agent" : {
"description" : "User List of the SNMP V3 Agent.",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"userName" : {
"description" : "name of the SNMP User.",
"type" : "string"
},
"authProtocol" : {
"description" : "authProtocol of the SNMP User.",
"type" : "string",
"enum" : [ "NONE", "MD5", "SHA" ]
},
"authPassword" : {
"description" : "authPassword of the SNMP User.",
"type" : "string",
"minLength" : 8
},
"privProtocol" : {
"description" : "privProtocol of the SNMP User.",
"type" : "string",
"enum" : [ "NONE", "DES", "AES" ]
},
"privPassword" : {
"description" : "privPassword of the SNMP User.",
"type" : "string",
"minLength" : 8
},
"readEnabled" : {
"description" : "read privilege of the SNMP User",
"type" : "boolean"
},
"writeEnabled" : {
"description" : "write privilege of the SNMP User",
"type" : "boolean"
},
"notificationEnabled" : {
"description" : "notification privilege of the SNMP User",
"type" : "boolean"
},
"notificationType" : {
"description" : "type of the notification privilege",
"type" : "string",
"enum" : [ "TRAP", "INFORM" ]
},
"notificationTarget" : {
"description" : "Trap List of the SNMP User",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"address" : {
"description" : "address of the SNMP Trap",
"type" : "string"
},
"port" : {
"description" : "port number of the SNMP Trap",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
}
},
"required" : [ "address", "port" ]
}
}
},
"required" : [ "userName" ]
}
}
}
},
"recoverySsid" : {
"description" : "Recovery SSID",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"recoverySsidEnabled" : {
"description" : "recovery ssid enable/disable",
"type" : "boolean"
}
}
},
"clusterRedundancyEnabled" : {
"description" : "Enable Cluster redundancy on zone",
"type" : "boolean"
},
"rogueApReportThreshold" : {
"description" : "Rogue AP report will leave out all entries that have signal strength lower than this threshold.",
"type" : "integer"
},
"rogueApAggressivenessMode" : {
"description" : "Adjust the frequency interval to de-authenticate rogue APs.",
"type" : "integer"
},
"rogueApJammingDetection" : {
"description" : "Enable jamming detection.",
"type" : "boolean"
},
"rogueApJammingThreshold" : {
"type" : "integer"
},
"directedMulticastFromWiredClientEnabled" : {
"description" : "Directed multicast from wired client.",
"type" : "boolean"
},
"directedMulticastFromWirelessClientEnabled" : {
"description" : "Directed multicast from wireless client.",
"type" : "boolean"
},
"directedMulticastFromNetworkEnabled" : {
"description" : "Directed multicast from network.",
"type" : "boolean"
},
"healthCheckSitesEnabled" : {
"description" : "Enabled Health Check Sites. ",
"type" : "boolean"
},
"healthCheckSites" : {
"description" : "Health Check Sites.",
"type" : "array",
"items" : {
"type" : "string"
}
},
"ruckusGreTunnelProfile" : {
"description" : "Ruckus GRE Profile for Multiple Tunnel (Start from SZ 5.0)",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"softGreTunnelProflies" : {
"description" : "SoftGRE Profiles for Multiple Tunnel (Start from SZ 5.0)",
"type" : "array",
"items" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"aaaAffinityEnabled" : {
"type" : "boolean"
}
}
}
},
"ipsecProfiles" : {
"description" : "Ipsec profile for Multiple Tunnel (Start from SZ 5.0)",
"type" : "array",
"items" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
}
},
"sshTunnelEncryption" : {
"type" : "string",
"enum" : [ "AES128", "AES256" ]
}
}
}204Modify Time Zone ¶
PATCH/v8_0/rkszones/{id}/timezone
Use this API command to modify the time zone of a zone.
Body
‧ Sample : systemTimezone sample1
{
"systemTimezone" : "America/Whitehorse"
}
‧ Sample : systemTimezone sample2
{
"systemTimezone" : "PRC"
}
‧ Sample : customizedTimezone sample
{
"customizedTimezone" : {
"abbreviation" : "ABC",
"gmtOffset" : 4,
"gmtOffsetMinute" : 10
}
}Schema
{
"description" : "Either systemTimezone or customizedTimezone must be specified",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"systemTimezone" : {
"description" : "System defined time zone, please refer to the “Overview > Time Zone” list",
"type" : "string"
},
"customizedTimezone" : {
"description" : "User defined time zone",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"abbreviation" : {
"description" : "Time zone abbreviation",
"type" : "string",
"pattern" : "^[a-zA-Z]{3,4}$"
},
"gmtOffset" : {
"description" : "GMT offset",
"type" : "integer",
"minimum" : -11,
"maximum" : 14
},
"gmtOffsetMinute" : {
"description" : "GMT offset minute",
"type" : "integer",
"minimum" : 0,
"maximum" : 59
},
"start" : {
"description" : "Daylight saving time start",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"month" : {
"description" : "Month when daylight saving time begins",
"type" : "integer",
"enum" : [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ]
},
"week" : {
"description" : "Week of the month (1 for the first week, 2 for the second week, and so on)",
"type" : "integer",
"enum" : [ 1, 2, 3, 4, 5 ]
},
"day" : {
"description" : "Day of the week (0 for Sunday, 1 for Monday, 2 for Tuesday, and so on)",
"type" : "integer",
"enum" : [ 0, 1, 2, 3, 4, 5, 6 ]
},
"hour" : {
"description" : "Hour of the day",
"type" : "integer",
"minimum" : 0,
"maximum" : 23
}
},
"required" : [ "month", "week", "day", "hour" ]
},
"end" : {
"description" : "Daylight saving time end",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"month" : {
"description" : "Month when daylight saving time begins",
"type" : "integer",
"enum" : [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ]
},
"week" : {
"description" : "Week of the month (1 for the first week, 2 for the second week, and so on)",
"type" : "integer",
"enum" : [ 1, 2, 3, 4, 5 ]
},
"day" : {
"description" : "Day of the week (0 for Sunday, 1 for Monday, 2 for Tuesday, and so on)",
"type" : "integer",
"enum" : [ 0, 1, 2, 3, 4, 5, 6 ]
},
"hour" : {
"description" : "Hour of the day",
"type" : "integer",
"minimum" : 0,
"maximum" : 23
}
},
"required" : [ "month", "week", "day", "hour" ]
}
},
"required" : [ "abbreviation", "gmtOffset", "gmtOffsetMinute" ]
}
}
}204Modify AP Logon ¶
PATCH/v8_0/rkszones/{id}/login
Use this API command to modify the AP logon information for APs that belong to a zone.
Body
{
"apLoginName": "admin",
"apLoginPassword": "admin!234"
}Schema
{
"description" : "AP administrator account",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"apLoginName" : {
"description" : "User name of the AP administrator",
"type" : "string",
"maxLength" : 64,
"pattern" : "^((?!\$\()[!-_a-~]){1,64}$"
},
"apLoginPassword" : {
"description" : "Password of the AP administrator",
"type" : "string",
"maxLength" : 64,
"pattern" : ".*(?=.{8,})(?=.*[a-zA-Z])(?=.*[0-9])(?=.*[_`~!@#$%^&*\(\)\[\]\{\}|;:'\",.\<>\/?=+-]).*"
}
},
"required" : [ "apLoginName", "apLoginPassword" ]
}204Modify Radio 2.4G ¶
PATCH/v8_0/rkszones/{id}/wifi24
Use this API command to modify the 2.4GHz radio configuration for APs that belong to a zone.
Body
{
"txPower": "Full",
"channelWidth": 20,
"channel": 0,
"channelRange": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11
]
}Schema
{
"description": "AP 2.4GHz radio configuration of the zone.",
"type": "object",
"additionalProperties": false,
"properties": {
"autoCellSizing": {
"description": "Auto Cell Sizing",
"type": "boolean"
},
"txPower": {
"description": "Transmission power",
"type": "string",
"enum": [
"Full",
"-1dB",
"-2dB",
"-3dB(1/2)",
"-4dB",
"-5dB",
"-6dB(1/4)",
"-7dB",
"-8dB",
"-9dB(1/8)",
"-10dB",
"Min"
]
},
"channelWidth": {
"description": "Channel width. Zero (0) means Auto.",
"type": "integer",
"enum": [
0,
20,
40
]
},
"channel": {
"description": "Channel number",
"type": "integer"
},
"channelRange": {
"description": "Channel range options",
"type": "array",
"items": {
"type": "integer"
}
}
}
}204Modify Radio 5G ¶
PATCH/v8_0/rkszones/{id}/wifi50
Use this API command to modify the 5GHz radio configuration for APs that belong to a zone.
Body
{
"txPower": "-1dB",
"channelWidth": 40,
"indoorChannel": 0,
"outdoorChannel": 0,
"indoorChannelRange": [
36,
40,
44,
48,
149,
153,
157,
161
],
"outdoorChannelRange": [
149,
153,
157,
161
]
}Schema
{
"description": "AP 5GHz radio configuration of the zone.",
"type": "object",
"additionalProperties": false,
"properties": {
"autoCellSizing": {
"description": "Auto Cell Sizing",
"type": "boolean"
},
"txPower": {
"description": "Transmission power",
"type": "string",
"enum": [
"Full",
"-1dB",
"-2dB",
"-3dB(1/2)",
"-4dB",
"-5dB",
"-6dB(1/4)",
"-7dB",
"-8dB",
"-9dB(1/8)",
"-10dB",
"Min"
]
},
"channelWidth": {
"description": "Channel width. Zero (0) means Auto. 8080 means 80+80MHz",
"type": "integer",
"enum": [
0,
20,
40,
80,
8080,
160
]
},
"indoorChannel": {
"description": "Channel number for Indoor AP",
"type": "integer"
},
"outdoorChannel": {
"description": "Channel number for Outdoor AP",
"type": "integer"
},
"indoorSecondaryChannel": {
"description": "Secondary channel number for Indoor AP (channelWidth is 80+80MHz only)",
"type": "integer"
},
"outdoorSecondaryChannel": {
"description": "Secondary channel number for outdoor AP (channelWidth is 80+80MHz only)",
"type": "integer"
},
"indoorChannelRange": {
"description": "Channel range options for Indoor AP",
"type": "array",
"items": {
"type": "integer"
}
},
"outdoorChannelRange": {
"description": "Channel range options for outdoor AP",
"type": "array",
"items": {
"type": "integer"
}
}
}
}204Modify Syslog ¶
PATCH/v8_0/rkszones/{id}/syslog
Use this API command to modify the syslog configuration for APs that belong to a zone.
Body
{
"address": "1.1.1.1",
"port": 514,
"facility": "Local0",
"priority": "Error"
}Schema
{
"description": "Syslog configuration of the zone.",
"type": "object",
"additionalProperties": false,
"properties": {
"flowLevel": {
"description": "Flow Level of the syslog",
"type": "string",
"enum": [
"GENERAL_LOGS",
"CLIENT_FLOW",
"ALL"
]
},
"address": {
"description": "Address of the syslog server.",
"type": "string"
},
"port": {
"description": "Port number of the syslog server",
"type": "integer",
"minimum": 1,
"maximum": 65535
},
"protocol": {
"description": "Protocol of the syslog server",
"type": "string",
"enum": [
"IPPROTO_TCP",
"IPPROTO_UDP"
]
},
"secondaryAddress": {
"description": "Secondary Server Address of the syslog server",
"type": "string"
},
"secondaryPort": {
"description": "Secondary Server Port of the syslog server",
"type": "integer",
"minimum": 1,
"maximum": 65535
},
"secondaryProtocol": {
"description": "Secondary Server Protocol of the syslog server",
"type": "string",
"enum": [
"IPPROTO_TCP",
"IPPROTO_UDP"
]
},
"facility": {
"description": "Facility of the syslog server",
"type": "string",
"enum": [
"Keep_Original",
"Local0",
"Local1",
"Local2",
"Local3",
"Local4",
"Local5",
"Local6",
"Local7"
]
},
"priority": {
"description": "Priority of the log messages",
"type": "string",
"enum": [
"Emergency",
"Alert",
"Critical",
"Error",
"Warning",
"Notice",
"Info",
"All"
]
}
}
}204Modify Smart Monitor ¶
PATCH/v8_0/rkszones/{id}/smartMonitor
Use this API command to modify the smart monitor for APs that belong to a zone.
Body
{
"intervalInSec": 10,
"retryThreshold": 3
}Schema
{
"description": "Smart monitor configuration of the zone.",
"type": "object",
"additionalProperties": false,
"properties": {
"intervalInSec": {
"description": "Interval in seconds. This is required if smartMonitor is enabled",
"type": "integer",
"minimum": 5,
"maximum": 60
},
"retryThreshold": {
"description": "Retry threshold. This is required if smartMonitor is enabled",
"type": "integer",
"minimum": 1,
"maximum": 10
}
}
}204Modify Client Admission Control 2.4G ¶
PATCH/v8_0/rkszones/{id}/clientAdmissionControl24
Use this API command to modify the client admission control 2.4GHz radio configuration for APs that belong to a zone.
Body
{
"maxRadioLoadPercent": 70,
"minClientCount": 10,
"minClientThroughputMbps": 10
}Schema
{
"description": "AP client admission control 2.4GHz radio configuration of the zone.",
"type": "object",
"additionalProperties": false,
"properties": {
"maxRadioLoadPercent": {
"description": "Maximum radio load percentage.",
"type": "integer",
"minimum": 50,
"maximum": 100
},
"minClientCount": {
"description": "Minimum client count number.",
"type": "integer",
"minimum": 0,
"maximum": 100
},
"minClientThroughputMbps": {
"description": "Minimum client throughput in Mbps.",
"type": "number",
"minimum": 0,
"maximum": 100
}
}
}204Modify Client Admission Control 5G ¶
PATCH/v8_0/rkszones/{id}/clientAdmissionControl50
Use this API command to modify the client admission control 5GHz radio configuration for APs that belong to a zone.
Body
{
"maxRadioLoadPercent": 70,
"minClientCount": 10,
"minClientThroughputMbps": 10
}Schema
{
"description": "AP client admission control 5GHz radio configuration of the zone.",
"type": "object",
"additionalProperties": false,
"properties": {
"maxRadioLoadPercent": {
"description": "Maximum radio load percentage.",
"type": "integer",
"minimum": 50,
"maximum": 100
},
"minClientCount": {
"description": "Minimum client count number.",
"type": "integer",
"minimum": 0,
"maximum": 100
},
"minClientThroughputMbps": {
"description": "Minimum client throughput in Mbps.",
"type": "number",
"minimum": 0,
"maximum": 100
}
}
}204Modify tunnel profile ¶
PATCH/v8_0/rkszones/{id}/tunnelProfile
Use this API command to change tunnel profile of Zone.
Body
{
"id": "f5b92938-aa4e-4d02-90ea-273799ff689b",
"name": "Default Tunnel Profile"
}Schema
{
"description": "Tunnel type configuration of the zone.",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}204Modify Background Scanning 2.4G ¶
PATCH/v8_0/rkszones/{id}/backgroundScanning24
Use this API command to modify the background scanning 2.4GHz radio configuration for APs that belong to a zone.
Body
{
"frequencyInSec": 20
}Schema
{
"description": "Background scanning on 2.4GHz radio configuration of the zone.",
"type": "object",
"additionalProperties": false,
"properties": {
"frequencyInSec": {
"description": "Frequency in second",
"type": "integer",
"minimum": 1,
"maximum": 65535
}
}
}204Modify Background Scanning 5G ¶
PATCH/v8_0/rkszones/{id}/backgroundScanning50
Use this API command to modify the background scanning 5GHz radio configuration for APs that belong to a zone.
Body
{
"frequencyInSec": 20
}Schema
{
"description": "Background scanning on 5GHz radio configuration of the zone.",
"type": "object",
"additionalProperties": false,
"properties": {
"frequencyInSec": {
"description": "Frequency in second",
"type": "integer",
"minimum": 1,
"maximum": 65535
}
}
}204Modify Client Load Balancing 2.4G ¶
PATCH/v8_0/rkszones/{id}/clientLoadBalancing24
Use this API command to modify the client load balancing 2.4GHz radio configuration for APs that belong to a zone.
Body
{
"adjacentRadioThreshold": 12
}Schema
{
"description": "Client load balancing on 2.4GHz radio configuration of the zone.",
"type": "object",
"additionalProperties": false,
"properties": {
"adjacentRadioThreshold": {
"description": "Adjacent radio threshold",
"type": "integer",
"minimum": 1,
"maximum": 100
}
}
}204Modify Client Load Balancing 5G ¶
PATCH/v8_0/rkszones/{id}/clientLoadBalancing50
Use this API command to modify the client load balancing 5GHz radio configuration for APs that belong to a zone.
Body
{
"adjacentRadioThreshold": 12
}Schema
{
"description": "Client load balancing on 5GHz radio configuration of the zone.",
"type": "object",
"additionalProperties": false,
"properties": {
"adjacentRadioThreshold": {
"description": "Adjacent radio threshold",
"type": "integer",
"minimum": 1,
"maximum": 100
}
}
}204Modify Band Balancing ¶
PATCH/v8_0/rkszones/{id}/bandBalancing
Use this API command to modify band balancing for APs that belong to a zone.
Body
{
"wifi24Percentage": 10
}Schema
{
"description": "Band balancing configuration of the zone.",
"type": "object",
"additionalProperties": false,
"properties": {
"mode": {
"description": "Band Balancing Mode: BASIC-Withholds probe and authentication responses at connetcion time in heavily loaded band to balance clients to the other band, PROACTIVE-Uses BASIC functionality and actively rebalances clients via 802.11v BTM, STRICT-Uses PROACTIVE functionality and forcefully rebalances clients via 802.11v BTM",
"type": "string",
"enum": [
"BASIC",
"PROACTIVE",
"STRICT"
]
},
"wifi24Percentage": {
"description": "Percentage of client load on 2.4GHz radio band",
"type": "integer",
"minimum": 0,
"maximum": 100
}
}
}204Modify AP Reboot Timeout ¶
PATCH/v8_0/rkszones/{id}/apRebootTimeout
Use this API command to modify AP reboot timeout for APs that belong to a zone.
Body
{
"gatewayLossTimeoutInSec": 1800,
"serverLossTimeoutInSec": 7200
}Schema
{
"description": "AP reboot timeout of the zone.",
"type": "object",
"additionalProperties": false,
"properties": {
"gatewayLossTimeoutInSec": {
"description": "Gateway loss timeout in second",
"type": "integer",
"enum": [
0,
1800,
3600,
5400,
7200,
9000,
10800,
12600,
14400,
16200,
18000,
19800,
23400,
25200,
27000,
28800,
30600,
32400,
34200,
36000,
37800,
39600,
41400,
43200,
45000,
46800,
48600,
50400,
52200,
54000,
55800,
57600,
59400,
61200,
63000,
64800,
66600,
68400,
70200,
72000,
73800,
75600,
77400,
79200,
81000,
82800,
84600,
86400
]
},
"serverLossTimeoutInSec": {
"description": "Server loss timeout in second",
"type": "integer",
"enum": [
0,
7200,
14400,
21600,
28800,
36000,
43200,
50400,
57600,
64800,
72000,
79200,
86400
]
}
}
}204Modify Node Affinity Profile ¶
PATCH/v8_0/rkszones/{id}/nodeAffinityProfile
Use this API command to modify node affinity profile for APs that belong to a zone.
Body
nullSchema
{
"description": "Node affinity profile of the zone.",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}204Modify Hotspot2.0 Venue Profile ¶
PATCH/v8_0/rkszones/{id}/venueProfile
Use this API command to modify Hotspot 2.0 venue profile for APs that belong to a zone.
Body
nullSchema
{
"description": "Venue profile configuration of the zone.",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}204Modify Rogue ¶
PATCH/v8_0/rkszones/{id}/rogue
Use this API command to modify the rogue AP detection for APs that belong to a zone.
Body
{
"reportType": "All",
"maliciousTypes": null,
"protectionEnabled": true
}Schema
{
"description": "Rogue AP detection configuration of the zone.",
"type": "object",
"additionalProperties": false,
"properties": {
"reportType": {
"description": "Report type",
"type": "string",
"enum": [
"All",
"Malicious"
]
},
"maliciousTypes": {
"description": "Malicious type when reportType is Malicious",
"type": [
"array",
"null"
],
"items": {
"type": "string",
"enum": [
"SSIDSpoofing",
"SameNetwork",
"MACSpoofing"
]
}
},
"protectionEnabled": {
"description": "Protection enabled",
"type": "boolean"
}
}
}204Modify Location Based Service ¶
PATCH/v8_0/rkszones/{id}/locationBasedService
Use this API command to modify location based service for APs that belong to a zone.
Body
nullSchema
{
"description": "Location based service configuration of the zone.",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}204Modify Radio 2.4G Auto ChannelSelectMode ¶
PATCH/v8_0/rkszones/{id}/autoChannelSelection24
Modify Radio 2.4G Auto ChannelSelectMode and ChannelFly MTBC of a zone.
Body
{
"channelSelectMode": "ChannelFly",
"channelFlyMtbc": 480
}Schema
{
"description": "client load balancing on Radio 2.4G, auto channel selection mode",
"type": "object",
"additionalProperties": false,
"properties": {
"channelSelectMode": {
"description": "Channel Select Mode",
"type": "string",
"enum": [
"None",
"BackgroundScanning",
"ChannelFly"
]
},
"channelFlyMtbc": {
"description": "ChannelFly MTBC",
"type": "integer",
"minimum": 100,
"maximum": 1440
}
}
}204Modify Radio 5G Auto ChannelSelectMode ¶
PATCH/v8_0/rkszones/{id}/autoChannelSelection50
Modify Radio 5G Auto ChannelSelectMode and ChannelFly MTBC of a zone.
Body
{
"channelSelectMode": "BackgroundScanning",
"channelFlyMtbc": 480
}Schema
{
"description": "client load balancing on Radio 5G, auto channel selection mode",
"type": "object",
"additionalProperties": false,
"properties": {
"channelSelectMode": {
"description": "Channel Select Mode",
"type": "string",
"enum": [
"None",
"BackgroundScanning",
"ChannelFly"
]
},
"channelFlyMtbc": {
"description": "ChannelFly MTBC",
"type": "integer",
"minimum": 100,
"maximum": 1440
}
}
}204Modify IPsec Profile ¶
PATCH/v8_0/rkszones/{id}/ipsecProfile
Modify IPsec Profile of a zone.
Body
{
"id": "ipsecProfileId",
"name": "ipsecProfileName"
}Schema
{
"description": "ipsec profile configuration of the Zone.",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}204Modify AP Management Vlan ¶
PATCH/v8_0/rkszones/{id}/apMgmtVlan
Modify AP Management Vlan of a zone.
Body
{
"id": 1,
"mode": "KEEP"
}Schema
{
"description": "ap Management Vlan of the zone",
"type": "object",
"additionalProperties": false,
"properties": {
"mode": {
"description": "Vlan Mode of the zone",
"type": "string",
"enum": [
"KEEP",
"USER_DEFINED"
]
},
"id": {
"description": "Vlan id of the zone",
"type": "integer"
}
}
}204Modify Altitude ¶
PATCH/v8_0/rkszones/{id}/altitude
Use this API command to modify the altitude configuration of zone.
Body
{
"altitudeUnit": "meters",
"altitudeValue": 1
}Schema
{
"description": "GPS Altitude",
"type": "object",
"additionalProperties": false,
"properties": {
"altitudeUnit": {
"description": "altitude unit",
"type": "string",
"enum": [
"meters",
"floor"
]
},
"altitudeValue": {
"description": "altitude value",
"type": "integer"
}
}
}204Modify AP SNMP Options ¶
PATCH/v8_0/rkszones/{id}/snmpAgent
Use this API command to modify SNMPv2 and SNMPv3 agent that belong to a zone.
Body
{
"apSnmpEnabled": true,
"snmpV2Agent": [
{
"communityName": "v2Agent",
"notificationEnabled": true,
"readEnabled": true,
"writeEnabled": true,
"notificationType": "TRAP",
"notificationTarget": [
{
"address": "172.19.16.20",
"port": 161
}
]
}
],
"snmpV3Agent": [
{
"userName": "v3Agent",
"authProtocol": "MD5",
"authPassword": "admin!234",
"privProtocol": "DES",
"privPassword": "admin!234",
"notificationEnabled": true,
"readEnabled": true,
"writeEnabled": true,
"notificationType": "TRAP",
"notificationTarget": [
{
"address": "172.19.16.20",
"port": 161
}
]
}
]
}Schema
{
"description": "AP SNMP Options",
"type": "object",
"additionalProperties": false,
"properties": {
"apSnmpEnabled": {
"description": "Enable AP SNMP",
"type": "boolean"
},
"snmpV2Agent": {
"description": "Community List of the SNMP V2 Agent.",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"communityName": {
"description": "name of the SNMP Community.",
"type": "string"
},
"readEnabled": {
"description": "read privilege of the SNMP Coummunity",
"type": "boolean"
},
"writeEnabled": {
"description": "write privilege of the SNMP Coummunity",
"type": "boolean"
},
"notificationEnabled": {
"description": "notification privilege of the SNMP Coummunity",
"type": "boolean"
},
"notificationType": {
"description": "type of the notification privilege",
"type": "string",
"enum": [
"TRAP",
"INFORM"
]
},
"notificationTarget": {
"description": "Trap List of the SNMP Coummunity",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"address": {
"description": "address of the SNMP Trap",
"type": "string"
},
"port": {
"description": "port number of the SNMP Trap",
"type": "integer",
"minimum": 1,
"maximum": 65535
}
},
"required": [
"address",
"port"
]
}
}
},
"required": [
"communityName"
]
}
},
"snmpV3Agent": {
"description": "User List of the SNMP V3 Agent.",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"userName": {
"description": "name of the SNMP User.",
"type": "string"
},
"authProtocol": {
"description": "authProtocol of the SNMP User.",
"type": "string",
"enum": [
"NONE",
"MD5",
"SHA"
]
},
"authPassword": {
"description": "authPassword of the SNMP User.",
"type": "string",
"minLength": 8
},
"privProtocol": {
"description": "privProtocol of the SNMP User.",
"type": "string",
"enum": [
"NONE",
"DES",
"AES"
]
},
"privPassword": {
"description": "privPassword of the SNMP User.",
"type": "string",
"minLength": 8
},
"readEnabled": {
"description": "read privilege of the SNMP User",
"type": "boolean"
},
"writeEnabled": {
"description": "write privilege of the SNMP User",
"type": "boolean"
},
"notificationEnabled": {
"description": "notification privilege of the SNMP User",
"type": "boolean"
},
"notificationType": {
"description": "type of the notification privilege",
"type": "string",
"enum": [
"TRAP",
"INFORM"
]
},
"notificationTarget": {
"description": "Trap List of the SNMP User",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"address": {
"description": "address of the SNMP Trap",
"type": "string"
},
"port": {
"description": "port number of the SNMP Trap",
"type": "integer",
"minimum": 1,
"maximum": 65535
}
},
"required": [
"address",
"port"
]
}
}
},
"required": [
"userName"
]
}
}
}
}204Modify zone recovery SSID ¶
PATCH/v8_0/rkszones/{id}/recoverySsid
Use this API command to modify recovery ssid setting of a zone.
Body
{
"recoverySsidEnabled": true
}Schema
{
"description": "Recovery SSID",
"type": "object",
"additionalProperties": false,
"properties": {
"recoverySsidEnabled": {
"description": "recovery ssid enable/disable",
"type": "boolean"
}
}
}204Modify DHCP/NAT service configuration ¶
PATCH/v8_0/rkszones/{id}/dhcpSiteConfig
Use this API command to modify DHCP/NAT service configuration of Zone.
Body
‧ Sample : DHCP Site Configuration when DHCP Service mode is EnableOnEachAPs
{
"siteEnabled" : true,
"siteMode" : "EnableOnEachAPs",
"siteProfileIds" : [ "75e26590-547f-11e6-9ca7-5a095364c13c", "869bb532-547f-11e6-9ca7-5a095364c13c" ]
}
‧ Sample : DHCP Site Configuration when DHCP Service mode is EnableOnMultipleAPs
{
"siteEnabled" : true,
"manualSelect" : true,
"siteMode" : "EnableOnMultipleAPs",
"siteAps" : [ {
"apMac" : "38:FF:36:00:0E:10",
"apServerEnabled" : true,
"apServerPrimary" : true
}, {
"apMac" : "58:FF:36:00:0E:20",
"apServerEnabled" : true,
"apServerPrimary" : false
} ],
"siteProfileIds" : [ "75e26590-547f-11e6-9ca7-5a095364c13c", "869bb532-547f-11e6-9ca7-5a095364c13c" ]
}
‧ Sample : DHCP Site Configuration when DHCP Service mode is EnableOnHierarchicalAPs
{
"siteEnabled" : true,
"manualSelect" : true,
"dwpdEnabled" : false,
"eth0ProfileId" : 0,
"eth1ProfileId" : 2,
"siteMode" : "EnableOnHierarchicalAPs",
"siteAps" : [ {
"apMac" : "38:FF:36:00:0E:10",
"apServerEnabled" : true,
"apServerPrimary" : true
}, {
"apMac" : "58:FF:36:00:0E:20",
"apServerEnabled" : true,
"apServerPrimary" : false
} ],
"siteProfileIds" : [ "75e26590-547f-11e6-9ca7-5a095364c13c", "869bb532-547f-11e6-9ca7-5a095364c13c" ]
}Schema
{
"description" : "DHCP Site Configuration in Zone",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"siteEnabled" : {
"description" : "DHCP Service Enabling Status",
"type" : "boolean"
},
"dwpdEnabled" : {
"description" : "DHCP Service Dynamic WAN Port Detection",
"type" : "boolean"
},
"manualSelect" : {
"description" : "DHCP Service AP Selection Mode. This value is effective when the siteMode is EnableOnMultipleAPs.",
"type" : "boolean"
},
"siteMode" : {
"description" : "DHCP Service mode",
"type" : "string",
"enum" : [ "EnableOnEachAPs", "EnableOnMultipleAPs", "EnableOnHierarchicalAPs" ]
},
"eth0ProfileId" : {
"type" : "integer"
},
"eth1ProfileId" : {
"type" : "integer"
},
"siteAps" : {
"type" : "array",
"items" : {
"type" : "object",
"description" : "DHCP Site selected APs. The content is effective when the siteMode is EnableOnMultipleAPs.",
"additionalProperties" : false,
"properties" : {
"apMac" : {
"type" : "string"
},
"apName" : {
"type" : "string"
},
"apStatus" : {
"type" : "string",
"enum" : [ "Online", "Offline", "Flagged" ]
},
"apServerEnabled" : {
"type" : "boolean"
},
"apServerPrimary" : {
"type" : "boolean"
},
"apServerIp" : {
"type" : [ "string", "null" ]
},
"apGatewayIp" : {
"type" : "string"
}
}
}
},
"siteProfileIds" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
}
}204Modify Bonjour Fencing Policy configuration ¶
PATCH/v8_0/rkszones/{id}/bonjourFencingPolicy
Use this API command to modify Bonjour Fencing Policy configuration of Zone.
Body
nullSchema
{
"description": "Bonjour Fencing Policy on the AP",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}204Create Zone ¶
POST/v8_0/rkszones
Use this API command to create a new Ruckus Wireless AP zone.
Body
{
"domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
"name": "createZoneName",
"description": "description Zone",
"countryCode": "US",
"timezone": {
"customizedTimezone": {
"abbreviation": "TPE",
"gmtOffset": 0,
"gmtOffsetMinute": 0
}
},
"login": {
"apLoginName": "admin",
"apLoginPassword": "admin!234"
},
"dfsChannelEnabled": false,
"wifi24": {
"txPower": "Full",
"channelWidth": 20,
"channel": 0,
"channelRange": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11
]
},
"wifi50": {
"txPower": "-1dB",
"channelWidth": 40,
"indoorChannel": 0,
"outdoorChannel": 0,
"indoorChannelRange": [
36,
40,
44,
48,
149,
153,
157,
161
],
"outdoorChannelRange": [
149,
153,
157,
161
]
},
"protectionMode24": "CTS_ONLY",
"syslog": {
"flowLevel": "GENERAL_LOGS",
"address": "1.1.1.1",
"port": 514,
"protocol": "IPPROTO_TCP",
"secondaryAddress": "2.2.2.2",
"secondaryPort": 514,
"secondaryProtocol": "IPPROTO_TCP",
"facility": "Local0",
"priority": "Error"
},
"smartMonitor": {
"intervalInSec": 10,
"retryThreshold": 3
},
"channelModeEnabled": false,
"tunnelType": "RuckusGRE",
"backgroundScanning24": {
"frequencyInSec": 20
},
"backgroundScanning50": {
"frequencyInSec": 20
},
"clientLoadBalancing24": {
"adjacentRadioThreshold": 12
},
"clientLoadBalancing50": {
"adjacentRadioThreshold": 12
},
"bandBalancing": {
"wifi24Percentage": 10
},
"loadBalancingMethod": "BASED_ON_CLIENT_COUNT",
"rogue": {
"reportType": "All",
"maliciousTypes": null,
"protectionEnabled": true
},
"dosBarringEnable": 0,
"dosBarringPeriod": 60,
"dosBarringThreshold": 5,
"dosBarringCheckPeriod": 30,
"apRebootTimeout": {
"gatewayLossTimeoutInSec": 1800,
"serverLossTimeoutInSec": 7200
},
"location": "location",
"locationAdditionalInfo": "locationAdditionalInfo",
"latitude": 23,
"longitude": 23,
"vlanOverlappingEnabled": false,
"autoChannelSelection24": {
"channelSelectMode": "ChannelFly",
"channelFlyMtbc": 480
},
"autoChannelSelection50": {
"channelSelectMode": "BackgroundScanning",
"channelFlyMtbc": 480
},
"channelEvaluationInterval": 777,
"apMgmtVlan": {
"id": 1,
"mode": "KEEP"
},
"apLatencyInterval": {
"pingEnabled": true
},
"ipsecProfile": {
"id": "ipsecProfileId",
"name": "ipsecProfileName"
},
"altitude": {
"altitudeUnit": "meters",
"altitudeValue": 1
},
"bonjourFencingPolicyEnabled": false,
"snmpAgent": {
"apSnmpEnabled": true,
"snmpV2Agent": [
{
"communityName": "v2Agent",
"notificationEnabled": true,
"readEnabled": true,
"writeEnabled": true,
"notificationType": "TRAP",
"notificationTarget": [
{
"address": "172.19.16.20",
"port": 161
}
]
}
],
"snmpV3Agent": [
{
"userName": "v3Agent",
"authProtocol": "MD5",
"authPassword": "admin!234",
"privProtocol": "DES",
"privPassword": "admin!234",
"notificationEnabled": true,
"readEnabled": true,
"writeEnabled": true,
"notificationType": "TRAP",
"notificationTarget": [
{
"address": "172.19.16.20",
"port": 161
}
]
}
]
},
"recoverySsid": {
"recoverySsidEnabled": true
},
"dhcpSiteConfig": {
"siteEnabled": true,
"siteMode": "EnableOnEachAPs",
"siteProfileIds": [
"75e26590-547f-11e6-9ca7-5a095364c13c",
"869bb532-547f-11e6-9ca7-5a095364c13c"
]
},
"rogueApReportThreshold": 40,
"rogueApAggressivenessMode": 2,
"rogueApJammingDetection": true,
"rogueApJammingThreshold": 40,
"directedMulticastFromWiredClientEnabled": true,
"directedMulticastFromWirelessClientEnabled": true,
"directedMulticastFromNetworkEnabled": false,
"healthCheckSitesEnabled": true,
"healthCheckSites": [
"www.google.com",
"www.live.com:443",
"www.github.com:443",
"source.codeaurora.org:443",
"www.wikipedia.com"
],
"ruckusGreTunnelProfile": {
"id": "f5b92938-aa4e-4d02-90ea-273799ff689b",
"name": "Default Tunnel Profile"
},
"softGreTunnelProflies": [
{
"id": "5a2e41b0-df53-11e7-98e1-08002748d78e",
"name": "softGre1",
"aaaAffinityEnabled": false
},
{
"id": "7803e411-df53-11e7-98e1-08002748d78e",
"name": "softGre2",
"aaaAffinityEnabled": true
},
{
"id": "664de4f1-df53-11e7-98e1-08002748d78e",
"name": "softGre3",
"aaaAffinityEnabled": false
}
],
"ipsecProfiles": [
{
"id": "3fd9aa91-df65-11e7-98e1-08002748d78e",
"name": "ipsec1"
},
{
"id": "832aa331-df65-11e7-98e1-08002748d78e",
"name": "ipsec2"
}
],
"sshTunnelEncryption": "AES128"
}Schema
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"domainId" : {
"description" : "Identifier of the management domain to which the zone belongs",
"type" : "string"
},
"name" : {
"description" : "Name of the zone",
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$"
},
"description" : {
"description" : "Description of the zone",
"type" : [ "string", "null" ],
"maxLength" : 64
},
"version" : {
"description" : "AP firmware version of the zone",
"type" : "string",
"pattern" : "^\d+\.\d+\.\d+\.\d+\.\d+$"
},
"countryCode" : {
"description" : "Country code of the zone",
"type" : "string"
},
"login" : {
"description" : "AP administrator account",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"apLoginName" : {
"description" : "User name of the AP administrator",
"type" : "string",
"maxLength" : 64,
"pattern" : "^((?!\$\()[!-_a-~]){1,64}$"
},
"apLoginPassword" : {
"description" : "Password of the AP administrator",
"type" : "string",
"maxLength" : 64,
"pattern" : ".*(?=.{8,})(?=.*[a-zA-Z])(?=.*[0-9])(?=.*[_`~!@#$%^&*\(\)\[\]\{\}|;:'\",.\<>\/?=+-]).*"
}
},
"required" : [ "apLoginName", "apLoginPassword" ]
},
"timezone" : {
"description" : "Either systemTimezone or customizedTimezone must be specified",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"systemTimezone" : {
"description" : "System defined time zone, please refer to the “Overview > Time Zone” list",
"type" : "string"
},
"customizedTimezone" : {
"description" : "User defined time zone",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"abbreviation" : {
"description" : "Time zone abbreviation",
"type" : "string",
"pattern" : "^[a-zA-Z]{3,4}$"
},
"gmtOffset" : {
"description" : "GMT offset",
"type" : "integer",
"minimum" : -11,
"maximum" : 14
},
"gmtOffsetMinute" : {
"description" : "GMT offset minute",
"type" : "integer",
"minimum" : 0,
"maximum" : 59
},
"start" : {
"description" : "Daylight saving time start",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"month" : {
"description" : "Month when daylight saving time begins",
"type" : "integer",
"enum" : [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ]
},
"week" : {
"description" : "Week of the month (1 for the first week, 2 for the second week, and so on)",
"type" : "integer",
"enum" : [ 1, 2, 3, 4, 5 ]
},
"day" : {
"description" : "Day of the week (0 for Sunday, 1 for Monday, 2 for Tuesday, and so on)",
"type" : "integer",
"enum" : [ 0, 1, 2, 3, 4, 5, 6 ]
},
"hour" : {
"description" : "Hour of the day",
"type" : "integer",
"minimum" : 0,
"maximum" : 23
}
},
"required" : [ "month", "week", "day", "hour" ]
},
"end" : {
"description" : "Daylight saving time end",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"month" : {
"description" : "Month when daylight saving time begins",
"type" : "integer",
"enum" : [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ]
},
"week" : {
"description" : "Week of the month (1 for the first week, 2 for the second week, and so on)",
"type" : "integer",
"enum" : [ 1, 2, 3, 4, 5 ]
},
"day" : {
"description" : "Day of the week (0 for Sunday, 1 for Monday, 2 for Tuesday, and so on)",
"type" : "integer",
"enum" : [ 0, 1, 2, 3, 4, 5, 6 ]
},
"hour" : {
"description" : "Hour of the day",
"type" : "integer",
"minimum" : 0,
"maximum" : 23
}
},
"required" : [ "month", "week", "day", "hour" ]
}
},
"required" : [ "abbreviation", "gmtOffset", "gmtOffsetMinute" ]
}
}
},
"mesh" : {
"description" : "Mesh configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"ssid" : {
"description" : "SSID of the mesh network",
"type" : "string"
},
"passphrase" : {
"description" : "Passphrase for the mesh network",
"type" : "string"
},
"meshRadioIdx" : {
"description" : "Mesh radio index",
"type" : "string",
"enum" : [ "Radio24G", "Radio5G" ],
"default" : "Radio5G"
},
"zeroTouchStatus" : {
"type" : "boolean"
}
}
},
"dfsChannelEnabled" : {
"description" : "DFS Channel enabled configuration of the zone, only for the US country code .",
"type" : "boolean",
"default" : false
},
"cbandChannelEnabled" : {
"description" : "5.8Ghz channels enabled configuration of the zone.",
"type" : "boolean",
"default" : false
},
"cbandChannelLicenseEnabled" : {
"description" : "5.8Ghz channels license enabled configuration of the zone.",
"type" : "boolean",
"default" : false
},
"wifi24" : {
"description" : "AP 2.4GHz radio configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"autoCellSizing" : {
"description" : "Auto Cell Sizing",
"type" : "boolean"
},
"txPower" : {
"description" : "Transmission power",
"type" : "string",
"enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
"default" : "Full"
},
"channelWidth" : {
"description" : "Channel width. Zero (0) means Auto.",
"type" : "integer",
"enum" : [ 0, 20, 40 ],
"default" : 0
},
"channel" : {
"description" : "Channel number",
"type" : "integer"
},
"channelRange" : {
"description" : "Channel range options",
"type" : "array",
"items" : {
"type" : "integer"
}
}
}
},
"wifi50" : {
"description" : "AP 5GHz radio configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"autoCellSizing" : {
"description" : "Auto Cell Sizing",
"type" : "boolean"
},
"txPower" : {
"description" : "Transmission power",
"type" : "string",
"enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
"default" : "Full"
},
"channelWidth" : {
"description" : "Channel width. Zero (0) means Auto. 8080 means 80+80MHz",
"type" : "integer",
"enum" : [ 0, 20, 40, 80, 8080, 160 ],
"default" : 0
},
"indoorChannel" : {
"description" : "Channel number for Indoor AP",
"type" : "integer"
},
"outdoorChannel" : {
"description" : "Channel number for Outdoor AP",
"type" : "integer"
},
"indoorSecondaryChannel" : {
"description" : "Secondary channel number for Indoor AP (channelWidth is 80+80MHz only)",
"type" : "integer"
},
"outdoorSecondaryChannel" : {
"description" : "Secondary channel number for outdoor AP (channelWidth is 80+80MHz only)",
"type" : "integer"
},
"indoorChannelRange" : {
"description" : "Channel range options for Indoor AP",
"type" : "array",
"items" : {
"type" : "integer"
}
},
"outdoorChannelRange" : {
"description" : "Channel range options for outdoor AP",
"type" : "array",
"items" : {
"type" : "integer"
}
}
}
},
"protectionMode24" : {
"description" : "AP 2.4GHz Protection mode configuration of the zone.",
"type" : "string",
"enum" : [ "NONE", "CTS_ONLY", "RTS_CTS" ],
"default" : "RTS_CTS"
},
"syslog" : {
"description" : "Syslog configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"flowLevel" : {
"description" : "Flow Level of the syslog",
"type" : "string",
"enum" : [ "GENERAL_LOGS", "CLIENT_FLOW", "ALL" ],
"default" : "GENERAL_LOGS"
},
"address" : {
"description" : "Address of the syslog server.",
"type" : "string"
},
"port" : {
"description" : "Port number of the syslog server",
"type" : "integer",
"default" : 514,
"minimum" : 1,
"maximum" : 65535
},
"protocol" : {
"description" : "Protocol of the syslog server",
"type" : "string",
"enum" : [ "IPPROTO_TCP", "IPPROTO_UDP" ],
"default" : "IPPROTO_TCP"
},
"secondaryAddress" : {
"description" : "Secondary Server Address of the syslog server",
"type" : "string"
},
"secondaryPort" : {
"description" : "Secondary Server Port of the syslog server",
"type" : "integer",
"default" : 514,
"minimum" : 1,
"maximum" : 65535
},
"secondaryProtocol" : {
"description" : "Secondary Server Protocol of the syslog server",
"type" : "string",
"enum" : [ "IPPROTO_TCP", "IPPROTO_UDP" ],
"default" : "IPPROTO_TCP"
},
"facility" : {
"description" : "Facility of the syslog server",
"type" : "string",
"enum" : [ "Keep_Original", "Local0", "Local1", "Local2", "Local3", "Local4", "Local5", "Local6", "Local7" ],
"default" : "Keep_Original"
},
"priority" : {
"description" : "Priority of the log messages",
"type" : "string",
"enum" : [ "Emergency", "Alert", "Critical", "Error", "Warning", "Notice", "Info", "All" ],
"default" : "Error"
}
}
},
"smartMonitor" : {
"description" : "Smart monitor configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"intervalInSec" : {
"description" : "Interval in seconds. This is required if smartMonitor is enabled",
"type" : "integer",
"default" : 10,
"minimum" : 5,
"maximum" : 60
},
"retryThreshold" : {
"description" : "Retry threshold. This is required if smartMonitor is enabled",
"type" : "integer",
"default" : 3,
"minimum" : 1,
"maximum" : 10
}
}
},
"clientAdmissionControl24" : {
"description" : "AP client admission control 2.4GHz radio configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"maxRadioLoadPercent" : {
"description" : "Maximum radio load percentage.",
"type" : "integer",
"default" : 75,
"minimum" : 50,
"maximum" : 100
},
"minClientCount" : {
"description" : "Minimum client count number.",
"type" : "integer",
"default" : 10,
"minimum" : 0,
"maximum" : 100
},
"minClientThroughputMbps" : {
"description" : "Minimum client throughput in Mbps.",
"type" : "number",
"default" : 0,
"minimum" : 0,
"maximum" : 100
}
}
},
"clientAdmissionControl50" : {
"description" : "AP client admission control 5GHz radio configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"maxRadioLoadPercent" : {
"description" : "Maximum radio load percentage.",
"type" : "integer",
"default" : 75,
"minimum" : 50,
"maximum" : 100
},
"minClientCount" : {
"description" : "Minimum client count number.",
"type" : "integer",
"default" : 10,
"minimum" : 0,
"maximum" : 100
},
"minClientThroughputMbps" : {
"description" : "Minimum client throughput in Mbps.",
"type" : "number",
"default" : 0,
"minimum" : 0,
"maximum" : 100
}
}
},
"channelModeEnabled" : {
"description" : "Channel mode configuration of the zone.",
"type" : "boolean",
"default" : false
},
"tunnelType" : {
"description" : "Tunnel type configuration of the zone. No_Tunneled is for IPv6 mode",
"type" : "string",
"enum" : [ "No_Tunneled", "RuckusGRE", "SoftGRE", "SoftGREIpsec" ],
"default" : "RuckusGRE"
},
"tunnelProfile" : {
"description" : "Tunnel type configuration of the zone.",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"backgroundScanning24" : {
"description" : "Background scanning on 2.4GHz radio configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"frequencyInSec" : {
"description" : "Frequency in second",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535,
"default" : 20
}
}
},
"backgroundScanning50" : {
"description" : "Background scanning on 5GHz radio configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"frequencyInSec" : {
"description" : "Frequency in second",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535,
"default" : 20
}
}
},
"clientLoadBalancing24" : {
"description" : "Client load balancing on 2.4GHz radio configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"adjacentRadioThreshold" : {
"description" : "Adjacent radio threshold",
"type" : "integer",
"minimum" : 1,
"maximum" : 100
}
}
},
"clientLoadBalancing50" : {
"description" : "Client load balancing on 5GHz radio configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"adjacentRadioThreshold" : {
"description" : "Adjacent radio threshold",
"type" : "integer",
"minimum" : 1,
"maximum" : 100
}
}
},
"bandBalancing" : {
"description" : "Band balancing configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"mode" : {
"description" : "Band Balancing Mode: BASIC-Withholds probe and authentication responses at connetcion time in heavily loaded band to balance clients to the other band, PROACTIVE-Uses BASIC functionality and actively rebalances clients via 802.11v BTM, STRICT-Uses PROACTIVE functionality and forcefully rebalances clients via 802.11v BTM",
"type" : "string",
"enum" : [ "BASIC", "PROACTIVE", "STRICT" ],
"default" : "BASIC"
},
"wifi24Percentage" : {
"description" : "Percentage of client load on 2.4GHz radio band",
"type" : "integer",
"minimum" : 0,
"maximum" : 100,
"default" : 25
}
}
},
"loadBalancingMethod" : {
"type" : "string",
"enum" : [ "BASED_ON_CLIENT_COUNT", "BASED_ON_CAPACITY", "OFF" ],
"default" : "BASED_ON_CLIENT_COUNT"
},
"rogue" : {
"description" : "Rogue AP detection configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"reportType" : {
"description" : "Report type",
"type" : "string",
"enum" : [ "All", "Malicious" ]
},
"maliciousTypes" : {
"description" : "Malicious type when reportType is Malicious",
"type" : [ "array", "null" ],
"items" : {
"type" : "string",
"enum" : [ "SSIDSpoofing", "SameNetwork", "MACSpoofing" ]
}
},
"protectionEnabled" : {
"description" : "Protection enabled",
"type" : "boolean"
}
}
},
"dosBarringEnable" : {
"description" : "Enable DoS Protection(Barring UE) of the zone.",
"type" : "integer"
},
"dosBarringPeriod" : {
"description" : "DoS Protection(Barring UE) blocking period of the zone.",
"type" : "integer",
"default" : 60
},
"dosBarringThreshold" : {
"description" : "DoS Protection(Barring UE) threshold of the zone.",
"type" : "integer",
"default" : 5
},
"dosBarringCheckPeriod" : {
"description" : "DoS Protection(Barring UE) check period of the zone.",
"type" : "integer",
"default" : 30
},
"locationBasedService" : {
"description" : "Location based service configuration of the zone.",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"apRebootTimeout" : {
"description" : "AP reboot timeout of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"gatewayLossTimeoutInSec" : {
"description" : "Gateway loss timeout in second",
"type" : "integer",
"enum" : [ 0, 1800, 3600, 5400, 7200, 9000, 10800, 12600, 14400, 16200, 18000, 19800, 23400, 25200, 27000, 28800, 30600, 32400, 34200, 36000, 37800, 39600, 41400, 43200, 45000, 46800, 48600, 50400, 52200, 54000, 55800, 57600, 59400, 61200, 63000, 64800, 66600, 68400, 70200, 72000, 73800, 75600, 77400, 79200, 81000, 82800, 84600, 86400 ],
"default" : 1800
},
"serverLossTimeoutInSec" : {
"description" : "Server loss timeout in second",
"type" : "integer",
"enum" : [ 0, 7200, 14400, 21600, 28800, 36000, 43200, 50400, 57600, 64800, 72000, 79200, 86400 ],
"default" : 7200
}
}
},
"location" : {
"description" : "Location of the zone.",
"type" : "string"
},
"locationAdditionalInfo" : {
"description" : "Location additional info of the zone.",
"type" : "string",
"pattern" : "^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
},
"altitude" : {
"description" : "GPS Altitude",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"altitudeUnit" : {
"description" : "altitude unit",
"type" : "string",
"enum" : [ "meters", "floor" ],
"default" : "meters"
},
"altitudeValue" : {
"description" : "altitude value",
"type" : "integer"
}
}
},
"latitude" : {
"description" : "Latitude coordinate (in decimal format) of the zone",
"type" : "number"
},
"longitude" : {
"description" : "Longitude coordinate (in decimal format) of the zone",
"type" : "number"
},
"vlanOverlappingEnabled" : {
"description" : "VLAN pooling overlapping of the zone",
"type" : "boolean"
},
"nodeAffinityProfile" : {
"description" : "Node affinity profile of the zone.",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"venueProfile" : {
"description" : "Venue profile configuration of the zone.",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"autoChannelSelection24" : {
"description" : "client load balancing on Radio 2.4G, auto channel selection mode",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"channelSelectMode" : {
"description" : "Channel Select Mode",
"type" : "string",
"enum" : [ "None", "BackgroundScanning", "ChannelFly" ],
"default" : "BackgroundScanning"
},
"channelFlyMtbc" : {
"description" : "ChannelFly MTBC",
"type" : "integer",
"default" : 480,
"minimum" : 100,
"maximum" : 1440
}
}
},
"autoChannelSelection50" : {
"description" : "client load balancing on Radio 5G, auto channel selection mode",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"channelSelectMode" : {
"description" : "Channel Select Mode",
"type" : "string",
"enum" : [ "None", "BackgroundScanning", "ChannelFly" ],
"default" : "BackgroundScanning"
},
"channelFlyMtbc" : {
"description" : "ChannelFly MTBC",
"type" : "integer",
"default" : 480,
"minimum" : 100,
"maximum" : 1440
}
}
},
"channelEvaluationInterval" : {
"description" : "channel evaluation Interval of the zone",
"type" : "integer",
"default" : 600,
"minimum" : 60,
"maximum" : 3600
},
"apMgmtVlan" : {
"description" : "ap Management Vlan of the zone",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"mode" : {
"description" : "Vlan Mode of the zone",
"type" : "string",
"enum" : [ "KEEP", "USER_DEFINED" ],
"default" : "KEEP"
},
"id" : {
"description" : "Vlan id of the zone",
"type" : "integer",
"default" : "1"
}
}
},
"apLatencyInterval" : {
"description" : "AP latency interval",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"pingEnabled" : {
"description" : "AP ping latency enabled",
"type" : "boolean",
"default" : true
}
}
},
"ipsecProfile" : {
"description" : "ipsec profile configuration of the Zone.",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"ipv6TrafficFilterEnabled" : {
"description" : "IPv6 Traffic filtering on the AP",
"type" : "integer"
},
"bonjourFencingPolicyEnabled" : {
"description" : "Enable Bonjour Fencing Policy on the AP",
"type" : "boolean"
},
"bonjourFencingPolicy" : {
"description" : "Bonjour Fencing Policy on the AP",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"dhcpSiteConfig" : {
"description" : "DHCP Site Configuration in Zone",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"siteEnabled" : {
"description" : "DHCP Service Enabling Status",
"type" : "boolean"
},
"dwpdEnabled" : {
"description" : "DHCP Service Dynamic WAN Port Detection",
"type" : "boolean"
},
"manualSelect" : {
"description" : "DHCP Service AP Selection Mode. This value is effective when the siteMode is EnableOnMultipleAPs.",
"type" : "boolean"
},
"siteMode" : {
"description" : "DHCP Service mode",
"type" : "string",
"enum" : [ "EnableOnEachAPs", "EnableOnMultipleAPs", "EnableOnHierarchicalAPs" ]
},
"eth0ProfileId" : {
"type" : "integer"
},
"eth1ProfileId" : {
"type" : "integer"
},
"siteAps" : {
"type" : "array",
"items" : {
"type" : "object",
"description" : "DHCP Site selected APs. The content is effective when the siteMode is EnableOnMultipleAPs.",
"additionalProperties" : false,
"properties" : {
"apMac" : {
"type" : "string"
},
"apName" : {
"type" : "string"
},
"apStatus" : {
"type" : "string",
"enum" : [ "Online", "Offline", "Flagged" ]
},
"apServerEnabled" : {
"type" : "boolean"
},
"apServerPrimary" : {
"type" : "boolean"
},
"apServerIp" : {
"type" : [ "string", "null" ]
},
"apGatewayIp" : {
"type" : "string"
}
}
}
},
"siteProfileIds" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
}
},
"snmpAgent" : {
"description" : "AP SNMP Options",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"apSnmpEnabled" : {
"description" : "Enable AP SNMP",
"type" : "boolean"
},
"snmpV2Agent" : {
"description" : "Community List of the SNMP V2 Agent.",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"communityName" : {
"description" : "name of the SNMP Community.",
"type" : "string"
},
"readEnabled" : {
"description" : "read privilege of the SNMP Coummunity",
"type" : "boolean"
},
"writeEnabled" : {
"description" : "write privilege of the SNMP Coummunity",
"type" : "boolean"
},
"notificationEnabled" : {
"description" : "notification privilege of the SNMP Coummunity",
"type" : "boolean"
},
"notificationType" : {
"description" : "type of the notification privilege",
"type" : "string",
"enum" : [ "TRAP", "INFORM" ]
},
"notificationTarget" : {
"description" : "Trap List of the SNMP Coummunity",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"address" : {
"description" : "address of the SNMP Trap",
"type" : "string"
},
"port" : {
"description" : "port number of the SNMP Trap",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
}
},
"required" : [ "address", "port" ]
}
}
},
"required" : [ "communityName" ]
}
},
"snmpV3Agent" : {
"description" : "User List of the SNMP V3 Agent.",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"userName" : {
"description" : "name of the SNMP User.",
"type" : "string"
},
"authProtocol" : {
"description" : "authProtocol of the SNMP User.",
"type" : "string",
"enum" : [ "NONE", "MD5", "SHA" ]
},
"authPassword" : {
"description" : "authPassword of the SNMP User.",
"type" : "string",
"minLength" : 8
},
"privProtocol" : {
"description" : "privProtocol of the SNMP User.",
"type" : "string",
"enum" : [ "NONE", "DES", "AES" ]
},
"privPassword" : {
"description" : "privPassword of the SNMP User.",
"type" : "string",
"minLength" : 8
},
"readEnabled" : {
"description" : "read privilege of the SNMP User",
"type" : "boolean"
},
"writeEnabled" : {
"description" : "write privilege of the SNMP User",
"type" : "boolean"
},
"notificationEnabled" : {
"description" : "notification privilege of the SNMP User",
"type" : "boolean"
},
"notificationType" : {
"description" : "type of the notification privilege",
"type" : "string",
"enum" : [ "TRAP", "INFORM" ]
},
"notificationTarget" : {
"description" : "Trap List of the SNMP User",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"address" : {
"description" : "address of the SNMP Trap",
"type" : "string"
},
"port" : {
"description" : "port number of the SNMP Trap",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
}
},
"required" : [ "address", "port" ]
}
}
},
"required" : [ "userName" ]
}
}
}
},
"recoverySsid" : {
"description" : "Recovery SSID",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"recoverySsidEnabled" : {
"description" : "recovery ssid enable/disable",
"type" : "boolean"
}
}
},
"clusterRedundancyEnabled" : {
"description" : "Enable Cluster redundancy on zone.",
"type" : "boolean",
"default" : false
},
"rogueApReportThreshold" : {
"description" : "Rogue AP report will leave out all entries that have signal strength lower than this threshold.",
"type" : "integer"
},
"rogueApAggressivenessMode" : {
"description" : "Adjust the frequency interval to de-authenticate rogue APs.",
"type" : "integer"
},
"rogueApJammingDetection" : {
"description" : "Enable jamming detection.",
"type" : "boolean",
"default" : false
},
"rogueApJammingThreshold" : {
"type" : "integer"
},
"directedMulticastFromWiredClientEnabled" : {
"description" : "Directed multicast from wired client.",
"type" : "boolean",
"default" : true
},
"directedMulticastFromWirelessClientEnabled" : {
"description" : "Directed multicast from wireless client.",
"type" : "boolean",
"default" : true
},
"directedMulticastFromNetworkEnabled" : {
"description" : "Directed multicast from network.",
"type" : "boolean",
"default" : true
},
"healthCheckSitesEnabled" : {
"description" : "Enabled Health Check Sites. ",
"type" : "boolean",
"default" : false
},
"healthCheckSites" : {
"description" : "Health Check Sites.",
"type" : "array",
"items" : {
"type" : "string"
}
},
"ruckusGreTunnelProfile" : {
"description" : "Ruckus GRE Profile for Multiple Tunnel (Start from SZ 5.0)",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"softGreTunnelProflies" : {
"description" : "SoftGRE Profiles for Multiple Tunnel (Start from SZ 5.0)",
"type" : "array",
"items" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"aaaAffinityEnabled" : {
"type" : "boolean"
}
}
}
},
"ipsecProfiles" : {
"description" : "Ipsec profile for Multiple Tunnel (Start from SZ 5.0)",
"type" : "array",
"items" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
}
},
"sshTunnelEncryption" : {
"type" : "string",
"enum" : [ "AES128", "AES256" ],
"default" : "AES128"
}
},
"required" : [ "name", "login" ]
}201Body
{
"id": "zoneUUID"
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
}
}
}AP Group ¶
Add Member ¶
POST/v8_0/rkszones/{zoneId}/apgroups/{id}/members/{apMac}
Use this API command to add a member AP to an AP group.
201Retrieve ¶
GET/v8_0/rkszones/{zoneId}/apgroups/{id}
Use this API command to retrieve information about an AP group.
200Body
{
"id": "apGroupUUID",
"zoneId": "zoneUUID",
"name": "apGroupName",
"description": "apGroupDescription",
"location": "test-ap1_modify",
"locationAdditionalInfo": "add",
"latitude": 34,
"longitude": 45,
"wifi24": {
"txPower": "Full",
"channelWidth": 20,
"channel": 9,
"channelRange": [
1,
2,
3,
4,
9,
10,
11
],
"availableChannelRange": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11
]
},
"wifi50": {
"txPower": "Full",
"channelWidth": 40,
"indoorChannel": 0,
"outdoorChannel": 157,
"indoorChannelRange": [
36,
40,
44,
48
],
"outdoorChannelRange": [
149,
153
],
"availableIndoorChannelRange": [
36,
40,
44,
48,
149,
153,
157,
161
],
"availableOutdoorChannelRange": [
149,
153,
157,
161
]
},
"protectionMode24": "CTS_ONLY",
"wlanGroup24": {
"id": "19b10850-7eaa-11e4-a584-08002716c79f",
"name": "default"
},
"wlanGroup50": null,
"locationBasedService": null,
"clientAdmissionControl24": {
"maxRadioLoadPercent": 70,
"minClientCount": 30,
"minClientThroughputMbps": 10,
"enabled": true
},
"clientAdmissionControl50": null,
"venueProfile": null,
"members": [
{
"apMac": "00:11:22:33:44:55"
},
{
"apMac": "11:22:33:44:55:66"
}
],
"autoChannelSelection24": {
"channelSelectMode": "ChannelFly",
"channelFlyMtbc": 480
},
"autoChannelSelection50": {
"channelSelectMode": "BackgroundScanning",
"channelFlyMtbc": 480
},
"channelEvaluationInterval": 777,
"apMgmtVlan": {
"id": 1,
"mode": "KEEP"
},
"altitude": {
"altitudeUnit": "meters",
"altitudeValue": 1
},
"recoverySsid": {
"recoverySsidEnabled": true
},
"rogueApReportThreshold": 30,
"rogueApAggressivenessMode": 1,
"rogueApJammingThreshold": 30,
"directedMulticastFromWiredClientEnabled": true,
"directedMulticastFromWirelessClientEnabled": true,
"directedMulticastFromNetworkEnabled": false
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the AP group",
"type": "string"
},
"zoneId": {
"description": "Identifier of the zone to which the AP group belongs",
"type": "string"
},
"name": {
"description": "Name of the AP group",
"type": "string"
},
"description": {
"description": "Description of the AP group",
"type": "string"
},
"location": {
"description": "Location of the AP group.",
"type": "string"
},
"locationAdditionalInfo": {
"description": "Location additional info of the AP group.",
"type": "string",
"pattern": "^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
},
"altitude": {
"description": "GPS Altitude",
"type": "object",
"additionalProperties": false,
"properties": {
"altitudeUnit": {
"description": "altitude unit",
"type": "string",
"enum": [
"meters",
"floor"
],
"default": "meters"
},
"altitudeValue": {
"description": "altitude value",
"type": "integer"
}
}
},
"latitude": {
"description": "Latitude coordinate (in decimal format) of the AP group",
"type": "number"
},
"longitude": {
"description": "Longitude coordinate (in decimal format) of the AP group",
"type": "number"
},
"wifi24": {
"description": "AP 2.4GHz radio configuration of the AP group.",
"type": "object",
"additionalProperties": false,
"properties": {
"autoCellSizing": {
"description": "Auto Cell Sizing",
"type": "boolean"
},
"txPower": {
"description": "Transmission power",
"type": "string",
"enum": [
"Full",
"-1dB",
"-2dB",
"-3dB(1/2)",
"-4dB",
"-5dB",
"-6dB(1/4)",
"-7dB",
"-8dB",
"-9dB(1/8)",
"-10dB",
"Min"
],
"default": "Full"
},
"channelWidth": {
"description": "Channel width. Zero (0) means Auto.",
"type": "integer",
"enum": [
0,
20,
40
]
},
"channel": {
"description": "Channel number",
"type": "integer"
},
"channelRange": {
"description": "Channel range options",
"type": "array",
"items": {
"type": "integer"
}
},
"availableChannelRange": {
"description": "Available channel range options",
"type": "array",
"items": {
"type": "integer"
}
}
}
},
"wifi50": {
"description": "AP 5GHz radio configuration of the AP group.",
"type": "object",
"additionalProperties": false,
"properties": {
"autoCellSizing": {
"description": "Auto Cell Sizing",
"type": "boolean"
},
"txPower": {
"description": "Transmission power",
"type": "string",
"enum": [
"Full",
"-1dB",
"-2dB",
"-3dB(1/2)",
"-4dB",
"-5dB",
"-6dB(1/4)",
"-7dB",
"-8dB",
"-9dB(1/8)",
"-10dB",
"Min"
],
"default": "Full"
},
"channelWidth": {
"description": "Channel width. Zero (0) means Auto. 8080 means 80+80MHz",
"type": "integer",
"enum": [
0,
20,
40,
80,
8080,
160
]
},
"indoorChannel": {
"description": "Channel number for Indoor AP",
"type": "integer"
},
"outdoorChannel": {
"description": "Channel number for Outdoor AP",
"type": "integer"
},
"indoorSecondaryChannel": {
"description": "Secondary channel number for Indoor AP (channelWidth is 80+80MHz only)",
"type": "integer"
},
"outdoorSecondaryChannel": {
"description": "Secondary channel number for outdoor AP (channelWidth is 80+80MHz only)",
"type": "integer"
},
"indoorChannelRange": {
"description": "Channel range options for Indoor AP",
"type": "array",
"items": {
"type": "integer"
}
},
"outdoorChannelRange": {
"description": "Channel range options for outdoor AP",
"type": "array",
"items": {
"type": "integer"
}
},
"availableIndoorChannelRange": {
"description": "Available channel range options",
"type": "array",
"items": {
"type": "integer"
}
},
"availableOutdoorChannelRange": {
"description": "Available channel range options",
"type": "array",
"items": {
"type": "integer"
}
}
}
},
"protectionMode24": {
"description": "AP 2.4GHz Protection mode configuration of the AP group.",
"type": "string",
"enum": [
"NONE",
"CTS_ONLY",
"RTS_CTS"
],
"default": "RTS_CTS"
},
"wlanGroup24": {
"description": "WLAN group of radio 2.4G. This configuraiton will override the WLAN group of radio 2.4G at the zone level.",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"wlanGroup50": {
"description": "WLAN group of radio 5G. This configuration will override the WLAN group of radio 5G at the zone level.",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"locationBasedService": {
"description": "Location based service configuration of the AP group.",
"type": "object",
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"clientAdmissionControl24": {
"description": "WLAN group of 2.4GHz radio. This configuraiton will override the WLAN group of 2.4GHz radio at the zone level.",
"type": "object",
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"maxRadioLoadPercent": {
"description": "Maximum radio load percentage.",
"type": "integer",
"default": 75,
"minimum": 50,
"maximum": 100
},
"minClientCount": {
"description": "Minimum client count number.",
"type": "integer",
"default": 10,
"minimum": 0,
"maximum": 100
},
"minClientThroughputMbps": {
"description": "Minimum client throughput in Mbps.",
"type": "number",
"default": 0,
"minimum": 0,
"maximum": 100
}
}
},
"clientAdmissionControl50": {
"description": "WLAN group of 5G radio. This configuration will override the WLAN group of 5G radio at the zone level.",
"type": "object",
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"maxRadioLoadPercent": {
"description": "Maximum radio load percentage.",
"type": "integer",
"default": 75,
"minimum": 50,
"maximum": 100
},
"minClientCount": {
"description": "Minimum client count number.",
"type": "integer",
"default": 10,
"minimum": 0,
"maximum": 100
},
"minClientThroughputMbps": {
"description": "Minimum client throughput in Mbps.",
"type": "number",
"default": 0,
"minimum": 0,
"maximum": 100
}
}
},
"venueProfile": {
"description": "Venue profile configuration of the AP group.",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"members": {
"description": "Members of the AP group",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"apMac": {
"description": "MAC address of member AP",
"type": "string",
"pattern": "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
}
}
}
},
"autoChannelSelection24": {
"description": "client load balancing on Radio 2.4G, auto channel selection mode",
"type": "object",
"additionalProperties": false,
"properties": {
"channelSelectMode": {
"description": "Channel Select Mode",
"type": "string",
"enum": [
"None",
"BackgroundScanning",
"ChannelFly"
],
"default": "BackgroundScanning"
},
"channelFlyMtbc": {
"description": "ChannelFly MTBC",
"type": "integer",
"default": 480,
"minimum": 100,
"maximum": 1440
}
}
},
"autoChannelSelection50": {
"description": "client load balancing on Radio 5G, auto channel selection mode",
"type": "object",
"additionalProperties": false,
"properties": {
"channelSelectMode": {
"description": "Channel Select Mode",
"type": "string",
"enum": [
"None",
"BackgroundScanning",
"ChannelFly"
],
"default": "BackgroundScanning"
},
"channelFlyMtbc": {
"description": "ChannelFly MTBC",
"type": "integer",
"default": 480,
"minimum": 100,
"maximum": 1440
}
}
},
"channelEvaluationInterval": {
"description": "channel evaluation Interval of the ap group",
"type": "integer",
"default": 600,
"minimum": 60,
"maximum": 3600
},
"apMgmtVlan": {
"description": "ap Management Vlan of the apgroup",
"type": "object",
"additionalProperties": false,
"properties": {
"mode": {
"description": "Vlan Mode of the zone",
"type": "string",
"enum": [
"KEEP",
"USER_DEFINED"
],
"default": "KEEP"
},
"id": {
"description": "Vlan id of the zone",
"type": "integer",
"default": "1"
}
}
},
"awsVenue": {
"description": "Venue code",
"type": "string"
},
"recoverySsid": {
"type": "object",
"additionalProperties": false,
"properties": {
"recoverySsidEnabled": {
"description": "recovery ssid enable/disable",
"type": "boolean"
}
}
},
"rogueApReportThreshold": {
"description": "Rogue AP report will leave out all entries that have signal strength lower than this threshold.",
"type": "integer"
},
"rogueApAggressivenessMode": {
"description": "Adjust the frequency interval to de-authenticate rogue APs.",
"type": "integer"
},
"rogueApJammingThreshold": {
"type": "integer"
},
"directedMulticastFromWiredClientEnabled": {
"type": "boolean"
},
"directedMulticastFromWirelessClientEnabled": {
"type": "boolean"
},
"directedMulticastFromNetworkEnabled": {
"type": "boolean"
}
},
"required": [
"name"
]
}Create ¶
POST/v8_0/rkszones/{zoneId}/apgroups
Use this API command to create new AP group within a zone.
Body
{
"name": "apGroupName",
"description": "apGroupDescription",
"location": "Location",
"locationAdditionalInfo": "Location_Additional_Info",
"latitude": 37.411,
"longitude": -122.0196,
"altitude": {
"altitudeUnit": "meters",
"altitudeValue": 65
},
"wlanGroup24": {
"id": "3b779e31-4469-11e8-823e-3e3d08a406ec",
"name": "wg1"
},
"wlanGroup50": {
"id": "4550acd1-4469-11e8-823e-3e3d08a406ec",
"name": "wg2"
},
"wifi24": {
"txPower": "-5dB",
"channelWidth": 40,
"channel": 5,
"channelRange": [
1,
2,
3,
4,
5,
6
]
},
"wifi50": {
"txPower": "-5dB",
"channelWidth": 20,
"indoorChannel": 36,
"outdoorChannel": 157,
"indoorChannelRange": [
36,
40,
44,
48,
157,
161
],
"outdoorChannelRange": [
157,
161
]
},
"locationBasedService": {
"id": "7bebe311-4471-11e8-823e-3e3d08a406ec",
"name": "lbs01",
"enabled": true
},
"clientAdmissionControl24": {
"maxRadioLoadPercent": 75,
"minClientCount": 10,
"minClientThroughputMbps": 0,
"enabled": true
},
"clientAdmissionControl50": {
"maxRadioLoadPercent": 75,
"minClientCount": 20,
"minClientThroughputMbps": 0,
"enabled": true
},
"protectionMode24": "RTS_CTS",
"recoverySsid": {
"recoverySsidEnabled": true
},
"rogueApReportThreshold": 30,
"rogueApAggressivenessMode": 1,
"rogueApJammingThreshold": 30,
"directedMulticastFromWiredClientEnabled": true,
"directedMulticastFromWirelessClientEnabled": true,
"directedMulticastFromNetworkEnabled": true,
"apMgmtVlan": {
"id": 123,
"mode": "USER_DEFINED"
},
"venueProfile": {
"id": "631d8150-4484-11e8-8b35-3e3d08a406ec",
"name": "venueProfile"
},
"channelEvaluationInterval": 777,
"autoChannelSelection24": {
"channelSelectMode": "BackgroundScanning",
"channelFlyMtbc": 480
},
"autoChannelSelection50": {
"channelSelectMode": "BackgroundScanning",
"channelFlyMtbc": 480
}
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"description": "Name of the AP group",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the AP group",
"type": [
"string",
"null"
],
"maxLength": 64
},
"location": {
"description": "Location of the AP group.",
"type": "string"
},
"locationAdditionalInfo": {
"description": "Location additional info of the AP group.",
"type": "string",
"pattern": "^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
},
"altitude": {
"description": "GPS Altitude",
"type": "object",
"additionalProperties": false,
"properties": {
"altitudeUnit": {
"description": "altitude unit",
"type": "string",
"enum": [
"meters",
"floor"
],
"default": "meters"
},
"altitudeValue": {
"description": "altitude value",
"type": "integer"
}
}
},
"latitude": {
"description": "Latitude coordinate (in decimal format) of the AP group",
"type": "number"
},
"longitude": {
"description": "Longitude coordinate (in decimal format) of the AP group",
"type": "number"
},
"wifi24": {
"description": "AP 2.4GHz radio configuration of the AP group.",
"type": "object",
"additionalProperties": false,
"properties": {
"autoCellSizing": {
"description": "Auto Cell Sizing",
"type": "boolean"
},
"txPower": {
"description": "Transmission power",
"type": "string",
"enum": [
"Full",
"-1dB",
"-2dB",
"-3dB(1/2)",
"-4dB",
"-5dB",
"-6dB(1/4)",
"-7dB",
"-8dB",
"-9dB(1/8)",
"-10dB",
"Min"
],
"default": "Full"
},
"channelWidth": {
"description": "Channel width. Zero (0) means Auto.",
"type": "integer",
"enum": [
0,
20,
40
],
"default": 0
},
"channel": {
"description": "Channel number",
"type": "integer"
},
"channelRange": {
"description": "Channel range options",
"type": "array",
"items": {
"type": "integer"
}
}
}
},
"wifi50": {
"description": "AP 5GHz radio configuration of the AP group.",
"type": "object",
"additionalProperties": false,
"properties": {
"autoCellSizing": {
"description": "Auto Cell Sizing",
"type": "boolean"
},
"txPower": {
"description": "Transmission power",
"type": "string",
"enum": [
"Full",
"-1dB",
"-2dB",
"-3dB(1/2)",
"-4dB",
"-5dB",
"-6dB(1/4)",
"-7dB",
"-8dB",
"-9dB(1/8)",
"-10dB",
"Min"
],
"default": "Full"
},
"channelWidth": {
"description": "Channel width. Zero (0) means Auto. 8080 means 80+80MHz",
"type": "integer",
"enum": [
0,
20,
40,
80,
8080,
160
],
"default": 0
},
"indoorChannel": {
"description": "Channel number for Indoor AP",
"type": "integer"
},
"outdoorChannel": {
"description": "Channel number for Outdoor AP",
"type": "integer"
},
"indoorSecondaryChannel": {
"description": "Secondary channel number for Indoor AP (channelWidth is 80+80MHz only)",
"type": "integer"
},
"outdoorSecondaryChannel": {
"description": "Secondary channel number for outdoor AP (channelWidth is 80+80MHz only)",
"type": "integer"
},
"indoorChannelRange": {
"description": "Channel range options for Indoor AP",
"type": "array",
"items": {
"type": "integer"
}
},
"outdoorChannelRange": {
"description": "Channel range options for outdoor AP",
"type": "array",
"items": {
"type": "integer"
}
}
}
},
"protectionMode24": {
"description": "AP 2.4GHz Protection mode configuration of the AP group.",
"type": "string",
"enum": [
"NONE",
"CTS_ONLY",
"RTS_CTS"
],
"default": "RTS_CTS"
},
"wlanGroup24": {
"description": "WLAN group of 2.4GHz radio. This configuraiton will override the WLAN group of 2.4GHz radio at the zone level.",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"wlanGroup50": {
"description": "WLAN group of 5G radio. This configuration will override the WLAN group of 5G radio at the zone level.",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"locationBasedService": {
"description": "Location based service configuration of the AP group.",
"type": "object",
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"clientAdmissionControl24": {
"description": "AP client admission control of 2.4GHz radio configuration of the AP group.",
"type": "object",
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"maxRadioLoadPercent": {
"description": "Maximum radio load percentage.",
"type": "integer",
"default": 75,
"minimum": 50,
"maximum": 100
},
"minClientCount": {
"description": "Minimum client count number.",
"type": "integer",
"default": 10,
"minimum": 0,
"maximum": 100
},
"minClientThroughputMbps": {
"description": "Minimum client throughput in Mbps.",
"type": "number",
"default": 0,
"minimum": 0,
"maximum": 100
}
}
},
"clientAdmissionControl50": {
"description": "AP client admission control of 5GHz radio configuration of the AP group.",
"type": "object",
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"maxRadioLoadPercent": {
"description": "Maximum radio load percentage.",
"type": "integer",
"default": 75,
"minimum": 50,
"maximum": 100
},
"minClientCount": {
"description": "Minimum client count number.",
"type": "integer",
"default": 10,
"minimum": 0,
"maximum": 100
},
"minClientThroughputMbps": {
"description": "Minimum client throughput in Mbps.",
"type": "number",
"default": 0,
"minimum": 0,
"maximum": 100
}
}
},
"venueProfile": {
"description": "Venue profile configuration of the AP group.",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"autoChannelSelection24": {
"description": "client load balancing on Radio 2.4G, auto channel selection mode",
"type": "object",
"additionalProperties": false,
"properties": {
"channelSelectMode": {
"description": "Channel Select Mode",
"type": "string",
"enum": [
"None",
"BackgroundScanning",
"ChannelFly"
],
"default": "BackgroundScanning"
},
"channelFlyMtbc": {
"description": "ChannelFly MTBC",
"type": "integer",
"default": 480,
"minimum": 100,
"maximum": 1440
}
}
},
"autoChannelSelection50": {
"description": "client load balancing on Radio 5G, auto channel selection mode",
"type": "object",
"additionalProperties": false,
"properties": {
"channelSelectMode": {
"description": "Channel Select Mode",
"type": "string",
"enum": [
"None",
"BackgroundScanning",
"ChannelFly"
],
"default": "BackgroundScanning"
},
"channelFlyMtbc": {
"description": "ChannelFly MTBC",
"type": "integer",
"default": 480,
"minimum": 100,
"maximum": 1440
}
}
},
"channelEvaluationInterval": {
"description": "channel evaluation Interval of the ap group",
"type": "integer",
"default": 600,
"minimum": 60,
"maximum": 3600
},
"apMgmtVlan": {
"description": "ap Management Vlan of the apgroup",
"type": "object",
"additionalProperties": false,
"properties": {
"mode": {
"description": "Vlan Mode of the zone",
"type": "string",
"enum": [
"KEEP",
"USER_DEFINED"
],
"default": "KEEP"
},
"id": {
"description": "Vlan id of the zone",
"type": "integer",
"default": "1"
}
}
},
"awsVenue": {
"description": "Venue code",
"type": "string"
},
"recoverySsid": {
"type": "object",
"additionalProperties": false,
"properties": {
"recoverySsidEnabled": {
"description": "recovery ssid enable/disable",
"type": "boolean"
}
}
},
"rogueApReportThreshold": {
"description": "Rogue AP report will leave out all entries that have signal strength lower than this threshold.",
"type": "integer"
},
"rogueApAggressivenessMode": {
"description": "Adjust the frequency interval to de-authenticate rogue APs.",
"type": "integer"
},
"rogueApJammingThreshold": {
"type": "integer"
},
"directedMulticastFromWiredClientEnabled": {
"description": "Directed multicast from wired client to network.",
"type": "boolean"
},
"directedMulticastFromWirelessClientEnabled": {
"description": "Directed multicast from wireless client to network.",
"type": "boolean"
},
"directedMulticastFromNetworkEnabled": {
"description": "Directed multicast from network to wired / wireless client.",
"type": "boolean"
}
},
"required": [
"name"
]
}201Body
{
"id": "apGroupUUID"
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
}
}
}Delete ¶
Retrieve List ¶
GET/v8_0/rkszones/{zoneId}/apgroups
Use this API command to retrieve the list of AP groups that belong to a zone.
- index
string(optional)The index of the first entry to be retrieved. Default: 0
- listSize
string(optional)The maximum number of entries to be retrieved. Default: 100
200Body
{
"totalCount": 2,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"id": "apGroupUUID",
"name": "apGroupName"
},
{
"id": "apGroupUUID2",
"name": "apGroupName2"
}
]
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"totalCount": {
"type": "integer"
},
"hasMore": {
"type": "boolean"
},
"firstIndex": {
"type": "integer"
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the AP group",
"type": "string"
},
"name": {
"description": "Description of the AP group",
"type": "string"
}
}
}
}
}
}Retrieve Default AP Group ¶
GET/v8_0/rkszones/{zoneId}/apgroups/default
Use this API command to retrieve information about default AP group of zone.
200Body
{
"id": "apGroupUUID",
"zoneId": "zoneUUID",
"name": "apGroupName",
"description": "apGroupDescription",
"location": "test-ap1_modify",
"locationAdditionalInfo": "add",
"latitude": 34,
"longitude": 45,
"wifi24": {
"txPower": "Full",
"channelWidth": 20,
"channel": 9,
"channelRange": [
1,
2,
3,
4,
9,
10,
11
],
"availableChannelRange": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11
]
},
"wifi50": {
"txPower": "Full",
"channelWidth": 40,
"indoorChannel": 0,
"outdoorChannel": 157,
"indoorChannelRange": [
36,
40,
44,
48
],
"outdoorChannelRange": [
149,
153
],
"availableIndoorChannelRange": [
36,
40,
44,
48,
149,
153,
157,
161
],
"availableOutdoorChannelRange": [
149,
153,
157,
161
]
},
"protectionMode24": "CTS_ONLY",
"wlanGroup24": {
"id": "19b10850-7eaa-11e4-a584-08002716c79f",
"name": "default"
},
"wlanGroup50": null,
"locationBasedService": null,
"clientAdmissionControl24": {
"maxRadioLoadPercent": 70,
"minClientCount": 30,
"minClientThroughputMbps": 10,
"enabled": true
},
"clientAdmissionControl50": null,
"venueProfile": null,
"members": [
{
"apMac": "00:11:22:33:44:55"
},
{
"apMac": "11:22:33:44:55:66"
}
],
"autoChannelSelection24": {
"channelSelectMode": "ChannelFly",
"channelFlyMtbc": 480
},
"autoChannelSelection50": {
"channelSelectMode": "BackgroundScanning",
"channelFlyMtbc": 480
},
"channelEvaluationInterval": 777,
"apMgmtVlan": {
"id": 1,
"mode": "KEEP"
},
"altitude": {
"altitudeUnit": "meters",
"altitudeValue": 1
},
"recoverySsid": {
"recoverySsidEnabled": true
},
"rogueApReportThreshold": 30,
"rogueApAggressivenessMode": 1,
"rogueApJammingThreshold": 30,
"directedMulticastFromWiredClientEnabled": true,
"directedMulticastFromWirelessClientEnabled": true,
"directedMulticastFromNetworkEnabled": false
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the AP group",
"type": "string"
},
"zoneId": {
"description": "Identifier of the zone to which the AP group belongs",
"type": "string"
},
"name": {
"description": "Name of the AP group",
"type": "string"
},
"description": {
"description": "Description of the AP group",
"type": "string"
},
"location": {
"description": "Location of the AP group.",
"type": "string"
},
"locationAdditionalInfo": {
"description": "Location additional info of the AP group.",
"type": "string",
"pattern": "^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
},
"altitude": {
"description": "GPS Altitude",
"type": "object",
"additionalProperties": false,
"properties": {
"altitudeUnit": {
"description": "altitude unit",
"type": "string",
"enum": [
"meters",
"floor"
],
"default": "meters"
},
"altitudeValue": {
"description": "altitude value",
"type": "integer"
}
}
},
"latitude": {
"description": "Latitude coordinate (in decimal format) of the AP group",
"type": "number"
},
"longitude": {
"description": "Longitude coordinate (in decimal format) of the AP group",
"type": "number"
},
"wifi24": {
"description": "AP 2.4GHz radio configuration of the AP group.",
"type": "object",
"additionalProperties": false,
"properties": {
"autoCellSizing": {
"description": "Auto Cell Sizing",
"type": "boolean"
},
"txPower": {
"description": "Transmission power",
"type": "string",
"enum": [
"Full",
"-1dB",
"-2dB",
"-3dB(1/2)",
"-4dB",
"-5dB",
"-6dB(1/4)",
"-7dB",
"-8dB",
"-9dB(1/8)",
"-10dB",
"Min"
],
"default": "Full"
},
"channelWidth": {
"description": "Channel width. Zero (0) means Auto.",
"type": "integer",
"enum": [
0,
20,
40
]
},
"channel": {
"description": "Channel number",
"type": "integer"
},
"channelRange": {
"description": "Channel range options",
"type": "array",
"items": {
"type": "integer"
}
},
"availableChannelRange": {
"description": "Available channel range options",
"type": "array",
"items": {
"type": "integer"
}
}
}
},
"wifi50": {
"description": "AP 5GHz radio configuration of the AP group.",
"type": "object",
"additionalProperties": false,
"properties": {
"autoCellSizing": {
"description": "Auto Cell Sizing",
"type": "boolean"
},
"txPower": {
"description": "Transmission power",
"type": "string",
"enum": [
"Full",
"-1dB",
"-2dB",
"-3dB(1/2)",
"-4dB",
"-5dB",
"-6dB(1/4)",
"-7dB",
"-8dB",
"-9dB(1/8)",
"-10dB",
"Min"
],
"default": "Full"
},
"channelWidth": {
"description": "Channel width. Zero (0) means Auto. 8080 means 80+80MHz",
"type": "integer",
"enum": [
0,
20,
40,
80,
8080,
160
]
},
"indoorChannel": {
"description": "Channel number for Indoor AP",
"type": "integer"
},
"outdoorChannel": {
"description": "Channel number for Outdoor AP",
"type": "integer"
},
"indoorSecondaryChannel": {
"description": "Secondary channel number for Indoor AP (channelWidth is 80+80MHz only)",
"type": "integer"
},
"outdoorSecondaryChannel": {
"description": "Secondary channel number for outdoor AP (channelWidth is 80+80MHz only)",
"type": "integer"
},
"indoorChannelRange": {
"description": "Channel range options for Indoor AP",
"type": "array",
"items": {
"type": "integer"
}
},
"outdoorChannelRange": {
"description": "Channel range options for outdoor AP",
"type": "array",
"items": {
"type": "integer"
}
},
"availableIndoorChannelRange": {
"description": "Available channel range options",
"type": "array",
"items": {
"type": "integer"
}
},
"availableOutdoorChannelRange": {
"description": "Available channel range options",
"type": "array",
"items": {
"type": "integer"
}
}
}
},
"protectionMode24": {
"description": "AP 2.4GHz Protection mode configuration of the AP group.",
"type": "string",
"enum": [
"NONE",
"CTS_ONLY",
"RTS_CTS"
],
"default": "RTS_CTS"
},
"wlanGroup24": {
"description": "WLAN group of radio 2.4G. This configuraiton will override the WLAN group of radio 2.4G at the zone level.",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"wlanGroup50": {
"description": "WLAN group of radio 5G. This configuration will override the WLAN group of radio 5G at the zone level.",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"locationBasedService": {
"description": "Location based service configuration of the AP group.",
"type": "object",
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"clientAdmissionControl24": {
"description": "WLAN group of 2.4GHz radio. This configuraiton will override the WLAN group of 2.4GHz radio at the zone level.",
"type": "object",
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"maxRadioLoadPercent": {
"description": "Maximum radio load percentage.",
"type": "integer",
"default": 75,
"minimum": 50,
"maximum": 100
},
"minClientCount": {
"description": "Minimum client count number.",
"type": "integer",
"default": 10,
"minimum": 0,
"maximum": 100
},
"minClientThroughputMbps": {
"description": "Minimum client throughput in Mbps.",
"type": "number",
"default": 0,
"minimum": 0,
"maximum": 100
}
}
},
"clientAdmissionControl50": {
"description": "WLAN group of 5G radio. This configuration will override the WLAN group of 5G radio at the zone level.",
"type": "object",
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"maxRadioLoadPercent": {
"description": "Maximum radio load percentage.",
"type": "integer",
"default": 75,
"minimum": 50,
"maximum": 100
},
"minClientCount": {
"description": "Minimum client count number.",
"type": "integer",
"default": 10,
"minimum": 0,
"maximum": 100
},
"minClientThroughputMbps": {
"description": "Minimum client throughput in Mbps.",
"type": "number",
"default": 0,
"minimum": 0,
"maximum": 100
}
}
},
"venueProfile": {
"description": "Venue profile configuration of the AP group.",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"members": {
"description": "Members of the AP group",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"apMac": {
"description": "MAC address of member AP",
"type": "string",
"pattern": "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
}
}
}
},
"autoChannelSelection24": {
"description": "client load balancing on Radio 2.4G, auto channel selection mode",
"type": "object",
"additionalProperties": false,
"properties": {
"channelSelectMode": {
"description": "Channel Select Mode",
"type": "string",
"enum": [
"None",
"BackgroundScanning",
"ChannelFly"
],
"default": "BackgroundScanning"
},
"channelFlyMtbc": {
"description": "ChannelFly MTBC",
"type": "integer",
"default": 480,
"minimum": 100,
"maximum": 1440
}
}
},
"autoChannelSelection50": {
"description": "client load balancing on Radio 5G, auto channel selection mode",
"type": "object",
"additionalProperties": false,
"properties": {
"channelSelectMode": {
"description": "Channel Select Mode",
"type": "string",
"enum": [
"None",
"BackgroundScanning",
"ChannelFly"
],
"default": "BackgroundScanning"
},
"channelFlyMtbc": {
"description": "ChannelFly MTBC",
"type": "integer",
"default": 480,
"minimum": 100,
"maximum": 1440
}
}
},
"channelEvaluationInterval": {
"description": "channel evaluation Interval of the ap group",
"type": "integer",
"default": 600,
"minimum": 60,
"maximum": 3600
},
"apMgmtVlan": {
"description": "ap Management Vlan of the apgroup",
"type": "object",
"additionalProperties": false,
"properties": {
"mode": {
"description": "Vlan Mode of the zone",
"type": "string",
"enum": [
"KEEP",
"USER_DEFINED"
],
"default": "KEEP"
},
"id": {
"description": "Vlan id of the zone",
"type": "integer",
"default": "1"
}
}
},
"awsVenue": {
"description": "Venue code",
"type": "string"
},
"recoverySsid": {
"type": "object",
"additionalProperties": false,
"properties": {
"recoverySsidEnabled": {
"description": "recovery ssid enable/disable",
"type": "boolean"
}
}
},
"rogueApReportThreshold": {
"description": "Rogue AP report will leave out all entries that have signal strength lower than this threshold.",
"type": "integer"
},
"rogueApAggressivenessMode": {
"description": "Adjust the frequency interval to de-authenticate rogue APs.",
"type": "integer"
},
"rogueApJammingThreshold": {
"type": "integer"
},
"directedMulticastFromWiredClientEnabled": {
"type": "boolean"
},
"directedMulticastFromWirelessClientEnabled": {
"type": "boolean"
},
"directedMulticastFromNetworkEnabled": {
"type": "boolean"
}
},
"required": [
"name"
]
}Modify ¶
PATCH/v8_0/rkszones/{zoneId}/apgroups/{id}
Use this API command to modify the basic information of an AP group.
Body
{
"name": "apGroupNameModified",
"description": "apGroupDescriptionModified",
"location": "test-ap1_modify",
"locationAdditionalInfo": "add",
"latitude": 34,
"longitude": 45,
"wifi24": {
"txPower": "Full",
"channelWidth": 20,
"channel": 10,
"channelRange": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11
]
},
"wifi50": {
"txPower": "Full",
"channelWidth": 20,
"indoorChannel": 36,
"outdoorChannel": 149,
"indoorChannelRange": [
36,
40,
44,
48,
149,
153,
157,
161
],
"outdoorChannelRange": [
149,
153,
157,
161
]
},
"protectionMode24": "CTS_ONLY",
"wlanGroup24": {
"id": "19b10850-7eaa-11e4-a584-08002716c79f",
"name": "default"
},
"wlanGroup50": {
"id": "19b10850-7eaa-11e4-a584-08002716c79f",
"name": "default"
},
"locationBasedService": {
"id": "lbsServiceId",
"name": "lbsServiceName"
},
"clientAdmissionControl24": {
"maxRadioLoadPercent": 70,
"minClientCount": 30,
"minClientThroughputMbps": 10,
"enabled": true
},
"clientAdmissionControl50": {
"maxRadioLoadPercent": 70,
"minClientCount": 30,
"minClientThroughputMbps": 10,
"enabled": true
},
"venueProfile": {
"id": "venueProfileId",
"name": "venueProfileName"
},
"autoChannelSelection24": {
"channelSelectMode": "ChannelFly",
"channelFlyMtbc": 480
},
"autoChannelSelection50": {
"channelSelectMode": "BackgroundScanning",
"channelFlyMtbc": 480
},
"channelEvaluationInterval": 777,
"apMgmtVlan": {
"id": 1,
"mode": "KEEP"
},
"altitude": {
"altitudeUnit": "meters",
"altitudeValue": 1
},
"recoverySsid": {
"recoverySsidEnabled": true
},
"rogueApReportThreshold": 30,
"rogueApAggressivenessMode": 1,
"rogueApJammingThreshold": 30,
"directedMulticastFromWiredClientEnabled": true,
"directedMulticastFromWirelessClientEnabled": true,
"directedMulticastFromNetworkEnabled": false
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"description": "Name of the AP group",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the AP group",
"type": [
"string",
"null"
],
"maxLength": 64
},
"location": {
"description": "Location of the AP group.",
"type": "string"
},
"locationAdditionalInfo": {
"description": "Location additional info of the AP group.",
"type": "string",
"pattern": "^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
},
"altitude": {
"description": "GPS Altitude",
"type": "object",
"additionalProperties": false,
"properties": {
"altitudeUnit": {
"description": "altitude unit",
"type": "string",
"enum": [
"meters",
"floor"
]
},
"altitudeValue": {
"description": "altitude value",
"type": "integer"
}
}
},
"latitude": {
"description": "Latitude coordinate (in decimal format) of the AP group",
"type": "number"
},
"longitude": {
"description": "Longitude coordinate (in decimal format) of the AP group",
"type": "number"
},
"wifi24": {
"description": "AP 2.4GHz radio configuration of the AP group.",
"type": "object",
"additionalProperties": false,
"properties": {
"autoCellSizing": {
"description": "Auto Cell Sizing",
"type": "boolean"
},
"txPower": {
"description": "Transmission power",
"type": "string",
"enum": [
"Full",
"-1dB",
"-2dB",
"-3dB(1/2)",
"-4dB",
"-5dB",
"-6dB(1/4)",
"-7dB",
"-8dB",
"-9dB(1/8)",
"-10dB",
"Min"
]
},
"channelWidth": {
"description": "Channel width. Zero (0) means Auto.",
"type": "integer",
"enum": [
0,
20,
40
]
},
"channel": {
"description": "Channel number",
"type": "integer"
},
"channelRange": {
"description": "Channel range options",
"type": "array",
"items": {
"type": "integer"
}
}
}
},
"wifi50": {
"description": "AP 5GHz radio configuration of the AP group.",
"type": "object",
"additionalProperties": false,
"properties": {
"autoCellSizing": {
"description": "Auto Cell Sizing",
"type": "boolean"
},
"txPower": {
"description": "Transmission power",
"type": "string",
"enum": [
"Full",
"-1dB",
"-2dB",
"-3dB(1/2)",
"-4dB",
"-5dB",
"-6dB(1/4)",
"-7dB",
"-8dB",
"-9dB(1/8)",
"-10dB",
"Min"
]
},
"channelWidth": {
"description": "Channel width. Zero (0) means Auto. 8080 means 80+80MHz",
"type": "integer",
"enum": [
0,
20,
40,
80,
8080,
160
]
},
"indoorChannel": {
"description": "Channel number for Indoor AP",
"type": "integer"
},
"outdoorChannel": {
"description": "Channel number for Outdoor AP",
"type": "integer"
},
"indoorSecondaryChannel": {
"description": "Secondary channel number for Indoor AP (channelWidth is 80+80MHz only)",
"type": "integer"
},
"outdoorSecondaryChannel": {
"description": "Secondary channel number for outdoor AP (channelWidth is 80+80MHz only)",
"type": "integer"
},
"indoorChannelRange": {
"description": "Channel range options for Indoor AP",
"type": "array",
"items": {
"type": "integer"
}
},
"outdoorChannelRange": {
"description": "Channel range options for outdoor AP",
"type": "array",
"items": {
"type": "integer"
}
}
}
},
"protectionMode24": {
"description": "AP 2.4GHz Protection mode configuration of the AP group.",
"type": "string",
"enum": [
"NONE",
"CTS_ONLY",
"RTS_CTS"
]
},
"wlanGroup24": {
"description": "WLAN group of 2.4GHz radio. This configuraiton will override the WLAN group of 2.4GHz radio at the zone level.",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"wlanGroup50": {
"description": "WLAN group of 5G radio. This configuration will override the WLAN group of 5G radio at the zone level.",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"locationBasedService": {
"description": "Location based service configuration of the AP group.",
"type": "object",
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"clientAdmissionControl24": {
"description": "AP client admission control of 2.4GHz radio configuration of the AP group.",
"type": "object",
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"maxRadioLoadPercent": {
"description": "Maximum radio load percentage.",
"type": "integer",
"minimum": 50,
"maximum": 100
},
"minClientCount": {
"description": "Minimum client count number.",
"type": "integer",
"minimum": 0,
"maximum": 100
},
"minClientThroughputMbps": {
"description": "Minimum client throughput in Mbps.",
"type": "number",
"minimum": 0,
"maximum": 100
}
}
},
"clientAdmissionControl50": {
"description": "AP client admission control of 5GHz radio configuration of the AP group.",
"type": "object",
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"maxRadioLoadPercent": {
"description": "Maximum radio load percentage.",
"type": "integer",
"minimum": 50,
"maximum": 100
},
"minClientCount": {
"description": "Minimum client count number.",
"type": "integer",
"minimum": 0,
"maximum": 100
},
"minClientThroughputMbps": {
"description": "Minimum client throughput in Mbps.",
"type": "number",
"minimum": 0,
"maximum": 100
}
}
},
"venueProfile": {
"description": "Venue profile configuration of the AP group.",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"autoChannelSelection24": {
"description": "client load balancing on Radio 2.4G, auto channel selection mode",
"type": "object",
"additionalProperties": false,
"properties": {
"channelSelectMode": {
"description": "Channel Select Mode",
"type": "string",
"enum": [
"None",
"BackgroundScanning",
"ChannelFly"
]
},
"channelFlyMtbc": {
"description": "ChannelFly MTBC",
"type": "integer",
"minimum": 100,
"maximum": 1440
}
}
},
"autoChannelSelection50": {
"description": "client load balancing on Radio 5G, auto channel selection mode",
"type": "object",
"additionalProperties": false,
"properties": {
"channelSelectMode": {
"description": "Channel Select Mode",
"type": "string",
"enum": [
"None",
"BackgroundScanning",
"ChannelFly"
]
},
"channelFlyMtbc": {
"description": "ChannelFly MTBC",
"type": "integer",
"minimum": 100,
"maximum": 1440
}
}
},
"channelEvaluationInterval": {
"description": "channel evaluation Interval of the ap group",
"type": "integer",
"minimum": 60,
"maximum": 3600
},
"apMgmtVlan": {
"description": "ap Management Vlan of the apgroup",
"type": "object",
"additionalProperties": false,
"properties": {
"mode": {
"description": "Vlan Mode of the zone",
"type": "string",
"enum": [
"KEEP",
"USER_DEFINED"
]
},
"id": {
"description": "Vlan id of the zone",
"type": "integer"
}
}
},
"awsVenue": {
"description": "Venue code",
"type": "string"
},
"recoverySsid": {
"type": "object",
"additionalProperties": false,
"properties": {
"recoverySsidEnabled": {
"description": "recovery ssid enable/disable",
"type": "boolean"
}
}
},
"rogueApReportThreshold": {
"description": "Rogue AP report will leave out all entries that have signal strength lower than this threshold.",
"type": "integer"
},
"rogueApAggressivenessMode": {
"description": "Adjust the frequency interval to de-authenticate rogue APs.",
"type": "integer"
},
"rogueApJammingThreshold": {
"type": "integer"
},
"directedMulticastFromWiredClientEnabled": {
"description": "Directed multicast from wired client to network.",
"type": "boolean"
},
"directedMulticastFromWirelessClientEnabled": {
"description": "Directed multicast from wireless client to network.",
"type": "boolean"
},
"directedMulticastFromNetworkEnabled": {
"description": "Directed multicast from network to wired / wireless client.",
"type": "boolean"
}
}
}204Modify Location Override ¶
PATCH/v8_0/rkszones/{zoneId}/apgroups/{id}/location
Use this API command to modify the location override zone for APs that belong to an AP group.
Body
"test-ap1_modify"Schema
{
"description": "Location of the AP group.",
"type": "string"
}204Modify Location AdditionalInfo Override ¶
PATCH/v8_0/rkszones/{zoneId}/apgroups/{id}/locationAdditionalInfo
Use this API command to modify the locationAdditionalInfo override zone for APs that belong to an AP group.
Body
"add"Schema
{
"description": "Location additional info of the AP group.",
"type": "string",
"pattern": "^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
}204Modify Radio 2.4G Override ¶
PATCH/v8_0/rkszones/{zoneId}/apgroups/{id}/wifi24
Use this API command to modify the 2.4GHz radio configuration override zone for APs that belong to an AP group.
Body
{
"txPower": "Full",
"channelWidth": 20,
"channel": 10,
"channelRange": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11
]
}Schema
{
"description": "AP 2.4GHz radio configuration of the AP group.",
"type": "object",
"additionalProperties": false,
"properties": {
"autoCellSizing": {
"description": "Auto Cell Sizing",
"type": "boolean"
},
"txPower": {
"description": "Transmission power",
"type": "string",
"enum": [
"Full",
"-1dB",
"-2dB",
"-3dB(1/2)",
"-4dB",
"-5dB",
"-6dB(1/4)",
"-7dB",
"-8dB",
"-9dB(1/8)",
"-10dB",
"Min"
]
},
"channelWidth": {
"description": "Channel width. Zero (0) means Auto.",
"type": "integer",
"enum": [
0,
20,
40
]
},
"channel": {
"description": "Channel number",
"type": "integer"
},
"channelRange": {
"description": "Channel range options",
"type": "array",
"items": {
"type": "integer"
}
}
}
}204Modify Radio 5G Override ¶
PATCH/v8_0/rkszones/{zoneId}/apgroups/{id}/wifi50
Use this API command to modify the 5GHz radio configuration override zone for APs that belong to an AP group.
Body
{
"txPower": "Full",
"channelWidth": 20,
"indoorChannel": 36,
"outdoorChannel": 149,
"indoorChannelRange": [
36,
40,
44,
48,
149,
153,
157,
161
],
"outdoorChannelRange": [
149,
153,
157,
161
]
}Schema
{
"description": "AP 5GHz radio configuration of the AP group.",
"type": "object",
"additionalProperties": false,
"properties": {
"autoCellSizing": {
"description": "Auto Cell Sizing",
"type": "boolean"
},
"txPower": {
"description": "Transmission power",
"type": "string",
"enum": [
"Full",
"-1dB",
"-2dB",
"-3dB(1/2)",
"-4dB",
"-5dB",
"-6dB(1/4)",
"-7dB",
"-8dB",
"-9dB(1/8)",
"-10dB",
"Min"
]
},
"channelWidth": {
"description": "Channel width. Zero (0) means Auto. 8080 means 80+80MHz",
"type": "integer",
"enum": [
0,
20,
40,
80,
8080,
160
]
},
"indoorChannel": {
"description": "Channel number for Indoor AP",
"type": "integer"
},
"outdoorChannel": {
"description": "Channel number for Outdoor AP",
"type": "integer"
},
"indoorSecondaryChannel": {
"description": "Secondary channel number for Indoor AP (channelWidth is 80+80MHz only)",
"type": "integer"
},
"outdoorSecondaryChannel": {
"description": "Secondary channel number for outdoor AP (channelWidth is 80+80MHz only)",
"type": "integer"
},
"indoorChannelRange": {
"description": "Channel range options for Indoor AP",
"type": "array",
"items": {
"type": "integer"
}
},
"outdoorChannelRange": {
"description": "Channel range options for outdoor AP",
"type": "array",
"items": {
"type": "integer"
}
}
}
}204Modify WLAN group 2.4G Override ¶
PATCH/v8_0/rkszones/{zoneId}/apgroups/{id}/wlanGroup24
Use this API command to modify the WLAN group on 2.4GHz radio override zone for APs that belong to an AP group.
Body
{
"id": "19b10850-7eaa-11e4-a584-08002716c79f",
"name": "default"
}Schema
{
"description": "WLAN group of 2.4GHz radio. This configuraiton will override the WLAN group of 2.4GHz radio at the zone level.",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}204Modify WLAN group 5G Override ¶
PATCH/v8_0/rkszones/{zoneId}/apgroups/{id}/wlanGroup50
Use this API command to modify the WLAN group on 5GHz radio override zone for APs that belong to an AP group.
Body
{
"id": "19b10850-7eaa-11e4-a584-08002716c79f",
"name": "default"
}Schema
{
"description": "WLAN group of 5G radio. This configuration will override the WLAN group of 5G radio at the zone level.",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}204Modify Location Based Service Override ¶
PATCH/v8_0/rkszones/{zoneId}/apgroups/{id}/locationBasedService
Use this API command to modify location based service override zone for APs that belong to an AP group.
Body
{
"id": "lbsServiceId",
"name": "lbsServiceName"
}Schema
{
"description": "Location based service configuration of the AP group.",
"type": "object",
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}204Modify Client Admission Control 2.4G Override ¶
PATCH/v8_0/rkszones/{zoneId}/apgroups/{id}/clientAdmissionControl24
Use this API command to modify client admission control 2.4GHz radio configuration override zone for APs that belong to an AP group.
Body
{
"maxRadioLoadPercent": 70,
"minClientCount": 30,
"minClientThroughputMbps": 10,
"enabled": true
}Schema
{
"description": "AP client admission control of 2.4GHz radio configuration of the AP group.",
"type": "object",
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"maxRadioLoadPercent": {
"description": "Maximum radio load percentage.",
"type": "integer",
"minimum": 50,
"maximum": 100
},
"minClientCount": {
"description": "Minimum client count number.",
"type": "integer",
"minimum": 0,
"maximum": 100
},
"minClientThroughputMbps": {
"description": "Minimum client throughput in Mbps.",
"type": "number",
"minimum": 0,
"maximum": 100
}
}
}204Modify Client Admission Control 5G Override ¶
PATCH/v8_0/rkszones/{zoneId}/apgroups/{id}/clientAdmissionControl50
Use this API command to modify client admission control 5GHz radio configuration override zone for APs that belong to an AP group.
Body
{
"maxRadioLoadPercent": 70,
"minClientCount": 30,
"minClientThroughputMbps": 10,
"enabled": true
}Schema
{
"description": "AP client admission control of 5GHz radio configuration of the AP group.",
"type": "object",
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"maxRadioLoadPercent": {
"description": "Maximum radio load percentage.",
"type": "integer",
"minimum": 50,
"maximum": 100
},
"minClientCount": {
"description": "Minimum client count number.",
"type": "integer",
"minimum": 0,
"maximum": 100
},
"minClientThroughputMbps": {
"description": "Minimum client throughput in Mbps.",
"type": "number",
"minimum": 0,
"maximum": 100
}
}
}204Modify Hotspot2.0 Venue Profile ¶
PATCH/v8_0/rkszones/{zoneId}/apgroups/{id}/venueProfile
Use this API command to modify Hotspot 2.0 venue profile for APs that belong to an AP group.
Body
{
"id": "venueProfileId",
"name": "venueProfileName"
}Schema
{
"description": "Venue profile configuration of the AP group.",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}204Modify Radio 2.4G Auto ChannelSelectMode Override ¶
PATCH/v8_0/rkszones/{zoneId}/apgroups/{id}/autoChannelSelection24
Override Radio 2.4G Auto ChannelSelectMode and ChannelFly MTBC of an AP group.
Body
{
"channelSelectMode": "ChannelFly",
"channelFlyMtbc": 480
}Schema
{
"description": "client load balancing on Radio 2.4G, auto channel selection mode",
"type": "object",
"additionalProperties": false,
"properties": {
"channelSelectMode": {
"description": "Channel Select Mode",
"type": "string",
"enum": [
"None",
"BackgroundScanning",
"ChannelFly"
]
},
"channelFlyMtbc": {
"description": "ChannelFly MTBC",
"type": "integer",
"minimum": 100,
"maximum": 1440
}
}
}204Modify Radio 5G Auto ChannelSelectMode Override ¶
PATCH/v8_0/rkszones/{zoneId}/apgroups/{id}/autoChannelSelection50
Override Radio 5G Auto ChannelSelectMode and ChannelFly MTBC of an AP group.
Body
{
"channelSelectMode": "BackgroundScanning",
"channelFlyMtbc": 480
}Schema
{
"description": "client load balancing on Radio 5G, auto channel selection mode",
"type": "object",
"additionalProperties": false,
"properties": {
"channelSelectMode": {
"description": "Channel Select Mode",
"type": "string",
"enum": [
"None",
"BackgroundScanning",
"ChannelFly"
]
},
"channelFlyMtbc": {
"description": "ChannelFly MTBC",
"type": "integer",
"minimum": 100,
"maximum": 1440
}
}
}204Modify AP Management Vlan ¶
PATCH/v8_0/rkszones/{zoneId}/apgroups/{id}/apMgmtVlan
Modify AP Management Vlan of an AP group.
Body
{
"id": 1,
"mode": "KEEP"
}Schema
{
"description": "ap Management Vlan of the apgroup",
"type": "object",
"additionalProperties": false,
"properties": {
"mode": {
"description": "Vlan Mode of the zone",
"type": "string",
"enum": [
"KEEP",
"USER_DEFINED"
]
},
"id": {
"description": "Vlan id of the zone",
"type": "integer"
}
}
}204Modify Altitude of ApGroup ¶
PATCH/v8_0/rkszones/{zoneId}/apgroups/{id}/altitude
Use this API command to modify the altitude of AP group.
Body
{
"altitudeUnit": "meters",
"altitudeValue": 1
}Schema
{
"description": "GPS Altitude",
"type": "object",
"additionalProperties": false,
"properties": {
"altitudeUnit": {
"description": "altitude unit",
"type": "string",
"enum": [
"meters",
"floor"
]
},
"altitudeValue": {
"description": "altitude value",
"type": "integer"
}
}
}204Modify Recovery SSID Override ¶
PATCH/v8_0/rkszones/{zoneId}/apgroups/{id}/recoverySsid
Use this API command to modify the Recovery SSID of an AP group.
Body
{
"recoverySsidEnabled": true
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"recoverySsidEnabled": {
"description": "recovery ssid enable/disable",
"type": "boolean"
}
}
}204Disable Location Override ¶
DELETE/v8_0/rkszones/{zoneId}/apgroups/{id}/location
Use this API command to disable location override for APs that belong to an AP group.
204Disable Location AdditionalInfo Override ¶
DELETE/v8_0/rkszones/{zoneId}/apgroups/{id}/locationAdditionalInfo
Use this API command to disable location additionalInfo override zone for APs that belong to an AP group.
204Disable Radio 2.4G Override ¶
DELETE/v8_0/rkszones/{zoneId}/apgroups/{id}/wifi24
Use this API command to disable 2.4GHz radio configuration override zone for APs that belong to an AP group.
204Disable Radio 5G Override ¶
DELETE/v8_0/rkszones/{zoneId}/apgroups/{id}/wifi50
Use this API command to disable 5GHz radio configuration override zone for APs that belong to an AP group.
204Disable WLAN group 2.4G Override ¶
DELETE/v8_0/rkszones/{zoneId}/apgroups/{id}/wlanGroup24
Use this API command to disable WLAN group on 2.4GHz radio override zone for APs that belong to an AP group.
204Disable WLAN group 5G Override ¶
DELETE/v8_0/rkszones/{zoneId}/apgroups/{id}/wlanGroup50
Use this API command to disable WLAN group on 5GHz radio override zone for APs that belong to an AP group.
204Disable Location Based Service Override ¶
DELETE/v8_0/rkszones/{zoneId}/apgroups/{id}/locationBasedService
Use this API command to disable location based service override zone for APs that belong to an AP group.
204Disable Client Admission Control 2.4G Override ¶
DELETE/v8_0/rkszones/{zoneId}/apgroups/{id}/clientAdmissionControl24
Use this API command to disable client admission control 2.4GHz radio configuration override zone for APs that belong to an AP group.
204Disable Client Admission Control 5G Override ¶
DELETE/v8_0/rkszones/{zoneId}/apgroups/{id}/clientAdmissionControl50
Use this API command to disable client admission control 5GHz radio configuration override zone for APs that belong to an AP group.
204Clear Hotspot2.0 Venue Profile ¶
DELETE/v8_0/rkszones/{zoneId}/apgroups/{id}/venueProfile
Use this API command to clear Hotspot 2.0 venue profile for APs that belong to an AP group.
204Disable Radio 2.4G Auto ChannelSelectMode Override ¶
DELETE/v8_0/rkszones/{zoneId}/apgroups/{id}/autoChannelSelection24
Disable Radio 2.4G Auto ChannelSelectMode and ChannelFly MTBC Override of an AP group.
204Disable Radio 5G Auto ChannelSelectMode Override ¶
DELETE/v8_0/rkszones/{zoneId}/apgroups/{id}/autoChannelSelection50
Disable Radio 5G Auto ChannelSelectMode and ChannelFly MTBC Override of an AP group.
204Disable Channel Evaluation Interval Override ¶
DELETE/v8_0/rkszones/{zoneId}/apgroups/{id}/channelEvaluationInterval
Disable Channel Evaluation Interval Override of an AP group.
204Disable AP Management Vlan Override ¶
DELETE/v8_0/rkszones/{zoneId}/apgroups/{id}/apMgmtVlan
Disable AP Management Vlan Override of an AP group.
204Disable Altitude of ApGroup ¶
DELETE/v8_0/rkszones/{zoneId}/apgroups/{id}/altitude
Use this API command to clear the altitude of AP group.
204Disable Radio 2.4G TxPower Override ¶
DELETE/v8_0/rkszones/{zoneId}/apgroups/{id}/wifi24/txPower
Use this API command to disable 2.4GHz radio txPower override zone for APs that belong to an AP group.
204Disable Radio 5G TxPower Override ¶
DELETE/v8_0/rkszones/{zoneId}/apgroups/{id}/wifi50/txPower
Use this API command to disable 5GHz radio txPower override zone for APs that belong to an AP group.
204Disable Radio 2.4G ChannelWidth Override ¶
DELETE/v8_0/rkszones/{zoneId}/apgroups/{id}/wifi24/channelWidth
Use this API command to disable 2.4GHz radio channelWidth override zone for APs that belong to an AP group.
204Disable Radio 2.4G Channel Override ¶
DELETE/v8_0/rkszones/{zoneId}/apgroups/{id}/wifi24/channel
Use this API command to disable 2.4GHz radio channel override zone for APs that belong to an AP group.
204Disable Radio 2.4G ChannelRange Override ¶
DELETE/v8_0/rkszones/{zoneId}/apgroups/{id}/wifi24/channelRange
Use this API command to disable 2.4GHz radio channelRange override zone for APs that belong to an AP group.
204Disable Radio 5G ChannelWidth Override ¶
DELETE/v8_0/rkszones/{zoneId}/apgroups/{id}/wifi50/channelWidth
Use this API command to disable 5GHz radio channelWidth override zone for APs that belong to an AP group.
204Disable Radio 5G IndoorChannel Override ¶
DELETE/v8_0/rkszones/{zoneId}/apgroups/{id}/wifi50/indoorChannel
Use this API command to disable 5GHz radio indoorChannel override zone for APs that belong to an AP group.
204Disable Radio 5G OutdoorChannel Override ¶
DELETE/v8_0/rkszones/{zoneId}/apgroups/{id}/wifi50/outdoorChannel
Use this API command to disable 5GHz radio outdoorChannel override zone for APs that belong to an AP group.
204Disable Radio 5G IndoorChannelRange Override ¶
DELETE/v8_0/rkszones/{zoneId}/apgroups/{id}/wifi50/indoorChannelRange
Use this API command to disable 5GHz radio indoorChannelRange override zone for APs that belong to an AP group.
204Disable Radio 5G OutdoorChannelRange Override ¶
DELETE/v8_0/rkszones/{zoneId}/apgroups/{id}/wifi50/outdoorChannelRange
Use this API command to disable 5GHz radio outdoorChannelRange override zone for APs that belong to an AP group.
204Disable 2.4GHz radio protection mode override. ¶
DELETE/v8_0/rkszones/{zoneId}/apgroups/{id}/protectionMode24
Use this API command to disable 2.4GHz radio protection mode configuration override zone for APs that belong to an AP group.
204Disable Recovery SSID override. ¶
DELETE/v8_0/rkszones/{zoneId}/apgroups/{id}/recoverySsid
Use this API command to disable Recovery SSID configuration override zone for APs that belong to an AP group.
204Disable Directed Multicast from wired client to Network ¶
DELETE/v8_0/rkszones/{zoneId}/apgroups/{id}/directedMulticastFromWiredClientEnabled
Use this API command to disable Directed Multicast from wired client to Network configuration override zone for APs that belong to an AP group.
204Disable Directed Multicast from wireless client to Network ¶
DELETE/v8_0/rkszones/{zoneId}/apgroups/{id}/directedMulticastFromWirelessClientEnabled
Use this API command to disable Directed Multicast from wireless client to Network configuration override zone for APs that belong to an AP group.
204Disable Directed Multicast from Network to wired/wireless client ¶
DELETE/v8_0/rkszones/{zoneId}/apgroups/{id}/directedMulticastFromNetworkEnabled
Use this API command to disable Directed Multicast from Network to wired/wireless client configuration override zone for APs that belong to an AP group.
204Disable rogue AP report threshold override ¶
DELETE/v8_0/rkszones/{zoneId}/apgroups/{id}/rogueApReportThreshold
Use this API command to disable rogue AP report threshold override zone for APs that belong to an AP group.
204Disable rogue AP aggressiveness mode override ¶
DELETE/v8_0/rkszones/{zoneId}/apgroups/{id}/rogueApAggressivenessMode
Use this API command to disable rogue AP aggressiveness mode override zone for APs that belong to an AP group.
204Disable rogue AP jamming threshold override ¶
DELETE/v8_0/rkszones/{zoneId}/apgroups/{id}/rogueApJammingThreshold
Use this API command to disable rogue AP jamming threshold override zone for APs that belong to an AP group.
204Add Member List ¶
POST/v8_0/rkszones/{zoneId}/apgroups/{id}/members
Add multiple members to an AP group.
Body
{
"memberList": [
{
"apMac": "00:22:11:0C:BD:13"
},
{
"apMac": "10:11:22:0C:0D:15"
}
]
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"memberList": {
"description": "List of apMac",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"apMac": {
"description": "MAC address of member AP",
"type": "string",
"pattern": "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
}
}
}
}
}
}201Remove Member ¶
DELETE/v8_0/rkszones/{zoneId}/apgroups/{id}/members/{apMac}
Use this API command to remove a member AP from an AP group.
204Retrieve AP Model ¶
GET/v8_0/rkszones/{zoneId}/apgroups/{id}/apmodel/{model}
Use this API command to retrieve AP model specific configuration override zone that belong to an AP group, NULL means the override setting is not checked inside an AP group.
200Body
{
"ledStatusEnabled": true,
"lldp": {
"enabled": true,
"advertiseIntervalInSec": 30,
"holdTimeInSec": 120,
"managementIPTLVEnabled": false
},
"cellularSettings": {
"mobileAPName": "internet",
"mobileAPName2": "internet",
"simCardUsage": 0,
"select3g4g": 0,
"select3g4g2": 0,
"dataRoaming": 1,
"dataRoaming2": 1,
"wanConnection": 0,
"wanRecoveryTimer": 60
},
"ledMode": null,
"internalHeaterEnabled": null,
"poeOutPortEnabled": null,
"usbPowerEnable": true,
"poeModeSetting": "Auto",
"poeTxChain": 2,
"radioBand": null,
"externalAntenna24": null,
"externalAntenna50": null,
"lanPorts": [
{
"portName": "LAN1",
"enabled": false,
"ethPortProfile": null
},
{
"portName": "LAN2",
"enabled": true,
"ethPortProfile": {
"id": "0",
"name": "Default Trunk Port"
}
},
{
"portName": "LAN3",
"enabled": true,
"ethPortProfile": {
"id": "1",
"name": "Default Access Port"
}
}
]
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"ledStatusEnabled": {
"type": [
"boolean",
"null"
]
},
"lldp": {
"type": "object",
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean",
"default": true
},
"advertiseIntervalInSec": {
"type": [
"integer",
"null"
],
"minimum": 1,
"maximum": 300
},
"holdTimeInSec": {
"type": [
"integer",
"null"
],
"minimum": 60,
"maximum": 1200
},
"managementIPTLVEnabled": {
"type": [
"boolean",
"null"
]
}
},
"required": [
"enabled"
]
},
"cellularSettings": {
"type": "object",
"additionalProperties": false,
"properties": {
"mobileAPName": {
"type": [
"string",
"null"
],
"maxLength": 100,
"pattern": "^([!-?A-~]([!-?A-~]){0,62}[!-?A-~]|[!-?A-~]{1,1})$"
},
"mobileAPName2": {
"type": [
"string",
"null"
],
"maxLength": 100,
"pattern": "^([!-?A-~]([!-?A-~]){0,62}[!-?A-~]|[!-?A-~]{1,1})$"
},
"simCardUsage": {
"type": [
"integer",
"null"
],
"minimum": 0,
"maximum": 2
},
"select3g4g": {
"type": "integer",
"minimum": 0,
"maximum": 2
},
"select3g4g2": {
"type": "integer",
"minimum": 0,
"maximum": 2
},
"dataRoaming": {
"type": [
"integer",
"null"
],
"minimum": 0,
"maximum": 1
},
"dataRoaming2": {
"type": [
"integer",
"null"
],
"minimum": 0,
"maximum": 1
},
"wanConnection": {
"type": "integer",
"minimum": 0,
"maximum": 3
},
"wanRecoveryTimer": {
"type": "integer",
"minimum": 10,
"maximum": 300
}
},
"required": [
"select3g4g",
"select3g4g2",
"wanConnection",
"wanRecoveryTimer"
]
},
"ledMode": {
"type": [
"string",
"null"
],
"enum": [
null,
"CableModem",
"AccessPoint",
"CableModem_AccessPoint",
"CableModem_AccessPoint_DEFAULT",
"ActiveSurgeProtector",
"ActiveSurgeProtector_ModemOnline_DEFAULT",
"Off"
]
},
"internalHeaterEnabled": {
"type": [
"boolean",
"null"
]
},
"poeOutPortEnabled": {
"type": [
"boolean",
"null"
]
},
"usbPowerEnable": {
"type": [
"boolean",
"null"
]
},
"poeModeSetting": {
"type": [
"string",
"null"
],
"enum": [
null,
"Auto",
"_802_3af",
"_802_3at",
"_802_3atPlus"
]
},
"poeTxChain": {
"description": "Option to use 1, 2 or 4 Tx chains while AP power source is 802.3af PoE",
"default": 2,
"type": [
"integer",
"null"
]
},
"radioBand": {
"description": "Band switch between 2.4GHz and 5GHz is provided in single radio AP ZF-7321, ZF-7321-U, and ZF-7441.",
"type": [
"string",
"null"
],
"enum": [
null,
"2.4GHz",
"5GHz"
]
},
"externalAntenna24": {
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"dbi": {
"type": [
"integer",
"null"
],
"minimum": 0,
"maximum": 90
},
"chainMask": {
"type": [
"string",
"null"
],
"enum": [
null,
"Two",
"Three"
]
}
},
"required": [
"enabled"
]
},
"externalAntenna50": {
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"dbi": {
"type": [
"integer",
"null"
],
"minimum": 0,
"maximum": 90
},
"chainMask": {
"type": [
"string",
"null"
],
"enum": [
null,
"Two",
"Three"
]
}
},
"required": [
"enabled"
]
},
"lanPorts": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"portName": {
"type": "string",
"enum": [
"LAN1",
"LAN2",
"LAN3",
"LAN4",
"LAN5"
]
},
"enabled": {
"type": "boolean"
},
"ethPortProfile": {
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"required": [
"portName",
"enabled"
]
}
}
}
}Override AP Model ¶
PUT/v8_0/rkszones/{zoneId}/apgroups/{id}/apmodel/{model}
Use this API command to modify AP model specific configuration override zone that belong to an AP group.
Body
{
"ledStatusEnabled": true,
"lldp": {
"enabled": true,
"advertiseIntervalInSec": 30,
"holdTimeInSec": 120,
"managementIPTLVEnabled": false
},
"cellularSettings": {
"mobileAPName": "internet",
"mobileAPName2": "internet",
"simCardUsage": 0,
"select3g4g": 0,
"select3g4g2": 0,
"dataRoaming": 1,
"dataRoaming2": 1,
"wanConnection": 0,
"wanRecoveryTimer": 60
},
"ledMode": null,
"internalHeaterEnabled": null,
"poeOutPortEnabled": null,
"usbPowerEnable": true,
"poeModeSetting": "Auto",
"poeTxChain": 2,
"radioBand": null,
"externalAntenna24": null,
"externalAntenna50": null,
"lanPorts": [
{
"portName": "LAN1",
"enabled": false,
"ethPortProfile": null
},
{
"portName": "LAN2",
"enabled": true,
"ethPortProfile": {
"id": "0",
"name": "Default Trunk Port"
}
},
{
"portName": "LAN3",
"enabled": true,
"ethPortProfile": {
"id": "1",
"name": "Default Access Port"
}
}
]
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"ledStatusEnabled": {
"type": [
"boolean",
"null"
]
},
"lldp": {
"type": "object",
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"advertiseIntervalInSec": {
"type": [
"integer",
"null"
],
"minimum": 1,
"maximum": 300
},
"holdTimeInSec": {
"type": [
"integer",
"null"
],
"minimum": 60,
"maximum": 1200
},
"managementIPTLVEnabled": {
"type": [
"boolean",
"null"
]
}
},
"required": [
"enabled"
]
},
"cellularSettings": {
"type": "object",
"additionalProperties": false,
"properties": {
"mobileAPName": {
"type": [
"string",
"null"
],
"maxLength": 100,
"pattern": "^([!-?A-~]([!-?A-~]){0,62}[!-?A-~]|[!-?A-~]{1,1})$"
},
"mobileAPName2": {
"type": [
"string",
"null"
],
"maxLength": 100,
"pattern": "^([!-?A-~]([!-?A-~]){0,62}[!-?A-~]|[!-?A-~]{1,1})$"
},
"simCardUsage": {
"type": [
"integer",
"null"
],
"minimum": 0,
"maximum": 2
},
"select3g4g": {
"type": "integer",
"minimum": 0,
"maximum": 2
},
"select3g4g2": {
"type": "integer",
"minimum": 0,
"maximum": 2
},
"dataRoaming": {
"type": [
"integer",
"null"
],
"minimum": 0,
"maximum": 1
},
"dataRoaming2": {
"type": [
"integer",
"null"
],
"minimum": 0,
"maximum": 1
},
"wanConnection": {
"type": "integer",
"minimum": 0,
"maximum": 3
},
"wanRecoveryTimer": {
"type": "integer",
"minimum": 10,
"maximum": 300
}
},
"required": [
"select3g4g",
"select3g4g2",
"wanConnection",
"wanRecoveryTimer"
]
},
"ledMode": {
"type": [
"string",
"null"
],
"enum": [
null,
"CableModem",
"AccessPoint",
"CableModem_AccessPoint",
"CableModem_AccessPoint_DEFAULT",
"ActiveSurgeProtector",
"ActiveSurgeProtector_ModemOnline_DEFAULT",
"Off"
]
},
"internalHeaterEnabled": {
"type": [
"boolean",
"null"
]
},
"poeOutPortEnabled": {
"type": [
"boolean",
"null"
]
},
"usbPowerEnable": {
"type": [
"boolean",
"null"
]
},
"poeModeSetting": {
"type": [
"string",
"null"
],
"enum": [
null,
"Auto",
"_802_3af",
"_802_3at",
"_802_3atPlus"
]
},
"poeTxChain": {
"description": "Option to use 1, 2 or 4 Tx chains while AP power source is 802.3af PoE",
"type": [
"integer",
"null"
]
},
"radioBand": {
"description": "Band switch between 2.4GHz and 5GHz is provided in single radio AP ZF-7321, ZF-7321-U, and ZF-7441.",
"type": [
"string",
"null"
],
"enum": [
null,
"2.4GHz",
"5GHz"
]
},
"externalAntenna24": {
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"dbi": {
"type": [
"integer",
"null"
],
"minimum": 0,
"maximum": 90
},
"chainMask": {
"type": [
"string",
"null"
],
"enum": [
null,
"Two",
"Three"
]
}
},
"required": [
"enabled"
]
},
"externalAntenna50": {
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"dbi": {
"type": [
"integer",
"null"
],
"minimum": 0,
"maximum": 90
},
"chainMask": {
"type": [
"string",
"null"
],
"enum": [
null,
"Two",
"Three"
]
}
},
"required": [
"enabled"
]
},
"lanPorts": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"portName": {
"type": "string",
"enum": [
"LAN1",
"LAN2",
"LAN3",
"LAN4",
"LAN5"
]
},
"enabled": {
"type": "boolean"
},
"ethPortProfile": {
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"required": [
"portName",
"enabled"
]
}
}
}
}204Access Point Configuration ¶
Upload AP Picture ¶
Retrieve ¶
GET/v8_0/aps/{apMac}
Use this API command to retrieve the configuration of an AP.
200Body
{
"zoneId": "zoneUUID",
"apGroupId": "apGroupUUID",
"serial": "00000096",
"model": "ZF7343",
"name": "apName",
"gpsSource": "MANUAL",
"latitude": 22.3,
"longitude": 114,
"location": "location",
"locationAdditionalInfo": "locationAdditionalInfo",
"description": "apDescription",
"administrativeState": "Unlocked",
"provisionChecklist": "provisionChecklist",
"login": {
"apLoginName": "apLoginName",
"apLoginPassword": "apLoginPassword"
},
"wifi24": {
"txPower": "Full",
"channelWidth": 20,
"channel": 1,
"channelRange": [
1,
2,
3
],
"availableChannelRange": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11
]
},
"wifi50": {
"txPower": "Full",
"channelWidth": 20,
"channel": 52,
"channelRange": [
52,
56,
60
],
"availableChannelRange": [
36,
40,
44,
48,
52,
56,
60,
64,
100,
104,
108,
112,
116,
132,
136,
149,
153,
157,
161
]
},
"protectionMode24": "CTS_ONLY",
"wlanGroup24": {
"id": "wlanGroupUUID",
"name": "wlanGroupName"
},
"wlanGroup50": {
"id": "wlanGroupUUID",
"name": "wlanGroupName"
},
"network": {
"ipType": "Static",
"ip": "1.1.1.1",
"netmask": "255.255.255.0",
"gateway": "1.1.1.0",
"primaryDns": "8.8.8.8",
"secondaryDns": "8.8.8.9"
},
"networkIpv6": {
"ipType": "Static",
"ip": "2001::55/32",
"gateway": "2001::66",
"primaryDns": "2001::77",
"secondaryDns": "2001::88"
},
"smartMonitor": {
"enabled": true,
"intervalInSec": 10,
"retryThreshold": 10
},
"bonjourGateway": {
"id": "bonjourGatewayUUID",
"name": "bonjourGatewayName"
},
"clientAdmissionControl24": {
"maxRadioLoadPercent": 70,
"minClientCount": 30,
"minClientThroughputMbps": 10,
"enabled": true
},
"clientAdmissionControl50": {
"maxRadioLoadPercent": 70,
"minClientCount": 30,
"minClientThroughputMbps": 10,
"enabled": true
},
"specific": {
"ledStatusEnabled": false,
"lldp": {
"enabled": true,
"advertiseIntervalInSec": 100,
"holdTimeInSec": 1000,
"managementIPTLVEnabled": false
},
"ledMode": null,
"internalHeaterEnabled": null,
"poeOutPortEnabled": null,
"usbPowerEnable": true,
"poeModeSetting": "Auto",
"poeTxChain": 2,
"radioBand": null,
"externalAntenna24": null,
"externalAntenna50": null,
"lanPorts": [
{
"portName": "LAN1",
"enabled": true,
"type": "Trunk",
"vlanUntagId": 13,
"members": "1-4094",
"_8021X": {
"type": "Disable",
"authenticator": null,
"supplicant": null
}
},
{
"portName": "LAN2",
"enabled": true,
"type": "Access",
"vlanUntagId": 15,
"members": "15",
"_8021X": {
"type": "MACBasedAuthenticator",
"authenticator": {
"authentication": {
"id": "5f66275c-b1fd-4e25-a4db-b64115740fb9",
"name": "zoneRadius"
},
"accounting": {
"id": "b86db5e8-884b-4c90-9315-dcd72acaf743",
"name": "zoneRadiusAcct"
},
"macAuthByPassEnabled": true
},
"supplicant": null
}
},
{
"portName": "LAN3",
"enabled": true,
"type": "Trunk",
"vlanUntagId": 1,
"members": "1-4094",
"_8021X": {
"type": "Supplicant",
"authenticator": null,
"supplicant": {
"type": "Custom",
"userName": "a",
"password": "a"
}
}
}
]
},
"autoChannelSelection24": {
"channelSelectMode": "ChannelFly",
"channelFlyMtbc": 480
},
"autoChannelSelection50": {
"channelSelectMode": "BackgroundScanning",
"channelFlyMtbc": 480
},
"channelEvaluationInterval": 777,
"apMgmtVlan": {
"id": 1,
"mode": "KEEP"
},
"altitude": {
"altitudeUnit": "meters",
"altitudeValue": 1
},
"meshOptions": {
"meshMode": "MESH_AP",
"uplinkSelection": "MANUAL",
"meshUplinkEntryList": [
"6C:AA:B3:26:6C:30"
]
},
"recoverySsid": {
"recoverySsidEnabled": true
},
"rogueApReportThreshold": 50,
"rogueApAggressivenessMode": 2,
"rogueApJammingThreshold": 50,
"directedMulticastFromWiredClientEnabled": true,
"directedMulticastFromWirelessClientEnabled": true,
"directedMulticastFromNetworkEnabled": false
}Schema
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"mac" : {
"description" : "MAC address of the AP",
"type" : "string",
"pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
},
"zoneId" : {
"description" : "Identifier of the AP group to which the AP belongs",
"type" : "string"
},
"apGroupId" : {
"type" : "string"
},
"serial" : {
"description" : "Serial number of the AP",
"type" : "string"
},
"model" : {
"description" : "Model name of the AP",
"type" : "string"
},
"name" : {
"description" : "Name of the AP",
"type" : "string",
"minLength" : 2,
"maxLength" : 64,
"pattern" : "^[!-~]((?!\$\()[ -_a-~]){0,62}[!-~]$"
},
"description" : {
"description" : "Description of the AP",
"type" : [ "string", "null" ],
"maxLength" : 64
},
"gpsSource" : {
"description" : "GPS Source of the AP",
"type" : "string",
"enum" : [ "GPS", "MANUAL" ]
},
"latitude" : {
"description" : "Latitude coordinate (in decimal format) of the AP",
"type" : "number"
},
"longitude" : {
"description" : "Longitude coordinate (in decimal format) of the AP",
"type" : "number"
},
"location" : {
"description" : "Location of the AP. It is a text description to indicate the location of the AP.",
"type" : "string"
},
"locationAdditionalInfo" : {
"description" : "Location additional info of the AP. This is a text description that indicates the location additional info of the AP.",
"type" : "string",
"pattern" : "^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
},
"altitude" : {
"description" : "GPS Altitude",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"altitudeUnit" : {
"description" : "altitude unit",
"type" : "string",
"enum" : [ "meters", "floor" ],
"default" : "meters"
},
"altitudeValue" : {
"description" : "altitude value",
"type" : "integer"
}
}
},
"provisionChecklist" : {
"description" : "Provision checklist of the AP. This field indicates the steps that have been completed in the AP provisioning process.",
"type" : "string"
},
"administrativeState" : {
"description" : "Administrative state of the AP. A locked AP will not provide any WLAN services.",
"type" : "string",
"enum" : [ "Locked", "Unlocked" ],
"default" : "Unlocked"
},
"userLocationInfo" : {
"description" : "User location information",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"areaCode" : {
"description" : "Area code",
"type" : "integer"
},
"cellId" : {
"description" : "Cell identifier",
"type" : "integer"
}
}
},
"wlanService24Enabled" : {
"description" : "WLAN service enabled or disabled on 2.4GHz radio",
"type" : "boolean"
},
"wlanService50Enabled" : {
"description" : "WLAN service enabled or disabled on 5GHz radio",
"type" : "boolean"
},
"login" : {
"description" : "Logon credentials for the AP. These logon credentials will override the logon credentials specified at the zone level or AP group level.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"apLoginName" : {
"description" : "User name of the AP administrator",
"type" : "string",
"maxLength" : 64,
"pattern" : "^((?!\$\()[!-_a-~]){1,64}$"
},
"apLoginPassword" : {
"description" : "Password of the AP administrator",
"type" : "string",
"maxLength" : 64,
"pattern" : ".*(?=.{8,})(?=.*[a-zA-Z])(?=.*[0-9])(?=.*[_`~!@#$%^&*\(\)\[\]\{\}|;:'\",.\<>\/?=+-]).*"
}
},
"required" : [ "apLoginName", "apLoginPassword" ]
},
"syslog" : {
"description" : "Syslog configuration of the AP. This configuration will override the syslog configuration at the zone level or AP group level.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"enabled" : {
"description" : "Indicates whether syslog is enabled or disabled",
"type" : "boolean"
},
"address" : {
"description" : "Address of the syslog server. If syslog is enabled, this attribute is required.",
"type" : "string"
},
"port" : {
"description" : "Port number of the syslog server",
"type" : "integer",
"default" : "514",
"minimum" : 1,
"maximum" : 65535
},
"facility" : {
"description" : "Facility of the syslog server",
"type" : "string",
"enum" : [ "Keep_Original", "Local0", "Local1", "Local2", "Local3", "Local4", "Local5", "Local6", "Local7" ],
"default" : "Keep_Original"
},
"priority" : {
"description" : "Priority of the log messages",
"type" : "string",
"enum" : [ "Emergency", "Alert", "Critical", "Error", "Warning", "Notice", "Info", "All" ],
"default" : "Error"
},
"flowLevel" : {
"description" : "Flow Level of the syslog",
"type" : "string",
"enum" : [ "GENERAL_LOGS", "CLIENT_FLOW", "ALL" ],
"default" : "GENERAL_LOGS"
},
"protocol" : {
"description" : "Protocol of the syslog server",
"type" : "string",
"enum" : [ "IPPROTO_TCP", "IPPROTO_UDP" ],
"default" : "IPPROTO_TCP"
},
"secondaryAddress" : {
"description" : "Secondary Server Address of the syslog server",
"type" : "string"
},
"secondaryPort" : {
"description" : "Secondary Server Port of the syslog server",
"type" : "integer",
"default" : "514",
"minimum" : 1,
"maximum" : 65535
},
"secondaryProtocol" : {
"description" : "Secondary Server Protocol of the syslog server",
"type" : "string",
"enum" : [ "IPPROTO_TCP", "IPPROTO_UDP" ],
"default" : "IPPROTO_TCP"
}
},
"required" : [ "enabled" ]
},
"wifi24" : {
"description" : "2.4GHz radio configuration of the AP. This configuration will override the radio 2.4GHz configuration at the zone level or AP group level.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"autoCellSizing" : {
"description" : "Auto Cell Sizing",
"type" : "boolean"
},
"txPower" : {
"description" : "Transmission power",
"type" : "string",
"enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
"default" : "Full"
},
"channelWidth" : {
"description" : "Channel width. Zero (0) means Auto.",
"type" : "integer",
"enum" : [ 0, 20, 40 ]
},
"channel" : {
"description" : "Channel number",
"type" : "integer"
},
"channelRange" : {
"description" : "Channel range options",
"type" : "array",
"items" : {
"type" : "integer"
}
},
"availableChannelRange" : {
"description" : "Available channel range options",
"type" : "array",
"items" : {
"type" : "integer"
}
}
}
},
"wifi50" : {
"description" : "5GHz radio configuration. This configuration will override the 5GHz radio configuration at the zone level or AP group level.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"autoCellSizing" : {
"description" : "Auto Cell Sizing",
"type" : "boolean"
},
"txPower" : {
"description" : "transmission power",
"type" : "string",
"enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
"default" : "Full"
},
"channelWidth" : {
"description" : "channel width, 0 mean Auto, 8080 means 80+80MHz",
"type" : "integer",
"enum" : [ 0, 20, 40, 80, 8080, 160 ]
},
"channel" : {
"description" : "channel number",
"type" : "integer"
},
"secondaryChannel" : {
"description" : "channel number (channelWidth is 80+80MHz only)",
"type" : "integer"
},
"channelRange" : {
"description" : "channel range options",
"type" : "array",
"items" : {
"type" : "integer"
}
},
"availableChannelRange" : {
"description" : "available channel range options",
"type" : "array",
"items" : {
"type" : "integer"
}
}
}
},
"protectionMode24" : {
"description" : "AP 2.4GHz Protection mode configuration of the AP.",
"type" : "string",
"enum" : [ "NONE", "CTS_ONLY", "RTS_CTS" ],
"default" : "RTS_CTS"
},
"wlanGroup24" : {
"description" : "WLAN group of 2.4GHz radio. This configuration will override the WLAN group of the 2.4GHz radio at the zone level or AP group level.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Identifier of the WLAN group",
"type" : "string"
},
"name" : {
"description" : "Name of the WLAN group",
"type" : "string"
}
}
},
"wlanGroup50" : {
"description" : "WLAN group of 5GHz radio. This configuration will override the WLAN group of the 5GHz radio at the zone level or AP group level.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Identifier of the WLAN group",
"type" : "string"
},
"name" : {
"description" : "Name of the WLAN group",
"type" : "string"
}
}
},
"network" : {
"description" : "Network settings ipv4 of the AP.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"ipType" : {
"description" : "Indicates how the AP's IP address was obtained. An AP's IP address can be statically or dynamically assigned or kept unchanged.",
"type" : "string",
"enum" : [ "Static", "Dynamic", "Autoconfig", "Keep" ]
},
"ip" : {
"description" : "IP address of the AP",
"type" : "string"
},
"netmask" : {
"description" : "Netmask of the AP's subnet",
"type" : "string",
"pattern" : "^$|(^(128|192|224|24[08]|25[245]).0.0.0$)|(^255.(0|128|192|224|24[08]|25[245]).0.0$)|(^255.255.(0|128|192|224|24[08]|25[245]).0$)|(^255.255.255.(0|128|192|224|24[08]|252|255)$)"
},
"gateway" : {
"description" : "Gateway of the AP",
"type" : "string"
},
"primaryDns" : {
"description" : "Primary DNS server address of the AP",
"type" : "string"
},
"secondaryDns" : {
"description" : "Secondary DNS server address of the AP",
"type" : "string"
}
}
},
"networkIpv6" : {
"description" : "Network settings ipv6 of the AP.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"ipType" : {
"description" : "Indicates how the AP's IP address was obtained. An AP's IP address can be statically or dynamically assigned or kept unchanged.",
"type" : "string",
"enum" : [ "Static", "Dynamic", "Autoconfig", "Keep" ]
},
"ip" : {
"description" : "IP address of the AP",
"type" : "string"
},
"gateway" : {
"description" : "Gateway of the AP",
"type" : "string"
},
"primaryDns" : {
"description" : "Primary DNS server address of the AP",
"type" : "string"
},
"secondaryDns" : {
"description" : "Secondary DNS server address of the AP",
"type" : "string"
}
}
},
"smartMonitor" : {
"description" : "Smart monitor of the AP.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"enabled" : {
"type" : "boolean"
},
"intervalInSec" : {
"description" : "Interval in seconds. This is required if smartMonitor is enabled",
"type" : "integer",
"default" : 10,
"minimum" : 5,
"maximum" : 60
},
"retryThreshold" : {
"description" : "Retry threshold. This is required if smartMonitor is enabled",
"type" : "integer",
"default" : 3,
"minimum" : 1,
"maximum" : 10
}
}
},
"bonjourGateway" : {
"description" : "Bonjour gateway of the AP.",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"clientAdmissionControl24" : {
"description" : "Client admission control configuration of 2.4GHz radio of the AP.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"enabled" : {
"type" : "boolean"
},
"maxRadioLoadPercent" : {
"description" : "Maximum radio load percentage.",
"type" : "integer",
"default" : 75,
"minimum" : 50,
"maximum" : 100
},
"minClientCount" : {
"description" : "Minimum client count number.",
"type" : "integer",
"default" : 10,
"minimum" : 0,
"maximum" : 100
},
"minClientThroughputMbps" : {
"description" : "Minimum client throughput in Mbps.",
"type" : "number",
"default" : 0,
"minimum" : 0,
"maximum" : 100
}
}
},
"clientAdmissionControl50" : {
"description" : "Client admission control configuration of 5GHz radio of the AP.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"enabled" : {
"type" : "boolean"
},
"maxRadioLoadPercent" : {
"description" : "Maximum radio load percentage.",
"type" : "integer",
"default" : 75,
"minimum" : 50,
"maximum" : 100
},
"minClientCount" : {
"description" : "Minimum client count number.",
"type" : "integer",
"default" : 10,
"minimum" : 0,
"maximum" : 100
},
"minClientThroughputMbps" : {
"description" : "Minimum client throughput in Mbps.",
"type" : "number",
"default" : 0,
"minimum" : 0,
"maximum" : 100
}
}
},
"venueProfile" : {
"description" : "Venue profile configuration of the AP.",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"autoChannelSelection24" : {
"description" : "client load balancing on Radio 2.4G, auto channel selection mode",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"channelSelectMode" : {
"description" : "Channel Select Mode",
"type" : "string",
"enum" : [ "None", "BackgroundScanning", "ChannelFly" ],
"default" : "BackgroundScanning"
},
"channelFlyMtbc" : {
"description" : "ChannelFly MTBC",
"type" : "integer",
"default" : 480,
"minimum" : 100,
"maximum" : 1440
}
}
},
"autoChannelSelection50" : {
"description" : "client load balancing on Radio 5G, auto channel selection mode",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"channelSelectMode" : {
"description" : "Channel Select Mode",
"type" : "string",
"enum" : [ "None", "BackgroundScanning", "ChannelFly" ],
"default" : "BackgroundScanning"
},
"channelFlyMtbc" : {
"description" : "ChannelFly MTBC",
"type" : "integer",
"default" : 480,
"minimum" : 100,
"maximum" : 1440
}
}
},
"channelEvaluationInterval" : {
"description" : "channel evaluation Interval of the AP",
"type" : "integer",
"default" : 600,
"minimum" : 60,
"maximum" : 3600
},
"apMgmtVlan" : {
"description" : "ap Management Vlan",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"mode" : {
"description" : "Vlan Mode of the zone",
"type" : "string",
"enum" : [ "KEEP", "USER_DEFINED" ],
"default" : "KEEP"
},
"id" : {
"description" : "Vlan id of the zone",
"type" : "integer",
"default" : "1"
}
}
},
"specific" : {
"description" : "Model specific configuration of the AP",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"ledStatusEnabled" : {
"type" : [ "boolean", "null" ]
},
"lldp" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"enabled" : {
"type" : "boolean",
"default" : true
},
"advertiseIntervalInSec" : {
"type" : [ "integer", "null" ],
"minimum" : 1,
"maximum" : 300
},
"holdTimeInSec" : {
"type" : [ "integer", "null" ],
"minimum" : 60,
"maximum" : 1200
},
"managementIPTLVEnabled" : {
"type" : [ "boolean", "null" ]
}
},
"required" : [ "enabled" ]
},
"cellularSettings" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"mobileAPName" : {
"type" : [ "string", "null" ],
"maxLength" : 100,
"pattern" : "^([!-?A-~]([!-?A-~]){0,62}[!-?A-~]|[!-?A-~]{1,1})$"
},
"mobileAPName2" : {
"type" : [ "string", "null" ],
"maxLength" : 100,
"pattern" : "^([!-?A-~]([!-?A-~]){0,62}[!-?A-~]|[!-?A-~]{1,1})$"
},
"simCardUsage" : {
"type" : [ "integer", "null" ],
"minimum" : 0,
"maximum" : 2
},
"select3g4g" : {
"type" : "integer",
"minimum" : 0,
"maximum" : 2
},
"select3g4g2" : {
"type" : "integer",
"minimum" : 0,
"maximum" : 2
},
"dataRoaming" : {
"type" : [ "integer", "null" ],
"minimum" : 0,
"maximum" : 1
},
"dataRoaming2" : {
"type" : [ "integer", "null" ],
"minimum" : 0,
"maximum" : 1
},
"wanConnection" : {
"type" : "integer",
"minimum" : 0,
"maximum" : 3
},
"wanRecoveryTimer" : {
"type" : "integer",
"minimum" : 10,
"maximum" : 300
}
},
"required" : [ "select3g4g", "select3g4g2", "wanConnection", "wanRecoveryTimer" ]
},
"ledMode" : {
"type" : [ "string", "null" ],
"enum" : [ null, "CableModem", "AccessPoint", "CableModem_AccessPoint", "CableModem_AccessPoint_DEFAULT", "ActiveSurgeProtector", "ActiveSurgeProtector_ModemOnline_DEFAULT", "Off" ]
},
"internalHeaterEnabled" : {
"type" : [ "boolean", "null" ]
},
"poeOutPortEnabled" : {
"type" : [ "boolean", "null" ]
},
"usbPowerEnable" : {
"type" : [ "boolean", "null" ]
},
"poeModeSetting" : {
"type" : [ "string", "null" ],
"enum" : [ "Auto", "_802_3af", "_802_3at", "_802_3atPlus", null ]
},
"poeTxChain" : {
"description" : "Option to use 1, 2 or 4 Tx chains while AP power source is 802.3af PoE",
"default" : 2,
"type" : [ "integer", "null" ]
},
"radioBand" : {
"description" : "Band switch between 2.4GHz and 5GHz is provided in single radio AP ZF-7321, ZF-7321-U, and ZF-7441.",
"type" : [ "string", "null" ],
"enum" : [ null, "2.4GHz", "5GHz" ]
},
"externalAntenna24" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"enabled" : {
"type" : "boolean"
},
"dbi" : {
"type" : [ "integer", "null" ],
"minimum" : 0,
"maximum" : 90
},
"chainMask" : {
"type" : [ "string", "null" ],
"enum" : [ null, "Two", "Three" ]
}
},
"required" : [ "enabled" ]
},
"externalAntenna50" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"enabled" : {
"type" : "boolean"
},
"dbi" : {
"type" : [ "integer", "null" ],
"minimum" : 0,
"maximum" : 90
},
"chainMask" : {
"type" : [ "string", "null" ],
"enum" : [ null, "Two", "Three" ]
}
},
"required" : [ "enabled" ]
},
"lanPorts" : {
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"portName" : {
"type" : "string",
"enum" : [ "LAN1", "LAN2", "LAN3", "LAN4", "LAN5" ]
},
"enabled" : {
"type" : "boolean"
},
"overwriteVlanEnabled" : {
"type" : "boolean"
},
"vlanUntagId" : {
"type" : [ "integer", "null" ],
"minimum" : 0,
"maximum" : 4094
},
"members" : {
"type" : [ "string", "null" ]
},
"ethPortProfile" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
}
},
"required" : [ "portName", "enabled" ]
}
}
}
},
"meshOptions" : {
"description" : "mesh options",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"meshMode" : {
"description" : "mesh mode",
"type" : "string",
"enum" : [ "AUTO", "ROOT_AP", "MESH_AP", "DISABLE" ]
},
"uplinkSelection" : {
"description" : "Uplink selection",
"type" : "string",
"enum" : [ "SMART", "MANUAL" ]
},
"meshUplinkEntryList" : {
"description" : "MAC address of the neighbor AP",
"type" : "array",
"items" : {
"type" : "string",
"pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
}
}
}
},
"recoverySsid" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"recoverySsidEnabled" : {
"description" : "recovery ssid enable/disable",
"type" : "boolean"
}
}
},
"rogueApReportThreshold" : {
"description" : "Rogue AP report will leave out all entries that have signal strength lower than this threshold.",
"type" : "integer"
},
"rogueApAggressivenessMode" : {
"description" : "Adjust the frequency interval to de-authenticate rogue APs.",
"type" : "integer"
},
"rogueApJammingThreshold" : {
"type" : "integer"
},
"directedMulticastFromWiredClientEnabled" : {
"type" : "boolean"
},
"directedMulticastFromWirelessClientEnabled" : {
"type" : "boolean"
},
"directedMulticastFromNetworkEnabled" : {
"type" : "boolean"
}
}
}Modify Recovery SSID Override ¶
PATCH/v8_0/aps/{apMac}/recoverySsid
Use this API command to modify the Recovery SSID of an AP.
Body
{
"recoverySsidEnabled": true
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"recoverySsidEnabled": {
"description": "recovery ssid enable/disable",
"type": "boolean"
}
}
}204Disable Login Override ¶
DELETE/v8_0/aps/{apMac}/login
Use this API command to disable the AP-level logon override. The AP will apply its group’s or zone’s configuration.
204Disable Syslog Override ¶
DELETE/v8_0/aps/{apMac}/syslog
Use this API command to disable the AP level syslog override. The access point will take its group’s or zone’s configuration.
204Disable Radio 2.4G Override ¶
DELETE/v8_0/aps/{apMac}/wifi24
Use this API command to disable the AP level override of the 2.4GHz radio configuration. The access point will take its group’s configuration or zone’s configuration.
204Disable Radio 5G Override ¶
DELETE/v8_0/aps/{apMac}/wifi50
Use this API command to disable the AP level override of 5GHz radio configuration. The access point will take its group’s or zone’s configuration.
204Disable WLAN Group 2.4G Override ¶
DELETE/v8_0/aps/{apMac}/wlanGroup24
Use this API command to disable the AP level override of WLAN group configuration on 2.4GHz radio. The access point will take its group’s or zone’s configuration.
204Disable WLAN group 5G Override ¶
DELETE/v8_0/aps/{apMac}/wlanGroup50
Use this API command to disable the AP level override of WLAN group on the 5GHz radio. The access point will take its group’s or zone’s configuration.
204Disable AP Channel Evaluation Interval ¶
DELETE/v8_0/aps/{apMac}/channelEvaluationInterval
Disable AP lChannel Evaluation Interval. The access point will take its group’s configuration or zone’s configuration.
204Disable Radio 2.4G Auto channel selection ¶
DELETE/v8_0/aps/{apMac}/autoChannelSelection24
Use this API command to disable the AP level override of auto channel selection on the 2.4GHz radio. The access point will take its group’s or zone’s configuration.
204Disable Radio 5G Auto channel selection ¶
DELETE/v8_0/aps/{apMac}/autoChannelSelection50
Use this API command to disable the AP level override of auto channel selection on the 5GHz radio. The access point will take its group’s or zone’s configuration.
204Disable AP Management Vlan Override ¶
Disable Altitude Override ¶
DELETE/v8_0/aps/{apMac}/altitude
Use this API command to disable AP level override of altitude. The access point will take its group’s configuration or zone’s configuration.
204Retrieve AP Picture ¶
Delete AP Picture ¶
Modify User Location Info ¶
PATCH/v8_0/aps/{apMac}/userLocationInfo
Use this API command to modify user location info of an AP.
Body
{
"areaCode": 886
}Schema
{
"description": "User location information of the AP.",
"type": "object",
"additionalProperties": false,
"properties": {
"areaCode": {
"description": "area code",
"type": "integer",
"minimum": 1,
"maximum": 65535
}
}
}204Disable Location Override ¶
DELETE/v8_0/aps/{apMac}/location
Use this API command to disable AP level override of location. The access point will take its group’s configuration or zone’s configuration.
204Disable Location AdditionalInfo Override ¶
DELETE/v8_0/aps/{apMac}/locationAdditionalInfo
Use this API command to disable AP level override of location additionalInfo. The access point will take its group’s configuration or zone’s configuration.
204Disable Smart Monitor Override ¶
DELETE/v8_0/aps/{apMac}/smartMonitor
Use this API command to disable AP level override of smart monitor. The access point will take its group’s configuration or zone’s configuration.
204Disable Bonjour Gateway Override ¶
DELETE/v8_0/aps/{apMac}/bonjourGateway
Use this API command to disable AP level override of bonjour gateway. The access point will take its group’s configuration or zone’s configuration.
204Disable Client Admission Control 2.4G Override ¶
DELETE/v8_0/aps/{apMac}/clientAdmissionControl24
Use this API command to disable AP level override of client admission control 2.4GHz radio configuration. The access point will take its group’s configuration or zone’s configuration.
204Disable Client Admission Control 5G Override ¶
DELETE/v8_0/aps/{apMac}/clientAdmissionControl50
Use this API command to disable AP level override of client admission control 5GHz radio configuration. The access point will take its group’s configuration or zone’s configuration.
204Disable Venue Profile Override ¶
DELETE/v8_0/aps/{apMac}/venueProfile
Use this API command to disable AP level override of venue profile. The access point will take its group’s configuration or zone’s configuration.
204Disable Radio 2.4G TxPower Override ¶
DELETE/v8_0/aps/{apMac}/wifi24/txPower
Use this API command to disable the AP level override of the 2.4GHz radio txPower. The access point will take its group’s configuration or zone’s configuration.
204Disable Radio 5G TxPower Override ¶
DELETE/v8_0/aps/{apMac}/wifi50/txPower
Use this API command to disable the AP level override of 5GHz radio txPower. The access point will take its group’s or zone’s configuration.
204Disable Radio 2.4G ChannelWidth Override ¶
DELETE/v8_0/aps/{apMac}/wifi24/channelWidth
Use this API command to disable the AP level override of the 2.4GHz radio channelWidth. The access point will take its group’s configuration or zone’s configuration.
204Disable Radio 2.4G Channel Override ¶
DELETE/v8_0/aps/{apMac}/wifi24/channel
Use this API command to disable the AP level override of the 2.4GHz radio channel. The access point will take its group’s configuration or zone’s configuration.
204Disable Radio 2.4G ChannelRange Override ¶
DELETE/v8_0/aps/{apMac}/wifi24/channelRange
Use this API command to disable the AP level override of the 2.4GHz radio channelRange. The access point will take its group’s configuration or zone’s configuration.
204Disable Radio 5G ChannelWidth Override ¶
DELETE/v8_0/aps/{apMac}/wifi50/channelWidth
Use this API command to disable the AP level override of 5GHz radio channelWidth. The access point will take its group’s or zone’s configuration.
204Disable Radio 5G Channel Override ¶
DELETE/v8_0/aps/{apMac}/wifi50/channel
Use this API command to disable the AP level override of 5GHz radio channel. The access point will take its group’s or zone’s configuration.
204Disable Radio 5G ChannelRange Override ¶
DELETE/v8_0/aps/{apMac}/wifi50/channelRange
Use this API command to disable the AP level override of 5GHz radio channelRange. The access point will take its group’s or zone’s configuration.
204Disable AP Management GPS Cooordinates ¶
Disable Mesh Options ¶
Modify Specific ¶
PUT/v8_0/aps/{apMac}/specific
Use this API command to modify specific configuration.
Body
{
"ledStatusEnabled": false,
"lldp": {
"enabled": true,
"advertiseIntervalInSec": 100,
"holdTimeInSec": 1000,
"managementIPTLVEnabled": false
},
"cellularSettings": {
"mobileAPName": "internet",
"mobileAPName2": "internet",
"simCardUsage": 0,
"select3g4g": 0,
"select3g4g2": 0,
"dataRoaming": 1,
"dataRoaming2": 1,
"wanConnection": 0,
"wanRecoveryTimer": 60
},
"ledMode": null,
"internalHeaterEnabled": null,
"poeOutPortEnabled": null,
"usbPowerEnable": true,
"poeModeSetting": "Auto",
"poeTxChain": 2,
"radioBand": null,
"externalAntenna24": null,
"externalAntenna50": null,
"lanPorts": [
{
"portName": "LAN3",
"enabled": true,
"ethPortProfile": {
"id": "1"
},
"overwriteVlanEnabled": true,
"vlanUntagId": 1,
"members": "1"
}
]
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"ledStatusEnabled": {
"type": [
"boolean",
"null"
]
},
"lldp": {
"type": "object",
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"advertiseIntervalInSec": {
"type": [
"integer",
"null"
],
"minimum": 1,
"maximum": 300
},
"holdTimeInSec": {
"type": [
"integer",
"null"
],
"minimum": 60,
"maximum": 1200
},
"managementIPTLVEnabled": {
"type": [
"boolean",
"null"
]
}
},
"required": [
"enabled"
]
},
"cellularSettings": {
"type": "object",
"additionalProperties": false,
"properties": {
"mobileAPName": {
"type": [
"string",
"null"
],
"maxLength": 100,
"pattern": "^([!-?A-~]([!-?A-~]){0,62}[!-?A-~]|[!-?A-~]{1,1})$"
},
"mobileAPName2": {
"type": [
"string",
"null"
],
"maxLength": 100,
"pattern": "^([!-?A-~]([!-?A-~]){0,62}[!-?A-~]|[!-?A-~]{1,1})$"
},
"simCardUsage": {
"type": [
"integer",
"null"
],
"minimum": 0,
"maximum": 2
},
"select3g4g": {
"type": "integer",
"minimum": 0,
"maximum": 2
},
"select3g4g2": {
"type": "integer",
"minimum": 0,
"maximum": 2
},
"dataRoaming": {
"type": [
"integer",
"null"
],
"minimum": 0,
"maximum": 1
},
"dataRoaming2": {
"type": [
"integer",
"null"
],
"minimum": 0,
"maximum": 1
},
"wanConnection": {
"type": "integer",
"minimum": 0,
"maximum": 3
},
"wanRecoveryTimer": {
"type": "integer",
"minimum": 10,
"maximum": 300
}
},
"required": [
"select3g4g",
"select3g4g2",
"wanConnection",
"wanRecoveryTimer"
]
},
"ledMode": {
"type": [
"string",
"null"
],
"enum": [
null,
"CableModem",
"AccessPoint",
"CableModem_AccessPoint",
"CableModem_AccessPoint_DEFAULT",
"ActiveSurgeProtector",
"ActiveSurgeProtector_ModemOnline_DEFAULT",
"Off"
]
},
"internalHeaterEnabled": {
"type": [
"boolean",
"null"
]
},
"poeOutPortEnabled": {
"type": [
"boolean",
"null"
]
},
"usbPowerEnable": {
"type": [
"boolean",
"null"
]
},
"poeModeSetting": {
"type": [
"string",
"null"
],
"enum": [
"Auto",
"_802_3af",
"_802_3at",
"_802_3atPlus",
null
]
},
"poeTxChain": {
"description": "Option to use 1, 2 or 4 Tx chains while AP power source is 802.3af PoE",
"type": [
"integer",
"null"
]
},
"radioBand": {
"description": "Band switch between 2.4GHz and 5GHz is provided in single radio AP ZF-7321, ZF-7321-U, and ZF-7441.",
"type": [
"string",
"null"
],
"enum": [
null,
"2.4GHz",
"5GHz"
]
},
"externalAntenna24": {
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"dbi": {
"type": [
"integer",
"null"
],
"minimum": 0,
"maximum": 90
},
"chainMask": {
"type": [
"string",
"null"
],
"enum": [
null,
"Two",
"Three"
]
}
},
"required": [
"enabled"
]
},
"externalAntenna50": {
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"dbi": {
"type": [
"integer",
"null"
],
"minimum": 0,
"maximum": 90
},
"chainMask": {
"type": [
"string",
"null"
],
"enum": [
null,
"Two",
"Three"
]
}
},
"required": [
"enabled"
]
},
"lanPorts": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"portName": {
"type": "string",
"enum": [
"LAN1",
"LAN2",
"LAN3",
"LAN4",
"LAN5"
]
},
"enabled": {
"type": "boolean"
},
"overwriteVlanEnabled": {
"type": "boolean"
},
"vlanUntagId": {
"type": [
"integer",
"null"
],
"minimum": 0,
"maximum": 4094
},
"members": {
"type": [
"string",
"null"
]
},
"ethPortProfile": {
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"required": [
"portName",
"enabled"
]
}
}
}
}204Disable Specific Override ¶
DELETE/v8_0/aps/{apMac}/specific
Use this API command to disable specific configuration override from AP group or zone.
204Disable 2.4GHz radio protection mode override. ¶
DELETE/v8_0/aps/{apMac}/protectionMode24
Use this API command to disable 2.4GHz radio protection mode configuration override.The AP will apply its group’s or zone’s configuration.
204Disable Recovery SSID override. ¶
DELETE/v8_0/aps/{apMac}/recoverySsid
Use this API command to disable Recovery SSID configuration override.The AP will apply its group’s or zone’s configuration.
204Disable Directed Multicast from wired client override. ¶
DELETE/v8_0/aps/{apMac}/directedMulticastFromWiredClientEnabled
Use this API command to disable Island SSID Broadcast enabled configuration override.The AP will apply its group’s or zone’s configuration.
204Disable Directed Multicast from wireless client override. ¶
DELETE/v8_0/aps/{apMac}/directedMulticastFromWirelessClientEnabled
Use this API command to disable Island SSID Broadcast enabled configuration override.The AP will apply its group’s or zone’s configuration.
204Disable Directed Multicast from network to wired/wireless client override ¶
DELETE/v8_0/aps/{apMac}/directedMulticastFromNetworkEnabled
Use this API command to disable Directed Multicast from network to wired/wireless client configuration override.The AP will apply its group’s or zone’s configuration.
204Disable rogue AP report threshold override ¶
DELETE/v8_0/aps/{apMac}/rogueApReportThreshold
Use this API command to disable rogue AP report threshold override. The AP will apply its group’s or zone’s configuration.
204Disable rogue AP aggressiveness mode override ¶
DELETE/v8_0/aps/{apMac}/rogueApAggressivenessMode
Use this API command to disable rogue AP aggressiveness mode override. The AP will apply its group’s or zone’s configuration.
204Disable rogue AP jamming threshold override ¶
DELETE/v8_0/aps/{apMac}/rogueApJammingThreshold
Use this API command to disable rogue AP jamming threshold override. The AP will apply its group’s or zone’s configuration.
204Download AP support log ¶
Retrieve List ¶
GET/v8_0/aps
Use this API command to retrieve the list of APs that belong to a zone or a domain.
- index
string(optional)The index of the first entry to be retrieved. Default: 0
- listSize
string(optional)The maximum number of entries to be retrieved. Default: 100
- zoneId
string(optional)filter AP list by zone
- domainId
string(optional)filter AP list by domain. Default: current logon domain
200Body
{
"totalCount": 2,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"mac": "00:11:22:33:44:55",
"zoneId": "zoneUUID",
"apGroupId": "apGroupUUID",
"name": "apName",
"lanPortSize": 2
},
{
"mac": "11:22:33:44:55:66",
"zoneId": "zoneUUID2",
"apGroupId": "apGroupUUID2",
"name": "apName2",
"lanPortSize": 1
}
]
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"totalCount": {
"description": "Total AP count",
"type": "integer"
},
"hasMore": {
"description": "Indicates whether there are more APs after the list that is currently displayed",
"type": "boolean"
},
"firstIndex": {
"description": "Index of the first AP returned out of the complete AP list",
"type": "integer"
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"mac": {
"description": "MAC address of the AP",
"type": "string",
"pattern": "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
},
"zoneId": {
"description": "Identifier of the zone to which the AP belongs",
"type": "string"
},
"apGroupId": {
"description": "Identifier of the AP group to which the AP belongs",
"type": "string"
},
"name": {
"description": "Name of the AP",
"type": "string"
},
"serial": {
"description": "Serial Number",
"type": "string"
}
}
}
}
}
}Modify ¶
PATCH/v8_0/aps/{apMac}
Use this API command to modify the basic information of an AP.
Body
{
"zoneId": "zoneUUID",
"apGroupId": "apGroupUUID",
"serial": "00000096",
"model": "ZF7343",
"name": "apName",
"gpsSource": "MANUAL",
"latitude": 22.3,
"longitude": 114,
"location": "location",
"locationAdditionalInfo": "locationAdditionalInfo",
"description": "apDescription",
"administrativeState": "Unlocked",
"provisionChecklist": "provisionChecklist",
"wlanService24Enabled": true,
"wlanService50Enabled": false,
"login": {
"apLoginName": "apLoginName",
"apLoginPassword": "test1@pwd"
},
"syslog": {
"enabled": true,
"address": "1.1.1.1",
"port": 514,
"facility": "Keep_Original",
"priority": "Error",
"flowLevel": "GENERAL_LOGS",
"protocol": "IPPROTO_TCP"
},
"wifi24": {
"txPower": "Full",
"channelWidth": 20,
"channel": 1,
"channelRange": [
1,
2,
3
]
},
"wifi50": {
"txPower": "Full",
"channelWidth": 20,
"channel": 52,
"channelRange": [
52,
56,
60
]
},
"protectionMode24": "CTS_ONLY",
"wlanGroup24": {
"id": "wlanGroupUUID",
"name": "wlanGroupName"
},
"wlanGroup50": {
"id": "wlanGroupUUID",
"name": "wlanGroupName"
},
"network": {
"ipType": "Static",
"ip": "1.1.1.1",
"netmask": "255.255.255.0",
"gateway": "1.1.1.0",
"primaryDns": "8.8.8.8",
"secondaryDns": "8.8.8.9"
},
"networkIpv6": {
"ipType": "Static",
"ip": "2001::55/32",
"gateway": "2001::66",
"primaryDns": "2001::77",
"secondaryDns": "2001::88"
},
"smartMonitor": {
"enabled": true,
"intervalInSec": 10,
"retryThreshold": 10
},
"bonjourGateway": {
"id": "bonjourGatewayUUID",
"name": "bonjourGatewayName"
},
"clientAdmissionControl24": {
"maxRadioLoadPercent": 70,
"minClientCount": 30,
"minClientThroughputMbps": 10,
"enabled": true
},
"clientAdmissionControl50": {
"maxRadioLoadPercent": 70,
"minClientCount": 30,
"minClientThroughputMbps": 10,
"enabled": true
},
"venueProfile": {
"id": "venueProfileId",
"name": "venueProfileName"
},
"autoChannelSelection24": {
"channelSelectMode": "ChannelFly",
"channelFlyMtbc": 480
},
"autoChannelSelection50": {
"channelSelectMode": "BackgroundScanning",
"channelFlyMtbc": 480
},
"channelEvaluationInterval": 777,
"apMgmtVlan": {
"id": 1,
"mode": "KEEP"
},
"altitude": {
"altitudeUnit": "meters",
"altitudeValue": 1
},
"meshOptions": {
"meshMode": "MESH_AP",
"uplinkSelection": "MANUAL",
"meshUplinkEntryList": [
"6C:AA:B3:26:6C:30"
]
},
"recoverySsid": {
"recoverySsidEnabled": true
},
"rogueApReportThreshold": 50,
"rogueApAggressivenessMode": 2,
"rogueApJammingThreshold": 50,
"directedMulticastFromWiredClientEnabled": true,
"directedMulticastFromWirelessClientEnabled": true,
"directedMulticastFromNetworkEnabled": false,
"userLocationInfo": {
"areaCode": 886
}
}Schema
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"zoneId" : {
"description" : "Identifier of the zone to which the AP belongs",
"type" : "string"
},
"apGroupId" : {
"description" : "Identifier of the AP group to which the AP belongs",
"type" : "string"
},
"serial" : {
"description" : "Serial number of the AP",
"type" : "string"
},
"model" : {
"description" : "Model name of the AP",
"type" : "string"
},
"name" : {
"description" : "Name of the AP",
"type" : "string",
"minLength" : 2,
"maxLength" : 64,
"pattern" : "^[!-~]((?!\$\()[ -_a-~]){0,62}[!-~]$"
},
"gpsSource" : {
"description" : "GPS Source of the AP",
"type" : "string",
"enum" : [ "GPS", "MANUAL" ]
},
"latitude" : {
"description" : "Latitude coordinate (in decimal format) of the AP",
"type" : "number"
},
"longitude" : {
"description" : "Longitude coordinate (in decimal format) of the AP",
"type" : "number"
},
"location" : {
"description" : "Location of the AP. This is a text description that indicates the location of the AP.",
"type" : "string"
},
"locationAdditionalInfo" : {
"description" : "Location additional info of the AP. This is a text description that indicates the location additional info of the AP.",
"type" : "string",
"pattern" : "^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
},
"altitude" : {
"description" : "GPS Altitude",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"altitudeUnit" : {
"description" : "altitude unit",
"type" : "string",
"enum" : [ "meters", "floor" ]
},
"altitudeValue" : {
"description" : "altitude value",
"type" : "integer"
}
}
},
"description" : {
"description" : "Description of the AP",
"type" : [ "string", "null" ],
"maxLength" : 64
},
"administrativeState" : {
"description" : "Administrative state of the AP. A locked AP will not provide any WLAN services.",
"type" : "string",
"enum" : [ "Locked", "Unlocked" ]
},
"provisionChecklist" : {
"description" : "Provision checklist of the AP. This field indicates the steps that have been completed in the AP provisioning process.",
"type" : "string"
},
"userLocationInfo" : {
"description" : "User location information of the AP.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"areaCode" : {
"description" : "area code",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
}
}
},
"wlanService24Enabled" : {
"description" : "WLAN service enabled or disabled on 2.4GHz radio",
"type" : "boolean"
},
"wlanService50Enabled" : {
"description" : "WLAN service enabled or disabled on 5GHz radio",
"type" : "boolean"
},
"login" : {
"description" : "Logon credentials for the AP. These logon credentials will override the logon credentials specified at the zone level or AP group level.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"apLoginName" : {
"description" : "User name of the AP administrator",
"type" : "string",
"maxLength" : 64,
"pattern" : "^((?!\$\()[!-_a-~]){1,64}$"
},
"apLoginPassword" : {
"description" : "Password of the AP administrator",
"type" : "string",
"maxLength" : 64,
"pattern" : ".*(?=.{8,})(?=.*[a-zA-Z])(?=.*[0-9])(?=.*[_`~!@#$%^&*\(\)\[\]\{\}|;:'\",.\<>\/?=+-]).*"
}
},
"required" : [ "apLoginName", "apLoginPassword" ]
},
"syslog" : {
"description" : "Syslog configuration of the AP. This configuration will override the syslog configuration at the zone level or AP group level.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"enabled" : {
"description" : "Indicates whether syslog is enabled or disabled",
"type" : "boolean"
},
"address" : {
"description" : "Address of the syslog server. If syslog is enabled, this attribute is required.",
"type" : "string"
},
"port" : {
"description" : "Port number of the syslog server",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
},
"facility" : {
"description" : "Facility of the syslog server",
"type" : "string",
"enum" : [ "Keep_Original", "Local0", "Local1", "Local2", "Local3", "Local4", "Local5", "Local6", "Local7" ]
},
"priority" : {
"description" : "Priority of the log messages",
"type" : "string",
"enum" : [ "Emergency", "Alert", "Critical", "Error", "Warning", "Notice", "Info", "All" ]
},
"flowLevel" : {
"description" : "Flow Level of the syslog",
"type" : "string",
"enum" : [ "GENERAL_LOGS", "CLIENT_FLOW", "ALL" ]
},
"protocol" : {
"description" : "Protocol of the syslog server",
"type" : "string",
"enum" : [ "IPPROTO_TCP", "IPPROTO_UDP" ]
},
"secondaryAddress" : {
"description" : "Secondary Server Address of the syslog server",
"type" : "string"
},
"secondaryPort" : {
"description" : "Secondary Server Port of the syslog server",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
},
"secondaryProtocol" : {
"description" : "Secondary Server Protocol of the syslog server",
"type" : "string",
"enum" : [ "IPPROTO_TCP", "IPPROTO_UDP" ]
}
},
"required" : [ "enabled" ]
},
"wifi24" : {
"description" : "2.4GHz radio configuration of the AP. This configuration will override the radio 2.4GHz configuration at the zone level or AP group level.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"autoCellSizing" : {
"description" : "Auto Cell Sizing",
"type" : "boolean"
},
"txPower" : {
"description" : "Transmission power",
"type" : "string",
"enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ]
},
"channelWidth" : {
"description" : "Channel width. Zero (0) means Auto.",
"type" : "integer",
"enum" : [ 0, 20, 40 ]
},
"channel" : {
"description" : "Channel number",
"type" : "integer"
},
"channelRange" : {
"description" : "Channel range options",
"type" : "array",
"items" : {
"type" : "integer"
}
}
}
},
"wifi50" : {
"description" : "5GHz radio configuration. This configuration will override the 5GHz radio configuration at the zone level or AP group level.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"autoCellSizing" : {
"description" : "Auto Cell Sizing",
"type" : "boolean"
},
"txPower" : {
"description" : "transmission power",
"type" : "string",
"enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ]
},
"channelWidth" : {
"description" : "channel width, 0 mean Auto, 8080 means 80+80MHz",
"type" : "integer",
"enum" : [ 0, 20, 40, 80, 8080, 160 ]
},
"channel" : {
"description" : "channel number",
"type" : "integer"
},
"secondaryChannel" : {
"description" : "channel number (channelWidth is 80+80MHz only)",
"type" : "integer"
},
"channelRange" : {
"description" : "channel range options",
"type" : "array",
"items" : {
"type" : "integer"
}
}
}
},
"protectionMode24" : {
"description" : "AP 2.4GHz Protection mode configuration of the AP.",
"type" : "string",
"enum" : [ "NONE", "CTS_ONLY", "RTS_CTS" ]
},
"wlanGroup24" : {
"description" : "WLAN group of 2.4GHz radio. This configuration will override the WLAN group of the 2.4GHz radio at the zone level or AP group level.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Identifier of the WLAN group",
"type" : "string"
},
"name" : {
"description" : "Name of the WLAN group",
"type" : "string"
}
}
},
"wlanGroup50" : {
"description" : "WLAN group of 5GHz radio. This configuration will override the WLAN group of the 5GHz radio at the zone level or AP group level.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Identifier of the WLAN group",
"type" : "string"
},
"name" : {
"description" : "Name of the WLAN group",
"type" : "string"
}
}
},
"network" : {
"description" : "Network settings ipv4 of the AP.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"ipType" : {
"description" : "Indicates how the AP's IP address was obtained. An AP's IP address can be statically or dynamically assigned or kept unchanged.",
"type" : "string",
"enum" : [ "Static", "Dynamic", "Autoconfig", "Keep" ]
},
"ip" : {
"description" : "IP address of the AP",
"type" : "string"
},
"netmask" : {
"description" : "Netmask of the AP's subnet",
"type" : "string",
"pattern" : "^$|(^(128|192|224|24[08]|25[245]).0.0.0$)|(^255.(0|128|192|224|24[08]|25[245]).0.0$)|(^255.255.(0|128|192|224|24[08]|25[245]).0$)|(^255.255.255.(0|128|192|224|24[08]|252|255)$)"
},
"gateway" : {
"description" : "Gateway of the AP",
"type" : "string"
},
"primaryDns" : {
"description" : "Primary DNS server address of the AP",
"type" : "string"
},
"secondaryDns" : {
"description" : "Secondary DNS server address of the AP",
"type" : "string"
}
}
},
"networkIpv6" : {
"description" : "Network settings ipv6 of the AP.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"ipType" : {
"description" : "Indicates how the AP's IP address was obtained. An AP's IP address can be statically or dynamically assigned or kept unchanged.",
"type" : "string",
"enum" : [ "Static", "Dynamic", "Autoconfig", "Keep" ]
},
"ip" : {
"description" : "IP address of the AP",
"type" : "string"
},
"gateway" : {
"description" : "Gateway of the AP",
"type" : "string"
},
"primaryDns" : {
"description" : "Primary DNS server address of the AP",
"type" : "string"
},
"secondaryDns" : {
"description" : "Secondary DNS server address of the AP",
"type" : "string"
}
}
},
"smartMonitor" : {
"description" : "Smart monitor of the AP.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"enabled" : {
"type" : "boolean"
},
"intervalInSec" : {
"description" : "Interval in seconds. This is required if smartMonitor is enabled",
"type" : "integer",
"minimum" : 5,
"maximum" : 60
},
"retryThreshold" : {
"description" : "Retry threshold. This is required if smartMonitor is enabled",
"type" : "integer",
"minimum" : 1,
"maximum" : 10
}
}
},
"bonjourGateway" : {
"description" : "Bonjour gateway of the AP.",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"clientAdmissionControl24" : {
"description" : "Client admission control configuration of 2.4GHz radio of the AP.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"enabled" : {
"type" : "boolean"
},
"maxRadioLoadPercent" : {
"description" : "Maximum radio load percentage.",
"type" : "integer",
"minimum" : 50,
"maximum" : 100
},
"minClientCount" : {
"description" : "Minimum client count number.",
"type" : "integer",
"minimum" : 0,
"maximum" : 100
},
"minClientThroughputMbps" : {
"description" : "Minimum client throughput in Mbps.",
"type" : "number",
"minimum" : 0,
"maximum" : 100
}
}
},
"clientAdmissionControl50" : {
"description" : "Client admission control configuration of 5GHz radio of the AP.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"enabled" : {
"type" : "boolean"
},
"maxRadioLoadPercent" : {
"description" : "Maximum radio load percentage.",
"type" : "integer",
"minimum" : 50,
"maximum" : 100
},
"minClientCount" : {
"description" : "Minimum client count number.",
"type" : "integer",
"minimum" : 0,
"maximum" : 100
},
"minClientThroughputMbps" : {
"description" : "Minimum client throughput in Mbps.",
"type" : "number",
"minimum" : 0,
"maximum" : 100
}
}
},
"venueProfile" : {
"description" : "Venue profile configuration of the AP.",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"autoChannelSelection24" : {
"description" : "client load balancing on Radio 2.4G, auto channel selection mode",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"channelSelectMode" : {
"description" : "Channel Select Mode",
"type" : "string",
"enum" : [ "None", "BackgroundScanning", "ChannelFly" ]
},
"channelFlyMtbc" : {
"description" : "ChannelFly MTBC",
"type" : "integer",
"minimum" : 100,
"maximum" : 1440
}
}
},
"autoChannelSelection50" : {
"description" : "client load balancing on Radio 5G, auto channel selection mode",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"channelSelectMode" : {
"description" : "Channel Select Mode",
"type" : "string",
"enum" : [ "None", "BackgroundScanning", "ChannelFly" ]
},
"channelFlyMtbc" : {
"description" : "ChannelFly MTBC",
"type" : "integer",
"minimum" : 100,
"maximum" : 1440
}
}
},
"channelEvaluationInterval" : {
"description" : "channel evaluation Interval of the AP",
"type" : "integer",
"minimum" : 60,
"maximum" : 3600
},
"apMgmtVlan" : {
"description" : "ap Management Vlan",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"mode" : {
"description" : "Vlan Mode of the zone",
"type" : "string",
"enum" : [ "KEEP", "USER_DEFINED" ]
},
"id" : {
"description" : "Vlan id of the zone",
"type" : "integer"
}
}
},
"meshOptions" : {
"description" : "mesh options",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"meshMode" : {
"description" : "mesh mode",
"type" : "string",
"enum" : [ "AUTO", "ROOT_AP", "MESH_AP", "DISABLE" ]
},
"uplinkSelection" : {
"description" : "Uplink selection",
"type" : "string",
"enum" : [ "SMART", "MANUAL" ]
},
"meshUplinkEntryList" : {
"description" : "MAC address of the neighbor AP",
"type" : "array",
"items" : {
"type" : "string",
"pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
}
}
}
},
"recoverySsid" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"recoverySsidEnabled" : {
"description" : "recovery ssid enable/disable",
"type" : "boolean"
}
}
},
"rogueApReportThreshold" : {
"description" : "Rogue AP report will leave out all entries that have signal strength lower than this threshold.",
"type" : "integer"
},
"rogueApAggressivenessMode" : {
"description" : "Adjust the frequency interval to de-authenticate rogue APs.",
"type" : "integer"
},
"rogueApJammingThreshold" : {
"type" : "integer"
},
"directedMulticastFromWiredClientEnabled" : {
"type" : "boolean"
},
"directedMulticastFromWirelessClientEnabled" : {
"type" : "boolean"
},
"directedMulticastFromNetworkEnabled" : {
"type" : "boolean"
}
}
}204Modify Login Override ¶
PATCH/v8_0/aps/{apMac}/login
Use this API command to enable or modify the AP-level logon override settings.
Body
{
"apLoginName": "apLoginName",
"apLoginPassword": "test1@pwd"
}Schema
{
"description" : "Logon credentials for the AP. These logon credentials will override the logon credentials specified at the zone level or AP group level.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"apLoginName" : {
"description" : "User name of the AP administrator",
"type" : "string",
"maxLength" : 64,
"pattern" : "^((?!\$\()[!-_a-~]){1,64}$"
},
"apLoginPassword" : {
"description" : "Password of the AP administrator",
"type" : "string",
"maxLength" : 64,
"pattern" : ".*(?=.{8,})(?=.*[a-zA-Z])(?=.*[0-9])(?=.*[_`~!@#$%^&*\(\)\[\]\{\}|;:'\",.\<>\/?=+-]).*"
}
},
"required" : [ "apLoginName", "apLoginPassword" ]
}204Modify Syslog Override ¶
PATCH/v8_0/aps/{apMac}/syslog
Use this API command to enable or modify the AP-level syslog override settings.
Body
{
"enabled": true,
"address": "1.1.1.1",
"port": 514,
"facility": "Keep_Original",
"priority": "Error",
"flowLevel": "GENERAL_LOGS",
"protocol": "IPPROTO_TCP"
}Schema
{
"description": "Syslog configuration of the AP. This configuration will override the syslog configuration at the zone level or AP group level.",
"type": "object",
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Indicates whether syslog is enabled or disabled",
"type": "boolean"
},
"address": {
"description": "Address of the syslog server. If syslog is enabled, this attribute is required.",
"type": "string"
},
"port": {
"description": "Port number of the syslog server",
"type": "integer",
"minimum": 1,
"maximum": 65535
},
"facility": {
"description": "Facility of the syslog server",
"type": "string",
"enum": [
"Keep_Original",
"Local0",
"Local1",
"Local2",
"Local3",
"Local4",
"Local5",
"Local6",
"Local7"
]
},
"priority": {
"description": "Priority of the log messages",
"type": "string",
"enum": [
"Emergency",
"Alert",
"Critical",
"Error",
"Warning",
"Notice",
"Info",
"All"
]
},
"flowLevel": {
"description": "Flow Level of the syslog",
"type": "string",
"enum": [
"GENERAL_LOGS",
"CLIENT_FLOW",
"ALL"
]
},
"protocol": {
"description": "Protocol of the syslog server",
"type": "string",
"enum": [
"IPPROTO_TCP",
"IPPROTO_UDP"
]
},
"secondaryAddress": {
"description": "Secondary Server Address of the syslog server",
"type": "string"
},
"secondaryPort": {
"description": "Secondary Server Port of the syslog server",
"type": "integer",
"minimum": 1,
"maximum": 65535
},
"secondaryProtocol": {
"description": "Secondary Server Protocol of the syslog server",
"type": "string",
"enum": [
"IPPROTO_TCP",
"IPPROTO_UDP"
]
}
},
"required": [
"enabled"
]
}204Modify Radio 2.4G Override ¶
PATCH/v8_0/aps/{apMac}/wifi24
Use this API command to modify the AP level override of the 2.4GHz radio configuration.
Body
{
"txPower": "Full",
"channelWidth": 20,
"channel": 1,
"channelRange": [
1,
2,
3
]
}Schema
{
"description": "2.4GHz radio configuration of the AP. This configuration will override the radio 2.4GHz configuration at the zone level or AP group level.",
"type": "object",
"additionalProperties": false,
"properties": {
"autoCellSizing": {
"description": "Auto Cell Sizing",
"type": "boolean"
},
"txPower": {
"description": "Transmission power",
"type": "string",
"enum": [
"Full",
"-1dB",
"-2dB",
"-3dB(1/2)",
"-4dB",
"-5dB",
"-6dB(1/4)",
"-7dB",
"-8dB",
"-9dB(1/8)",
"-10dB",
"Min"
]
},
"channelWidth": {
"description": "Channel width. Zero (0) means Auto.",
"type": "integer",
"enum": [
0,
20,
40
]
},
"channel": {
"description": "Channel number",
"type": "integer"
},
"channelRange": {
"description": "Channel range options",
"type": "array",
"items": {
"type": "integer"
}
}
}
}204Modify Radio 5G Override ¶
PATCH/v8_0/aps/{apMac}/wifi50
Use this API command to Modify the AP level override of the 5GHz radio configuration.
Body
{
"txPower": "Full",
"channelWidth": 20,
"channel": 52,
"channelRange": [
52,
56,
60
]
}Schema
{
"description": "5GHz radio configuration. This configuration will override the 5GHz radio configuration at the zone level or AP group level.",
"type": "object",
"additionalProperties": false,
"properties": {
"autoCellSizing": {
"description": "Auto Cell Sizing",
"type": "boolean"
},
"txPower": {
"description": "transmission power",
"type": "string",
"enum": [
"Full",
"-1dB",
"-2dB",
"-3dB(1/2)",
"-4dB",
"-5dB",
"-6dB(1/4)",
"-7dB",
"-8dB",
"-9dB(1/8)",
"-10dB",
"Min"
]
},
"channelWidth": {
"description": "channel width, 0 mean Auto, 8080 means 80+80MHz",
"type": "integer",
"enum": [
0,
20,
40,
80,
8080,
160
]
},
"channel": {
"description": "channel number",
"type": "integer"
},
"secondaryChannel": {
"description": "channel number (channelWidth is 80+80MHz only)",
"type": "integer"
},
"channelRange": {
"description": "channel range options",
"type": "array",
"items": {
"type": "integer"
}
}
}
}204Modify WLAN Group 2.4G Override ¶
PATCH/v8_0/aps/{apMac}/wlanGroup24
Use this API command to enable or modify the AP level override of the WLAN group configuration on the 2.4GHz radio.
Body
{
"id": "wlanGroupUUID",
"name": "wlanGroupName"
}Schema
{
"description": "WLAN group of 2.4GHz radio. This configuration will override the WLAN group of the 2.4GHz radio at the zone level or AP group level.",
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the WLAN group",
"type": "string"
},
"name": {
"description": "Name of the WLAN group",
"type": "string"
}
}
}204Modify WLAN Group 5G Override ¶
PATCH/v8_0/aps/{apMac}/wlanGroup50
Use this API command to enable or modify the AP level override of the WLAN group configuration on the 5GHz radio.
Body
{
"id": "wlanGroupUUID",
"name": "wlanGroupName"
}Schema
{
"description": "WLAN group of 5GHz radio. This configuration will override the WLAN group of the 5GHz radio at the zone level or AP group level.",
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the WLAN group",
"type": "string"
},
"name": {
"description": "Name of the WLAN group",
"type": "string"
}
}
}204Modify Network Settings Ipv4 ¶
PATCH/v8_0/aps/{apMac}/network
Use this API command to modify the network settings Ipv4 of an AP.
Body
{
"ipType": "Static",
"ip": "1.1.1.1",
"netmask": "255.255.255.0",
"gateway": "1.1.1.0",
"primaryDns": "8.8.8.8",
"secondaryDns": "8.8.8.9"
}Schema
{
"description": "Network settings ipv4 of the AP.",
"type": "object",
"additionalProperties": false,
"properties": {
"ipType": {
"description": "Indicates how the AP's IP address was obtained. An AP's IP address can be statically or dynamically assigned or kept unchanged.",
"type": "string",
"enum": [
"Static",
"Dynamic",
"Autoconfig",
"Keep"
]
},
"ip": {
"description": "IP address of the AP",
"type": "string"
},
"netmask": {
"description": "Netmask of the AP's subnet",
"type": "string",
"pattern": "^$|(^(128|192|224|24[08]|25[245]).0.0.0$)|(^255.(0|128|192|224|24[08]|25[245]).0.0$)|(^255.255.(0|128|192|224|24[08]|25[245]).0$)|(^255.255.255.(0|128|192|224|24[08]|252|255)$)"
},
"gateway": {
"description": "Gateway of the AP",
"type": "string"
},
"primaryDns": {
"description": "Primary DNS server address of the AP",
"type": "string"
},
"secondaryDns": {
"description": "Secondary DNS server address of the AP",
"type": "string"
}
}
}204Modify Network Settings Ipv6 ¶
PATCH/v8_0/aps/{apMac}/networkIpv6
Use this API command to modify the network settings Ipv6 of an AP.
Body
{
"ipType": "Static",
"ip": "2001::55/32",
"gateway": "2001::66",
"primaryDns": "2001::77",
"secondaryDns": "2001::88"
}Schema
{
"description": "Network settings ipv6 of the AP.",
"type": "object",
"additionalProperties": false,
"properties": {
"ipType": {
"description": "Indicates how the AP's IP address was obtained. An AP's IP address can be statically or dynamically assigned or kept unchanged.",
"type": "string",
"enum": [
"Static",
"Dynamic",
"Autoconfig",
"Keep"
]
},
"ip": {
"description": "IP address of the AP",
"type": "string"
},
"gateway": {
"description": "Gateway of the AP",
"type": "string"
},
"primaryDns": {
"description": "Primary DNS server address of the AP",
"type": "string"
},
"secondaryDns": {
"description": "Secondary DNS server address of the AP",
"type": "string"
}
}
}204Modify Smart Monitor ¶
PATCH/v8_0/aps/{apMac}/smartMonitor
Use this API command to modify smart monitor of an AP.
Body
{
"enabled": true,
"intervalInSec": 10,
"retryThreshold": 10
}Schema
{
"description": "Smart monitor of the AP.",
"type": "object",
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"intervalInSec": {
"description": "Interval in seconds. This is required if smartMonitor is enabled",
"type": "integer",
"minimum": 5,
"maximum": 60
},
"retryThreshold": {
"description": "Retry threshold. This is required if smartMonitor is enabled",
"type": "integer",
"minimum": 1,
"maximum": 10
}
}
}204Modify Bonjour Gateway ¶
PATCH/v8_0/aps/{apMac}/bonjourGateway
Use this API command to modify bonjour gateway of an AP.
Body
{
"id": "bonjourGatewayUUID",
"name": "bonjourGatewayName"
}Schema
{
"description": "Bonjour gateway of the AP.",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}204Modify Client Admission Control 2.4G ¶
PATCH/v8_0/aps/{apMac}/clientAdmissionControl24
Use this API command to modify client admission control 2.4GHz radio configuration of an AP.
Body
{
"maxRadioLoadPercent": 70,
"minClientCount": 30,
"minClientThroughputMbps": 10,
"enabled": true
}Schema
{
"description": "Client admission control configuration of 2.4GHz radio of the AP.",
"type": "object",
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"maxRadioLoadPercent": {
"description": "Maximum radio load percentage.",
"type": "integer",
"minimum": 50,
"maximum": 100
},
"minClientCount": {
"description": "Minimum client count number.",
"type": "integer",
"minimum": 0,
"maximum": 100
},
"minClientThroughputMbps": {
"description": "Minimum client throughput in Mbps.",
"type": "number",
"minimum": 0,
"maximum": 100
}
}
}204Modify Client Admission Control 5G ¶
PATCH/v8_0/aps/{apMac}/clientAdmissionControl50
Use this API command to modify client admission control 5GHz radio configuration of an AP.
Body
{
"maxRadioLoadPercent": 70,
"minClientCount": 30,
"minClientThroughputMbps": 10,
"enabled": true
}Schema
{
"description": "Client admission control configuration of 5GHz radio of the AP.",
"type": "object",
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"maxRadioLoadPercent": {
"description": "Maximum radio load percentage.",
"type": "integer",
"minimum": 50,
"maximum": 100
},
"minClientCount": {
"description": "Minimum client count number.",
"type": "integer",
"minimum": 0,
"maximum": 100
},
"minClientThroughputMbps": {
"description": "Minimum client throughput in Mbps.",
"type": "number",
"minimum": 0,
"maximum": 100
}
}
}204Modify Venue Profile ¶
PATCH/v8_0/aps/{apMac}/venueProfile
Use this API command to modify venue profile of an AP.
Body
{
"id": "venueProfileId",
"name": "venueProfileName"
}Schema
{
"description": "Venue profile configuration of the AP.",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}204Modify Radio 2.4G Auto ChannelSelectMode Override ¶
PATCH/v8_0/aps/{apMac}/autoChannelSelection24
Override Radio 2.4G Auto ChannelSelectMode and ChannelFly MTBC of an AP.
Body
{
"channelSelectMode": "ChannelFly",
"channelFlyMtbc": 480
}Schema
{
"description": "client load balancing on Radio 2.4G, auto channel selection mode",
"type": "object",
"additionalProperties": false,
"properties": {
"channelSelectMode": {
"description": "Channel Select Mode",
"type": "string",
"enum": [
"None",
"BackgroundScanning",
"ChannelFly"
]
},
"channelFlyMtbc": {
"description": "ChannelFly MTBC",
"type": "integer",
"minimum": 100,
"maximum": 1440
}
}
}204Modify Radio 5G Auto ChannelSelectMode Override ¶
PATCH/v8_0/aps/{apMac}/autoChannelSelection50
Override Radio 5G Auto ChannelSelectMode and ChannelFly MTBC of an AP.
Body
{
"channelSelectMode": "BackgroundScanning",
"channelFlyMtbc": 480
}Schema
{
"description": "client load balancing on Radio 5G, auto channel selection mode",
"type": "object",
"additionalProperties": false,
"properties": {
"channelSelectMode": {
"description": "Channel Select Mode",
"type": "string",
"enum": [
"None",
"BackgroundScanning",
"ChannelFly"
]
},
"channelFlyMtbc": {
"description": "ChannelFly MTBC",
"type": "integer",
"minimum": 100,
"maximum": 1440
}
}
}204Modify AP Management Vlan ¶
PATCH/v8_0/aps/{apMac}/apMgmtVlan
Modify AP Management Vlan of an AP.
Body
{
"id": 1,
"mode": "KEEP"
}Schema
{
"description": "ap Management Vlan",
"type": "object",
"additionalProperties": false,
"properties": {
"mode": {
"description": "Vlan Mode of the zone",
"type": "string",
"enum": [
"KEEP",
"USER_DEFINED"
]
},
"id": {
"description": "Vlan id of the zone",
"type": "integer"
}
}
}204Modify Altitude Override ¶
PATCH/v8_0/aps/{apMac}/altitude
Use this API command to modify the altitude of an AP.
Body
{
"altitudeUnit": "meters",
"altitudeValue": 1
}Schema
{
"description": "GPS Altitude",
"type": "object",
"additionalProperties": false,
"properties": {
"altitudeUnit": {
"description": "altitude unit",
"type": "string",
"enum": [
"meters",
"floor"
]
},
"altitudeValue": {
"description": "altitude value",
"type": "integer"
}
}
}204Modify Mesh Options ¶
PATCH/v8_0/aps/{apMac}/meshOptions
Use this API command to modify mesh options of an AP.
Body
{
"meshMode": "MESH_AP",
"uplinkSelection": "MANUAL",
"meshUplinkEntryList": [
"6C:AA:B3:26:6C:30"
]
}Schema
{
"description": "mesh options",
"type": "object",
"additionalProperties": false,
"properties": {
"meshMode": {
"description": "mesh mode",
"type": "string",
"enum": [
"AUTO",
"ROOT_AP",
"MESH_AP",
"DISABLE"
]
},
"uplinkSelection": {
"description": "Uplink selection",
"type": "string",
"enum": [
"SMART",
"MANUAL"
]
},
"meshUplinkEntryList": {
"description": "MAC address of the neighbor AP",
"type": "array",
"items": {
"type": "string",
"pattern": "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
}
}
}
}204Create ¶
POST/v8_0/aps
Use this API command to create a new access point.
Body
{
"mac": "00:11:22:33:44:55",
"zoneId": "zoneUUID",
"apGroupId": "apGroupUUID",
"serial": "00000096",
"model": "ZF7962",
"name": "apName",
"gpsSource": "MANUAL",
"latitude": 22.3,
"longitude": 114,
"location": "shenzhen",
"description": "apDescription",
"administrativeState": "Unlocked",
"provisionChecklist": "test"
}Schema
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"mac" : {
"description" : "MAC address of the AP",
"type" : "string",
"pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
},
"zoneId" : {
"description" : "Identifier of the zone to which the AP belongs",
"type" : "string"
},
"apGroupId" : {
"description" : "Identifier of the AP group to which the AP belongs. If the AP belongs to the default AP group, this property is not needed.",
"type" : "string"
},
"serial" : {
"description" : "Serial number of the AP",
"type" : "string"
},
"model" : {
"description" : "Model name of the AP",
"type" : "string"
},
"name" : {
"description" : "Name of the AP",
"type" : "string",
"minLength" : 2,
"maxLength" : 64,
"pattern" : "^[!-~]((?!\$\()[ -_a-~]){0,62}[!-~]$"
},
"gpsSource" : {
"description" : "GPS Source of the AP",
"type" : "string",
"enum" : [ "GPS", "MANUAL" ]
},
"latitude" : {
"description" : "Latitude coordinate (in decimal format) of the AP",
"type" : "number"
},
"longitude" : {
"description" : "Longitude coordinate (in decimal format) of the AP",
"type" : "number"
},
"location" : {
"description" : "Location of the AP. This is a free format text description that indicates the location of the AP.",
"type" : "string"
},
"description" : {
"description" : "Description of the AP",
"type" : [ "string", "null" ],
"maxLength" : 64
},
"administrativeState" : {
"description" : "Administrative state of the AP. A locked AP will not provide any WLAN services.",
"type" : "string",
"enum" : [ "Locked", "Unlocked" ],
"default" : "Unlocked"
},
"provisionChecklist" : {
"description" : "Provision checklist of the AP. This field indicates the steps that have been completed in the AP provisioning process.",
"type" : "string"
}
},
"required" : [ "mac", "zoneId" ]
}201Query Zero Touch Unapproved AP list ¶
GET/v8_0/mesh/zeroTouch
Use this API command to retrieve a list of unapproved AP.
200Body
{
"rawDataTotalCount": 100,
"totalCount": 10,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"apMac": "AB:CD:00:00:00:0D",
"meshRole": "eMesh AP",
"apName": "AP014",
"apModel": "R500",
"ipAddress": "192.168.0.162",
"externalIPAddress": "10.10.10.33:3000",
"channel": null,
"uplinkRssi": 77,
"downlinkRssi": null,
"hasDownLink": false,
"clientCount": 0,
"hops": 0
}
],
"extra": null
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"rawDataTotalCount": {
"description": "MeshNodeInfos count.",
"type": "integer"
},
"totalCount": {
"description": "MeshNodeInfos count in this response.",
"type": "integer"
},
"extra": {
"description": "Any additional response data.",
"type": "object"
},
"hasMore": {
"description": "Indicator of whether there are more MeshNodeInfo after the current displayed list",
"type": "boolean"
},
"firstIndex": {
"description": "Index of the first MeshNodeInfo returned out of the complete Rogue AP list",
"type": "integer"
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"apMac": {
"description": "The MAC of the mesh AP",
"type": "string"
},
"meshRole": {
"description": "The Role of the mesh AP",
"type": "string"
},
"apName": {
"description": "The name of the mesh AP",
"type": "string"
},
"apModel": {
"description": "The model of the mesh AP",
"type": "string"
},
"ipAddress": {
"description": "The IP of the mesh AP",
"type": "integer"
},
"externalIPAddress": {
"description": "The external IP of the mesh AP",
"type": "string"
},
"channel": {
"description": "The channel of the mesh AP",
"type": "string"
},
"uplinkRssi": {
"description": "The uplinkRssi of the mesh AP",
"type": "integer"
},
"downlinkRssi": {
"description": "The downlinkRssi of the mesh AP",
"type": "integer"
},
"hasDownLink": {
"description": "The hasDownLink of the mesh AP",
"type": "boolean"
},
"clientCount": {
"description": "The count of clients of the mesh AP",
"type": "integer"
},
"hops": {
"description": "The hop count of this mesh AP",
"type": "integer"
},
"helperZoneInfo": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"helperAPZoneId": {
"type": "string"
},
"helperAPZoneName": {
"type": "string"
}
}
}
}
}
}
}
}
}Update Zero Touch Unapproved AP ¶
PUT/v8_0/mesh/zeroTouch
Use this API command to approve/reject unapproved AP. Recommend to deploy 20 island APs to join per batch at the same time.
Body
{
"apMac": "AB:CD:00:00:00:0D",
"status": "Accept",
"helperZoneId": "fce48fb7-8b89-49f6-8ce5-f52aecfc81ff",
"serialNumber": "0089"
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"apMac": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"Accept",
"Reject"
]
},
"helperZoneId": {
"type": "string"
},
"serialNumber": {
"type": "string"
}
}
}200Access Point Operational ¶
AP Blink Led ¶
POST/v8_0/aps/{apMac}/operational/blinkLed
use this API to make ap blink its led to show its position.
200Retrieve Alarm Summary ¶
GET/v8_0/aps/{apMac}/operational/alarmSummary
Use this API command to retrieve the alarm summary of an AP.
Deprecated : this URI will be deprecated after Version: v8_0, and no longer be supported. For the alternative URI, please refer to the “RETRIEVE ALARM SUMMARY” section of the category “Event and Alarm”.
200Body
{
"criticalCount": 3,
"majorCount": 3,
"minorCount": 4,
"warningCount": 0
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"criticalCount": {
"description": "Critical alarm count",
"type": "integer"
},
"majorCount": {
"description": "Major alarm count",
"type": "integer"
},
"minorCount": {
"description": "Minor alarm count",
"type": "integer"
},
"warningCount": {
"description": "Warning alarm count",
"type": "integer"
}
}
}Retrieve Event List ¶
GET/v8_0/aps/{apMac}/operational/events
Use this API command to retrieve the list of events from an AP.
Deprecated : this URI will be deprecated after Version: v8_0, and no longer be supported. For the alternative URI, please refer to the “RETRIEVE EVENT LIST” section of the category “Event and Alarm”.
- index
string(optional)The index of the first entry to be retrieved. Default: 0
- listSize
string(optional)The maximum number of entries to be retrieved. Default: 100
- severity
string(optional)filter by severity
- category
string(optional)filter by category
- code
number(optional)filter by event code
- startTime
string(optional)filter by trigger time later than startTime (milliseconds in UTC time)
- endTime
string(optional)filter by trigger time earlier than endTime (milliseconds in UTC time)
200Body
{
"totalCount": 2,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"id": "7a06627a-f739-4aac-b2a1-5fc6d7bb2767",
"time": 1408648612000,
"code": 110,
"category": "AP Communication",
"type": "AP configuration updated",
"severity": "Informational",
"description": "AP [abcpeng@24:C9:A1:1D:55:A0] updated to configuration [af8d97a0-2967-11e4-91cf-000c29b1347d]."
},
{
"id": "8c5796c1-746c-460b-81f0-f97b8ab2b74f",
"time": 1408648603000,
"code": 109,
"category": "AP Communication",
"type": "Updating AP configuration...",
"severity": "Informational",
"description": "AP [abcpeng@24:C9:A1:1D:55:A0] is being updated to new configuration ID [af8d97a0-2967-11e4-91cf-000c29b1347d]."
}
]
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"totalCount": {
"description": "Total event count",
"type": "integer"
},
"hasMore": {
"description": "Indicates whether there are more events after the currently displayed list",
"type": "boolean"
},
"firstIndex": {
"description": "Index of the first event returned from the complete event list",
"type": "integer"
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the event",
"type": "string",
"pattern": "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
},
"time": {
"description": "Time of the event",
"type": "string"
},
"code": {
"description": "Event code",
"type": "string"
},
"category": {
"description": "Event category",
"type": "string"
},
"type": {
"description": "Event type",
"type": "string"
},
"severity": {
"description": "Event severity",
"type": "string",
"enum": [
"Critical",
"Major",
"Minor",
"Warning",
"Informational",
"Debug"
]
},
"description": {
"description": "Event description",
"type": "string"
}
}
}
}
}
}Retrieve Event Summary ¶
GET/v8_0/aps/{apMac}/operational/eventSummary
Use this API command to retrieve the event summary of an AP.
Deprecated : this URI will be deprecated after Version: v8_0, and no longer be supported. For the alternative URI, please refer to the “RETRIEVE EVENT SUMMARY” section of the category “Event and Alarm”.
200Body
{
"criticalCount": 4,
"majorCount": 2,
"minorCount": 5,
"warningCount": 5,
"informationalCount": 2,
"debugCount": 5
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"criticalCount": {
"description": "Critical event count",
"type": "integer"
},
"majorCount": {
"description": "Major event count",
"type": "integer"
},
"minorCount": {
"description": "Minor event count",
"type": "integer"
},
"warningCount": {
"description": "Warning event count",
"type": "integer"
},
"informationalCount": {
"description": "Informational event count",
"type": "integer"
},
"debugCount": {
"description": "Debug event count",
"type": "integer"
}
}
}Retrieve Alarm List ¶
GET/v8_0/aps/{apMac}/operational/alarms
Use this API command to retrieve the list of alarms on an AP.
Deprecated : this URI will be deprecated after Version: v8_0, and no longer be supported. For the alternative URI, please refer to the “RETRIEVE ALARM LIST” section of the category “Event and Alarm”.
- index
string(optional)The index of the first entry to be retrieved. Default: 0
- listSize
string(optional)The maximum number of entries to be retrieved. Default: 100
- severity
string(optional)filter by severity
- category
string(optional)filter by category
- code
number(optional)filter by alarm code
- startTime
string(optional)filter by trigger time later than startTime (milliseconds in UTC time)
- endTime
string(optional)filter by trigger time earlier than endTime (milliseconds in UTC time)
- status
string(optional)filter by alarm status
200Body
{
"totalCount": 2,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"id": "538324f5-f085-4567-ae3f-6b40244d38d6",
"time": 1408715298000,
"code": 302,
"category": "AP Communication",
"type": "AP rebooted by system",
"severity": "Major",
"description": "AP [abcpeng@24:C9:A1:1D:55:A0] rebooted because of [application, wsgclient, reboot due to switch radio band].",
"status": "Outstanding",
"clearedTime": null,
"acknowledgedTime": null
},
{
"id": "5cc35da9-4d3c-4c9a-97e0-303d9b2b1776",
"time": 1408715248732,
"code": 307,
"category": "AP Communication",
"type": "AP heartbeat lost",
"severity": "Informational",
"description": "AP [abcpeng@24:C9:A1:1D:55:A0] heartbeat lost.",
"status": "Cleared",
"clearedTime": 1408715299243,
"acknowledgedTime": null
}
]
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"totalCount": {
"description": "Total alarm count",
"type": "integer"
},
"hasMore": {
"description": "Indicates whether there are more alarms after the currently displayed list",
"type": "boolean"
},
"firstIndex": {
"description": "Index of the first alarm returned from the complete alarm list",
"type": "integer"
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the alarm",
"type": "string",
"pattern": "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
},
"time": {
"description": "Time of the alarm",
"type": "string"
},
"code": {
"description": "Alarm code",
"type": "string"
},
"category": {
"description": "Alarm category",
"type": "string"
},
"type": {
"description": "Alarm type",
"type": "string"
},
"severity": {
"description": "Alarm severity",
"type": "string",
"enum": [
"Critical",
"Major",
"Minor",
"Warning",
"Informational"
]
},
"description": {
"description": "Alarm description",
"type": "string"
},
"status": {
"description": "Alarm status",
"type": "string",
"enum": [
"Outstanding",
"Acknowledged",
"Cleared"
]
},
"clearedTime": {
"description": "Time that alarm was cleared",
"type": "integer"
},
"acknowledgedTime": {
"description": "Time the alarm was acknowledged",
"type": "integer"
}
}
}
}
}
}Retrieve Mesh Neighbor AP List ¶
GET/v8_0/aps/{apMac}/operational/neighbor
Use this API command to retrieve a list of neighbor access points on mesh AP.
- index
string(optional)The index of the first entry to be retrieved. Default: 0
- listSize
string(optional)The maximum number of entries to be retrieved. Default: 100
200Body
{
"totalCount": 1,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"mac": "8C:0C:90:2B:8B:90",
"model": "ZF7372",
"name": "RuckusAP",
"version": "3.1.0.0.157",
"ip": "10.2.6.239",
"externalIp": "10.2.6.239",
"externalPort": "58788",
"connectionState": "Connect",
"channel": "40 (11a/n)",
"signal": "119%",
"zoneName": "neilMeshZone"
}
]
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"totalCount": {
"description": "Total mesh neighbor APs count",
"type": "integer"
},
"hasMore": {
"description": "Indicator of whether there are more Mesh Neighbor APs after the current displayed list",
"type": "boolean"
},
"firstIndex": {
"description": "Index of the first Mesh Neighbor AP returned out of the complete Mesh Neighbor AP list",
"type": "integer"
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"mac": {
"description": "MAC address of the mesh neighbor AP",
"type": "string",
"pattern": "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
},
"name": {
"description": "Name of the mesh neighbor AP",
"type": "string"
},
"zoneName": {
"description": "Name of the zone which the mesh neighbor AP belongs to",
"type": "string"
},
"ip": {
"description": "IP address of the mesh neighbor AP",
"type": "string"
},
"externalIp": {
"description": "External IP of the mesh neighbor AP",
"type": "string"
},
"externalPort": {
"description": "External port of the mesh neighbor AP",
"type": "string"
},
"model": {
"description": "Model of the mesh neighbor AP",
"type": "string"
},
"version": {
"description": "Firmware version of the mesh neighbor AP",
"type": "string"
},
"channel": {
"description": "Channel of the mesh neighbor AP",
"type": "string"
},
"signal": {
"description": "Signal of the mesh neighbor AP",
"type": "string"
},
"connectionState": {
"description": "Connection state of the mesh neighbor AP",
"type": "string"
}
}
}
}
}
}Retrieve Operational Information ¶
GET/v8_0/aps/{apMac}/operational/summary
Use this API command to retrieve the operational information of an AP.
200Body
{
"mac": "00:11:22:33:44:55",
"zoneId": "zoneUUID",
"apGroupId": "apGroupUUID",
"serial": "00000096",
"model": "ZF7962",
"name": "apName",
"version": "3.0.0.385",
"description": "apDescription",
"countryCode": "US",
"latitude": 22.3,
"longitude": 114,
"altitude": {
"altitudeUnit": "meters",
"altitudeValue": 33
},
"location": "location",
"locationAdditionalInfo": "locationAdditionalInfo",
"cpId": "controlPlaneUUID",
"dpId": "dataPlaneUUID",
"wifi24Channel": "2",
"wifi50Channel": "6",
"meshRole": "Map",
"meshHop": 2,
"ipType": "Static",
"ip": "1.1.1.1",
"ipv6Type": null,
"ipv6": null,
"externalIp": "172.18.11.11",
"externalPort": 675,
"configState": "newConfig",
"connectionState": "Connected",
"registrationState": "Approved",
"administrativeState": "Unlocked",
"provisionMethod": "Discovered",
"provisionStage": "Waiting for Registration",
"isCriticalAP": true,
"approvedTime": 111111,
"lastSeenTime": 111111,
"uptime": 111111,
"clientCount": 2
}Schema
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"mac" : {
"description" : "MAC address of the AP",
"type" : "string",
"pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
},
"zoneId" : {
"description" : "Identifier of the zone to which the AP belongs",
"type" : "string"
},
"apGroupId" : {
"description" : "Identifier of the AP group to which the AP belongs",
"type" : "string"
},
"serial" : {
"description" : "Serial number of the AP",
"type" : "string"
},
"model" : {
"description" : "Model name of the AP",
"type" : "string"
},
"name" : {
"description" : "Name of the AP",
"type" : "string",
"minLength" : 2,
"maxLength" : 64,
"pattern" : "^[!-~]((?!\$\()[ -_a-~]){0,62}[!-~]$"
},
"description" : {
"description" : "Description of the AP",
"type" : [ "string", "null" ],
"maxLength" : 64
},
"version" : {
"description" : "Firmware version of the AP",
"type" : "string",
"pattern" : "^\d+\.\d+\.\d+\.\d+\.\d+$"
},
"countryCode" : {
"description" : "Country code of the AP",
"type" : "string"
},
"latitude" : {
"description" : "Latitude coordinate (in decimal format) of the AP",
"type" : "number"
},
"longitude" : {
"description" : "Longitude coordinate (in decimal format) of the AP",
"type" : "number"
},
"location" : {
"description" : "Location of the AP. This is a text description that indicates the location of the AP.",
"type" : "string"
},
"locationAdditionalInfo" : {
"description" : "Location additional info of the AP. This is a text description that indicates the location additional info of the AP.",
"type" : "string",
"pattern" : "^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
},
"altitude" : {
"description" : "GPS Altitude.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"altitudeUnit" : {
"description" : "altitude unit",
"type" : "string",
"enum" : [ "meters", "floor" ],
"default" : "meters"
},
"altitudeValue" : {
"description" : "altitude value",
"type" : "integer"
}
}
},
"cpId" : {
"description" : "Identifier of the control plane to which the AP is currently connected",
"type" : "string"
},
"dpId" : {
"description" : "Identifier of the data plane to which the AP is currently connected",
"type" : "string"
},
"wifi24Channel" : {
"description" : "2.4GHz radio channel number that the AP is currently using",
"type" : "string"
},
"wifi50Channel" : {
"description" : "5GHZ radio channel number that the AP is currently using",
"type" : "string"
},
"meshRole" : {
"description" : "Mesh role of the AP",
"type" : "string",
"enum" : [ "Disabled", "Root", "Map", "eMap", "Down", "Undefined" ]
},
"meshHop" : {
"description" : "Number of mesh hops of the AP. This is only applicable to mesh APs.",
"type" : "integer"
},
"ipType" : {
"description" : "Indicates how the AP's IP address was obtained. The AP's IP address can be statically or dynamically assigned or kept unchanged.",
"type" : "string",
"enum" : [ "Static", "Dynamic", "Keep" ]
},
"ip" : {
"description" : "IP address of the AP",
"type" : "string"
},
"ipv6Type" : {
"description" : "Indicates how the AP's IP address was obtained. The AP's IP address can be statically or dynamically assigned or kept unchanged.",
"type" : "string",
"enum" : [ "Static", "Autoconfig", "Keep" ]
},
"ipv6" : {
"description" : "IP address of the AP",
"type" : "string"
},
"externalIp" : {
"description" : "External IP address of the AP. This is only applicable when the AP is behind a NAT server.",
"type" : "string"
},
"externalPort" : {
"description" : "External port number of the AP. This is only applicable when the AP is behind a NAT server.",
"type" : "integer"
},
"configState" : {
"description" : "State of the AP configuration.",
"type" : "string",
"enum" : [ "newConfig", "fwApplied", "fwDownloaded", "fwFailed", "configApplied", "completed", "configFailed" ]
},
"connectionState" : {
"description" : "Connection state of the AP (value: 'Discovery','Connect','Rebooting','Disconnect','Provisioned')",
"type" : "string"
},
"registrationState" : {
"description" : "Registration state of the AP",
"type" : "string"
},
"administrativeState" : {
"description" : "Administrative state of the AP. A locked AP will not provide any WLAN services.",
"type" : "string",
"enum" : [ "Locked", "Unlocked" ]
},
"provisionMethod" : {
"description" : "Provisioning method of the AP. Discovered indicates that the AP contacted the controller using discovery and the AP did not have pre-existing record on the controller. Preprovision indicates that the AP was provisioned to the controller before AP made the first contact. Swap indicates that the AP was provisioned to be a replacement of an existing AP.",
"type" : "string",
"enum" : [ "Discovered", "Preprovision", "Swap" ]
},
"provisionStage" : {
"description" : "Provisioning stage of the AP. This indicates the stage at which the AP is at in the provisioning process. (value: 'Waiting for Registration','Pre-Provision AP Joined','Waiting for Swap In;Waiting for registration','Waiting for Swap In;Swap In AP Joined','Swapped In;Waiting for registration','Swapped In','Waiting for Swap Out','Swapped Out','Waiting for Swap In, the other AP was deleted','Swapped In, the other AP was deleted','Waiting for Swap Out, the other AP was deleted','Swapped Out, the other AP was deleted')",
"type" : "string"
},
"isCriticalAP" : {
"description" : "Indicates critical APs. Critical AP are APs that were tagged by the controller based on predefined rules.",
"type" : "boolean"
},
"approvedTime" : {
"description" : "Timestamp when the AP was approved by the controller",
"type" : "integer"
},
"lastSeenTime" : {
"description" : "Timestamp of the last successful communication with the AP",
"type" : "integer"
},
"uptime" : {
"description" : "Uptime of the AP since it was last rebooted (unit:second)",
"type" : "integer"
},
"clientCount" : {
"description" : "Number of clients on the AP",
"type" : "integer"
},
"managementVlan" : {
"description" : "Management vlan on the AP",
"type" : "integer"
}
}
}Switchover AP ¶
POST/v8_0/aps/switchoverCluster
Use this API command to switchover AP to another cluster
Body
{
"ipOrFqdn": "172.18.11.11",
"apMacList": [
"01:02:03:11:12:A3",
"01:02:03:11:13:29",
"01:02:03:11:13:AF",
"01:02:03:11:14:35",
"01:02:03:11:14:BB"
],
"deleteRecord": false
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"ipOrFqdn": {
"description": "IP or FQDN address of destination cluster, Notice: Once this value been set, clusterName will be ignored.",
"type": "string"
},
"clusterName": {
"description": "Name of destination cluster, Notice: Once user has set ipOrFqdn, this value will be ignored.",
"type": "string"
},
"apMacList": {
"type": "array",
"description": "AP MAC address list",
"items": {
"type": "string",
"pattern": "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
}
},
"zoneIdList": {
"description": "Zone ID list for which APs attached to will be switchovered.",
"type": "array",
"items": {
"type": "string"
}
},
"deleteRecord": {
"description": "Flag to delete AP record after switchover cluster. Default value is false.",
"type": "boolean"
}
}
}204AP packet capture download ¶
POST/v8_0/aps/{apMac}/apPacketCapture/download
Use this API to download AP packet capture file
200AP packet capture ¶
GET/v8_0/aps/{apMac}/apPacketCapture
Use this API to get AP packet capture status
200Body
{
"apMac": "A1:B2:C3:D4:E5:F6",
"captureInterface": "ETH0",
"hostIp": "192.168.1.1",
"includedMac": "1A:2B:3C:4D:5E:6F",
"includedFrameTypes": [
"MANAGEMENT"
],
"captureMode": "STREAMING",
"captureState": "Streaming"
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"apMac": {
"type": "string",
"description": "AP MAC address"
},
"captureInterface": {
"type": "string",
"enum": [
"RADIO24",
"RADIO50",
"ETH0",
"ETH1",
"ETH2",
"ETH3",
"ETH4",
"ETH5",
"ETH6",
"ETH7"
],
"description": "Capture interface"
},
"hostIp": {
"type": "string",
"description": "Wireshark host IP"
},
"includedMac": {
"type": "string",
"description": "MAC filter"
},
"includedFrameTypes": {
"type": "array",
"items": {
"type": "string",
"enum": [
"CONTROL",
"DATA",
"MANAGEMENT"
]
},
"description": "Frame type filter"
},
"captureMode": {
"type": "string",
"enum": [
"STREAMING",
"FILE_CAPTURE"
],
"description": "Capture mode"
},
"captureState": {
"type": "string",
"description": "Capture state"
}
}
}AP packet capture startFileCapture ¶
POST/v8_0/aps/{apMac}/apPacketCapture/startFileCapture
Use this API to start AP packet capture
Body
{
"captureInterface": "RADIO50",
"hostIp": "192.168.1.1",
"includedMac": "1A:2B:3C:4D:5E:6F",
"includedFrameTypes": [
"CONTROL",
"DATA"
]
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"captureInterface": {
"type": "string",
"enum": [
"RADIO24",
"RADIO50",
"ETH0",
"ETH1",
"ETH2",
"ETH3",
"ETH4",
"ETH5",
"ETH6",
"ETH7"
],
"description": "Capture interface"
},
"hostIp": {
"type": "string",
"description": "Wireshark host IP"
},
"includedMac": {
"type": "string",
"description": "MAC filter"
},
"includedFrameTypes": {
"type": "array",
"items": {
"type": "string",
"enum": [
"CONTROL",
"DATA",
"MANAGEMENT"
]
},
"description": "Frame type filter"
}
},
"required": [
"captureInterface"
]
}200Body
{
"apMac": "A1:B2:C3:D4:E5:F6",
"captureInterface": "ETH0",
"hostIp": "192.168.1.1",
"includedMac": "1A:2B:3C:4D:5E:6F",
"includedFrameTypes": [
"MANAGEMENT"
],
"captureMode": "STREAMING",
"captureState": "Streaming"
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"apMac": {
"type": "string",
"description": "AP MAC address"
},
"captureInterface": {
"type": "string",
"enum": [
"RADIO24",
"RADIO50",
"ETH0",
"ETH1",
"ETH2",
"ETH3",
"ETH4",
"ETH5",
"ETH6",
"ETH7"
],
"description": "Capture interface"
},
"hostIp": {
"type": "string",
"description": "Wireshark host IP"
},
"includedMac": {
"type": "string",
"description": "MAC filter"
},
"includedFrameTypes": {
"type": "array",
"items": {
"type": "string",
"enum": [
"CONTROL",
"DATA",
"MANAGEMENT"
]
},
"description": "Frame type filter"
},
"captureMode": {
"type": "string",
"enum": [
"STREAMING",
"FILE_CAPTURE"
],
"description": "Capture mode"
},
"captureState": {
"type": "string",
"description": "Capture state"
}
}
}AP packet capture startStreaming ¶
POST/v8_0/aps/{apMac}/apPacketCapture/startStreaming
Use this API to start AP packet streaming
Body
{
"captureInterface": "RADIO50",
"hostIp": "192.168.1.1",
"includedMac": "1A:2B:3C:4D:5E:6F",
"includedFrameTypes": [
"CONTROL",
"DATA"
]
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"captureInterface": {
"type": "string",
"enum": [
"RADIO24",
"RADIO50",
"ETH0",
"ETH1",
"ETH2",
"ETH3",
"ETH4",
"ETH5",
"ETH6",
"ETH7"
],
"description": "Capture interface"
},
"hostIp": {
"type": "string",
"description": "Wireshark host IP"
},
"includedMac": {
"type": "string",
"description": "MAC filter"
},
"includedFrameTypes": {
"type": "array",
"items": {
"type": "string",
"enum": [
"CONTROL",
"DATA",
"MANAGEMENT"
]
},
"description": "Frame type filter"
}
},
"required": [
"captureInterface"
]
}200Body
{
"apMac": "A1:B2:C3:D4:E5:F6",
"captureInterface": "ETH0",
"hostIp": "192.168.1.1",
"includedMac": "1A:2B:3C:4D:5E:6F",
"includedFrameTypes": [
"MANAGEMENT"
],
"captureMode": "STREAMING",
"captureState": "Streaming"
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"apMac": {
"type": "string",
"description": "AP MAC address"
},
"captureInterface": {
"type": "string",
"enum": [
"RADIO24",
"RADIO50",
"ETH0",
"ETH1",
"ETH2",
"ETH3",
"ETH4",
"ETH5",
"ETH6",
"ETH7"
],
"description": "Capture interface"
},
"hostIp": {
"type": "string",
"description": "Wireshark host IP"
},
"includedMac": {
"type": "string",
"description": "MAC filter"
},
"includedFrameTypes": {
"type": "array",
"items": {
"type": "string",
"enum": [
"CONTROL",
"DATA",
"MANAGEMENT"
]
},
"description": "Frame type filter"
},
"captureMode": {
"type": "string",
"enum": [
"STREAMING",
"FILE_CAPTURE"
],
"description": "Capture mode"
},
"captureState": {
"type": "string",
"description": "Capture state"
}
}
}WLAN Group ¶
Retrieve List ¶
GET/v8_0/rkszones/{zoneId}/wlangroups
Use this API command to retrieve the list of WLAN groups within a zone.
- index
string(optional)The index of the first entry to be retrieved. Default: 0
- listSize
string(optional)The maximum number of entries to be retrieved. Default: 100
200Body
{
"totalCount": 2,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"id": "wlanGroupUUID",
"name": "wlanGroupName",
"description": "wlanGroupDescription",
"members": [
{
"id": "wlanID",
"accessVlan": 1,
"nasId": "nasId",
"vlanPooling": null
}
]
},
{
"id": "wlanGroupUUID2",
"zoneId": "zoneUUID",
"name": "wlanGroupName2",
"description": "wlanGroupDescription2",
"members": [
{
"id": "wlanID2",
"accessVlan": 1,
"nasId": "nasId",
"vlanPooling": null
}
]
}
]
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"totalCount": {
"type": "integer"
},
"hasMore": {
"type": "boolean"
},
"firstIndex": {
"type": "integer"
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the WLAN group",
"type": "string"
},
"zoneId": {
"description": "Identifier of the zone to which the WLAN group belongs",
"type": "string"
},
"name": {
"description": "Name of the WLAN group",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the WLAN group",
"type": [
"string",
"null"
],
"maxLength": 64
},
"members": {
"description": "Members of the WLAN group",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the WLAN",
"type": "string"
},
"accessVlan": {
"description": "Access VLAN",
"type": "integer",
"minimum": 1,
"maximum": 4094
},
"vlanPooling": {
"description": "Vlan pooling",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"nasId": {
"description": "NAS-ID",
"type": "string",
"maxLength": 63,
"pattern": "^([!-~]([ -~]){0,61}[!-~]|[!-~]{1,1})$"
}
},
"required": [
"id"
]
}
},
"createDateTime": {
"description": "Timestamp of being created",
"type": "integer"
},
"modifiedDateTime": {
"description": "Timestamp of being modified",
"type": "integer"
},
"creatorId": {
"description": "Creator ID",
"type": "string"
},
"modifierId": {
"description": "Modifier ID",
"type": "string"
},
"creatorUsername": {
"description": "Creator Name",
"type": "string"
},
"modifierUsername": {
"description": "Modifier Name",
"type": "string"
}
},
"required": [
"name"
]
}
}
}
}Create ¶
POST/v8_0/rkszones/{zoneId}/wlangroups
Use this API command to create a new WLAN group.
Body
{
"name": "wlanGroupName",
"description": "wlanGroupDescription"
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"description": "Name of the WLAN group",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the WLAN group",
"type": [
"string",
"null"
],
"maxLength": 64
}
},
"required": [
"name"
]
}201Body
{
"id": "wlanGroupUUID"
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
}
}
}Retrieve ¶
GET/v8_0/rkszones/{zoneId}/wlangroups/{id}
Use this API command to retrieve the WLAN group.
200Body
{
"id": "wlanGroupUUID2",
"zoneId": "zoneUUID",
"name": "wlanGroupName2",
"description": "wlanGroupDescription2",
"members": [
{
"id": "wlanID2",
"accessVlan": 1,
"nasId": "nasId",
"vlanPooling": null
}
]
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the WLAN group",
"type": "string"
},
"zoneId": {
"description": "Identifier of the zone to which the WLAN group belongs",
"type": "string"
},
"name": {
"description": "Name of the WLAN group",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the WLAN group",
"type": [
"string",
"null"
],
"maxLength": 64
},
"members": {
"description": "Members of the WLAN group",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the WLAN",
"type": "string"
},
"accessVlan": {
"description": "Access VLAN",
"type": "integer",
"minimum": 1,
"maximum": 4094
},
"vlanPooling": {
"description": "Vlan pooling",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"nasId": {
"description": "NAS-ID",
"type": "string",
"maxLength": 63,
"pattern": "^([!-~]([ -~]){0,61}[!-~]|[!-~]{1,1})$"
}
},
"required": [
"id"
]
}
},
"createDateTime": {
"description": "Timestamp of being created",
"type": "integer"
},
"modifiedDateTime": {
"description": "Timestamp of being modified",
"type": "integer"
},
"creatorId": {
"description": "Creator ID",
"type": "string"
},
"modifierId": {
"description": "Modifier ID",
"type": "string"
},
"creatorUsername": {
"description": "Creator Name",
"type": "string"
},
"modifierUsername": {
"description": "Modifier Name",
"type": "string"
}
},
"required": [
"name"
]
}Delete ¶
DELETE/v8_0/rkszones/{zoneId}/wlangroups/{id}
Use this API command to delete a WLAN group.
204Modify ¶
PATCH/v8_0/rkszones/{zoneId}/wlangroups/{id}
Use this API command to modify the basic information of a WLAN group.
Body
{
"name": "wlanGroupNameModified",
"description": "wlanGroupDescriptionModified"
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"description": "Name of the WLAN group",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the WLAN group",
"type": [
"string",
"null"
],
"maxLength": 64
}
}
}204Add Member ¶
POST/v8_0/rkszones/{zoneId}/wlangroups/{id}/members
Use this API command to add a member to a WLAN group.
Body
{
"id": "wlanID",
"accessVlan": 1
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the WLAN",
"type": "string"
},
"accessVlan": {
"description": "Access VLAN",
"type": "integer",
"minimum": 1,
"maximum": 4094
},
"vlanPooling": {
"description": "Vlan pooling",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"nasId": {
"description": "NAS-ID",
"type": "string",
"maxLength": 63,
"pattern": "^([!-~]([ -~]){0,61}[!-~]|[!-~]{1,1})$"
}
},
"required": [
"id"
]
}201Modify Member ¶
PATCH/v8_0/rkszones/{zoneId}/wlangroups/{id}/members/{memberId}
Use this API command to modify a member of a WLAN group.
Body
{
"accessVlan": 23,
"nasId": "nasId",
"vlanPooling": {
"id": "a61997e0-699b-11e4-b9bb-08002716c79f",
"name": "zoneVlanPooling"
}
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"accessVlan": {
"description": "Access VLAN",
"type": "integer",
"minimum": 1,
"maximum": 4094
},
"vlanPooling": {
"description": "Vlan pooling",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"nasId": {
"description": "NAS-ID",
"type": "string",
"maxLength": 63,
"pattern": "^([!-~]([ -~]){0,61}[!-~]|[!-~]{1,1})$"
}
}
}204Modify Member VLAN Pooling ¶
PATCH/v8_0/rkszones/{zoneId}/wlangroups/{id}/members/{memberId}/vlanPooling
Use this API command to modify a member’s VLAN pooling of a WLAN group.
Body
{
"id": "a61997e0-699b-11e4-b9bb-08002716c79f",
"name": "zoneVlanPooling"
}Schema
{
"description": "Vlan pooling",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}204Disable Member VLAN Override ¶
DELETE/v8_0/rkszones/{zoneId}/wlangroups/{id}/members/{memberId}/vlanOverride
Use this API command to disable a member VLAN override of a WLAN group.
204WLAN ¶
Retrieve List ¶
GET/v8_0/rkszones/{zoneId}/wlans
Use this API command to retrieve a list of WLANs within a zone.
- index
string(optional)The index of the first entry to be retrieved. Default: 0
- listSize
string(optional)The maximum number of entries to be retrieved. Default: 100
200Body
{
"totalCount": 2,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"id": "1028",
"mvnoId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"zoneId": "11111111-2222-3333-4444-555555555555",
"name": "wlan2",
"ssid": "wlan2"
},
{
"id": "1027",
"mvnoId": "bbbbbbbb-bbbb-cccc-dddd-eeeeeeeeeeee",
"zoneId": "22222222-2222-3333-4444-555555555555",
"name": "wlan1",
"ssid": "wlan1"
}
]
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"totalCount": {
"type": "integer"
},
"hasMore": {
"type": "boolean"
},
"firstIndex": {
"type": "integer"
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the WLAN",
"type": "string"
},
"mvnoId": {
"description": "Tenant UUID",
"type": "string"
},
"zoneId": {
"description": "Zone ID",
"type": "string"
},
"name": {
"description": "Name of the WLAN",
"type": "string"
},
"ssid": {
"description": "SSID of the WLAN",
"type": "string"
}
}
}
}
}
}Create - Standard Open ¶
POST/v8_0/rkszones/{zoneId}/wlans
Use this API command to create a new standard, open and non-tunneled basic WLAN.
Body
{
"name": "wlanName",
"ssid": "wlanSSID",
"description": "wlanDescription",
"accessTunnelType": "RuckusGRE",
"accessTunnelProfile": {
"id": "f5b92938-aa4e-4d02-90ea-273799ff689b",
"name": "Default Tunnel Profile"
},
"accessIpsecProfile": null,
"splitTunnelProfileId": "38119bac-49e1-4410-ab8e-1c1bc88dd770",
"coreTunnelProfile": {
"type": "Bridge",
"id": "forwardingUUID",
"name": "forwardingName"
},
"encryption": {
"method": "WPA2",
"algorithm": "AES",
"passphrase": "password",
"mfp": "disabled",
"support80211rEnabled": true,
"mobilityDomainId": 3
},
"operatorRealm": "operator realm",
"defaultUserTrafficProfile": {
"id": "userTrafficUUID",
"name": "userTrafficName"
},
"precedenceProfileId": "c514d450-c839-9527-afc9-525400d12345",
"portalDetectionProfileId": "de0fa30c-9565-11e8-9eb6-529269fb1459",
"schedule": {
"type": "Customized",
"id": "ServiceUUID",
"name": "ServiceName"
},
"vlan": {
"accessVlan": 23,
"coreQinQEnabled": false,
"coreSVlan": 1,
"vlanPooling": null
},
"l2ACL": {
"id": "l2ACLUUID",
"name": "l2ACLName"
},
"devicePolicy": {
"id": "devicePolicyUUID",
"name": "devicePolicyName"
},
"radiusOptions": {
"nasIdType": "Customized",
"customizedNasId": "nasId",
"nasRequestTimeoutSec": 12,
"nasMaxRetry": 3,
"nasReconnectPrimaryMin": 30,
"calledStaIdType": "WLAN_BSSID",
"nasIpType": "disabled",
"nasIpUserDefined": "192.168.1.1"
},
"advancedOptions": {
"clientIsolationEnabled": true,
"clientIsolationUnicastEnabled": true,
"clientIsolationMulticastEnabled": false,
"clientIsolationAutoVrrpEnabled": false,
"clientIsolationWhitelist": {
"id": "b89323e1-3168-11e7-b027-5254009ae3f0",
"name": "myWhitelist"
},
"priority": "High",
"hideSsidEnabled": true,
"maxClientsPerRadio": 12,
"clientIdleTimeoutSec": 60,
"clientLoadBalancingEnabled": true,
"proxyARPEnabled": true,
"ndProxyEnabled": false,
"suppressNsEnabled": false,
"raProxyEnabled": false,
"rsraGuardEnabled": false,
"raThrottlingEnabled": false,
"maxAllowedRA": 10,
"raInterval": 10,
"support80211dEnabled": false,
"support80211kEnabled": true,
"antiSpoofingEnabled": true,
"arpRequestRateLimit": 15,
"dhcpRequestRateLimit": 15,
"forceClientDHCPTimeoutSec": 5,
"dhcpOption82Enabled": true,
"dhcp82Format": "RUCKUS_DEFAULT",
"unauthClientStatsEnabled": false,
"clientFingerprintingEnabled": true,
"ofdmOnlyEnabled": false,
"bandBalancing": "UseZoneSetting",
"bssMinRateMbps": "Disable",
"mgmtTxRateMbps": "2 mbps",
"avcEnabled": true,
"uplinkEnabled": true,
"uplinkRate": 100,
"downlinkEnabled": true,
"downlinkRate": 200,
"ratePerSTAUplink": "650mbps",
"ratePerSTADownlink": "1mbps",
"urlFilteringPolicyEnabled": true,
"urlFilteringPolicyId": "eabd4fa0-5015-11e7-84d0-525400a0e6c5",
"wifiCallingPolicyEnabled": true,
"wifiCallingPolicyIds": [
"75e26590-547f-11e6-9ca7-5a095364c13c",
"869bb532-547f-11e6-9ca7-5a095364c13c"
],
"hdOverheadOptimizeEnable": false,
"probeRssiThr": -85,
"transientClientMgmtEnable": true,
"joinIgnoreTimeout": 30,
"joinAcceptTimeout": 300,
"joinIgnoreThr": 10,
"authRssiThr": -85,
"assocRssiThr": -85
},
"diffServProfile": {
"id": "diffServId",
"name": "diffServName"
},
"qosMaps": [
{
"enable": true,
"priority": 0,
"low": 0,
"high": 7,
"excepts": null
},
{
"enable": true,
"priority": 1,
"low": 8,
"high": 15,
"excepts": null
},
{
"enable": true,
"priority": 2,
"low": 16,
"high": 23,
"excepts": null
},
{
"enable": true,
"priority": 3,
"low": 0,
"high": 32,
"excepts": [
43,
45,
60
]
},
{
"enable": true,
"priority": 4,
"low": 32,
"high": 39,
"excepts": null
},
{
"enable": true,
"priority": 5,
"low": 40,
"high": 47,
"excepts": null
},
{
"enable": true,
"priority": 6,
"low": 48,
"high": 55,
"excepts": [
46
]
},
{
"enable": true,
"priority": 7,
"low": 56,
"high": 63,
"excepts": null
}
],
"dnsServerProfile": {
"id": "DNS server profile UUID",
"name": "DNS server profile name"
},
"dpsk": {
"dpskEnabled": true,
"length": 8,
"dpskType": "Secure",
"expiration": "OneDay",
"dpskFromType": "FirstUse"
},
"externalDpsk": {
"enabled": false,
"encryption": {
"method": "None"
}
}
}Schema
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"name" : {
"description" : "Name of the WLAN",
"type" : "string",
"minLength" : 1,
"maxLength" : 32
},
"ssid" : {
"description" : "SSID of the WLAN",
"type" : "string",
"minLength" : 1,
"maxLength" : 32
},
"hessid" : {
"description" : "HESSID of the WLAN",
"type" : "string",
"pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$"
},
"description" : {
"description" : "Description of the WLAN",
"type" : [ "string", "null" ],
"maxLength" : 64
},
"caleaEnabled" : {
"description" : "DP CALEA Server Enabled",
"type" : "boolean"
},
"dpTunnelNatEnabled" : {
"description" : "DP Tunnel NAT Enabled",
"type" : "boolean"
},
"dpTunnelDhcpEnabled" : {
"description" : "DP Tunnel DHCP Enabled",
"type" : "boolean"
},
"awsExtNasIPEnable" : {
"description" : "Aws ExtNasIP Enable",
"type" : "boolean"
},
"awsVenueEnable" : {
"description" : "Aws Venue Enable",
"type" : "boolean"
},
"accessTunnelType" : {
"description" : "Access tunnel type of the WLAN. APLBO means AP local breakout, RuckusGRE means RuckusGRE tunnel to the data plane, and SoftGRE means AP direct SoftGRE tunnel",
"type" : "string",
"enum" : [ "APLBO", "RuckusGRE", "SoftGRE" ],
"default" : "APLBO"
},
"coreTunnelProfile" : {
"description" : "Core tunnel of the WLAN. This only applies when the access tunnel type is set to RuckusGRE.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"type" : {
"description" : "Tunnel type",
"type" : "string",
"enum" : [ "Bridge", "L2oGRE", "TTG_PDG", "Mixed" ]
},
"id" : {
"description" : "Identifier of the forwarding profile. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the forwarding profile. At least one ID or name is required in the request.",
"type" : "string"
},
"operatorRealm" : {
"description" : "Operator realm, deprecated coreTunnelProfile.operatorRealm from version3.1, prepare remove",
"type" : "string",
"maxLength" : 255,
"pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
}
},
"required" : [ "type" ]
},
"macAuth" : {
"description" : "MAC address authentication settings of the WLAN. This only applies to standard MAC and Hotspot MAC bypass WLAN.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"macAuthMacFormat" : {
"description" : "MAC address format. The default format is 0010a42319c0 and the 802.1X format is 00-10-A4-23-19-C0.",
"type" : "string",
"enum" : [ "Default", "802.1X", "UpperColon", "Upper", "LowerDash", "LowerColon" ]
},
"customizedPassword" : {
"description" : "User defined password. When this field is set to an empty string, the MAC address is used as password.",
"type" : "string",
"maxLength" : 64,
"pattern" : "^([!-;=?-~]([ -;=?-~]){0,62}[!-;=?-~]|[!-;=?-~]{1,1}|\s{0,0})$"
}
}
},
"encryption" : {
"description" : "Encryption of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"method" : {
"description" : "Encryption method",
"type" : "string",
"enum" : [ "WPA2", "WPA_Mixed", "WEP_64", "WEP_128", "None" ],
"default" : "None"
},
"algorithm" : {
"description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
"type" : "string",
"enum" : [ "AES", "TKIP_AES" ]
},
"passphrase" : {
"description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
"type" : "string"
},
"mfp" : {
"description" : "Management frame protection. This only applies to WPA2 + AES",
"type" : "string",
"enum" : [ "disabled", "capable", "required" ]
},
"keyIndex" : {
"description" : "Key index. This only applies to WEP64 and WEP128.",
"type" : "integer"
},
"keyInHex" : {
"description" : "Key in hex format. This only applies to WEP64 and WEP128.",
"type" : "string"
},
"support80211rEnabled" : {
"description" : "Enable 802.11r Fast BSS Transition, fast Romaing.",
"type" : "boolean"
},
"mobilityDomainId" : {
"description" : "mobility Domain Id.",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
}
},
"required" : [ "method" ]
},
"authServiceOrProfile" : {
"description" : "Authentication of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"throughController" : {
"description" : "Indicates whether authentication messages were sent through the controller or not",
"type" : "boolean"
},
"realmBasedAuth" : {
"type" : "boolean"
},
"id" : {
"description" : "Identifier of the authentication service or profile. At least one ID or name or authenticationOption is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the authentication service or profile. At least one ID or name or authenticationOption is required in the request. Or could input the 'Always Accept' or 'Local DB'.",
"type" : "string"
},
"authenticationOption" : {
"description" : "Option of the authentication service or profile, At least one ID or name or authenticationOption is required in the request. This only applies to hotspot and guest WLANs.",
"type" : [ "string", "null" ],
"enum" : [ "Local DB", "Guest", "Always Accept", null ]
},
"locationDeliveryEnabled" : {
"description" : "RFC5580 location delivery support",
"type" : "boolean"
},
"backupAuthenticationId" : {
"description" : "Identifier of the backup authentication service or profile. At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service.",
"type" : "string"
},
"backupAuthenticationName" : {
"description" : "Name of the backup authentication service or profile. At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service. Or could input the 'Always Accept'.",
"type" : "string"
},
"backupAuthenticationOption" : {
"description" : "Option of the backup authentication service or profile, At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service. This only applies to hotspot WLANs.",
"type" : [ "string", "null" ],
"enum" : [ "Always Accept", null ]
}
}
},
"operatorRealm" : {
"description" : "Operator realm, operatorRealm only supports coreTunnelProfile type is authServiceOrProfile.locationDeliveryEnabled is true",
"type" : "string",
"maxLength" : 255,
"pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
},
"accountingServiceOrProfile" : {
"description" : "Accounting of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"throughController" : {
"description" : "Indicates whether accounting messages were sent through the controller",
"type" : "boolean"
},
"realmBasedAcct" : {
"type" : "boolean"
},
"id" : {
"description" : "Accounting service or profile ID. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Accounting service or profile name. At least one ID or name is required in the request.",
"type" : "string"
},
"interimUpdateMin" : {
"description" : "Interval (in minutes) for sending interim updates",
"type" : "integer",
"minimum" : 0,
"maximum" : 1440
},
"accountingDelayEnabled" : {
"description" : "Indicates whether accounting delay time is enabled",
"type" : "boolean"
},
"accountingTTGSessionEnabled" : {
"description" : "Indicates whether accounting for TTG sessions is to enabled",
"type" : "boolean"
},
"backupAccountingId" : {
"description" : "Backup accounting service or profile ID. At least one backupAccountingId or backupAccountingName is required in the request when setting backup accounting service.",
"type" : "string"
},
"backupAccountingName" : {
"description" : "Backup accounting service or profile name. At least one backupAccountingId or backupAccountingName is required in the request when setting backup accounting service.",
"type" : "string"
}
}
},
"portalServiceProfile" : {
"description" : "Portal service of the WLAN. This only applies to hotspot, hotspot MAC bypass, guest and web auth WLANs.",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"hotspot20Profile" : {
"description" : "Hotspot 2.0 operator profile of the WLAN. id or name of the hotspot 2.0 operator profiles within the zone is required.",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"defaultUserTrafficProfile" : {
"description" : "User traffic profile of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"precedenceProfileId" : {
"description" : "Precedence profile of the WLAN",
"type" : "string"
},
"flexiVpnProfile" : {
"description" : "Flexi-VPN profile of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"wlanId" : {
"type" : "string",
"description" : "Wlan ID"
},
"zoneAffinityId" : {
"type" : "string",
"description" : "Zone Affinity ID"
}
},
"required" : [ "zoneAffinityId" ]
},
"schedule" : {
"description" : "Schedule of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"type" : {
"description" : "Type of WLAN schedule",
"type" : "string",
"enum" : [ "AlwaysOn", "AlwaysOff", "Customized" ],
"default" : "AlwaysOn"
},
"id" : {
"description" : "Identifier of the schedule profile. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the schedule profile. At least one ID or name is required in the request.",
"type" : "string"
}
},
"required" : [ "type" ]
},
"vlan" : {
"description" : "VLAN (access and/or core) of the WLAN.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"accessVlan" : {
"description" : "Access VLAN ID",
"type" : "integer",
"minimum" : 1,
"maximum" : 4094,
"default" : 1
},
"aaaVlanOverride" : {
"description" : "Indicates whether the AAA VLAN settings can be overriden or not",
"type" : "boolean"
},
"coreQinQEnabled" : {
"description" : "Indicates whether Q-in-Q is allowed at the core network or not",
"type" : "boolean"
},
"coreSVlan" : {
"description" : "Core SVLAN ID. This only applies when core Q-in-Q is enabled",
"type" : "integer",
"minimum" : 1,
"maximum" : 4094
},
"vlanPooling" : {
"description" : "Vlan pooling",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
}
}
},
"l2ACL" : {
"description" : "Layer 2 ACL of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"devicePolicy" : {
"description" : "Device policy of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"radiusOptions" : {
"description" : "RADIUS options of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"nasIdType" : {
"description" : "NAS ID type",
"type" : "string",
"enum" : [ "WLAN_BSSID", "AP_MAC", "Customized" ],
"default" : "WLAN_BSSID"
},
"customizedNasId" : {
"description" : "User defined NAS ID",
"type" : "string",
"maxLength" : 64,
"pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$"
},
"nasRequestTimeoutSec" : {
"description" : "NAS request timeout in seconds",
"type" : "integer",
"default" : 3,
"minimum" : 2,
"maximum" : 20
},
"nasMaxRetry" : {
"description" : "NAS request maximum retry",
"type" : "integer",
"default" : 2,
"minimum" : 2,
"maximum" : 10
},
"nasReconnectPrimaryMin" : {
"description" : "NAS reconnect primary time in minutes",
"type" : "integer",
"default" : 5,
"minimum" : 1,
"maximum" : 60
},
"calledStaIdType" : {
"description" : "Called station ID type",
"type" : "string",
"enum" : [ "WLAN_BSSID", "AP_MAC", "NONE" ],
"default" : "WLAN_BSSID"
},
"nasIpType" : {
"description" : "NAS IP type",
"type" : "string",
"enum" : [ "disabled", "control", "management", "userDefined" ],
"default" : "disabled"
},
"nasIpUserDefined" : {
"description" : "User-defined NAS IP",
"type" : "string",
"maxLength" : 45
},
"singleSessionIdAcctEnabled" : {
"description" : "When Single Accounting Session ID is enabled, APs will maintain one accounting session for client roaming",
"type" : "boolean",
"default" : false
}
}
},
"advancedOptions" : {
"description" : "Advanced settings for the WLAN.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"clientIsolationEnabled" : {
"description" : "Indicates whether wireless client isolation is enabled or disabled",
"type" : "boolean",
"default" : false
},
"clientIsolationUnicastEnabled" : {
"description" : "Indicates whether isolate unicast of wireless client isolation is enabled or disabled",
"type" : "boolean",
"default" : true
},
"clientIsolationMulticastEnabled" : {
"description" : "Indicates whether isolate multicast of wireless client isolation is enabled or disabled",
"type" : "boolean"
},
"clientIsolationAutoVrrpEnabled" : {
"description" : "Indicates whether Automatic support for VRRP of wireless client isolation is enabled or disabled",
"type" : "boolean",
"default" : false
},
"clientIsolationWhitelist" : {
"description" : "Indicates wireless client isolation whitelist",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"priority" : {
"description" : "Priority of the WLAN",
"type" : "string",
"enum" : [ "High", "Low" ],
"default" : "High"
},
"hideSsidEnabled" : {
"description" : "Indicates whether the SSID is hidden or broadcast",
"type" : "boolean",
"default" : false
},
"hs20Onboarding" : {
"description" : "Allow WISPr WLAN for Hotspot 2.0 Onboarding",
"type" : "boolean",
"default" : false
},
"maxClientsPerRadio" : {
"description" : "Maximum number of clients per radio",
"type" : "integer",
"default" : 100,
"minimum" : 1,
"maximum" : 512
},
"clientIdleTimeoutSec" : {
"description" : "Client idle timeout in seconds",
"type" : "integer",
"minimum" : 60,
"maximum" : 1000,
"default" : 120
},
"dgafEnabled" : {
"description" : "Indicates whether dgaf is enabled or disabled",
"type" : "boolean"
},
"clientLoadBalancingEnabled" : {
"description" : "Indicates whether Client Load Balancing is enabled or disabled",
"type" : "boolean",
"default" : true
},
"proxyARPEnabled" : {
"description" : "Indicates whether proxy ARP is enabled or disabled",
"type" : "boolean",
"default" : false
},
"ndProxyEnabled" : {
"description" : "Indicates whether ND Proxy is enabled or disabled",
"type" : "boolean",
"default" : false
},
"suppressNsEnabled" : {
"description" : "Indicates whether supperssNS is enabled or disabled",
"type" : "boolean",
"default" : false
},
"raProxyEnabled" : {
"description" : "Indicates whether RA proxy is enabled or disabled",
"type" : "boolean",
"default" : false
},
"rsraGuardEnabled" : {
"description" : "Indicates whether RS/RA Guard is enabled or disabled",
"type" : "boolean",
"default" : false
},
"raThrottlingEnabled" : {
"description" : "Indicates whether RA Throttling is enabled or disabled",
"type" : "boolean",
"default" : false
},
"maxAllowedRA" : {
"description" : "Max Allowed RAs",
"type" : "integer",
"minimum" : 1,
"maximum" : 1440,
"default" : 10
},
"raInterval" : {
"description" : "A timer that RA proxy runs and once receives unsolicited RA checks against the configured time and allow/drop RA based on next timeout",
"type" : "integer",
"minimum" : 1,
"maximum" : 256,
"default" : 10
},
"support80211dEnabled" : {
"description" : "Indicates whether support for 802.11d is enabled or disabled",
"type" : "boolean",
"default" : true
},
"support80211kEnabled" : {
"description" : "Indicates whether support for 802.11k is enabled or disabled",
"type" : "boolean",
"default" : true
},
"antiSpoofingEnabled" : {
"description" : "Anti-Spoofing enabled",
"type" : "boolean",
"default" : false
},
"arpRequestRateLimit" : {
"description" : "ARP packets request rate limit, default value will be 15 if both rate limit not being set.",
"type" : "integer",
"minimum" : 0,
"maximum" : 100
},
"dhcpRequestRateLimit" : {
"description" : "DHCP packets request rate limit, default value will be 15 if both rate limit not being set.",
"type" : "integer",
"minimum" : 0,
"maximum" : 100
},
"forceClientDHCPTimeoutSec" : {
"description" : "Force DHCP disconnects the client if the client does not obtain a valid IP address within the timeout peroid. To disable force DHCP, set this value to zero (0).",
"type" : "integer",
"enum" : [ 0, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15 ],
"default" : 0
},
"dhcpOption82Enabled" : {
"description" : "Indicates whether DCHP Option 82 is enabled or disabled",
"type" : "boolean",
"default" : false
},
"dhcp82Format" : {
"description" : "DHCP Option 82 format",
"type" : "string",
"enum" : [ "RUCKUS_DEFAULT", "SOFTGRE_CUSTOMIZED" ]
},
"unauthClientStatsEnabled" : {
"description" : "Indicates whether to send statistics of unauthorized clients or not",
"type" : "boolean",
"default" : false
},
"clientFingerprintingEnabled" : {
"description" : "Indicates whether client fingerprinting is enabled or disabled",
"type" : "boolean",
"default" : false
},
"ofdmOnlyEnabled" : {
"description" : "Indicates whether OFDM only is enabled or disabled",
"type" : "boolean",
"default" : false
},
"bandBalancing" : {
"description" : "Indicates whether band balancing is enabled or disabled",
"type" : "string",
"enum" : [ "Disabled", "UseZoneSetting" ],
"default" : "UseZoneSetting"
},
"bssMinRateMbps" : {
"description" : "BSS minimum rate (mbps)",
"type" : "string",
"enum" : [ "Disable", "1 mbps", "2 mbps", "5.5 mbps", "12 mbps", "24 mbps" ],
"default" : "Disable"
},
"mgmtTxRateMbps" : {
"description" : "Management TX rate (mbps)",
"type" : "string",
"enum" : [ "1 mbps", "2 mbps", "5.5 mbps", "6 mbps", "9 mbps", "11 mbps", "12 mbps", "18 mbps", "24 mbps", "36 mbps", "48 mbps", "54 mbps" ],
"default" : "2 mbps"
},
"pmkCachingEnabled" : {
"description" : "Indicator of whether PKM caching support is enabled or disabled. The default value is true when the WLAN is WPA+AES non open WLAN.",
"type" : "boolean"
},
"okcEnabled" : {
"description" : "Indicator of whether OKC support is enabled or disabled. The default value is true when the WLAN is WPA+AES non open WLAN.",
"type" : "boolean"
},
"avcEnabled" : {
"description" : "Indicator of whether ARC support is enabled or disabled",
"type" : "boolean",
"default" : false
},
"urlFilteringPolicyEnabled" : {
"description" : "Indicator of whether URL Filtering is enabled or disabled",
"type" : "boolean",
"default" : false
},
"urlFilteringPolicyId" : {
"description" : "The URL Filtering policy ID.",
"type" : "string"
},
"wifiCallingPolicyEnabled" : {
"description" : "Indicator of whether Wi-Fi Calling is enabled or disabled",
"type" : "boolean",
"default" : false
},
"wifiCallingPolicyIds" : {
"description" : "The Wi-Fi Calling policy IDs. (Maximum allowed number is 5)",
"type" : "array",
"items" : {
"type" : "string"
}
},
"uplinkEnabled" : {
"description" : "SSID Rate Limiting uplink enabled.",
"type" : "boolean",
"default" : false
},
"uplinkRate" : {
"description" : "SSID Rate Limiting uplink.",
"type" : "number",
"default" : 0.0
},
"downlinkEnabled" : {
"description" : "SSID Rate Limiting downlink enabled.",
"type" : "boolean",
"default" : false
},
"downlinkRate" : {
"description" : "SSID Rate Limiting downlink.",
"type" : "number",
"default" : 0.0
},
"ratePerSTAUplink" : {
"description" : "UE Rate Limiting uplink.",
"type" : "string"
},
"ratePerSTADownlink" : {
"description" : "UE Rate Limiting downlink.",
"type" : "string"
},
"dtimInterval" : {
"description" : "DTIM Interval",
"type" : "integer",
"minimum" : 1,
"maximum" : 255,
"default" : 1
},
"directedThreshold" : {
"description" : "Directed Threshold Setting, Defines the client count at which an AP will stop converting group addressed data traffic to unicast.",
"type" : "integer",
"minimum" : 0,
"maximum" : 128,
"default" : 5
},
"flowLogEnabled" : {
"description" : "Flow log enabled.",
"type" : "boolean",
"default" : false
},
"hdOverheadOptimizeEnable" : {
"description" : "Airtime decongestion enabled.",
"type" : "boolean",
"default" : false
},
"probeRssiThr" : {
"type" : "integer",
"description" : "Join RSSI threshold.",
"minimum" : -90,
"maximum" : -60,
"default" : -85
},
"transientClientMgmtEnable" : {
"description" : "Transient Client Management enabled.",
"type" : "boolean",
"default" : false
},
"joinIgnoreTimeout" : {
"description" : "Join wait time.",
"type" : "integer",
"minimum" : 1,
"maximum" : 60,
"default" : 30
},
"joinAcceptTimeout" : {
"description" : "Join expire time.",
"type" : "integer",
"minimum" : 1,
"maximum" : 300,
"default" : 300
},
"joinIgnoreThr" : {
"description" : "Join wait threshold.",
"type" : "integer",
"minimum" : 1,
"maximum" : 50,
"default" : 10
},
"authRssiThr" : {
"description" : "Auth RSSI threshold.",
"type" : "integer",
"minimum" : -90,
"maximum" : -60
},
"assocRssiThr" : {
"description" : "Assoc RSSI threshold.",
"type" : "integer",
"minimum" : -90,
"maximum" : -60
},
"oceEnabled" : {
"description" : "Optimized Connectivity Experience(OCE) enabled.",
"type" : "boolean",
"default" : false
},
"oceBroadcastProbeResponseDelay" : {
"description" : "Broadcast probe response delay.",
"type" : "integer",
"minimum" : 8,
"maximum" : 120,
"default" : 15
},
"oceRssiBasedAssociationRejectionThreshold" : {
"description" : "RSSI-based association rejection threshold.",
"type" : "integer",
"minimum" : -90,
"maximum" : -60,
"default" : -75
}
}
},
"diffServProfile" : {
"description" : "DiffServ profile of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"qosMaps" : {
"description" : "Qos map set of the WLAN.",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"enable" : {
"description" : "Enabled or disabled",
"type" : "boolean"
},
"priority" : {
"description" : "Priority",
"type" : "integer"
},
"low" : {
"description" : "DSCP range - low",
"type" : [ "integer", "null" ],
"minimum" : 0,
"maximum" : 255
},
"high" : {
"description" : "DSCP range - high",
"type" : [ "integer", "null" ],
"minimum" : 0,
"maximum" : 255
},
"excepts" : {
"type" : [ "array", "null" ],
"items" : {
"type" : "integer",
"minimum" : 0,
"maximum" : 63
}
}
},
"required" : [ "enable", "priority" ]
}
},
"dpsk" : {
"description" : "DPSK Setting",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"dpskEnabled" : {
"description" : "DPSK enabled",
"type" : "boolean",
"default" : false
},
"length" : {
"description" : "Length of DPSK key",
"type" : "integer",
"default" : 62
},
"dpskType" : {
"description" : "Type of DPSK key",
"type" : "string",
"enum" : [ "Secure", "KeyboardFriendly", "NumbersOnly" ],
"default" : "Secure"
},
"expiration" : {
"description" : "Expiration of DPSK key",
"type" : "string",
"enum" : [ "Unlimited", "OneDay", "TwoDays", "OneWeek", "TwoWeeks", "OneMonth", "SixMonths", "OneYear", "TwoYears" ],
"default" : "Unlimited"
},
"dpskFromType" : {
"description" : "Type of expiration start from",
"type" : "string",
"enum" : [ "CreateTime", "FirstUse" ],
"default" : "CreateTime"
}
}
},
"externalDpsk" : {
"description" : "External DPSK Enabled",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"enabled" : {
"description" : "Enable External DPSK",
"type" : "boolean",
"default" : false
},
"encryption" : {
"description" : "Encryption of the WLAN relate to external DPSK",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"method" : {
"description" : "Encryption method",
"type" : "string",
"enum" : [ "WPA2", "WPA_Mixed", "None" ]
},
"algorithm" : {
"description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
"type" : "string",
"enum" : [ "AES", "TKIP_AES" ]
}
}
},
"authService" : {
"description" : "Autentication of the WLAN relate to external DPSK",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Identifier of the authentication service. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the authentication service. At least one ID or name is required in the request.",
"type" : "string"
}
}
}
},
"required" : [ "enabled" ]
},
"dnsServerProfile" : {
"description" : "DNS server profile of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"accessTunnelProfile" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"accessIpsecProfile" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"splitTunnelProfileId" : {
"type" : "string"
},
"portalDetectionProfileId" : {
"type" : "string"
}
},
"required" : [ "name", "ssid" ]
}201Body
{
"id": "wlanID"
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
}
}
}Create - 802.1X ¶
POST/v8_0/rkszones/{zoneId}/wlans/standard8021X
Use this API command to create a new standard, 802.1X and non-tunneled WLAN.
Body
{
"name": "wlanName",
"ssid": "wlanSSID",
"description": "wlanDescription",
"authServiceOrProfile": {
"throughController": false,
"id": "authServiceUUID",
"name": "authServiceName",
"authenticationOption": null
},
"accessTunnelType": "RuckusGRE",
"accessTunnelProfile": {
"id": "f5b92938-aa4e-4d02-90ea-273799ff689b",
"name": "Default Tunnel Profile"
},
"splitTunnelProfileId": "38119bac-49e1-4410-ab8e-1c1bc88dd770",
"coreTunnelProfile": {
"type": "Bridge",
"id": "forwardingUUID",
"name": "forwardingName"
},
"encryption": {
"method": "WPA2",
"algorithm": "AES",
"mfp": "disabled",
"support80211rEnabled": true,
"mobilityDomainId": 3
},
"operatorRealm": "operator realm",
"defaultUserTrafficProfile": {
"id": "userTrafficUUID",
"name": "userTrafficName"
},
"precedenceProfileId": "c514d450-c839-9527-afc9-525400d12345",
"portalDetectionProfileId": "de0fa30c-9565-11e8-9eb6-529269fb1459",
"schedule": {
"type": "Customized",
"id": "ServiceUUID",
"name": "ServiceName"
},
"vlan": {
"accessVlan": 23,
"aaaVlanOverride": true,
"coreQinQEnabled": false,
"coreSVlan": 1,
"vlanPooling": null
},
"l2ACL": {
"id": "l2ACLUUID",
"name": "l2ACLName"
},
"devicePolicy": {
"id": "devicePolicyUUID",
"name": "devicePolicyName"
},
"radiusOptions": {
"nasIdType": "Customized",
"customizedNasId": "nasId",
"nasRequestTimeoutSec": 12,
"nasMaxRetry": 3,
"nasReconnectPrimaryMin": 30,
"calledStaIdType": "WLAN_BSSID",
"nasIpType": "disabled",
"nasIpUserDefined": "192.168.1.1"
},
"advancedOptions": {
"clientIsolationEnabled": true,
"clientIsolationUnicastEnabled": true,
"clientIsolationMulticastEnabled": false,
"clientIsolationAutoVrrpEnabled": false,
"clientIsolationWhitelist": {
"id": "b89323e1-3168-11e7-b027-5254009ae3f0",
"name": "myWhitelist"
},
"priority": "High",
"hideSsidEnabled": true,
"maxClientsPerRadio": 12,
"clientIdleTimeoutSec": 60,
"clientLoadBalancingEnabled": true,
"proxyARPEnabled": true,
"ndProxyEnabled": false,
"suppressNsEnabled": false,
"raProxyEnabled": false,
"rsraGuardEnabled": false,
"raThrottlingEnabled": false,
"maxAllowedRA": 10,
"raInterval": 10,
"support80211dEnabled": false,
"support80211kEnabled": true,
"forceClientDHCPTimeoutSec": 5,
"dhcpOption82Enabled": true,
"dhcp82Format": "RUCKUS_DEFAULT",
"unauthClientStatsEnabled": false,
"clientFingerprintingEnabled": true,
"ofdmOnlyEnabled": false,
"bandBalancing": "UseZoneSetting",
"bssMinRateMbps": "Disable",
"mgmtTxRateMbps": "2 mbps",
"avcEnabled": true,
"urlFilteringPolicyEnabled": true,
"urlFilteringPolicyId": "eabd4fa0-5015-11e7-84d0-525400a0e6c5",
"wifiCallingPolicyEnabled": true,
"wifiCallingPolicyIds": [
"75e26590-547f-11e6-9ca7-5a095364c13c",
"869bb532-547f-11e6-9ca7-5a095364c13c"
],
"uplinkEnabled": true,
"uplinkRate": 100,
"downlinkEnabled": true,
"downlinkRate": 200,
"ratePerSTAUplink": "650mbps",
"ratePerSTADownlink": "1mbps"
},
"diffServProfile": {
"id": "diffServId",
"name": "diffServName"
},
"qosMaps": [
{
"enable": true,
"priority": 0,
"low": 0,
"high": 7,
"excepts": null
},
{
"enable": true,
"priority": 1,
"low": 8,
"high": 15,
"excepts": null
},
{
"enable": true,
"priority": 2,
"low": 16,
"high": 23,
"excepts": null
},
{
"enable": true,
"priority": 3,
"low": 0,
"high": 32,
"excepts": [
43,
45,
60
]
},
{
"enable": true,
"priority": 4,
"low": 32,
"high": 39,
"excepts": null
},
{
"enable": true,
"priority": 5,
"low": 40,
"high": 47,
"excepts": null
},
{
"enable": true,
"priority": 6,
"low": 48,
"high": 55,
"excepts": [
46
]
},
{
"enable": true,
"priority": 7,
"low": 56,
"high": 63,
"excepts": null
}
],
"dnsServerProfile": {
"id": "DNS server profile UUID",
"name": "DNS server profile name"
},
"dpsk": {
"dpskEnabled": false,
"length": 8,
"dpskType": "Secure",
"expiration": "OneDay",
"dpskFromType": "FirstUse"
},
"externalDpsk": {
"enabled": true,
"encryption": {
"method": "WPA2",
"algorithm": "AES"
},
"authService": {
"id": "authServiceUUID"
}
}
}Schema
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"name" : {
"description" : "Name of the WLAN",
"type" : "string",
"minLength" : 1,
"maxLength" : 32
},
"ssid" : {
"description" : "SSID of the WLAN",
"type" : "string",
"minLength" : 1,
"maxLength" : 32
},
"hessid" : {
"description" : "HESSID of the WLAN",
"type" : "string",
"pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$"
},
"description" : {
"description" : "Description of the WLAN",
"type" : [ "string", "null" ],
"maxLength" : 64
},
"caleaEnabled" : {
"description" : "DP CALEA Server Enabled",
"type" : "boolean"
},
"dpTunnelNatEnabled" : {
"description" : "DP Tunnel NAT Enabled",
"type" : "boolean"
},
"dpTunnelDhcpEnabled" : {
"description" : "DP Tunnel DHCP Enabled",
"type" : "boolean"
},
"awsExtNasIPEnable" : {
"description" : "Aws ExtNasIP Enable",
"type" : "boolean"
},
"awsVenueEnable" : {
"description" : "Aws Venue Enable",
"type" : "boolean"
},
"accessTunnelType" : {
"description" : "Access tunnel type of the WLAN. APLBO means AP local breakout, RuckusGRE means RuckusGRE tunnel to the data plane, and SoftGRE means AP direct SoftGRE tunnel",
"type" : "string",
"enum" : [ "APLBO", "RuckusGRE", "SoftGRE" ]
},
"coreTunnelProfile" : {
"description" : "Core tunnel of the WLAN. This only applies when the access tunnel type is set to RuckusGRE.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"type" : {
"description" : "Tunnel type",
"type" : "string",
"enum" : [ "Bridge", "L2oGRE", "TTG_PDG", "Mixed" ]
},
"id" : {
"description" : "Identifier of the forwarding profile. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the forwarding profile. At least one ID or name is required in the request.",
"type" : "string"
},
"operatorRealm" : {
"description" : "Operator realm, deprecated coreTunnelProfile.operatorRealm from version3.1, prepare remove",
"type" : "string",
"maxLength" : 255,
"pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
}
},
"required" : [ "type" ]
},
"macAuth" : {
"description" : "MAC address authentication settings of the WLAN. This only applies to standard MAC and Hotspot MAC bypass WLAN.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"macAuthMacFormat" : {
"description" : "MAC address format. The default format is 0010a42319c0 and the 802.1X format is 00-10-A4-23-19-C0.",
"type" : "string",
"enum" : [ "Default", "802.1X", "UpperColon", "Upper", "LowerDash", "LowerColon" ]
},
"customizedPassword" : {
"description" : "User defined password. When this field is set to an empty string, the MAC address is used as password.",
"type" : "string",
"maxLength" : 64,
"pattern" : "^([!-;=?-~]([ -;=?-~]){0,62}[!-;=?-~]|[!-;=?-~]{1,1}|\s{0,0})$"
}
}
},
"encryption" : {
"description" : "Encryption of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"method" : {
"description" : "Encryption method",
"type" : "string",
"enum" : [ "WPA2", "WPA_Mixed", "WEP_64", "WEP_128", "None" ],
"default" : "None"
},
"algorithm" : {
"description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
"type" : "string",
"enum" : [ "AES", "TKIP_AES" ]
},
"passphrase" : {
"description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
"type" : "string"
},
"mfp" : {
"description" : "Management frame protection. This only applies to WPA2 + AES",
"type" : "string",
"enum" : [ "disabled", "capable", "required" ]
},
"keyIndex" : {
"description" : "Key index. This only applies to WEP64 and WEP128.",
"type" : "integer"
},
"keyInHex" : {
"description" : "Key in hex format. This only applies to WEP64 and WEP128.",
"type" : "string"
},
"support80211rEnabled" : {
"description" : "Enable 802.11r Fast BSS Transition, fast Romaing.",
"type" : "boolean"
},
"mobilityDomainId" : {
"description" : "mobility Domain Id.",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
}
},
"required" : [ "method" ]
},
"authServiceOrProfile" : {
"description" : "Authentication of the WLAN. If authentication messages are sent through the controller, the ID or name of the global authentication profiles is required. If authentication messages are not sent through the controller, the ID or name of the authentication services configured within the zone is required.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"throughController" : {
"description" : "Indicates whether authentication messages were sent through the controller or not",
"type" : "boolean"
},
"realmBasedAuth" : {
"type" : "boolean"
},
"id" : {
"description" : "Identifier of the authentication service or profile. At least one ID or name or authenticationOption is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the authentication service or profile. At least one ID or name or authenticationOption is required in the request. Or could input the 'Always Accept' or 'Local DB'.",
"type" : "string"
},
"authenticationOption" : {
"description" : "Option of the authentication service or profile, At least one ID or name or authenticationOption is required in the request. This only applies to hotspot and guest WLANs.",
"type" : [ "string", "null" ],
"enum" : [ "Local DB", "Guest", "Always Accept", null ]
},
"locationDeliveryEnabled" : {
"description" : "RFC5580 location delivery support",
"type" : "boolean"
},
"backupAuthenticationId" : {
"description" : "Identifier of the backup authentication service or profile. At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service.",
"type" : "string"
},
"backupAuthenticationName" : {
"description" : "Name of the backup authentication service or profile. At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service. Or could input the 'Always Accept'.",
"type" : "string"
},
"backupAuthenticationOption" : {
"description" : "Option of the backup authentication service or profile, At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service. This only applies to hotspot WLANs.",
"type" : [ "string", "null" ],
"enum" : [ "Always Accept", null ]
}
}
},
"operatorRealm" : {
"description" : "Operator realm, operatorRealm only supports coreTunnelProfile type is authServiceOrProfile.locationDeliveryEnabled is true",
"type" : "string",
"maxLength" : 255,
"pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
},
"accountingServiceOrProfile" : {
"description" : "Accounting of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"throughController" : {
"description" : "Indicates whether accounting messages were sent through the controller",
"type" : "boolean"
},
"realmBasedAcct" : {
"type" : "boolean"
},
"id" : {
"description" : "Accounting service or profile ID. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Accounting service or profile name. At least one ID or name is required in the request.",
"type" : "string"
},
"interimUpdateMin" : {
"description" : "Interval (in minutes) for sending interim updates",
"type" : "integer",
"minimum" : 0,
"maximum" : 1440
},
"accountingDelayEnabled" : {
"description" : "Indicates whether accounting delay time is enabled",
"type" : "boolean"
},
"accountingTTGSessionEnabled" : {
"description" : "Indicates whether accounting for TTG sessions is to enabled",
"type" : "boolean"
},
"backupAccountingId" : {
"description" : "Backup accounting service or profile ID. At least one backupAccountingId or backupAccountingName is required in the request when setting backup accounting service.",
"type" : "string"
},
"backupAccountingName" : {
"description" : "Backup accounting service or profile name. At least one backupAccountingId or backupAccountingName is required in the request when setting backup accounting service.",
"type" : "string"
}
}
},
"portalServiceProfile" : {
"description" : "Portal service of the WLAN. This only applies to hotspot, hotspot MAC bypass, guest and web auth WLANs.",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"hotspot20Profile" : {
"description" : "Hotspot 2.0 operator profile of the WLAN. id or name of the hotspot 2.0 operator profiles within the zone is required.",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"defaultUserTrafficProfile" : {
"description" : "User traffic profile of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"precedenceProfileId" : {
"description" : "Precedence profile of the WLAN",
"type" : "string"
},
"flexiVpnProfile" : {
"description" : "Flexi-VPN profile of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"wlanId" : {
"type" : "string",
"description" : "Wlan ID"
},
"zoneAffinityId" : {
"type" : "string",
"description" : "Zone Affinity ID"
}
},
"required" : [ "zoneAffinityId" ]
},
"schedule" : {
"description" : "Schedule of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"type" : {
"description" : "Type of WLAN schedule",
"type" : "string",
"enum" : [ "AlwaysOn", "AlwaysOff", "Customized" ],
"default" : "AlwaysOn"
},
"id" : {
"description" : "Identifier of the schedule profile. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the schedule profile. At least one ID or name is required in the request.",
"type" : "string"
}
},
"required" : [ "type" ]
},
"vlan" : {
"description" : "VLAN (access and/or core) of the WLAN.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"accessVlan" : {
"description" : "Access VLAN ID",
"type" : "integer",
"minimum" : 1,
"maximum" : 4094,
"default" : 1
},
"aaaVlanOverride" : {
"description" : "Indicates whether the AAA VLAN settings can be overriden or not",
"type" : "boolean"
},
"coreQinQEnabled" : {
"description" : "Indicates whether Q-in-Q is allowed at the core network or not",
"type" : "boolean"
},
"coreSVlan" : {
"description" : "Core SVLAN ID. This only applies when core Q-in-Q is enabled",
"type" : "integer",
"minimum" : 1,
"maximum" : 4094
},
"vlanPooling" : {
"description" : "Vlan pooling",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
}
}
},
"l2ACL" : {
"description" : "Layer 2 ACL of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"devicePolicy" : {
"description" : "Device policy of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"radiusOptions" : {
"description" : "RADIUS options of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"nasIdType" : {
"description" : "NAS ID type",
"type" : "string",
"enum" : [ "WLAN_BSSID", "AP_MAC", "Customized" ],
"default" : "WLAN_BSSID"
},
"customizedNasId" : {
"description" : "User defined NAS ID",
"type" : "string",
"maxLength" : 64,
"pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$"
},
"nasRequestTimeoutSec" : {
"description" : "NAS request timeout in seconds",
"type" : "integer",
"default" : 3,
"minimum" : 2,
"maximum" : 20
},
"nasMaxRetry" : {
"description" : "NAS request maximum retry",
"type" : "integer",
"default" : 2,
"minimum" : 2,
"maximum" : 10
},
"nasReconnectPrimaryMin" : {
"description" : "NAS reconnect primary time in minutes",
"type" : "integer",
"default" : 5,
"minimum" : 1,
"maximum" : 60
},
"calledStaIdType" : {
"description" : "Called station ID type",
"type" : "string",
"enum" : [ "WLAN_BSSID", "AP_MAC", "NONE" ],
"default" : "WLAN_BSSID"
},
"nasIpType" : {
"description" : "NAS IP type",
"type" : "string",
"enum" : [ "disabled", "control", "management", "userDefined" ],
"default" : "disabled"
},
"nasIpUserDefined" : {
"description" : "User-defined NAS IP",
"type" : "string",
"maxLength" : 45
},
"singleSessionIdAcctEnabled" : {
"description" : "When Single Accounting Session ID is enabled, APs will maintain one accounting session for client roaming",
"type" : "boolean",
"default" : false
}
}
},
"advancedOptions" : {
"description" : "Advanced settings for the WLAN.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"clientIsolationEnabled" : {
"description" : "Indicates whether wireless client isolation is enabled or disabled",
"type" : "boolean",
"default" : false
},
"clientIsolationUnicastEnabled" : {
"description" : "Indicates whether isolate unicast of wireless client isolation is enabled or disabled",
"type" : "boolean",
"default" : true
},
"clientIsolationMulticastEnabled" : {
"description" : "Indicates whether isolate multicast of wireless client isolation is enabled or disabled",
"type" : "boolean"
},
"clientIsolationAutoVrrpEnabled" : {
"description" : "Indicates whether Automatic support for VRRP of wireless client isolation is enabled or disabled",
"type" : "boolean",
"default" : false
},
"clientIsolationWhitelist" : {
"description" : "Indicates wireless client isolation whitelist",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"priority" : {
"description" : "Priority of the WLAN",
"type" : "string",
"enum" : [ "High", "Low" ],
"default" : "High"
},
"hideSsidEnabled" : {
"description" : "Indicates whether the SSID is hidden or broadcast",
"type" : "boolean",
"default" : false
},
"hs20Onboarding" : {
"description" : "Allow WISPr WLAN for Hotspot 2.0 Onboarding",
"type" : "boolean",
"default" : false
},
"maxClientsPerRadio" : {
"description" : "Maximum number of clients per radio",
"type" : "integer",
"default" : 100,
"minimum" : 1,
"maximum" : 512
},
"clientIdleTimeoutSec" : {
"description" : "Client idle timeout in seconds",
"type" : "integer",
"minimum" : 60,
"maximum" : 1000,
"default" : 120
},
"dgafEnabled" : {
"description" : "Indicates whether dgaf is enabled or disabled",
"type" : "boolean"
},
"clientLoadBalancingEnabled" : {
"description" : "Indicates whether Client Load Balancing is enabled or disabled",
"type" : "boolean",
"default" : true
},
"proxyARPEnabled" : {
"description" : "Indicates whether proxy ARP is enabled or disabled",
"type" : "boolean",
"default" : false
},
"ndProxyEnabled" : {
"description" : "Indicates whether ND Proxy is enabled or disabled",
"type" : "boolean",
"default" : false
},
"suppressNsEnabled" : {
"description" : "Indicates whether supperssNS is enabled or disabled",
"type" : "boolean",
"default" : false
},
"raProxyEnabled" : {
"description" : "Indicates whether RA proxy is enabled or disabled",
"type" : "boolean",
"default" : false
},
"rsraGuardEnabled" : {
"description" : "Indicates whether RS/RA Guard is enabled or disabled",
"type" : "boolean",
"default" : false
},
"raThrottlingEnabled" : {
"description" : "Indicates whether RA Throttling is enabled or disabled",
"type" : "boolean",
"default" : false
},
"maxAllowedRA" : {
"description" : "Max Allowed RAs",
"type" : "integer",
"minimum" : 1,
"maximum" : 1440,
"default" : 10
},
"raInterval" : {
"description" : "A timer that RA proxy runs and once receives unsolicited RA checks against the configured time and allow/drop RA based on next timeout",
"type" : "integer",
"minimum" : 1,
"maximum" : 256,
"default" : 10
},
"support80211dEnabled" : {
"description" : "Indicates whether support for 802.11d is enabled or disabled",
"type" : "boolean",
"default" : true
},
"support80211kEnabled" : {
"description" : "Indicates whether support for 802.11k is enabled or disabled",
"type" : "boolean",
"default" : true
},
"antiSpoofingEnabled" : {
"description" : "Anti-Spoofing enabled",
"type" : "boolean",
"default" : false
},
"arpRequestRateLimit" : {
"description" : "ARP packets request rate limit, default value will be 15 if both rate limit not being set.",
"type" : "integer",
"minimum" : 0,
"maximum" : 100
},
"dhcpRequestRateLimit" : {
"description" : "DHCP packets request rate limit, default value will be 15 if both rate limit not being set.",
"type" : "integer",
"minimum" : 0,
"maximum" : 100
},
"forceClientDHCPTimeoutSec" : {
"description" : "Force DHCP disconnects the client if the client does not obtain a valid IP address within the timeout peroid. To disable force DHCP, set this value to zero (0).",
"type" : "integer",
"enum" : [ 0, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15 ],
"default" : 0
},
"dhcpOption82Enabled" : {
"description" : "Indicates whether DCHP Option 82 is enabled or disabled",
"type" : "boolean",
"default" : false
},
"dhcp82Format" : {
"description" : "DHCP Option 82 format",
"type" : "string",
"enum" : [ "RUCKUS_DEFAULT", "SOFTGRE_CUSTOMIZED" ]
},
"unauthClientStatsEnabled" : {
"description" : "Indicates whether to send statistics of unauthorized clients or not",
"type" : "boolean",
"default" : false
},
"clientFingerprintingEnabled" : {
"description" : "Indicates whether client fingerprinting is enabled or disabled",
"type" : "boolean",
"default" : false
},
"ofdmOnlyEnabled" : {
"description" : "Indicates whether OFDM only is enabled or disabled",
"type" : "boolean",
"default" : false
},
"bandBalancing" : {
"description" : "Indicates whether band balancing is enabled or disabled",
"type" : "string",
"enum" : [ "Disabled", "UseZoneSetting" ],
"default" : "UseZoneSetting"
},
"bssMinRateMbps" : {
"description" : "BSS minimum rate (mbps)",
"type" : "string",
"enum" : [ "Disable", "1 mbps", "2 mbps", "5.5 mbps", "12 mbps", "24 mbps" ],
"default" : "Disable"
},
"mgmtTxRateMbps" : {
"description" : "Management TX rate (mbps)",
"type" : "string",
"enum" : [ "1 mbps", "2 mbps", "5.5 mbps", "6 mbps", "9 mbps", "11 mbps", "12 mbps", "18 mbps", "24 mbps", "36 mbps", "48 mbps", "54 mbps" ],
"default" : "2 mbps"
},
"pmkCachingEnabled" : {
"description" : "Indicator of whether PKM caching support is enabled or disabled. The default value is true when the WLAN is WPA+AES non open WLAN.",
"type" : "boolean"
},
"okcEnabled" : {
"description" : "Indicator of whether OKC support is enabled or disabled. The default value is true when the WLAN is WPA+AES non open WLAN.",
"type" : "boolean"
},
"avcEnabled" : {
"description" : "Indicator of whether ARC support is enabled or disabled",
"type" : "boolean",
"default" : false
},
"urlFilteringPolicyEnabled" : {
"description" : "Indicator of whether URL Filtering is enabled or disabled",
"type" : "boolean",
"default" : false
},
"urlFilteringPolicyId" : {
"description" : "The URL Filtering policy ID.",
"type" : "string"
},
"wifiCallingPolicyEnabled" : {
"description" : "Indicator of whether Wi-Fi Calling is enabled or disabled",
"type" : "boolean",
"default" : false
},
"wifiCallingPolicyIds" : {
"description" : "The Wi-Fi Calling policy IDs. (Maximum allowed number is 5)",
"type" : "array",
"items" : {
"type" : "string"
}
},
"uplinkEnabled" : {
"description" : "SSID Rate Limiting uplink enabled.",
"type" : "boolean",
"default" : false
},
"uplinkRate" : {
"description" : "SSID Rate Limiting uplink.",
"type" : "number",
"default" : 0.0
},
"downlinkEnabled" : {
"description" : "SSID Rate Limiting downlink enabled.",
"type" : "boolean",
"default" : false
},
"downlinkRate" : {
"description" : "SSID Rate Limiting downlink.",
"type" : "number",
"default" : 0.0
},
"ratePerSTAUplink" : {
"description" : "UE Rate Limiting uplink.",
"type" : "string"
},
"ratePerSTADownlink" : {
"description" : "UE Rate Limiting downlink.",
"type" : "string"
},
"dtimInterval" : {
"description" : "DTIM Interval",
"type" : "integer",
"minimum" : 1,
"maximum" : 255,
"default" : 1
},
"directedThreshold" : {
"description" : "Directed Threshold Setting, Defines the client count at which an AP will stop converting group addressed data traffic to unicast.",
"type" : "integer",
"minimum" : 0,
"maximum" : 128,
"default" : 5
},
"flowLogEnabled" : {
"description" : "Flow log enabled.",
"type" : "boolean",
"default" : false
},
"hdOverheadOptimizeEnable" : {
"description" : "Airtime decongestion enabled.",
"type" : "boolean",
"default" : false
},
"probeRssiThr" : {
"type" : "integer",
"description" : "Join RSSI threshold.",
"minimum" : -90,
"maximum" : -60,
"default" : -85
},
"transientClientMgmtEnable" : {
"description" : "Transient Client Management enabled.",
"type" : "boolean",
"default" : false
},
"joinIgnoreTimeout" : {
"description" : "Join wait time.",
"type" : "integer",
"minimum" : 1,
"maximum" : 60,
"default" : 30
},
"joinAcceptTimeout" : {
"description" : "Join expire time.",
"type" : "integer",
"minimum" : 1,
"maximum" : 300,
"default" : 300
},
"joinIgnoreThr" : {
"description" : "Join wait threshold.",
"type" : "integer",
"minimum" : 1,
"maximum" : 50,
"default" : 10
},
"authRssiThr" : {
"description" : "Auth RSSI threshold.",
"type" : "integer",
"minimum" : -90,
"maximum" : -60
},
"assocRssiThr" : {
"description" : "Assoc RSSI threshold.",
"type" : "integer",
"minimum" : -90,
"maximum" : -60
},
"oceEnabled" : {
"description" : "Optimized Connectivity Experience(OCE) enabled.",
"type" : "boolean",
"default" : false
},
"oceBroadcastProbeResponseDelay" : {
"description" : "Broadcast probe response delay.",
"type" : "integer",
"minimum" : 8,
"maximum" : 120,
"default" : 15
},
"oceRssiBasedAssociationRejectionThreshold" : {
"description" : "RSSI-based association rejection threshold.",
"type" : "integer",
"minimum" : -90,
"maximum" : -60,
"default" : -75
}
}
},
"diffServProfile" : {
"description" : "DiffServ profile of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"qosMaps" : {
"description" : "Qos map set of the WLAN.",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"enable" : {
"description" : "Enabled or disabled",
"type" : "boolean"
},
"priority" : {
"description" : "Priority",
"type" : "integer"
},
"low" : {
"description" : "DSCP range - low",
"type" : [ "integer", "null" ],
"minimum" : 0,
"maximum" : 255
},
"high" : {
"description" : "DSCP range - high",
"type" : [ "integer", "null" ],
"minimum" : 0,
"maximum" : 255
},
"excepts" : {
"type" : [ "array", "null" ],
"items" : {
"type" : "integer",
"minimum" : 0,
"maximum" : 63
}
}
},
"required" : [ "enable", "priority" ]
}
},
"dpsk" : {
"description" : "DPSK Setting",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"dpskEnabled" : {
"description" : "DPSK enabled",
"type" : "boolean",
"default" : false
},
"length" : {
"description" : "Length of DPSK key",
"type" : "integer",
"default" : 62
},
"dpskType" : {
"description" : "Type of DPSK key",
"type" : "string",
"enum" : [ "Secure", "KeyboardFriendly", "NumbersOnly" ],
"default" : "Secure"
},
"expiration" : {
"description" : "Expiration of DPSK key",
"type" : "string",
"enum" : [ "Unlimited", "OneDay", "TwoDays", "OneWeek", "TwoWeeks", "OneMonth", "SixMonths", "OneYear", "TwoYears" ],
"default" : "Unlimited"
},
"dpskFromType" : {
"description" : "Type of expiration start from",
"type" : "string",
"enum" : [ "CreateTime", "FirstUse" ],
"default" : "CreateTime"
}
}
},
"externalDpsk" : {
"description" : "External DPSK Enabled",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"enabled" : {
"description" : "Enable External DPSK",
"type" : "boolean",
"default" : false
},
"encryption" : {
"description" : "Encryption of the WLAN relate to external DPSK",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"method" : {
"description" : "Encryption method",
"type" : "string",
"enum" : [ "WPA2", "WPA_Mixed", "None" ]
},
"algorithm" : {
"description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
"type" : "string",
"enum" : [ "AES", "TKIP_AES" ]
}
}
},
"authService" : {
"description" : "Autentication of the WLAN relate to external DPSK",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Identifier of the authentication service. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the authentication service. At least one ID or name is required in the request.",
"type" : "string"
}
}
}
},
"required" : [ "enabled" ]
},
"dnsServerProfile" : {
"description" : "DNS server profile of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"accessTunnelProfile" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"accessIpsecProfile" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"splitTunnelProfileId" : {
"type" : "string"
},
"portalDetectionProfileId" : {
"type" : "string"
}
},
"required" : [ "name", "ssid", "authServiceOrProfile" ]
}201Body
{
"id": "wlanID"
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
}
}
}Create - 802.1X with MAC Address ¶
POST/v8_0/rkszones/{zoneId}/wlans/standard8021Xmac
Use this API command to create a new standard, 802.1X with MAC address and non-tunneled WLAN.
Body
{
"name": "wlanName",
"ssid": "wlanSSID",
"description": "wlanDescription",
"authServiceOrProfile": {
"throughController": false,
"id": "authServiceUUID",
"name": "authServiceName",
"authenticationOption": null
},
"accessTunnelType": "RuckusGRE",
"accessTunnelProfile": {
"id": "f5b92938-aa4e-4d02-90ea-273799ff689b",
"name": "Default Tunnel Profile"
},
"splitTunnelProfileId": "38119bac-49e1-4410-ab8e-1c1bc88dd770",
"coreTunnelProfile": {
"type": "Bridge",
"id": "forwardingUUID",
"name": "forwardingName"
},
"macAuth": {
"macAuthMacFormat": "802.1X",
"customizedPassword": "password"
},
"encryption": {
"method": "WPA2",
"algorithm": "AES",
"passphrase": "password",
"mfp": "disabled",
"support80211rEnabled": false,
"mobilityDomainId": 3
},
"operatorRealm": "operator realm",
"defaultUserTrafficProfile": {
"id": "userTrafficUUID",
"name": "userTrafficName"
},
"precedenceProfileId": "c514d450-c839-9527-afc9-525400d12345",
"portalDetectionProfileId": "de0fa30c-9565-11e8-9eb6-529269fb1459",
"schedule": {
"type": "Customized",
"id": "ServiceUUID",
"name": "ServiceName"
},
"vlan": {
"accessVlan": 23,
"aaaVlanOverride": true,
"coreQinQEnabled": false,
"coreSVlan": 1,
"vlanPooling": null
},
"l2ACL": {
"id": "l2ACLUUID",
"name": "l2ACLName"
},
"devicePolicy": {
"id": "devicePolicyUUID",
"name": "devicePolicyName"
},
"radiusOptions": {
"nasIdType": "Customized",
"customizedNasId": "nasId",
"nasRequestTimeoutSec": 12,
"nasMaxRetry": 3,
"nasReconnectPrimaryMin": 30,
"calledStaIdType": "WLAN_BSSID",
"nasIpType": "disabled",
"nasIpUserDefined": "192.168.1.1"
},
"advancedOptions": {
"clientIsolationEnabled": true,
"clientIsolationUnicastEnabled": true,
"clientIsolationMulticastEnabled": false,
"clientIsolationAutoVrrpEnabled": false,
"clientIsolationWhitelist": {
"id": "b89323e1-3168-11e7-b027-5254009ae3f0",
"name": "myWhitelist"
},
"priority": "High",
"hideSsidEnabled": true,
"maxClientsPerRadio": 12,
"clientIdleTimeoutSec": 60,
"clientLoadBalancingEnabled": true,
"proxyARPEnabled": true,
"ndProxyEnabled": false,
"suppressNsEnabled": false,
"raProxyEnabled": false,
"rsraGuardEnabled": false,
"raThrottlingEnabled": false,
"maxAllowedRA": 10,
"raInterval": 10,
"support80211dEnabled": false,
"support80211kEnabled": true,
"forceClientDHCPTimeoutSec": 5,
"dhcpOption82Enabled": true,
"dhcp82Format": "RUCKUS_DEFAULT",
"unauthClientStatsEnabled": false,
"clientFingerprintingEnabled": true,
"ofdmOnlyEnabled": false,
"bandBalancing": "UseZoneSetting",
"bssMinRateMbps": "Disable",
"mgmtTxRateMbps": "2 mbps",
"avcEnabled": true,
"urlFilteringPolicyEnabled": false,
"urlFilteringPolicyId": "",
"wifiCallingPolicyEnabled": false,
"wifiCallingPolicyIds": [],
"uplinkEnabled": true,
"uplinkRate": 100,
"downlinkEnabled": true,
"downlinkRate": 200,
"ratePerSTAUplink": "650mbps",
"ratePerSTADownlink": "1mbps"
},
"diffServProfile": {
"id": "diffServId",
"name": "diffServName"
},
"qosMaps": [
{
"enable": true,
"priority": 0,
"low": 0,
"high": 7,
"excepts": null
},
{
"enable": true,
"priority": 1,
"low": 8,
"high": 15,
"excepts": null
},
{
"enable": true,
"priority": 2,
"low": 16,
"high": 23,
"excepts": null
},
{
"enable": true,
"priority": 3,
"low": 0,
"high": 32,
"excepts": [
43,
45,
60
]
},
{
"enable": true,
"priority": 4,
"low": 32,
"high": 39,
"excepts": null
},
{
"enable": true,
"priority": 5,
"low": 40,
"high": 47,
"excepts": null
},
{
"enable": true,
"priority": 6,
"low": 48,
"high": 55,
"excepts": [
46
]
},
{
"enable": true,
"priority": 7,
"low": 56,
"high": 63,
"excepts": null
}
],
"dnsServerProfile": {
"id": "DNS server profile UUID",
"name": "DNS server profile name"
},
"dpsk": {
"dpskEnabled": false,
"length": 8,
"dpskType": "Secure",
"expiration": "OneDay",
"dpskFromType": "FirstUse"
},
"externalDpsk": {
"enabled": true,
"encryption": {
"method": "WPA2",
"algorithm": "AES"
},
"authService": {
"id": "authServiceUUID"
}
}
}Schema
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"name" : {
"description" : "Name of the WLAN",
"type" : "string",
"minLength" : 1,
"maxLength" : 32
},
"ssid" : {
"description" : "SSID of the WLAN",
"type" : "string",
"minLength" : 1,
"maxLength" : 32
},
"hessid" : {
"description" : "HESSID of the WLAN",
"type" : "string",
"pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$"
},
"description" : {
"description" : "Description of the WLAN",
"type" : [ "string", "null" ],
"maxLength" : 64
},
"caleaEnabled" : {
"description" : "DP CALEA Server Enabled",
"type" : "boolean"
},
"dpTunnelNatEnabled" : {
"description" : "DP Tunnel NAT Enabled",
"type" : "boolean"
},
"dpTunnelDhcpEnabled" : {
"description" : "DP Tunnel DHCP Enabled",
"type" : "boolean"
},
"awsExtNasIPEnable" : {
"description" : "Aws ExtNasIP Enable",
"type" : "boolean"
},
"awsVenueEnable" : {
"description" : "Aws Venue Enable",
"type" : "boolean"
},
"accessTunnelType" : {
"description" : "Access tunnel type of the WLAN. APLBO means AP local breakout, RuckusGRE means RuckusGRE tunnel to the data plane, and SoftGRE means AP direct SoftGRE tunnel",
"type" : "string",
"enum" : [ "APLBO", "RuckusGRE", "SoftGRE" ]
},
"coreTunnelProfile" : {
"description" : "Core tunnel of the WLAN. This only applies when the access tunnel type is set to RuckusGRE.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"type" : {
"description" : "Tunnel type",
"type" : "string",
"enum" : [ "Bridge", "L2oGRE", "TTG_PDG", "Mixed" ]
},
"id" : {
"description" : "Identifier of the forwarding profile. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the forwarding profile. At least one ID or name is required in the request.",
"type" : "string"
},
"operatorRealm" : {
"description" : "Operator realm, deprecated coreTunnelProfile.operatorRealm from version3.1, prepare remove",
"type" : "string",
"maxLength" : 255,
"pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
}
},
"required" : [ "type" ]
},
"macAuth" : {
"description" : "MAC address authentication settings of the WLAN. This only applies to standard MAC and Hotspot MAC bypass WLAN.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"macAuthMacFormat" : {
"description" : "MAC address format. The default format is 0010a42319c0 and the 802.1X format is 00-10-A4-23-19-C0.",
"type" : "string",
"enum" : [ "Default", "802.1X", "UpperColon", "Upper", "LowerDash", "LowerColon" ]
},
"customizedPassword" : {
"description" : "User defined password. When this field is set to an empty string, the MAC address is used as password.",
"type" : "string",
"maxLength" : 64,
"pattern" : "^([!-;=?-~]([ -;=?-~]){0,62}[!-;=?-~]|[!-;=?-~]{1,1}|\s{0,0})$"
}
}
},
"encryption" : {
"description" : "Encryption of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"method" : {
"description" : "Encryption method",
"type" : "string",
"enum" : [ "WPA2", "WPA_Mixed", "WEP_64", "WEP_128", "None" ],
"default" : "None"
},
"algorithm" : {
"description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
"type" : "string",
"enum" : [ "AES", "TKIP_AES" ]
},
"passphrase" : {
"description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
"type" : "string"
},
"mfp" : {
"description" : "Management frame protection. This only applies to WPA2 + AES",
"type" : "string",
"enum" : [ "disabled", "capable", "required" ]
},
"keyIndex" : {
"description" : "Key index. This only applies to WEP64 and WEP128.",
"type" : "integer"
},
"keyInHex" : {
"description" : "Key in hex format. This only applies to WEP64 and WEP128.",
"type" : "string"
},
"support80211rEnabled" : {
"description" : "Enable 802.11r Fast BSS Transition, fast Romaing.",
"type" : "boolean"
},
"mobilityDomainId" : {
"description" : "mobility Domain Id.",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
}
},
"required" : [ "method" ]
},
"authServiceOrProfile" : {
"description" : "Authentication of the WLAN. If authentication messages are sent through the controller, the ID or name of the global authentication profiles is required. If authentication messages are not sent through the controller, the ID or name of the authentication services configured within the zone is required.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"throughController" : {
"description" : "Indicates whether authentication messages were sent through the controller or not",
"type" : "boolean"
},
"realmBasedAuth" : {
"type" : "boolean"
},
"id" : {
"description" : "Identifier of the authentication service or profile. At least one ID or name or authenticationOption is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the authentication service or profile. At least one ID or name or authenticationOption is required in the request. Or could input the 'Always Accept' or 'Local DB'.",
"type" : "string"
},
"authenticationOption" : {
"description" : "Option of the authentication service or profile, At least one ID or name or authenticationOption is required in the request. This only applies to hotspot and guest WLANs.",
"type" : [ "string", "null" ],
"enum" : [ "Local DB", "Guest", "Always Accept", null ]
},
"locationDeliveryEnabled" : {
"description" : "RFC5580 location delivery support",
"type" : "boolean"
},
"backupAuthenticationId" : {
"description" : "Identifier of the backup authentication service or profile. At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service.",
"type" : "string"
},
"backupAuthenticationName" : {
"description" : "Name of the backup authentication service or profile. At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service. Or could input the 'Always Accept'.",
"type" : "string"
},
"backupAuthenticationOption" : {
"description" : "Option of the backup authentication service or profile, At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service. This only applies to hotspot WLANs.",
"type" : [ "string", "null" ],
"enum" : [ "Always Accept", null ]
}
}
},
"operatorRealm" : {
"description" : "Operator realm, operatorRealm only supports coreTunnelProfile type is authServiceOrProfile.locationDeliveryEnabled is true",
"type" : "string",
"maxLength" : 255,
"pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
},
"accountingServiceOrProfile" : {
"description" : "Accounting of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"throughController" : {
"description" : "Indicates whether accounting messages were sent through the controller",
"type" : "boolean"
},
"realmBasedAcct" : {
"type" : "boolean"
},
"id" : {
"description" : "Accounting service or profile ID. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Accounting service or profile name. At least one ID or name is required in the request.",
"type" : "string"
},
"interimUpdateMin" : {
"description" : "Interval (in minutes) for sending interim updates",
"type" : "integer",
"minimum" : 0,
"maximum" : 1440
},
"accountingDelayEnabled" : {
"description" : "Indicates whether accounting delay time is enabled",
"type" : "boolean"
},
"accountingTTGSessionEnabled" : {
"description" : "Indicates whether accounting for TTG sessions is to enabled",
"type" : "boolean"
},
"backupAccountingId" : {
"description" : "Backup accounting service or profile ID. At least one backupAccountingId or backupAccountingName is required in the request when setting backup accounting service.",
"type" : "string"
},
"backupAccountingName" : {
"description" : "Backup accounting service or profile name. At least one backupAccountingId or backupAccountingName is required in the request when setting backup accounting service.",
"type" : "string"
}
}
},
"portalServiceProfile" : {
"description" : "Portal service of the WLAN. This only applies to hotspot, hotspot MAC bypass, guest and web auth WLANs.",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"hotspot20Profile" : {
"description" : "Hotspot 2.0 operator profile of the WLAN. id or name of the hotspot 2.0 operator profiles within the zone is required.",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"defaultUserTrafficProfile" : {
"description" : "User traffic profile of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"precedenceProfileId" : {
"description" : "Precedence profile of the WLAN",
"type" : "string"
},
"flexiVpnProfile" : {
"description" : "Flexi-VPN profile of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"wlanId" : {
"type" : "string",
"description" : "Wlan ID"
},
"zoneAffinityId" : {
"type" : "string",
"description" : "Zone Affinity ID"
}
},
"required" : [ "zoneAffinityId" ]
},
"schedule" : {
"description" : "Schedule of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"type" : {
"description" : "Type of WLAN schedule",
"type" : "string",
"enum" : [ "AlwaysOn", "AlwaysOff", "Customized" ],
"default" : "AlwaysOn"
},
"id" : {
"description" : "Identifier of the schedule profile. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the schedule profile. At least one ID or name is required in the request.",
"type" : "string"
}
},
"required" : [ "type" ]
},
"vlan" : {
"description" : "VLAN (access and/or core) of the WLAN.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"accessVlan" : {
"description" : "Access VLAN ID",
"type" : "integer",
"minimum" : 1,
"maximum" : 4094,
"default" : 1
},
"aaaVlanOverride" : {
"description" : "Indicates whether the AAA VLAN settings can be overriden or not",
"type" : "boolean"
},
"coreQinQEnabled" : {
"description" : "Indicates whether Q-in-Q is allowed at the core network or not",
"type" : "boolean"
},
"coreSVlan" : {
"description" : "Core SVLAN ID. This only applies when core Q-in-Q is enabled",
"type" : "integer",
"minimum" : 1,
"maximum" : 4094
},
"vlanPooling" : {
"description" : "Vlan pooling",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
}
}
},
"l2ACL" : {
"description" : "Layer 2 ACL of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"devicePolicy" : {
"description" : "Device policy of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"radiusOptions" : {
"description" : "RADIUS options of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"nasIdType" : {
"description" : "NAS ID type",
"type" : "string",
"enum" : [ "WLAN_BSSID", "AP_MAC", "Customized" ],
"default" : "WLAN_BSSID"
},
"customizedNasId" : {
"description" : "User defined NAS ID",
"type" : "string",
"maxLength" : 64,
"pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$"
},
"nasRequestTimeoutSec" : {
"description" : "NAS request timeout in seconds",
"type" : "integer",
"default" : 3,
"minimum" : 2,
"maximum" : 20
},
"nasMaxRetry" : {
"description" : "NAS request maximum retry",
"type" : "integer",
"default" : 2,
"minimum" : 2,
"maximum" : 10
},
"nasReconnectPrimaryMin" : {
"description" : "NAS reconnect primary time in minutes",
"type" : "integer",
"default" : 5,
"minimum" : 1,
"maximum" : 60
},
"calledStaIdType" : {
"description" : "Called station ID type",
"type" : "string",
"enum" : [ "WLAN_BSSID", "AP_MAC", "NONE" ],
"default" : "WLAN_BSSID"
},
"nasIpType" : {
"description" : "NAS IP type",
"type" : "string",
"enum" : [ "disabled", "control", "management", "userDefined" ],
"default" : "disabled"
},
"nasIpUserDefined" : {
"description" : "User-defined NAS IP",
"type" : "string",
"maxLength" : 45
},
"singleSessionIdAcctEnabled" : {
"description" : "When Single Accounting Session ID is enabled, APs will maintain one accounting session for client roaming",
"type" : "boolean",
"default" : false
}
}
},
"advancedOptions" : {
"description" : "Advanced settings for the WLAN.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"clientIsolationEnabled" : {
"description" : "Indicates whether wireless client isolation is enabled or disabled",
"type" : "boolean",
"default" : false
},
"clientIsolationUnicastEnabled" : {
"description" : "Indicates whether isolate unicast of wireless client isolation is enabled or disabled",
"type" : "boolean",
"default" : true
},
"clientIsolationMulticastEnabled" : {
"description" : "Indicates whether isolate multicast of wireless client isolation is enabled or disabled",
"type" : "boolean"
},
"clientIsolationAutoVrrpEnabled" : {
"description" : "Indicates whether Automatic support for VRRP of wireless client isolation is enabled or disabled",
"type" : "boolean",
"default" : false
},
"clientIsolationWhitelist" : {
"description" : "Indicates wireless client isolation whitelist",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"priority" : {
"description" : "Priority of the WLAN",
"type" : "string",
"enum" : [ "High", "Low" ],
"default" : "High"
},
"hideSsidEnabled" : {
"description" : "Indicates whether the SSID is hidden or broadcast",
"type" : "boolean",
"default" : false
},
"hs20Onboarding" : {
"description" : "Allow WISPr WLAN for Hotspot 2.0 Onboarding",
"type" : "boolean",
"default" : false
},
"maxClientsPerRadio" : {
"description" : "Maximum number of clients per radio",
"type" : "integer",
"default" : 100,
"minimum" : 1,
"maximum" : 512
},
"clientIdleTimeoutSec" : {
"description" : "Client idle timeout in seconds",
"type" : "integer",
"minimum" : 60,
"maximum" : 1000,
"default" : 120
},
"dgafEnabled" : {
"description" : "Indicates whether dgaf is enabled or disabled",
"type" : "boolean"
},
"clientLoadBalancingEnabled" : {
"description" : "Indicates whether Client Load Balancing is enabled or disabled",
"type" : "boolean",
"default" : true
},
"proxyARPEnabled" : {
"description" : "Indicates whether proxy ARP is enabled or disabled",
"type" : "boolean",
"default" : false
},
"ndProxyEnabled" : {
"description" : "Indicates whether ND Proxy is enabled or disabled",
"type" : "boolean",
"default" : false
},
"suppressNsEnabled" : {
"description" : "Indicates whether supperssNS is enabled or disabled",
"type" : "boolean",
"default" : false
},
"raProxyEnabled" : {
"description" : "Indicates whether RA proxy is enabled or disabled",
"type" : "boolean",
"default" : false
},
"rsraGuardEnabled" : {
"description" : "Indicates whether RS/RA Guard is enabled or disabled",
"type" : "boolean",
"default" : false
},
"raThrottlingEnabled" : {
"description" : "Indicates whether RA Throttling is enabled or disabled",
"type" : "boolean",
"default" : false
},
"maxAllowedRA" : {
"description" : "Max Allowed RAs",
"type" : "integer",
"minimum" : 1,
"maximum" : 1440,
"default" : 10
},
"raInterval" : {
"description" : "A timer that RA proxy runs and once receives unsolicited RA checks against the configured time and allow/drop RA based on next timeout",
"type" : "integer",
"minimum" : 1,
"maximum" : 256,
"default" : 10
},
"support80211dEnabled" : {
"description" : "Indicates whether support for 802.11d is enabled or disabled",
"type" : "boolean",
"default" : true
},
"support80211kEnabled" : {
"description" : "Indicates whether support for 802.11k is enabled or disabled",
"type" : "boolean",
"default" : true
},
"antiSpoofingEnabled" : {
"description" : "Anti-Spoofing enabled",
"type" : "boolean",
"default" : false
},
"arpRequestRateLimit" : {
"description" : "ARP packets request rate limit, default value will be 15 if both rate limit not being set.",
"type" : "integer",
"minimum" : 0,
"maximum" : 100
},
"dhcpRequestRateLimit" : {
"description" : "DHCP packets request rate limit, default value will be 15 if both rate limit not being set.",
"type" : "integer",
"minimum" : 0,
"maximum" : 100
},
"forceClientDHCPTimeoutSec" : {
"description" : "Force DHCP disconnects the client if the client does not obtain a valid IP address within the timeout peroid. To disable force DHCP, set this value to zero (0).",
"type" : "integer",
"enum" : [ 0, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15 ],
"default" : 0
},
"dhcpOption82Enabled" : {
"description" : "Indicates whether DCHP Option 82 is enabled or disabled",
"type" : "boolean",
"default" : false
},
"dhcp82Format" : {
"description" : "DHCP Option 82 format",
"type" : "string",
"enum" : [ "RUCKUS_DEFAULT", "SOFTGRE_CUSTOMIZED" ]
},
"unauthClientStatsEnabled" : {
"description" : "Indicates whether to send statistics of unauthorized clients or not",
"type" : "boolean",
"default" : false
},
"clientFingerprintingEnabled" : {
"description" : "Indicates whether client fingerprinting is enabled or disabled",
"type" : "boolean",
"default" : false
},
"ofdmOnlyEnabled" : {
"description" : "Indicates whether OFDM only is enabled or disabled",
"type" : "boolean",
"default" : false
},
"bandBalancing" : {
"description" : "Indicates whether band balancing is enabled or disabled",
"type" : "string",
"enum" : [ "Disabled", "UseZoneSetting" ],
"default" : "UseZoneSetting"
},
"bssMinRateMbps" : {
"description" : "BSS minimum rate (mbps)",
"type" : "string",
"enum" : [ "Disable", "1 mbps", "2 mbps", "5.5 mbps", "12 mbps", "24 mbps" ],
"default" : "Disable"
},
"mgmtTxRateMbps" : {
"description" : "Management TX rate (mbps)",
"type" : "string",
"enum" : [ "1 mbps", "2 mbps", "5.5 mbps", "6 mbps", "9 mbps", "11 mbps", "12 mbps", "18 mbps", "24 mbps", "36 mbps", "48 mbps", "54 mbps" ],
"default" : "2 mbps"
},
"pmkCachingEnabled" : {
"description" : "Indicator of whether PKM caching support is enabled or disabled. The default value is true when the WLAN is WPA+AES non open WLAN.",
"type" : "boolean"
},
"okcEnabled" : {
"description" : "Indicator of whether OKC support is enabled or disabled. The default value is true when the WLAN is WPA+AES non open WLAN.",
"type" : "boolean"
},
"avcEnabled" : {
"description" : "Indicator of whether ARC support is enabled or disabled",
"type" : "boolean",
"default" : false
},
"urlFilteringPolicyEnabled" : {
"description" : "Indicator of whether URL Filtering is enabled or disabled",
"type" : "boolean",
"default" : false
},
"urlFilteringPolicyId" : {
"description" : "The URL Filtering policy ID.",
"type" : "string"
},
"wifiCallingPolicyEnabled" : {
"description" : "Indicator of whether Wi-Fi Calling is enabled or disabled",
"type" : "boolean",
"default" : false
},
"wifiCallingPolicyIds" : {
"description" : "The Wi-Fi Calling policy IDs. (Maximum allowed number is 5)",
"type" : "array",
"items" : {
"type" : "string"
}
},
"uplinkEnabled" : {
"description" : "SSID Rate Limiting uplink enabled.",
"type" : "boolean",
"default" : false
},
"uplinkRate" : {
"description" : "SSID Rate Limiting uplink.",
"type" : "number",
"default" : 0.0
},
"downlinkEnabled" : {
"description" : "SSID Rate Limiting downlink enabled.",
"type" : "boolean",
"default" : false
},
"downlinkRate" : {
"description" : "SSID Rate Limiting downlink.",
"type" : "number",
"default" : 0.0
},
"ratePerSTAUplink" : {
"description" : "UE Rate Limiting uplink.",
"type" : "string"
},
"ratePerSTADownlink" : {
"description" : "UE Rate Limiting downlink.",
"type" : "string"
},
"dtimInterval" : {
"description" : "DTIM Interval",
"type" : "integer",
"minimum" : 1,
"maximum" : 255,
"default" : 1
},
"directedThreshold" : {
"description" : "Directed Threshold Setting, Defines the client count at which an AP will stop converting group addressed data traffic to unicast.",
"type" : "integer",
"minimum" : 0,
"maximum" : 128,
"default" : 5
},
"flowLogEnabled" : {
"description" : "Flow log enabled.",
"type" : "boolean",
"default" : false
},
"hdOverheadOptimizeEnable" : {
"description" : "Airtime decongestion enabled.",
"type" : "boolean",
"default" : false
},
"probeRssiThr" : {
"type" : "integer",
"description" : "Join RSSI threshold.",
"minimum" : -90,
"maximum" : -60,
"default" : -85
},
"transientClientMgmtEnable" : {
"description" : "Transient Client Management enabled.",
"type" : "boolean",
"default" : false
},
"joinIgnoreTimeout" : {
"description" : "Join wait time.",
"type" : "integer",
"minimum" : 1,
"maximum" : 60,
"default" : 30
},
"joinAcceptTimeout" : {
"description" : "Join expire time.",
"type" : "integer",
"minimum" : 1,
"maximum" : 300,
"default" : 300
},
"joinIgnoreThr" : {
"description" : "Join wait threshold.",
"type" : "integer",
"minimum" : 1,
"maximum" : 50,
"default" : 10
},
"authRssiThr" : {
"description" : "Auth RSSI threshold.",
"type" : "integer",
"minimum" : -90,
"maximum" : -60
},
"assocRssiThr" : {
"description" : "Assoc RSSI threshold.",
"type" : "integer",
"minimum" : -90,
"maximum" : -60
},
"oceEnabled" : {
"description" : "Optimized Connectivity Experience(OCE) enabled.",
"type" : "boolean",
"default" : false
},
"oceBroadcastProbeResponseDelay" : {
"description" : "Broadcast probe response delay.",
"type" : "integer",
"minimum" : 8,
"maximum" : 120,
"default" : 15
},
"oceRssiBasedAssociationRejectionThreshold" : {
"description" : "RSSI-based association rejection threshold.",
"type" : "integer",
"minimum" : -90,
"maximum" : -60,
"default" : -75
}
}
},
"diffServProfile" : {
"description" : "DiffServ profile of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"qosMaps" : {
"description" : "Qos map set of the WLAN.",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"enable" : {
"description" : "Enabled or disabled",
"type" : "boolean"
},
"priority" : {
"description" : "Priority",
"type" : "integer"
},
"low" : {
"description" : "DSCP range - low",
"type" : [ "integer", "null" ],
"minimum" : 0,
"maximum" : 255
},
"high" : {
"description" : "DSCP range - high",
"type" : [ "integer", "null" ],
"minimum" : 0,
"maximum" : 255
},
"excepts" : {
"type" : [ "array", "null" ],
"items" : {
"type" : "integer",
"minimum" : 0,
"maximum" : 63
}
}
},
"required" : [ "enable", "priority" ]
}
},
"dpsk" : {
"description" : "DPSK Setting",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"dpskEnabled" : {
"description" : "DPSK enabled",
"type" : "boolean",
"default" : false
},
"length" : {
"description" : "Length of DPSK key",
"type" : "integer",
"default" : 62
},
"dpskType" : {
"description" : "Type of DPSK key",
"type" : "string",
"enum" : [ "Secure", "KeyboardFriendly", "NumbersOnly" ],
"default" : "Secure"
},
"expiration" : {
"description" : "Expiration of DPSK key",
"type" : "string",
"enum" : [ "Unlimited", "OneDay", "TwoDays", "OneWeek", "TwoWeeks", "OneMonth", "SixMonths", "OneYear", "TwoYears" ],
"default" : "Unlimited"
},
"dpskFromType" : {
"description" : "Type of expiration start from",
"type" : "string",
"enum" : [ "CreateTime", "FirstUse" ],
"default" : "CreateTime"
}
}
},
"externalDpsk" : {
"description" : "External DPSK Enabled",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"enabled" : {
"description" : "Enable External DPSK",
"type" : "boolean",
"default" : false
},
"encryption" : {
"description" : "Encryption of the WLAN relate to external DPSK",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"method" : {
"description" : "Encryption method",
"type" : "string",
"enum" : [ "WPA2", "WPA_Mixed", "None" ]
},
"algorithm" : {
"description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
"type" : "string",
"enum" : [ "AES", "TKIP_AES" ]
}
}
},
"authService" : {
"description" : "Autentication of the WLAN relate to external DPSK",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Identifier of the authentication service. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the authentication service. At least one ID or name is required in the request.",
"type" : "string"
}
}
}
},
"required" : [ "enabled" ]
},
"dnsServerProfile" : {
"description" : "DNS server profile of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"accessTunnelProfile" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"accessIpsecProfile" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"splitTunnelProfileId" : {
"type" : "string"
},
"portalDetectionProfileId" : {
"type" : "string"
}
},
"required" : [ "name", "ssid", "authServiceOrProfile" ]
}201Body
{
"id": "wlanID"
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
}
}
}Create - MAC Auth ¶
POST/v8_0/rkszones/{zoneId}/wlans/standardmac
Use this API command to create a new standard, MAC auth and non-tunneled WLAN.
Body
{
"name": "wlanName",
"ssid": "wlanSSID",
"description": "wlanDescription",
"authServiceOrProfile": {
"throughController": false,
"id": "authServiceUUID",
"name": "authServiceName",
"authenticationOption": null
},
"accessTunnelType": "RuckusGRE",
"accessTunnelProfile": {
"id": "f5b92938-aa4e-4d02-90ea-273799ff689b",
"name": "Default Tunnel Profile"
},
"splitTunnelProfileId": "38119bac-49e1-4410-ab8e-1c1bc88dd770",
"coreTunnelProfile": {
"type": "Bridge",
"id": "forwardingUUID",
"name": "forwardingName"
},
"macAuth": {
"macAuthMacFormat": "802.1X",
"customizedPassword": "password"
},
"encryption": {
"method": "WPA2",
"algorithm": "AES",
"passphrase": "password",
"mfp": "disabled",
"support80211rEnabled": false,
"mobilityDomainId": 3
},
"operatorRealm": "operator realm",
"defaultUserTrafficProfile": {
"id": "userTrafficUUID",
"name": "userTrafficName"
},
"precedenceProfileId": "c514d450-c839-9527-afc9-525400d12345",
"portalDetectionProfileId": "de0fa30c-9565-11e8-9eb6-529269fb1459",
"schedule": {
"type": "Customized",
"id": "ServiceUUID",
"name": "ServiceName"
},
"vlan": {
"accessVlan": 23,
"aaaVlanOverride": true,
"coreQinQEnabled": false,
"coreSVlan": 1,
"vlanPooling": null
},
"l2ACL": {
"id": "l2ACLUUID",
"name": "l2ACLName"
},
"devicePolicy": {
"id": "devicePolicyUUID",
"name": "devicePolicyName"
},
"radiusOptions": {
"nasIdType": "Customized",
"customizedNasId": "nasId",
"nasRequestTimeoutSec": 12,
"nasMaxRetry": 3,
"nasReconnectPrimaryMin": 30,
"calledStaIdType": "WLAN_BSSID",
"nasIpType": "disabled",
"nasIpUserDefined": "192.168.1.1"
},
"advancedOptions": {
"clientIsolationEnabled": true,
"clientIsolationUnicastEnabled": true,
"clientIsolationMulticastEnabled": false,
"clientIsolationAutoVrrpEnabled": false,
"clientIsolationWhitelist": {
"id": "b89323e1-3168-11e7-b027-5254009ae3f0",
"name": "myWhitelist"
},
"priority": "High",
"hideSsidEnabled": true,
"maxClientsPerRadio": 12,
"clientIdleTimeoutSec": 60,
"clientLoadBalancingEnabled": true,
"proxyARPEnabled": true,
"ndProxyEnabled": false,
"suppressNsEnabled": false,
"raProxyEnabled": false,
"rsraGuardEnabled": false,
"raThrottlingEnabled": false,
"maxAllowedRA": 10,
"raInterval": 10,
"support80211dEnabled": false,
"support80211kEnabled": true,
"forceClientDHCPTimeoutSec": 5,
"dhcpOption82Enabled": true,
"dhcp82Format": "RUCKUS_DEFAULT",
"unauthClientStatsEnabled": false,
"clientFingerprintingEnabled": true,
"ofdmOnlyEnabled": false,
"bandBalancing": "UseZoneSetting",
"bssMinRateMbps": "Disable",
"mgmtTxRateMbps": "2 mbps",
"avcEnabled": true,
"urlFilteringPolicyEnabled": false,
"urlFilteringPolicyId": "",
"wifiCallingPolicyEnabled": false,
"wifiCallingPolicyIds": [],
"uplinkEnabled": true,
"uplinkRate": 100,
"downlinkEnabled": true,
"downlinkRate": 200,
"ratePerSTAUplink": "650mbps",
"ratePerSTADownlink": "1mbps"
},
"diffServProfile": {
"id": "diffServId",
"name": "diffServName"
},
"qosMaps": [
{
"enable": true,
"priority": 0,
"low": 0,
"high": 7,
"excepts": null
},
{
"enable": true,
"priority": 1,
"low": 8,
"high": 15,
"excepts": null
},
{
"enable": true,
"priority": 2,
"low": 16,
"high": 23,
"excepts": null
},
{
"enable": true,
"priority": 3,
"low": 0,
"high": 32,
"excepts": [
43,
45,
60
]
},
{
"enable": true,
"priority": 4,
"low": 32,
"high": 39,
"excepts": null
},
{
"enable": true,
"priority": 5,
"low": 40,
"high": 47,
"excepts": null
},
{
"enable": true,
"priority": 6,
"low": 48,
"high": 55,
"excepts": [
46
]
},
{
"enable": true,
"priority": 7,
"low": 56,
"high": 63,
"excepts": null
}
],
"dnsServerProfile": {
"id": "DNS server profile UUID",
"name": "DNS server profile name"
},
"dpsk": {
"dpskEnabled": false,
"length": 8,
"dpskType": "Secure",
"expiration": "OneDay",
"dpskFromType": "FirstUse"
},
"externalDpsk": {
"enabled": true,
"encryption": {
"method": "WPA2",
"algorithm": "AES"
},
"authService": {
"id": "authServiceUUID"
}
}
}Schema
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"name" : {
"description" : "Name of the WLAN",
"type" : "string",
"minLength" : 1,
"maxLength" : 32
},
"ssid" : {
"description" : "SSID of the WLAN",
"type" : "string",
"minLength" : 1,
"maxLength" : 32
},
"hessid" : {
"description" : "HESSID of the WLAN",
"type" : "string",
"pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$"
},
"description" : {
"description" : "Description of the WLAN",
"type" : [ "string", "null" ],
"maxLength" : 64
},
"caleaEnabled" : {
"description" : "DP CALEA Server Enabled",
"type" : "boolean"
},
"dpTunnelNatEnabled" : {
"description" : "DP Tunnel NAT Enabled",
"type" : "boolean"
},
"dpTunnelDhcpEnabled" : {
"description" : "DP Tunnel DHCP Enabled",
"type" : "boolean"
},
"awsExtNasIPEnable" : {
"description" : "Aws ExtNasIP Enable",
"type" : "boolean"
},
"awsVenueEnable" : {
"description" : "Aws Venue Enable",
"type" : "boolean"
},
"accessTunnelType" : {
"description" : "Access tunnel type of the WLAN. APLBO means AP local breakout, RuckusGRE means RuckusGRE tunnel to the data plane, and SoftGRE means AP direct SoftGRE tunnel",
"type" : "string",
"enum" : [ "APLBO", "RuckusGRE", "SoftGRE" ]
},
"coreTunnelProfile" : {
"description" : "Core tunnel of the WLAN. This only applies when the access tunnel type is set to RuckusGRE.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"type" : {
"description" : "Tunnel type",
"type" : "string",
"enum" : [ "Bridge", "L2oGRE", "TTG_PDG", "Mixed" ]
},
"id" : {
"description" : "Identifier of the forwarding profile. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the forwarding profile. At least one ID or name is required in the request.",
"type" : "string"
},
"operatorRealm" : {
"description" : "Operator realm, deprecated coreTunnelProfile.operatorRealm from version3.1, prepare remove",
"type" : "string",
"maxLength" : 255,
"pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
}
},
"required" : [ "type" ]
},
"macAuth" : {
"description" : "MAC address authentication settings of the WLAN. This only applies to standard MAC and Hotspot MAC bypass WLAN.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"macAuthMacFormat" : {
"description" : "MAC address format. The default format is 0010a42319c0 and the 802.1X format is 00-10-A4-23-19-C0.",
"type" : "string",
"enum" : [ "Default", "802.1X", "UpperColon", "Upper", "LowerDash", "LowerColon" ]
},
"customizedPassword" : {
"description" : "User defined password. When this field is set to an empty string, the MAC address is used as password.",
"type" : "string",
"maxLength" : 64,
"pattern" : "^([!-;=?-~]([ -;=?-~]){0,62}[!-;=?-~]|[!-;=?-~]{1,1}|\s{0,0})$"
}
}
},
"encryption" : {
"description" : "Encryption of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"method" : {
"description" : "Encryption method",
"type" : "string",
"enum" : [ "WPA2", "WPA_Mixed", "WEP_64", "WEP_128", "None" ],
"default" : "None"
},
"algorithm" : {
"description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
"type" : "string",
"enum" : [ "AES", "TKIP_AES" ]
},
"passphrase" : {
"description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
"type" : "string"
},
"mfp" : {
"description" : "Management frame protection. This only applies to WPA2 + AES",
"type" : "string",
"enum" : [ "disabled", "capable", "required" ]
},
"keyIndex" : {
"description" : "Key index. This only applies to WEP64 and WEP128.",
"type" : "integer"
},
"keyInHex" : {
"description" : "Key in hex format. This only applies to WEP64 and WEP128.",
"type" : "string"
},
"support80211rEnabled" : {
"description" : "Enable 802.11r Fast BSS Transition, fast Romaing.",
"type" : "boolean"
},
"mobilityDomainId" : {
"description" : "mobility Domain Id.",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
}
},
"required" : [ "method" ]
},
"authServiceOrProfile" : {
"description" : "Authentication of the WLAN. If authentication messages are sent through the controller, the ID or name of the global authentication profiles is required. If authentication messages are not sent through the controller, the ID or name of the authentication services configured within the zone is required.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"throughController" : {
"description" : "Indicates whether authentication messages were sent through the controller or not",
"type" : "boolean"
},
"realmBasedAuth" : {
"type" : "boolean"
},
"id" : {
"description" : "Identifier of the authentication service or profile. At least one ID or name or authenticationOption is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the authentication service or profile. At least one ID or name or authenticationOption is required in the request. Or could input the 'Always Accept' or 'Local DB'.",
"type" : "string"
},
"authenticationOption" : {
"description" : "Option of the authentication service or profile, At least one ID or name or authenticationOption is required in the request. This only applies to hotspot and guest WLANs.",
"type" : [ "string", "null" ],
"enum" : [ "Local DB", "Guest", "Always Accept", null ]
},
"locationDeliveryEnabled" : {
"description" : "RFC5580 location delivery support",
"type" : "boolean"
},
"backupAuthenticationId" : {
"description" : "Identifier of the backup authentication service or profile. At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service.",
"type" : "string"
},
"backupAuthenticationName" : {
"description" : "Name of the backup authentication service or profile. At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service. Or could input the 'Always Accept'.",
"type" : "string"
},
"backupAuthenticationOption" : {
"description" : "Option of the backup authentication service or profile, At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service. This only applies to hotspot WLANs.",
"type" : [ "string", "null" ],
"enum" : [ "Always Accept", null ]
}
}
},
"operatorRealm" : {
"description" : "Operator realm, operatorRealm only supports coreTunnelProfile type is authServiceOrProfile.locationDeliveryEnabled is true",
"type" : "string",
"maxLength" : 255,
"pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
},
"accountingServiceOrProfile" : {
"description" : "Accounting of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"throughController" : {
"description" : "Indicates whether accounting messages were sent through the controller",
"type" : "boolean"
},
"realmBasedAcct" : {
"type" : "boolean"
},
"id" : {
"description" : "Accounting service or profile ID. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Accounting service or profile name. At least one ID or name is required in the request.",
"type" : "string"
},
"interimUpdateMin" : {
"description" : "Interval (in minutes) for sending interim updates",
"type" : "integer",
"minimum" : 0,
"maximum" : 1440
},
"accountingDelayEnabled" : {
"description" : "Indicates whether accounting delay time is enabled",
"type" : "boolean"
},
"accountingTTGSessionEnabled" : {
"description" : "Indicates whether accounting for TTG sessions is to enabled",
"type" : "boolean"
},
"backupAccountingId" : {
"description" : "Backup accounting service or profile ID. At least one backupAccountingId or backupAccountingName is required in the request when setting backup accounting service.",
"type" : "string"
},
"backupAccountingName" : {
"description" : "Backup accounting service or profile name. At least one backupAccountingId or backupAccountingName is required in the request when setting backup accounting service.",
"type" : "string"
}
}
},
"portalServiceProfile" : {
"description" : "Portal service of the WLAN. This only applies to hotspot, hotspot MAC bypass, guest and web auth WLANs.",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"hotspot20Profile" : {
"description" : "Hotspot 2.0 operator profile of the WLAN. id or name of the hotspot 2.0 operator profiles within the zone is required.",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"defaultUserTrafficProfile" : {
"description" : "User traffic profile of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"precedenceProfileId" : {
"description" : "Precedence profile of the WLAN",
"type" : "string"
},
"flexiVpnProfile" : {
"description" : "Flexi-VPN profile of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"wlanId" : {
"type" : "string",
"description" : "Wlan ID"
},
"zoneAffinityId" : {
"type" : "string",
"description" : "Zone Affinity ID"
}
},
"required" : [ "zoneAffinityId" ]
},
"schedule" : {
"description" : "Schedule of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"type" : {
"description" : "Type of WLAN schedule",
"type" : "string",
"enum" : [ "AlwaysOn", "AlwaysOff", "Customized" ],
"default" : "AlwaysOn"
},
"id" : {
"description" : "Identifier of the schedule profile. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the schedule profile. At least one ID or name is required in the request.",
"type" : "string"
}
},
"required" : [ "type" ]
},
"vlan" : {
"description" : "VLAN (access and/or core) of the WLAN.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"accessVlan" : {
"description" : "Access VLAN ID",
"type" : "integer",
"minimum" : 1,
"maximum" : 4094,
"default" : 1
},
"aaaVlanOverride" : {
"description" : "Indicates whether the AAA VLAN settings can be overriden or not",
"type" : "boolean"
},
"coreQinQEnabled" : {
"description" : "Indicates whether Q-in-Q is allowed at the core network or not",
"type" : "boolean"
},
"coreSVlan" : {
"description" : "Core SVLAN ID. This only applies when core Q-in-Q is enabled",
"type" : "integer",
"minimum" : 1,
"maximum" : 4094
},
"vlanPooling" : {
"description" : "Vlan pooling",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
}
}
},
"l2ACL" : {
"description" : "Layer 2 ACL of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"devicePolicy" : {
"description" : "Device policy of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"radiusOptions" : {
"description" : "RADIUS options of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"nasIdType" : {
"description" : "NAS ID type",
"type" : "string",
"enum" : [ "WLAN_BSSID", "AP_MAC", "Customized" ],
"default" : "WLAN_BSSID"
},
"customizedNasId" : {
"description" : "User defined NAS ID",
"type" : "string",
"maxLength" : 64,
"pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$"
},
"nasRequestTimeoutSec" : {
"description" : "NAS request timeout in seconds",
"type" : "integer",
"default" : 3,
"minimum" : 2,
"maximum" : 20
},
"nasMaxRetry" : {
"description" : "NAS request maximum retry",
"type" : "integer",
"default" : 2,
"minimum" : 2,
"maximum" : 10
},
"nasReconnectPrimaryMin" : {
"description" : "NAS reconnect primary time in minutes",
"type" : "integer",
"default" : 5,
"minimum" : 1,
"maximum" : 60
},
"calledStaIdType" : {
"description" : "Called station ID type",
"type" : "string",
"enum" : [ "WLAN_BSSID", "AP_MAC", "NONE" ],
"default" : "WLAN_BSSID"
},
"nasIpType" : {
"description" : "NAS IP type",
"type" : "string",
"enum" : [ "disabled", "control", "management", "userDefined" ],
"default" : "disabled"
},
"nasIpUserDefined" : {
"description" : "User-defined NAS IP",
"type" : "string",
"maxLength" : 45
},
"singleSessionIdAcctEnabled" : {
"description" : "When Single Accounting Session ID is enabled, APs will maintain one accounting session for client roaming",
"type" : "boolean",
"default" : false
}
}
},
"advancedOptions" : {
"description" : "Advanced settings for the WLAN.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"clientIsolationEnabled" : {
"description" : "Indicates whether wireless client isolation is enabled or disabled",
"type" : "boolean",
"default" : false
},
"clientIsolationUnicastEnabled" : {
"description" : "Indicates whether isolate unicast of wireless client isolation is enabled or disabled",
"type" : "boolean",
"default" : true
},
"clientIsolationMulticastEnabled" : {
"description" : "Indicates whether isolate multicast of wireless client isolation is enabled or disabled",
"type" : "boolean"
},
"clientIsolationAutoVrrpEnabled" : {
"description" : "Indicates whether Automatic support for VRRP of wireless client isolation is enabled or disabled",
"type" : "boolean",
"default" : false
},
"clientIsolationWhitelist" : {
"description" : "Indicates wireless client isolation whitelist",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"priority" : {
"description" : "Priority of the WLAN",
"type" : "string",
"enum" : [ "High", "Low" ],
"default" : "High"
},
"hideSsidEnabled" : {
"description" : "Indicates whether the SSID is hidden or broadcast",
"type" : "boolean",
"default" : false
},
"hs20Onboarding" : {
"description" : "Allow WISPr WLAN for Hotspot 2.0 Onboarding",
"type" : "boolean",
"default" : false
},
"maxClientsPerRadio" : {
"description" : "Maximum number of clients per radio",
"type" : "integer",
"default" : 100,
"minimum" : 1,
"maximum" : 512
},
"clientIdleTimeoutSec" : {
"description" : "Client idle timeout in seconds",
"type" : "integer",
"minimum" : 60,
"maximum" : 1000,
"default" : 120
},
"dgafEnabled" : {
"description" : "Indicates whether dgaf is enabled or disabled",
"type" : "boolean"
},
"clientLoadBalancingEnabled" : {
"description" : "Indicates whether Client Load Balancing is enabled or disabled",
"type" : "boolean",
"default" : true
},
"proxyARPEnabled" : {
"description" : "Indicates whether proxy ARP is enabled or disabled",
"type" : "boolean",
"default" : false
},
"ndProxyEnabled" : {
"description" : "Indicates whether ND Proxy is enabled or disabled",
"type" : "boolean",
"default" : false
},
"suppressNsEnabled" : {
"description" : "Indicates whether supperssNS is enabled or disabled",
"type" : "boolean",
"default" : false
},
"raProxyEnabled" : {
"description" : "Indicates whether RA proxy is enabled or disabled",
"type" : "boolean",
"default" : false
},
"rsraGuardEnabled" : {
"description" : "Indicates whether RS/RA Guard is enabled or disabled",
"type" : "boolean",
"default" : false
},
"raThrottlingEnabled" : {
"description" : "Indicates whether RA Throttling is enabled or disabled",
"type" : "boolean",
"default" : false
},
"maxAllowedRA" : {
"description" : "Max Allowed RAs",
"type" : "integer",
"minimum" : 1,
"maximum" : 1440,
"default" : 10
},
"raInterval" : {
"description" : "A timer that RA proxy runs and once receives unsolicited RA checks against the configured time and allow/drop RA based on next timeout",
"type" : "integer",
"minimum" : 1,
"maximum" : 256,
"default" : 10
},
"support80211dEnabled" : {
"description" : "Indicates whether support for 802.11d is enabled or disabled",
"type" : "boolean",
"default" : true
},
"support80211kEnabled" : {
"description" : "Indicates whether support for 802.11k is enabled or disabled",
"type" : "boolean",
"default" : true
},
"antiSpoofingEnabled" : {
"description" : "Anti-Spoofing enabled",
"type" : "boolean",
"default" : false
},
"arpRequestRateLimit" : {
"description" : "ARP packets request rate limit, default value will be 15 if both rate limit not being set.",
"type" : "integer",
"minimum" : 0,
"maximum" : 100
},
"dhcpRequestRateLimit" : {
"description" : "DHCP packets request rate limit, default value will be 15 if both rate limit not being set.",
"type" : "integer",
"minimum" : 0,
"maximum" : 100
},
"forceClientDHCPTimeoutSec" : {
"description" : "Force DHCP disconnects the client if the client does not obtain a valid IP address within the timeout peroid. To disable force DHCP, set this value to zero (0).",
"type" : "integer",
"enum" : [ 0, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15 ],
"default" : 0
},
"dhcpOption82Enabled" : {
"description" : "Indicates whether DCHP Option 82 is enabled or disabled",
"type" : "boolean",
"default" : false
},
"dhcp82Format" : {
"description" : "DHCP Option 82 format",
"type" : "string",
"enum" : [ "RUCKUS_DEFAULT", "SOFTGRE_CUSTOMIZED" ]
},
"unauthClientStatsEnabled" : {
"description" : "Indicates whether to send statistics of unauthorized clients or not",
"type" : "boolean",
"default" : false
},
"clientFingerprintingEnabled" : {
"description" : "Indicates whether client fingerprinting is enabled or disabled",
"type" : "boolean",
"default" : false
},
"ofdmOnlyEnabled" : {
"description" : "Indicates whether OFDM only is enabled or disabled",
"type" : "boolean",
"default" : false
},
"bandBalancing" : {
"description" : "Indicates whether band balancing is enabled or disabled",
"type" : "string",
"enum" : [ "Disabled", "UseZoneSetting" ],
"default" : "UseZoneSetting"
},
"bssMinRateMbps" : {
"description" : "BSS minimum rate (mbps)",
"type" : "string",
"enum" : [ "Disable", "1 mbps", "2 mbps", "5.5 mbps", "12 mbps", "24 mbps" ],
"default" : "Disable"
},
"mgmtTxRateMbps" : {
"description" : "Management TX rate (mbps)",
"type" : "string",
"enum" : [ "1 mbps", "2 mbps", "5.5 mbps", "6 mbps", "9 mbps", "11 mbps", "12 mbps", "18 mbps", "24 mbps", "36 mbps", "48 mbps", "54 mbps" ],
"default" : "2 mbps"
},
"pmkCachingEnabled" : {
"description" : "Indicator of whether PKM caching support is enabled or disabled. The default value is true when the WLAN is WPA+AES non open WLAN.",
"type" : "boolean"
},
"okcEnabled" : {
"description" : "Indicator of whether OKC support is enabled or disabled. The default value is true when the WLAN is WPA+AES non open WLAN.",
"type" : "boolean"
},
"avcEnabled" : {
"description" : "Indicator of whether ARC support is enabled or disabled",
"type" : "boolean",
"default" : false
},
"urlFilteringPolicyEnabled" : {
"description" : "Indicator of whether URL Filtering is enabled or disabled",
"type" : "boolean",
"default" : false
},
"urlFilteringPolicyId" : {
"description" : "The URL Filtering policy ID.",
"type" : "string"
},
"wifiCallingPolicyEnabled" : {
"description" : "Indicator of whether Wi-Fi Calling is enabled or disabled",
"type" : "boolean",
"default" : false
},
"wifiCallingPolicyIds" : {
"description" : "The Wi-Fi Calling policy IDs. (Maximum allowed number is 5)",
"type" : "array",
"items" : {
"type" : "string"
}
},
"uplinkEnabled" : {
"description" : "SSID Rate Limiting uplink enabled.",
"type" : "boolean",
"default" : false
},
"uplinkRate" : {
"description" : "SSID Rate Limiting uplink.",
"type" : "number",
"default" : 0.0
},
"downlinkEnabled" : {
"description" : "SSID Rate Limiting downlink enabled.",
"type" : "boolean",
"default" : false
},
"downlinkRate" : {
"description" : "SSID Rate Limiting downlink.",
"type" : "number",
"default" : 0.0
},
"ratePerSTAUplink" : {
"description" : "UE Rate Limiting uplink.",
"type" : "string"
},
"ratePerSTADownlink" : {
"description" : "UE Rate Limiting downlink.",
"type" : "string"
},
"dtimInterval" : {
"description" : "DTIM Interval",
"type" : "integer",
"minimum" : 1,
"maximum" : 255,
"default" : 1
},
"directedThreshold" : {
"description" : "Directed Threshold Setting, Defines the client count at which an AP will stop converting group addressed data traffic to unicast.",
"type" : "integer",
"minimum" : 0,
"maximum" : 128,
"default" : 5
},
"flowLogEnabled" : {
"description" : "Flow log enabled.",
"type" : "boolean",
"default" : false
},
"hdOverheadOptimizeEnable" : {
"description" : "Airtime decongestion enabled.",
"type" : "boolean",
"default" : false
},
"probeRssiThr" : {
"type" : "integer",
"description" : "Join RSSI threshold.",
"minimum" : -90,
"maximum" : -60,
"default" : -85
},
"transientClientMgmtEnable" : {
"description" : "Transient Client Management enabled.",
"type" : "boolean",
"default" : false
},
"joinIgnoreTimeout" : {
"description" : "Join wait time.",
"type" : "integer",
"minimum" : 1,
"maximum" : 60,
"default" : 30
},
"joinAcceptTimeout" : {
"description" : "Join expire time.",
"type" : "integer",
"minimum" : 1,
"maximum" : 300,
"default" : 300
},
"joinIgnoreThr" : {
"description" : "Join wait threshold.",
"type" : "integer",
"minimum" : 1,
"maximum" : 50,
"default" : 10
},
"authRssiThr" : {
"description" : "Auth RSSI threshold.",
"type" : "integer",
"minimum" : -90,
"maximum" : -60
},
"assocRssiThr" : {
"description" : "Assoc RSSI threshold.",
"type" : "integer",
"minimum" : -90,
"maximum" : -60
},
"oceEnabled" : {
"description" : "Optimized Connectivity Experience(OCE) enabled.",
"type" : "boolean",
"default" : false
},
"oceBroadcastProbeResponseDelay" : {
"description" : "Broadcast probe response delay.",
"type" : "integer",
"minimum" : 8,
"maximum" : 120,
"default" : 15
},
"oceRssiBasedAssociationRejectionThreshold" : {
"description" : "RSSI-based association rejection threshold.",
"type" : "integer",
"minimum" : -90,
"maximum" : -60,
"default" : -75
}
}
},
"diffServProfile" : {
"description" : "DiffServ profile of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"qosMaps" : {
"description" : "Qos map set of the WLAN.",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"enable" : {
"description" : "Enabled or disabled",
"type" : "boolean"
},
"priority" : {
"description" : "Priority",
"type" : "integer"
},
"low" : {
"description" : "DSCP range - low",
"type" : [ "integer", "null" ],
"minimum" : 0,
"maximum" : 255
},
"high" : {
"description" : "DSCP range - high",
"type" : [ "integer", "null" ],
"minimum" : 0,
"maximum" : 255
},
"excepts" : {
"type" : [ "array", "null" ],
"items" : {
"type" : "integer",
"minimum" : 0,
"maximum" : 63
}
}
},
"required" : [ "enable", "priority" ]
}
},
"dpsk" : {
"description" : "DPSK Setting",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"dpskEnabled" : {
"description" : "DPSK enabled",
"type" : "boolean",
"default" : false
},
"length" : {
"description" : "Length of DPSK key",
"type" : "integer",
"default" : 62
},
"dpskType" : {
"description" : "Type of DPSK key",
"type" : "string",
"enum" : [ "Secure", "KeyboardFriendly", "NumbersOnly" ],
"default" : "Secure"
},
"expiration" : {
"description" : "Expiration of DPSK key",
"type" : "string",
"enum" : [ "Unlimited", "OneDay", "TwoDays", "OneWeek", "TwoWeeks", "OneMonth", "SixMonths", "OneYear", "TwoYears" ],
"default" : "Unlimited"
},
"dpskFromType" : {
"description" : "Type of expiration start from",
"type" : "string",
"enum" : [ "CreateTime", "FirstUse" ],
"default" : "CreateTime"
}
}
},
"externalDpsk" : {
"description" : "External DPSK Enabled",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"enabled" : {
"description" : "Enable External DPSK",
"type" : "boolean",
"default" : false
},
"encryption" : {
"description" : "Encryption of the WLAN relate to external DPSK",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"method" : {
"description" : "Encryption method",
"type" : "string",
"enum" : [ "WPA2", "WPA_Mixed", "None" ]
},
"algorithm" : {
"description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
"type" : "string",
"enum" : [ "AES", "TKIP_AES" ]
}
}
},
"authService" : {
"description" : "Autentication of the WLAN relate to external DPSK",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Identifier of the authentication service. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the authentication service. At least one ID or name is required in the request.",
"type" : "string"
}
}
}
},
"required" : [ "enabled" ]
},
"dnsServerProfile" : {
"description" : "DNS server profile of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"accessTunnelProfile" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"accessIpsecProfile" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"splitTunnelProfileId" : {
"type" : "string"
},
"portalDetectionProfileId" : {
"type" : "string"
}
},
"required" : [ "name", "ssid", "authServiceOrProfile" ]
}201Body
{
"id": "wlanID"
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
}
}
}Create - Hotspot ¶
POST/v8_0/rkszones/{zoneId}/wlans/wispr
Use this API command to create new hotspot (WISPr) WLAN.
Body
‧ Sample : Create a Hotspot (WISPr) WLAN with default configurations
{
"name" : "wlanName",
"ssid" : "wlanSSID",
"description" : "wlanDescription",
"authServiceOrProfile" : {
"throughController" : false,
"id" : "authServiceUUID",
"name" : "authServiceName",
"authenticationOption" : null,
"backupAuthenticationId" : "otherAuthServiceUUID",
"backupAuthenticationOption" : null
},
"accountingServiceOrProfile" : {
"id" : "acctingServiceUUID",
"name" : "acctingServiceName",
"throughController" : false,
"realmBasedAcct" : false,
"interimUpdateMin" : 10,
"accountingDelayEnabled" : false,
"backupAccountingId" : "otherAccountingServiceUUID",
"backupAccountingName" : "otherAccountingServiceName"
},
"portalServiceProfile" : {
"id" : "portalServiceUUID",
"name" : "portalServiceName"
},
"accessTunnelType" : "RuckusGRE",
"accessTunnelProfile" : {
"id" : "f5b92938-aa4e-4d02-90ea-273799ff689b",
"name" : "Default Tunnel Profile"
},
"splitTunnelProfileId" : "38119bac-49e1-4410-ab8e-1c1bc88dd770",
"coreTunnelProfile" : {
"type" : "Bridge",
"id" : "forwardingUUID",
"name" : "forwardingName"
},
"encryption" : {
"method" : "WPA2",
"algorithm" : "AES",
"passphrase" : "password",
"mfp" : "disabled",
"support80211rEnabled" : true,
"mobilityDomainId" : 3
},
"operatorRealm" : "operator realm",
"defaultUserTrafficProfile" : {
"id" : "userTrafficUUID",
"name" : "userTrafficName"
},
"precedenceProfileId" : "c514d450-c839-9527-afc9-525400d12345",
"portalDetectionProfileId" : "de0fa30c-9565-11e8-9eb6-529269fb1459",
"schedule" : {
"type" : "Customized",
"id" : "ServiceUUID",
"name" : "ServiceName"
},
"vlan" : {
"accessVlan" : 23,
"coreQinQEnabled" : false,
"coreSVlan" : 1,
"vlanPooling" : null
},
"l2ACL" : {
"id" : "l2ACLUUID",
"name" : "l2ACLName"
},
"devicePolicy" : {
"id" : "devicePolicyUUID",
"name" : "devicePolicyName"
},
"radiusOptions" : {
"nasIdType" : "Customized",
"customizedNasId" : "nasId",
"nasRequestTimeoutSec" : 12,
"nasMaxRetry" : 3,
"nasReconnectPrimaryMin" : 30,
"calledStaIdType" : "WLAN_BSSID",
"nasIpType" : "disabled",
"nasIpUserDefined" : "192.168.1.1"
},
"advancedOptions" : {
"clientIsolationEnabled" : true,
"clientIsolationUnicastEnabled" : true,
"clientIsolationMulticastEnabled" : false,
"clientIsolationAutoVrrpEnabled" : false,
"clientIsolationWhitelist" : {
"id" : "b89323e1-3168-11e7-b027-5254009ae3f0",
"name" : "myWhitelist"
},
"priority" : "High",
"hideSsidEnabled" : true,
"maxClientsPerRadio" : 12,
"clientIdleTimeoutSec" : 60,
"clientLoadBalancingEnabled" : true,
"proxyARPEnabled" : true,
"ndProxyEnabled" : false,
"suppressNsEnabled" : false,
"raProxyEnabled" : false,
"rsraGuardEnabled" : false,
"raThrottlingEnabled" : false,
"maxAllowedRA" : 10,
"raInterval" : 10,
"support80211dEnabled" : false,
"support80211kEnabled" : true,
"forceClientDHCPTimeoutSec" : 5,
"dhcpOption82Enabled" : true,
"dhcp82Format" : "RUCKUS_DEFAULT",
"unauthClientStatsEnabled" : false,
"clientFingerprintingEnabled" : true,
"ofdmOnlyEnabled" : false,
"bandBalancing" : "UseZoneSetting",
"bssMinRateMbps" : "Disable",
"mgmtTxRateMbps" : "2 mbps",
"avcEnabled" : true,
"urlFilteringPolicyEnabled" : false,
"urlFilteringPolicyId" : "",
"wifiCallingPolicyEnabled" : false,
"wifiCallingPolicyIds" : [ ],
"uplinkEnabled" : true,
"uplinkRate" : 100,
"downlinkEnabled" : true,
"downlinkRate" : 200,
"ratePerSTAUplink" : "650mbps",
"ratePerSTADownlink" : "1mbps"
},
"diffServProfile" : {
"id" : "diffServId",
"name" : "diffServName"
},
"qosMaps" : [ {
"enable" : true,
"priority" : 0,
"low" : 0,
"high" : 7,
"excepts" : null
}, {
"enable" : true,
"priority" : 1,
"low" : 8,
"high" : 15,
"excepts" : null
}, {
"enable" : true,
"priority" : 2,
"low" : 16,
"high" : 23,
"excepts" : null
}, {
"enable" : true,
"priority" : 3,
"low" : 0,
"high" : 32,
"excepts" : [ 43, 45, 60 ]
}, {
"enable" : true,
"priority" : 4,
"low" : 32,
"high" : 39,
"excepts" : null
}, {
"enable" : true,
"priority" : 5,
"low" : 40,
"high" : 47,
"excepts" : null
}, {
"enable" : true,
"priority" : 6,
"low" : 48,
"high" : 55,
"excepts" : [ 46 ]
}, {
"enable" : true,
"priority" : 7,
"low" : 56,
"high" : 63,
"excepts" : null
} ],
"dnsServerProfile" : {
"id" : "DNS server profile UUID",
"name" : "DNS server profile name"
},
"dpsk" : {
"dpskEnabled" : false,
"length" : 8,
"dpskType" : "Secure",
"expiration" : "OneDay",
"dpskFromType" : "FirstUse"
},
"externalDpsk" : {
"enabled" : true,
"encryption" : {
"method" : "WPA2",
"algorithm" : "AES"
},
"authService" : {
"id" : "authServiceUUID"
}
}
}
‧ Sample : Create a Hotspot (WISPr) WLAN allows Hotspot 2.0 Onboarding
{
"name" : "wlanName",
"ssid" : "wlanSSID",
"description" : "wlanDescription",
"authServiceOrProfile" : {
"throughController" : false,
"id" : "authServiceUUID",
"name" : "authServiceName"
},
"portalServiceProfile" : {
"id" : "portalServiceUUID",
"name" : "portalServiceName"
},
"advancedOptions" : {
"hs20Onboarding" : true
}
}
‧ Sample : Create a Hotspot (WISPr) WLAN with authenticationOption configurations
{
"name" : "wlanName",
"ssid" : "wlanSSID",
"description" : "wlanDescription",
"authServiceOrProfile" : {
"throughController" : true,
"authenticationOption" : "Local DB",
"backupAuthenticationId" : "otherAuthServiceUUID",
"backupAuthenticationOption" : null
},
"portalServiceProfile" : {
"id" : "portalServiceUUID",
"name" : "portalServiceName"
}
}Schema
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"name" : {
"description" : "Name of the WLAN",
"type" : "string",
"minLength" : 1,
"maxLength" : 32
},
"ssid" : {
"description" : "SSID of the WLAN",
"type" : "string",
"minLength" : 1,
"maxLength" : 32
},
"hessid" : {
"description" : "HESSID of the WLAN",
"type" : "string",
"pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$"
},
"description" : {
"description" : "Description of the WLAN",
"type" : [ "string", "null" ],
"maxLength" : 64
},
"bypassCNA" : {
"description" : "Bypass Capitive Network Assitance",
"type" : "boolean",
"default" : false
},
"caleaEnabled" : {
"description" : "DP CALEA Server Enabled",
"type" : "boolean"
},
"dpTunnelNatEnabled" : {
"description" : "DP Tunnel NAT Enabled",
"type" : "boolean"
},
"dpTunnelDhcpEnabled" : {
"description" : "DP Tunnel DHCP Enabled",
"type" : "boolean"
},
"awsExtNasIPEnable" : {
"description" : "Aws ExtNasIP Enable",
"type" : "boolean"
},
"awsVenueEnable" : {
"description" : "Aws Venue Enable",
"type" : "boolean"
},
"accessTunnelType" : {
"description" : "Access tunnel type of the WLAN. APLBO means AP local breakout, RuckusGRE means RuckusGRE tunnel to the data plane, and SoftGRE means AP direct SoftGRE tunnel",
"type" : "string",
"enum" : [ "APLBO", "RuckusGRE", "SoftGRE" ]
},
"coreTunnelProfile" : {
"description" : "Core tunnel of the WLAN. This only applies when the access tunnel type is set to RuckusGRE.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"type" : {
"description" : "Tunnel type",
"type" : "string",
"enum" : [ "Bridge", "L2oGRE", "TTG_PDG", "Mixed" ]
},
"id" : {
"description" : "Identifier of the forwarding profile. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the forwarding profile. At least one ID or name is required in the request.",
"type" : "string"
},
"operatorRealm" : {
"description" : "Operator realm, deprecated coreTunnelProfile.operatorRealm from version3.1, prepare remove",
"type" : "string",
"maxLength" : 255,
"pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
}
},
"required" : [ "type" ]
},
"macAuth" : {
"description" : "MAC address authentication settings of the WLAN. This only applies to standard MAC and Hotspot MAC bypass WLAN.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"macAuthMacFormat" : {
"description" : "MAC address format. The default format is 0010a42319c0 and the 802.1X format is 00-10-A4-23-19-C0.",
"type" : "string",
"enum" : [ "Default", "802.1X", "UpperColon", "Upper", "LowerDash", "LowerColon" ]
},
"customizedPassword" : {
"description" : "User defined password. When this field is set to an empty string, the MAC address is used as password.",
"type" : "string",
"maxLength" : 64,
"pattern" : "^([!-;=?-~]([ -;=?-~]){0,62}[!-;=?-~]|[!-;=?-~]{1,1}|\s{0,0})$"
}
}
},
"encryption" : {
"description" : "Encryption of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"method" : {
"description" : "Encryption method",
"type" : "string",
"enum" : [ "WPA2", "WPA_Mixed", "WEP_64", "WEP_128", "None" ],
"default" : "None"
},
"algorithm" : {
"description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
"type" : "string",
"enum" : [ "AES", "TKIP_AES" ]
},
"passphrase" : {
"description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
"type" : "string"
},
"mfp" : {
"description" : "Management frame protection. This only applies to WPA2 + AES",
"type" : "string",
"enum" : [ "disabled", "capable", "required" ]
},
"keyIndex" : {
"description" : "Key index. This only applies to WEP64 and WEP128.",
"type" : "integer"
},
"keyInHex" : {
"description" : "Key in hex format. This only applies to WEP64 and WEP128.",
"type" : "string"
},
"support80211rEnabled" : {
"description" : "Enable 802.11r Fast BSS Transition, fast Romaing.",
"type" : "boolean"
},
"mobilityDomainId" : {
"description" : "mobility Domain Id.",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
}
},
"required" : [ "method" ]
},
"authServiceOrProfile" : {
"description" : "Authentication of the WLAN. The hotspot WLAN requires authentication messages to be sent through the controller. The ID or name of the authentication services configured globally is required.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"throughController" : {
"description" : "Indicates whether authentication messages were sent through the controller or not",
"type" : "boolean"
},
"realmBasedAuth" : {
"type" : "boolean"
},
"id" : {
"description" : "Identifier of the authentication service or profile. At least one ID or name or authenticationOption is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the authentication service or profile. At least one ID or name or authenticationOption is required in the request. Or could input the 'Always Accept' or 'Local DB'.",
"type" : "string"
},
"authenticationOption" : {
"description" : "Option of the authentication service or profile, At least one ID or name or authenticationOption is required in the request. This only applies to hotspot and guest WLANs.",
"type" : [ "string", "null" ],
"enum" : [ "Local DB", "Guest", "Always Accept", null ]
},
"locationDeliveryEnabled" : {
"description" : "RFC5580 location delivery support",
"type" : "boolean"
},
"backupAuthenticationId" : {
"description" : "Identifier of the backup authentication service or profile. At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service.",
"type" : "string"
},
"backupAuthenticationName" : {
"description" : "Name of the backup authentication service or profile. At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service. Or could input the 'Always Accept'.",
"type" : "string"
},
"backupAuthenticationOption" : {
"description" : "Option of the backup authentication service or profile, At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service. This only applies to hotspot WLANs.",
"type" : [ "string", "null" ],
"enum" : [ "Always Accept", null ]
}
}
},
"operatorRealm" : {
"description" : "Operator realm, operatorRealm only supports coreTunnelProfile type is authServiceOrProfile.locationDeliveryEnabled is true",
"type" : "string",
"maxLength" : 255,
"pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
},
"accountingServiceOrProfile" : {
"description" : "Accounting of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"throughController" : {
"description" : "Indicates whether accounting messages were sent through the controller",
"type" : "boolean"
},
"realmBasedAcct" : {
"type" : "boolean"
},
"id" : {
"description" : "Accounting service or profile ID. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Accounting service or profile name. At least one ID or name is required in the request.",
"type" : "string"
},
"interimUpdateMin" : {
"description" : "Interval (in minutes) for sending interim updates",
"type" : "integer",
"minimum" : 0,
"maximum" : 1440
},
"accountingDelayEnabled" : {
"description" : "Indicates whether accounting delay time is enabled",
"type" : "boolean"
},
"accountingTTGSessionEnabled" : {
"description" : "Indicates whether accounting for TTG sessions is to enabled",
"type" : "boolean"
},
"backupAccountingId" : {
"description" : "Backup accounting service or profile ID. At least one backupAccountingId or backupAccountingName is required in the request when setting backup accounting service.",
"type" : "string"
},
"backupAccountingName" : {
"description" : "Backup accounting service or profile name. At least one backupAccountingId or backupAccountingName is required in the request when setting backup accounting service.",
"type" : "string"
}
}
},
"portalServiceProfile" : {
"description" : "Hotspot portal service of the WLAN. The ID or name of the hotspot portal services within the zone is required.",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"hotspot20Profile" : {
"description" : "Hotspot 2.0 operator profile of the WLAN. id or name of the hotspot 2.0 operator profiles within the zone is required.",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"defaultUserTrafficProfile" : {
"description" : "User traffic profile of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"precedenceProfileId" : {
"description" : "Precedence profile of the WLAN",
"type" : "string"
},
"flexiVpnProfile" : {
"description" : "Flexi-VPN profile of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"wlanId" : {
"type" : "string",
"description" : "Wlan ID"
},
"zoneAffinityId" : {
"type" : "string",
"description" : "Zone Affinity ID"
}
},
"required" : [ "zoneAffinityId" ]
},
"schedule" : {
"description" : "Schedule of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"type" : {
"description" : "Type of WLAN schedule",
"type" : "string",
"enum" : [ "AlwaysOn", "AlwaysOff", "Customized" ],
"default" : "AlwaysOn"
},
"id" : {
"description" : "Identifier of the schedule profile. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the schedule profile. At least one ID or name is required in the request.",
"type" : "string"
}
},
"required" : [ "type" ]
},
"vlan" : {
"description" : "VLAN (access and/or core) of the WLAN.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"accessVlan" : {
"description" : "Access VLAN ID",
"type" : "integer",
"minimum" : 1,
"maximum" : 4094,
"default" : 1
},
"aaaVlanOverride" : {
"description" : "Indicates whether the AAA VLAN settings can be overriden or not",
"type" : "boolean"
},
"coreQinQEnabled" : {
"description" : "Indicates whether Q-in-Q is allowed at the core network or not",
"type" : "boolean"
},
"coreSVlan" : {
"description" : "Core SVLAN ID. This only applies when core Q-in-Q is enabled",
"type" : "integer",
"minimum" : 1,
"maximum" : 4094
},
"vlanPooling" : {
"description" : "Vlan pooling",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
}
}
},
"l2ACL" : {
"description" : "Layer 2 ACL of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"devicePolicy" : {
"description" : "Device policy of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"radiusOptions" : {
"description" : "RADIUS options of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"nasIdType" : {
"description" : "NAS ID type",
"type" : "string",
"enum" : [ "WLAN_BSSID", "AP_MAC", "Customized" ],
"default" : "WLAN_BSSID"
},
"customizedNasId" : {
"description" : "User defined NAS ID",
"type" : "string",
"maxLength" : 64,
"pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$"
},
"nasRequestTimeoutSec" : {
"description" : "NAS request timeout in seconds",
"type" : "integer",
"default" : 3,
"minimum" : 2,
"maximum" : 20
},
"nasMaxRetry" : {
"description" : "NAS request maximum retry",
"type" : "integer",
"default" : 2,
"minimum" : 2,
"maximum" : 10
},
"nasReconnectPrimaryMin" : {
"description" : "NAS reconnect primary time in minutes",
"type" : "integer",
"default" : 5,
"minimum" : 1,
"maximum" : 60
},
"calledStaIdType" : {
"description" : "Called station ID type",
"type" : "string",
"enum" : [ "WLAN_BSSID", "AP_MAC", "NONE" ],
"default" : "WLAN_BSSID"
},
"nasIpType" : {
"description" : "NAS IP type",
"type" : "string",
"enum" : [ "disabled", "control", "management", "userDefined" ],
"default" : "disabled"
},
"nasIpUserDefined" : {
"description" : "User-defined NAS IP",
"type" : "string",
"maxLength" : 45
},
"singleSessionIdAcctEnabled" : {
"description" : "When Single Accounting Session ID is enabled, APs will maintain one accounting session for client roaming",
"type" : "boolean",
"default" : false
}
}
},
"advancedOptions" : {
"description" : "Advanced settings for the WLAN.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"clientIsolationEnabled" : {
"description" : "Indicates whether wireless client isolation is enabled or disabled",
"type" : "boolean",
"default" : false
},
"clientIsolationUnicastEnabled" : {
"description" : "Indicates whether isolate unicast of wireless client isolation is enabled or disabled",
"type" : "boolean",
"default" : true
},
"clientIsolationMulticastEnabled" : {
"description" : "Indicates whether isolate multicast of wireless client isolation is enabled or disabled",
"type" : "boolean"
},
"clientIsolationAutoVrrpEnabled" : {
"description" : "Indicates whether Automatic support for VRRP of wireless client isolation is enabled or disabled",
"type" : "boolean",
"default" : false
},
"clientIsolationWhitelist" : {
"description" : "Indicates wireless client isolation whitelist",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"priority" : {
"description" : "Priority of the WLAN",
"type" : "string",
"enum" : [ "High", "Low" ],
"default" : "High"
},
"hideSsidEnabled" : {
"description" : "Indicates whether the SSID is hidden or broadcast",
"type" : "boolean",
"default" : false
},
"hs20Onboarding" : {
"description" : "Allow WISPr WLAN for Hotspot 2.0 Onboarding",
"type" : "boolean",
"default" : false
},
"maxClientsPerRadio" : {
"description" : "Maximum number of clients per radio",
"type" : "integer",
"default" : 100,
"minimum" : 1,
"maximum" : 512
},
"clientIdleTimeoutSec" : {
"description" : "Client idle timeout in seconds",
"type" : "integer",
"minimum" : 60,
"maximum" : 1000,
"default" : 120
},
"dgafEnabled" : {
"description" : "Indicates whether dgaf is enabled or disabled",
"type" : "boolean"
},
"clientLoadBalancingEnabled" : {
"description" : "Indicates whether Client Load Balancing is enabled or disabled",
"type" : "boolean",
"default" : true
},
"proxyARPEnabled" : {
"description" : "Indicates whether proxy ARP is enabled or disabled",
"type" : "boolean",
"default" : false
},
"ndProxyEnabled" : {
"description" : "Indicates whether ND Proxy is enabled or disabled",
"type" : "boolean",
"default" : false
},
"suppressNsEnabled" : {
"description" : "Indicates whether supperssNS is enabled or disabled",
"type" : "boolean",
"default" : false
},
"raProxyEnabled" : {
"description" : "Indicates whether RA proxy is enabled or disabled",
"type" : "boolean",
"default" : false
},
"rsraGuardEnabled" : {
"description" : "Indicates whether RS/RA Guard is enabled or disabled",
"type" : "boolean",
"default" : false
},
"raThrottlingEnabled" : {
"description" : "Indicates whether RA Throttling is enabled or disabled",
"type" : "boolean",
"default" : false
},
"maxAllowedRA" : {
"description" : "Max Allowed RAs",
"type" : "integer",
"minimum" : 1,
"maximum" : 1440,
"default" : 10
},
"raInterval" : {
"description" : "A timer that RA proxy runs and once receives unsolicited RA checks against the configured time and allow/drop RA based on next timeout",
"type" : "integer",
"minimum" : 1,
"maximum" : 256,
"default" : 10
},
"support80211dEnabled" : {
"description" : "Indicates whether support for 802.11d is enabled or disabled",
"type" : "boolean",
"default" : true
},
"support80211kEnabled" : {
"description" : "Indicates whether support for 802.11k is enabled or disabled",
"type" : "boolean",
"default" : true
},
"antiSpoofingEnabled" : {
"description" : "Anti-Spoofing enabled",
"type" : "boolean",
"default" : false
},
"arpRequestRateLimit" : {
"description" : "ARP packets request rate limit, default value will be 15 if both rate limit not being set.",
"type" : "integer",
"minimum" : 0,
"maximum" : 100
},
"dhcpRequestRateLimit" : {
"description" : "DHCP packets request rate limit, default value will be 15 if both rate limit not being set.",
"type" : "integer",
"minimum" : 0,
"maximum" : 100
},
"forceClientDHCPTimeoutSec" : {
"description" : "Force DHCP disconnects the client if the client does not obtain a valid IP address within the timeout peroid. To disable force DHCP, set this value to zero (0).",
"type" : "integer",
"enum" : [ 0, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15 ],
"default" : 0
},
"dhcpOption82Enabled" : {
"description" : "Indicates whether DCHP Option 82 is enabled or disabled",
"type" : "boolean",
"default" : false
},
"dhcp82Format" : {
"description" : "DHCP Option 82 format",
"type" : "string",
"enum" : [ "RUCKUS_DEFAULT", "SOFTGRE_CUSTOMIZED" ]
},
"unauthClientStatsEnabled" : {
"description" : "Indicates whether to send statistics of unauthorized clients or not",
"type" : "boolean",
"default" : false
},
"clientFingerprintingEnabled" : {
"description" : "Indicates whether client fingerprinting is enabled or disabled",
"type" : "boolean",
"default" : false
},
"ofdmOnlyEnabled" : {
"description" : "Indicates whether OFDM only is enabled or disabled",
"type" : "boolean",
"default" : false
},
"bandBalancing" : {
"description" : "Indicates whether band balancing is enabled or disabled",
"type" : "string",
"enum" : [ "Disabled", "UseZoneSetting" ],
"default" : "UseZoneSetting"
},
"bssMinRateMbps" : {
"description" : "BSS minimum rate (mbps)",
"type" : "string",
"enum" : [ "Disable", "1 mbps", "2 mbps", "5.5 mbps", "12 mbps", "24 mbps" ],
"default" : "Disable"
},
"mgmtTxRateMbps" : {
"description" : "Management TX rate (mbps)",
"type" : "string",
"enum" : [ "1 mbps", "2 mbps", "5.5 mbps", "6 mbps", "9 mbps", "11 mbps", "12 mbps", "18 mbps", "24 mbps", "36 mbps", "48 mbps", "54 mbps" ],
"default" : "2 mbps"
},
"pmkCachingEnabled" : {
"description" : "Indicator of whether PKM caching support is enabled or disabled. The default value is true when the WLAN is WPA+AES non open WLAN.",
"type" : "boolean"
},
"okcEnabled" : {
"description" : "Indicator of whether OKC support is enabled or disabled. The default value is true when the WLAN is WPA+AES non open WLAN.",
"type" : "boolean"
},
"avcEnabled" : {
"description" : "Indicator of whether ARC support is enabled or disabled",
"type" : "boolean",
"default" : false
},
"urlFilteringPolicyEnabled" : {
"description" : "Indicator of whether URL Filtering is enabled or disabled",
"type" : "boolean",
"default" : false
},
"urlFilteringPolicyId" : {
"description" : "The URL Filtering policy ID.",
"type" : "string"
},
"wifiCallingPolicyEnabled" : {
"description" : "Indicator of whether Wi-Fi Calling is enabled or disabled",
"type" : "boolean",
"default" : false
},
"wifiCallingPolicyIds" : {
"description" : "The Wi-Fi Calling policy IDs. (Maximum allowed number is 5)",
"type" : "array",
"items" : {
"type" : "string"
}
},
"uplinkEnabled" : {
"description" : "SSID Rate Limiting uplink enabled.",
"type" : "boolean",
"default" : false
},
"uplinkRate" : {
"description" : "SSID Rate Limiting uplink.",
"type" : "number",
"default" : 0.0
},
"downlinkEnabled" : {
"description" : "SSID Rate Limiting downlink enabled.",
"type" : "boolean",
"default" : false
},
"downlinkRate" : {
"description" : "SSID Rate Limiting downlink.",
"type" : "number",
"default" : 0.0
},
"ratePerSTAUplink" : {
"description" : "UE Rate Limiting uplink.",
"type" : "string"
},
"ratePerSTADownlink" : {
"description" : "UE Rate Limiting downlink.",
"type" : "string"
},
"dtimInterval" : {
"description" : "DTIM Interval",
"type" : "integer",
"minimum" : 1,
"maximum" : 255,
"default" : 1
},
"directedThreshold" : {
"description" : "Directed Threshold Setting, Defines the client count at which an AP will stop converting group addressed data traffic to unicast.",
"type" : "integer",
"minimum" : 0,
"maximum" : 128,
"default" : 5
},
"flowLogEnabled" : {
"description" : "Flow log enabled.",
"type" : "boolean",
"default" : false
},
"hdOverheadOptimizeEnable" : {
"description" : "Airtime decongestion enabled.",
"type" : "boolean",
"default" : false
},
"probeRssiThr" : {
"type" : "integer",
"description" : "Join RSSI threshold.",
"minimum" : -90,
"maximum" : -60,
"default" : -85
},
"transientClientMgmtEnable" : {
"description" : "Transient Client Management enabled.",
"type" : "boolean",
"default" : false
},
"joinIgnoreTimeout" : {
"description" : "Join wait time.",
"type" : "integer",
"minimum" : 1,
"maximum" : 60,
"default" : 30
},
"joinAcceptTimeout" : {
"description" : "Join expire time.",
"type" : "integer",
"minimum" : 1,
"maximum" : 300,
"default" : 300
},
"joinIgnoreThr" : {
"description" : "Join wait threshold.",
"type" : "integer",
"minimum" : 1,
"maximum" : 50,
"default" : 10
},
"authRssiThr" : {
"description" : "Auth RSSI threshold.",
"type" : "integer",
"minimum" : -90,
"maximum" : -60
},
"assocRssiThr" : {
"description" : "Assoc RSSI threshold.",
"type" : "integer",
"minimum" : -90,
"maximum" : -60
},
"oceEnabled" : {
"description" : "Optimized Connectivity Experience(OCE) enabled.",
"type" : "boolean",
"default" : false
},
"oceBroadcastProbeResponseDelay" : {
"description" : "Broadcast probe response delay.",
"type" : "integer",
"minimum" : 8,
"maximum" : 120,
"default" : 15
},
"oceRssiBasedAssociationRejectionThreshold" : {
"description" : "RSSI-based association rejection threshold.",
"type" : "integer",
"minimum" : -90,
"maximum" : -60,
"default" : -75
}
}
},
"diffServProfile" : {
"description" : "DiffServ profile of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"qosMaps" : {
"description" : "Qos map set of the WLAN.",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"enable" : {
"description" : "Enabled or disabled",
"type" : "boolean"
},
"priority" : {
"description" : "Priority",
"type" : "integer"
},
"low" : {
"description" : "DSCP range - low",
"type" : [ "integer", "null" ],
"minimum" : 0,
"maximum" : 255
},
"high" : {
"description" : "DSCP range - high",
"type" : [ "integer", "null" ],
"minimum" : 0,
"maximum" : 255
},
"excepts" : {
"type" : [ "array", "null" ],
"items" : {
"type" : "integer",
"minimum" : 0,
"maximum" : 63
}
}
},
"required" : [ "enable", "priority" ]
}
},
"dpsk" : {
"description" : "DPSK Setting",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"dpskEnabled" : {
"description" : "DPSK enabled",
"type" : "boolean",
"default" : false
},
"length" : {
"description" : "Length of DPSK key",
"type" : "integer",
"default" : 62
},
"dpskType" : {
"description" : "Type of DPSK key",
"type" : "string",
"enum" : [ "Secure", "KeyboardFriendly", "NumbersOnly" ],
"default" : "Secure"
},
"expiration" : {
"description" : "Expiration of DPSK key",
"type" : "string",
"enum" : [ "Unlimited", "OneDay", "TwoDays", "OneWeek", "TwoWeeks", "OneMonth", "SixMonths", "OneYear", "TwoYears" ],
"default" : "Unlimited"
},
"dpskFromType" : {
"description" : "Type of expiration start from",
"type" : "string",
"enum" : [ "CreateTime", "FirstUse" ],
"default" : "CreateTime"
}
}
},
"externalDpsk" : {
"description" : "External DPSK Enabled",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"enabled" : {
"description" : "Enable External DPSK",
"type" : "boolean",
"default" : false
},
"encryption" : {
"description" : "Encryption of the WLAN relate to external DPSK",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"method" : {
"description" : "Encryption method",
"type" : "string",
"enum" : [ "WPA2", "WPA_Mixed", "None" ]
},
"algorithm" : {
"description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
"type" : "string",
"enum" : [ "AES", "TKIP_AES" ]
}
}
},
"authService" : {
"description" : "Autentication of the WLAN relate to external DPSK",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Identifier of the authentication service. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the authentication service. At least one ID or name is required in the request.",
"type" : "string"
}
}
}
},
"required" : [ "enabled" ]
},
"dnsServerProfile" : {
"description" : "DNS server profile of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"accessTunnelProfile" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"accessIpsecProfile" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"splitTunnelProfileId" : {
"type" : "string"
},
"portalDetectionProfileId" : {
"type" : "string"
}
},
"required" : [ "name", "ssid", "authServiceOrProfile", "portalServiceProfile" ]
}201Body
{
"id": "wlanID"
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
}
}
}Create - Hotspot + MAC bypass ¶
POST/v8_0/rkszones/{zoneId}/wlans/wisprmac
Use this API command to create a new hotspot (WISPr) with MAC bypass WLAN.
Body
{
"name": "wlanName",
"ssid": "wlanSSID",
"description": "wlanDescription",
"authServiceOrProfile": {
"throughController": false,
"id": "authServiceUUID",
"name": "authServiceName",
"authenticationOption": null,
"backupAuthenticationId": "otherAuthServiceUUID",
"backupAuthenticationOption": null
},
"portalServiceProfile": {
"id": "portalServiceUUID",
"name": "portalServiceName"
},
"accessTunnelType": "RuckusGRE",
"accessTunnelProfile": {
"id": "f5b92938-aa4e-4d02-90ea-273799ff689b",
"name": "Default Tunnel Profile"
},
"splitTunnelProfileId": "38119bac-49e1-4410-ab8e-1c1bc88dd770",
"coreTunnelProfile": {
"type": "Bridge",
"id": "forwardingUUID",
"name": "forwardingName"
},
"macAuth": {
"macAuthMacFormat": "802.1X",
"customizedPassword": "password"
},
"encryption": {
"method": "WPA2",
"algorithm": "AES",
"passphrase": "password",
"mfp": "disabled",
"support80211rEnabled": false,
"mobilityDomainId": 3
},
"operatorRealm": "operator realm",
"defaultUserTrafficProfile": {
"id": "userTrafficUUID",
"name": "userTrafficName"
},
"precedenceProfileId": "c514d450-c839-9527-afc9-525400d12345",
"portalDetectionProfileId": "de0fa30c-9565-11e8-9eb6-529269fb1459",
"schedule": {
"type": "Customized",
"id": "ServiceUUID",
"name": "ServiceName"
},
"vlan": {
"accessVlan": 23,
"coreQinQEnabled": false,
"coreSVlan": 1,
"vlanPooling": null
},
"l2ACL": {
"id": "l2ACLUUID",
"name": "l2ACLName"
},
"devicePolicy": {
"id": "devicePolicyUUID",
"name": "devicePolicyName"
},
"radiusOptions": {
"nasIdType": "Customized",
"customizedNasId": "nasId",
"nasRequestTimeoutSec": 12,
"nasMaxRetry": 3,
"nasReconnectPrimaryMin": 30,
"calledStaIdType": "WLAN_BSSID",
"nasIpType": "disabled",
"nasIpUserDefined": "192.168.1.1"
},
"advancedOptions": {
"clientIsolationEnabled": true,
"clientIsolationUnicastEnabled": true,
"clientIsolationMulticastEnabled": false,
"clientIsolationAutoVrrpEnabled": false,
"clientIsolationWhitelist": {
"id": "b89323e1-3168-11e7-b027-5254009ae3f0",
"name": "myWhitelist"
},
"priority": "High",
"hideSsidEnabled": true,
"maxClientsPerRadio": 12,
"clientIdleTimeoutSec": 60,
"clientLoadBalancingEnabled": true,
"proxyARPEnabled": true,
"ndProxyEnabled": false,
"suppressNsEnabled": false,
"raProxyEnabled": false,
"rsraGuardEnabled": false,
"raThrottlingEnabled": false,
"maxAllowedRA": 10,
"raInterval": 10,
"support80211dEnabled": false,
"support80211kEnabled": true,
"forceClientDHCPTimeoutSec": 5,
"dhcpOption82Enabled": true,
"dhcp82Format": "RUCKUS_DEFAULT",
"unauthClientStatsEnabled": false,
"clientFingerprintingEnabled": true,
"ofdmOnlyEnabled": false,
"bandBalancing": "UseZoneSetting",
"bssMinRateMbps": "Disable",
"mgmtTxRateMbps": "2 mbps",
"avcEnabled": true,
"urlFilteringPolicyEnabled": false,
"urlFilteringPolicyId": "",
"wifiCallingPolicyEnabled": false,
"wifiCallingPolicyIds": [],
"uplinkEnabled": true,
"uplinkRate": 100,
"downlinkEnabled": true,
"downlinkRate": 200,
"ratePerSTAUplink": "650mbps",
"ratePerSTADownlink": "1mbps"
},
"diffServProfile": {
"id": "diffServId",
"name": "diffServName"
},
"qosMaps": [
{
"enable": true,
"priority": 0,
"low": 0,
"high": 7,
"excepts": null
},
{
"enable": true,
"priority": 1,
"low": 8,
"high": 15,
"excepts": null
},
{
"enable": true,
"priority": 2,
"low": 16,
"high": 23,
"excepts": null
},
{
"enable": true,
"priority": 3,
"low": 0,
"high": 32,
"excepts": [
43,
45,
60
]
},
{
"enable": true,
"priority": 4,
"low": 32,
"high": 39,
"excepts": null
},
{
"enable": true,
"priority": 5,
"low": 40,
"high": 47,
"excepts": null
},
{
"enable": true,
"priority": 6,
"low": 48,
"high": 55,
"excepts": [
46
]
},
{
"enable": true,
"priority": 7,
"low": 56,
"high": 63,
"excepts": null
}
],
"dnsServerProfile": {
"id": "DNS server profile UUID",
"name": "DNS server profile name"
},
"dpsk": {
"dpskEnabled": false,
"length": 8,
"dpskType": "Secure",
"expiration": "OneDay",
"dpskFromType": "FirstUse"
},
"externalDpsk": {
"enabled": true,
"encryption": {
"method": "WPA2",
"algorithm": "AES"
},
"authService": {
"id": "authServiceUUID"
}
}
}Schema
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"name" : {
"description" : "Name of the WLAN",
"type" : "string",
"minLength" : 1,
"maxLength" : 32
},
"ssid" : {
"description" : "SSID of the WLAN",
"type" : "string",
"minLength" : 1,
"maxLength" : 32
},
"hessid" : {
"description" : "HESSID of the WLAN",
"type" : "string",
"pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$"
},
"description" : {
"description" : "Description of the WLAN",
"type" : [ "string", "null" ],
"maxLength" : 64
},
"bypassCNA" : {
"description" : "Bypass Capitive Network Assitance",
"type" : "boolean",
"default" : false
},
"caleaEnabled" : {
"description" : "DP CALEA Server Enabled",
"type" : "boolean"
},
"dpTunnelNatEnabled" : {
"description" : "DP Tunnel NAT Enabled",
"type" : "boolean"
},
"dpTunnelDhcpEnabled" : {
"description" : "DP Tunnel DHCP Enabled",
"type" : "boolean"
},
"awsExtNasIPEnable" : {
"description" : "Aws ExtNasIP Enable",
"type" : "boolean"
},
"awsVenueEnable" : {
"description" : "Aws Venue Enable",
"type" : "boolean"
},
"accessTunnelType" : {
"description" : "Access tunnel type of the WLAN. APLBO means AP local breakout, RuckusGRE means RuckusGRE tunnel to the data plane, and SoftGRE means AP direct SoftGRE tunnel",
"type" : "string",
"enum" : [ "APLBO", "RuckusGRE", "SoftGRE" ]
},
"coreTunnelProfile" : {
"description" : "Core tunnel of the WLAN. This only applies when the access tunnel type is set to RuckusGRE.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"type" : {
"description" : "Tunnel type",
"type" : "string",
"enum" : [ "Bridge", "L2oGRE", "TTG_PDG", "Mixed" ]
},
"id" : {
"description" : "Identifier of the forwarding profile. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the forwarding profile. At least one ID or name is required in the request.",
"type" : "string"
},
"operatorRealm" : {
"description" : "Operator realm, deprecated coreTunnelProfile.operatorRealm from version3.1, prepare remove",
"type" : "string",
"maxLength" : 255,
"pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
}
},
"required" : [ "type" ]
},
"macAuth" : {
"description" : "MAC address authentication settings of the WLAN. This only applies to standard MAC and Hotspot MAC bypass WLAN.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"macAuthMacFormat" : {
"description" : "MAC address format. The default format is 0010a42319c0 and the 802.1X format is 00-10-A4-23-19-C0.",
"type" : "string",
"enum" : [ "Default", "802.1X", "UpperColon", "Upper", "LowerDash", "LowerColon" ]
},
"customizedPassword" : {
"description" : "User defined password. When this field is set to an empty string, the MAC address is used as password.",
"type" : "string",
"maxLength" : 64,
"pattern" : "^([!-;=?-~]([ -;=?-~]){0,62}[!-;=?-~]|[!-;=?-~]{1,1}|\s{0,0})$"
}
}
},
"encryption" : {
"description" : "Encryption of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"method" : {
"description" : "Encryption method",
"type" : "string",
"enum" : [ "WPA2", "WPA_Mixed", "WEP_64", "WEP_128", "None" ],
"default" : "None"
},
"algorithm" : {
"description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
"type" : "string",
"enum" : [ "AES", "TKIP_AES" ]
},
"passphrase" : {
"description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
"type" : "string"
},
"mfp" : {
"description" : "Management frame protection. This only applies to WPA2 + AES",
"type" : "string",
"enum" : [ "disabled", "capable", "required" ]
},
"keyIndex" : {
"description" : "Key index. This only applies to WEP64 and WEP128.",
"type" : "integer"
},
"keyInHex" : {
"description" : "Key in hex format. This only applies to WEP64 and WEP128.",
"type" : "string"
},
"support80211rEnabled" : {
"description" : "Enable 802.11r Fast BSS Transition, fast Romaing.",
"type" : "boolean"
},
"mobilityDomainId" : {
"description" : "mobility Domain Id.",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
}
},
"required" : [ "method" ]
},
"authServiceOrProfile" : {
"description" : "Authentication of the WLAN. The hotspot WLAN requires authentication messages to be sent through the controller. The ID or name of the authentication services configured globally is required.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"throughController" : {
"description" : "Indicates whether authentication messages were sent through the controller or not",
"type" : "boolean"
},
"realmBasedAuth" : {
"type" : "boolean"
},
"id" : {
"description" : "Identifier of the authentication service or profile. At least one ID or name or authenticationOption is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the authentication service or profile. At least one ID or name or authenticationOption is required in the request. Or could input the 'Always Accept' or 'Local DB'.",
"type" : "string"
},
"authenticationOption" : {
"description" : "Option of the authentication service or profile, At least one ID or name or authenticationOption is required in the request. This only applies to hotspot and guest WLANs.",
"type" : [ "string", "null" ],
"enum" : [ "Local DB", "Guest", "Always Accept", null ]
},
"locationDeliveryEnabled" : {
"description" : "RFC5580 location delivery support",
"type" : "boolean"
},
"backupAuthenticationId" : {
"description" : "Identifier of the backup authentication service or profile. At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service.",
"type" : "string"
},
"backupAuthenticationName" : {
"description" : "Name of the backup authentication service or profile. At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service. Or could input the 'Always Accept'.",
"type" : "string"
},
"backupAuthenticationOption" : {
"description" : "Option of the backup authentication service or profile, At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service. This only applies to hotspot WLANs.",
"type" : [ "string", "null" ],
"enum" : [ "Always Accept", null ]
}
}
},
"operatorRealm" : {
"description" : "Operator realm, operatorRealm only supports coreTunnelProfile type is authServiceOrProfile.locationDeliveryEnabled is true",
"type" : "string",
"maxLength" : 255,
"pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
},
"accountingServiceOrProfile" : {
"description" : "Accounting of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"throughController" : {
"description" : "Indicates whether accounting messages were sent through the controller",
"type" : "boolean"
},
"realmBasedAcct" : {
"type" : "boolean"
},
"id" : {
"description" : "Accounting service or profile ID. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Accounting service or profile name. At least one ID or name is required in the request.",
"type" : "string"
},
"interimUpdateMin" : {
"description" : "Interval (in minutes) for sending interim updates",
"type" : "integer",
"minimum" : 0,
"maximum" : 1440
},
"accountingDelayEnabled" : {
"description" : "Indicates whether accounting delay time is enabled",
"type" : "boolean"
},
"accountingTTGSessionEnabled" : {
"description" : "Indicates whether accounting for TTG sessions is to enabled",
"type" : "boolean"
},
"backupAccountingId" : {
"description" : "Backup accounting service or profile ID. At least one backupAccountingId or backupAccountingName is required in the request when setting backup accounting service.",
"type" : "string"
},
"backupAccountingName" : {
"description" : "Backup accounting service or profile name. At least one backupAccountingId or backupAccountingName is required in the request when setting backup accounting service.",
"type" : "string"
}
}
},
"portalServiceProfile" : {
"description" : "Hotspot portal service of the WLAN. The ID or name of the hotspot portal services within the zone is required.",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"hotspot20Profile" : {
"description" : "Hotspot 2.0 operator profile of the WLAN. id or name of the hotspot 2.0 operator profiles within the zone is required.",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"defaultUserTrafficProfile" : {
"description" : "User traffic profile of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"precedenceProfileId" : {
"description" : "Precedence profile of the WLAN",
"type" : "string"
},
"flexiVpnProfile" : {
"description" : "Flexi-VPN profile of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"wlanId" : {
"type" : "string",
"description" : "Wlan ID"
},
"zoneAffinityId" : {
"type" : "string",
"description" : "Zone Affinity ID"
}
},
"required" : [ "zoneAffinityId" ]
},
"schedule" : {
"description" : "Schedule of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"type" : {
"description" : "Type of WLAN schedule",
"type" : "string",
"enum" : [ "AlwaysOn", "AlwaysOff", "Customized" ],
"default" : "AlwaysOn"
},
"id" : {
"description" : "Identifier of the schedule profile. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the schedule profile. At least one ID or name is required in the request.",
"type" : "string"
}
},
"required" : [ "type" ]
},
"vlan" : {
"description" : "VLAN (access and/or core) of the WLAN.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"accessVlan" : {
"description" : "Access VLAN ID",
"type" : "integer",
"minimum" : 1,
"maximum" : 4094,
"default" : 1
},
"aaaVlanOverride" : {
"description" : "Indicates whether the AAA VLAN settings can be overriden or not",
"type" : "boolean"
},
"coreQinQEnabled" : {
"description" : "Indicates whether Q-in-Q is allowed at the core network or not",
"type" : "boolean"
},
"coreSVlan" : {
"description" : "Core SVLAN ID. This only applies when core Q-in-Q is enabled",
"type" : "integer",
"minimum" : 1,
"maximum" : 4094
},
"vlanPooling" : {
"description" : "Vlan pooling",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
}
}
},
"l2ACL" : {
"description" : "Layer 2 ACL of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"devicePolicy" : {
"description" : "Device policy of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"radiusOptions" : {
"description" : "RADIUS options of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"nasIdType" : {
"description" : "NAS ID type",
"type" : "string",
"enum" : [ "WLAN_BSSID", "AP_MAC", "Customized" ],
"default" : "WLAN_BSSID"
},
"customizedNasId" : {
"description" : "User defined NAS ID",
"type" : "string",
"maxLength" : 64,
"pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$"
},
"nasRequestTimeoutSec" : {
"description" : "NAS request timeout in seconds",
"type" : "integer",
"default" : 3,
"minimum" : 2,
"maximum" : 20
},
"nasMaxRetry" : {
"description" : "NAS request maximum retry",
"type" : "integer",
"default" : 2,
"minimum" : 2,
"maximum" : 10
},
"nasReconnectPrimaryMin" : {
"description" : "NAS reconnect primary time in minutes",
"type" : "integer",
"default" : 5,
"minimum" : 1,
"maximum" : 60
},
"calledStaIdType" : {
"description" : "Called station ID type",
"type" : "string",
"enum" : [ "WLAN_BSSID", "AP_MAC", "NONE" ],
"default" : "WLAN_BSSID"
},
"nasIpType" : {
"description" : "NAS IP type",
"type" : "string",
"enum" : [ "disabled", "control", "management", "userDefined" ],
"default" : "disabled"
},
"nasIpUserDefined" : {
"description" : "User-defined NAS IP",
"type" : "string",
"maxLength" : 45
},
"singleSessionIdAcctEnabled" : {
"description" : "When Single Accounting Session ID is enabled, APs will maintain one accounting session for client roaming",
"type" : "boolean",
"default" : false
}
}
},
"advancedOptions" : {
"description" : "Advanced settings for the WLAN.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"clientIsolationEnabled" : {
"description" : "Indicates whether wireless client isolation is enabled or disabled",
"type" : "boolean",
"default" : false
},
"clientIsolationUnicastEnabled" : {
"description" : "Indicates whether isolate unicast of wireless client isolation is enabled or disabled",
"type" : "boolean",
"default" : true
},
"clientIsolationMulticastEnabled" : {
"description" : "Indicates whether isolate multicast of wireless client isolation is enabled or disabled",
"type" : "boolean"
},
"clientIsolationAutoVrrpEnabled" : {
"description" : "Indicates whether Automatic support for VRRP of wireless client isolation is enabled or disabled",
"type" : "boolean",
"default" : false
},
"clientIsolationWhitelist" : {
"description" : "Indicates wireless client isolation whitelist",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"priority" : {
"description" : "Priority of the WLAN",
"type" : "string",
"enum" : [ "High", "Low" ],
"default" : "High"
},
"hideSsidEnabled" : {
"description" : "Indicates whether the SSID is hidden or broadcast",
"type" : "boolean",
"default" : false
},
"hs20Onboarding" : {
"description" : "Allow WISPr WLAN for Hotspot 2.0 Onboarding",
"type" : "boolean",
"default" : false
},
"maxClientsPerRadio" : {
"description" : "Maximum number of clients per radio",
"type" : "integer",
"default" : 100,
"minimum" : 1,
"maximum" : 512
},
"clientIdleTimeoutSec" : {
"description" : "Client idle timeout in seconds",
"type" : "integer",
"minimum" : 60,
"maximum" : 1000,
"default" : 120
},
"dgafEnabled" : {
"description" : "Indicates whether dgaf is enabled or disabled",
"type" : "boolean"
},
"clientLoadBalancingEnabled" : {
"description" : "Indicates whether Client Load Balancing is enabled or disabled",
"type" : "boolean",
"default" : true
},
"proxyARPEnabled" : {
"description" : "Indicates whether proxy ARP is enabled or disabled",
"type" : "boolean",
"default" : false
},
"ndProxyEnabled" : {
"description" : "Indicates whether ND Proxy is enabled or disabled",
"type" : "boolean",
"default" : false
},
"suppressNsEnabled" : {
"description" : "Indicates whether supperssNS is enabled or disabled",
"type" : "boolean",
"default" : false
},
"raProxyEnabled" : {
"description" : "Indicates whether RA proxy is enabled or disabled",
"type" : "boolean",
"default" : false
},
"rsraGuardEnabled" : {
"description" : "Indicates whether RS/RA Guard is enabled or disabled",
"type" : "boolean",
"default" : false
},
"raThrottlingEnabled" : {
"description" : "Indicates whether RA Throttling is enabled or disabled",
"type" : "boolean",
"default" : false
},
"maxAllowedRA" : {
"description" : "Max Allowed RAs",
"type" : "integer",
"minimum" : 1,
"maximum" : 1440,
"default" : 10
},
"raInterval" : {
"description" : "A timer that RA proxy runs and once receives unsolicited RA checks against the configured time and allow/drop RA based on next timeout",
"type" : "integer",
"minimum" : 1,
"maximum" : 256,
"default" : 10
},
"support80211dEnabled" : {
"description" : "Indicates whether support for 802.11d is enabled or disabled",
"type" : "boolean",
"default" : true
},
"support80211kEnabled" : {
"description" : "Indicates whether support for 802.11k is enabled or disabled",
"type" : "boolean",
"default" : true
},
"antiSpoofingEnabled" : {
"description" : "Anti-Spoofing enabled",
"type" : "boolean",
"default" : false
},
"arpRequestRateLimit" : {
"description" : "ARP packets request rate limit, default value will be 15 if both rate limit not being set.",
"type" : "integer",
"minimum" : 0,
"maximum" : 100
},
"dhcpRequestRateLimit" : {
"description" : "DHCP packets request rate limit, default value will be 15 if both rate limit not being set.",
"type" : "integer",
"minimum" : 0,
"maximum" : 100
},
"forceClientDHCPTimeoutSec" : {
"description" : "Force DHCP disconnects the client if the client does not obtain a valid IP address within the timeout peroid. To disable force DHCP, set this value to zero (0).",
"type" : "integer",
"enum" : [ 0, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15 ],
"default" : 0
},
"dhcpOption82Enabled" : {
"description" : "Indicates whether DCHP Option 82 is enabled or disabled",
"type" : "boolean",
"default" : false
},
"dhcp82Format" : {
"description" : "DHCP Option 82 format",
"type" : "string",
"enum" : [ "RUCKUS_DEFAULT", "SOFTGRE_CUSTOMIZED" ]
},
"unauthClientStatsEnabled" : {
"description" : "Indicates whether to send statistics of unauthorized clients or not",
"type" : "boolean",
"default" : false
},
"clientFingerprintingEnabled" : {
"description" : "Indicates whether client fingerprinting is enabled or disabled",
"type" : "boolean",
"default" : false
},
"ofdmOnlyEnabled" : {
"description" : "Indicates whether OFDM only is enabled or disabled",
"type" : "boolean",
"default" : false
},
"bandBalancing" : {
"description" : "Indicates whether band balancing is enabled or disabled",
"type" : "string",
"enum" : [ "Disabled", "UseZoneSetting" ],
"default" : "UseZoneSetting"
},
"bssMinRateMbps" : {
"description" : "BSS minimum rate (mbps)",
"type" : "string",
"enum" : [ "Disable", "1 mbps", "2 mbps", "5.5 mbps", "12 mbps", "24 mbps" ],
"default" : "Disable"
},
"mgmtTxRateMbps" : {
"description" : "Management TX rate (mbps)",
"type" : "string",
"enum" : [ "1 mbps", "2 mbps", "5.5 mbps", "6 mbps", "9 mbps", "11 mbps", "12 mbps", "18 mbps", "24 mbps", "36 mbps", "48 mbps", "54 mbps" ],
"default" : "2 mbps"
},
"pmkCachingEnabled" : {
"description" : "Indicator of whether PKM caching support is enabled or disabled. The default value is true when the WLAN is WPA+AES non open WLAN.",
"type" : "boolean"
},
"okcEnabled" : {
"description" : "Indicator of whether OKC support is enabled or disabled. The default value is true when the WLAN is WPA+AES non open WLAN.",
"type" : "boolean"
},
"avcEnabled" : {
"description" : "Indicator of whether ARC support is enabled or disabled",
"type" : "boolean",
"default" : false
},
"urlFilteringPolicyEnabled" : {
"description" : "Indicator of whether URL Filtering is enabled or disabled",
"type" : "boolean",
"default" : false
},
"urlFilteringPolicyId" : {
"description" : "The URL Filtering policy ID.",
"type" : "string"
},
"wifiCallingPolicyEnabled" : {
"description" : "Indicator of whether Wi-Fi Calling is enabled or disabled",
"type" : "boolean",
"default" : false
},
"wifiCallingPolicyIds" : {
"description" : "The Wi-Fi Calling policy IDs. (Maximum allowed number is 5)",
"type" : "array",
"items" : {
"type" : "string"
}
},
"uplinkEnabled" : {
"description" : "SSID Rate Limiting uplink enabled.",
"type" : "boolean",
"default" : false
},
"uplinkRate" : {
"description" : "SSID Rate Limiting uplink.",
"type" : "number",
"default" : 0.0
},
"downlinkEnabled" : {
"description" : "SSID Rate Limiting downlink enabled.",
"type" : "boolean",
"default" : false
},
"downlinkRate" : {
"description" : "SSID Rate Limiting downlink.",
"type" : "number",
"default" : 0.0
},
"ratePerSTAUplink" : {
"description" : "UE Rate Limiting uplink.",
"type" : "string"
},
"ratePerSTADownlink" : {
"description" : "UE Rate Limiting downlink.",
"type" : "string"
},
"dtimInterval" : {
"description" : "DTIM Interval",
"type" : "integer",
"minimum" : 1,
"maximum" : 255,
"default" : 1
},
"directedThreshold" : {
"description" : "Directed Threshold Setting, Defines the client count at which an AP will stop converting group addressed data traffic to unicast.",
"type" : "integer",
"minimum" : 0,
"maximum" : 128,
"default" : 5
},
"flowLogEnabled" : {
"description" : "Flow log enabled.",
"type" : "boolean",
"default" : false
},
"hdOverheadOptimizeEnable" : {
"description" : "Airtime decongestion enabled.",
"type" : "boolean",
"default" : false
},
"probeRssiThr" : {
"type" : "integer",
"description" : "Join RSSI threshold.",
"minimum" : -90,
"maximum" : -60,
"default" : -85
},
"transientClientMgmtEnable" : {
"description" : "Transient Client Management enabled.",
"type" : "boolean",
"default" : false
},
"joinIgnoreTimeout" : {
"description" : "Join wait time.",
"type" : "integer",
"minimum" : 1,
"maximum" : 60,
"default" : 30
},
"joinAcceptTimeout" : {
"description" : "Join expire time.",
"type" : "integer",
"minimum" : 1,
"maximum" : 300,
"default" : 300
},
"joinIgnoreThr" : {
"description" : "Join wait threshold.",
"type" : "integer",
"minimum" : 1,
"maximum" : 50,
"default" : 10
},
"authRssiThr" : {
"description" : "Auth RSSI threshold.",
"type" : "integer",
"minimum" : -90,
"maximum" : -60
},
"assocRssiThr" : {
"description" : "Assoc RSSI threshold.",
"type" : "integer",
"minimum" : -90,
"maximum" : -60
},
"oceEnabled" : {
"description" : "Optimized Connectivity Experience(OCE) enabled.",
"type" : "boolean",
"default" : false
},
"oceBroadcastProbeResponseDelay" : {
"description" : "Broadcast probe response delay.",
"type" : "integer",
"minimum" : 8,
"maximum" : 120,
"default" : 15
},
"oceRssiBasedAssociationRejectionThreshold" : {
"description" : "RSSI-based association rejection threshold.",
"type" : "integer",
"minimum" : -90,
"maximum" : -60,
"default" : -75
}
}
},
"diffServProfile" : {
"description" : "DiffServ profile of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"qosMaps" : {
"description" : "Qos map set of the WLAN.",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"enable" : {
"description" : "Enabled or disabled",
"type" : "boolean"
},
"priority" : {
"description" : "Priority",
"type" : "integer"
},
"low" : {
"description" : "DSCP range - low",
"type" : [ "integer", "null" ],
"minimum" : 0,
"maximum" : 255
},
"high" : {
"description" : "DSCP range - high",
"type" : [ "integer", "null" ],
"minimum" : 0,
"maximum" : 255
},
"excepts" : {
"type" : [ "array", "null" ],
"items" : {
"type" : "integer",
"minimum" : 0,
"maximum" : 63
}
}
},
"required" : [ "enable", "priority" ]
}
},
"dpsk" : {
"description" : "DPSK Setting",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"dpskEnabled" : {
"description" : "DPSK enabled",
"type" : "boolean",
"default" : false
},
"length" : {
"description" : "Length of DPSK key",
"type" : "integer",
"default" : 62
},
"dpskType" : {
"description" : "Type of DPSK key",
"type" : "string",
"enum" : [ "Secure", "KeyboardFriendly", "NumbersOnly" ],
"default" : "Secure"
},
"expiration" : {
"description" : "Expiration of DPSK key",
"type" : "string",
"enum" : [ "Unlimited", "OneDay", "TwoDays", "OneWeek", "TwoWeeks", "OneMonth", "SixMonths", "OneYear", "TwoYears" ],
"default" : "Unlimited"
},
"dpskFromType" : {
"description" : "Type of expiration start from",
"type" : "string",
"enum" : [ "CreateTime", "FirstUse" ],
"default" : "CreateTime"
}
}
},
"externalDpsk" : {
"description" : "External DPSK Enabled",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"enabled" : {
"description" : "Enable External DPSK",
"type" : "boolean",
"default" : false
},
"encryption" : {
"description" : "Encryption of the WLAN relate to external DPSK",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"method" : {
"description" : "Encryption method",
"type" : "string",
"enum" : [ "WPA2", "WPA_Mixed", "None" ]
},
"algorithm" : {
"description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
"type" : "string",
"enum" : [ "AES", "TKIP_AES" ]
}
}
},
"authService" : {
"description" : "Autentication of the WLAN relate to external DPSK",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Identifier of the authentication service. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the authentication service. At least one ID or name is required in the request.",
"type" : "string"
}
}
}
},
"required" : [ "enabled" ]
},
"dnsServerProfile" : {
"description" : "DNS server profile of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"accessTunnelProfile" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"accessIpsecProfile" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"splitTunnelProfileId" : {
"type" : "string"
},
"portalDetectionProfileId" : {
"type" : "string"
}
},
"required" : [ "name", "ssid", "authServiceOrProfile", "portalServiceProfile" ]
}201Body
{
"id": "wlanID"
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
}
}
}Create - Hotspot + 802.1X ¶
POST/v8_0/rkszones/{zoneId}/wlans/wispr8021X
Use this API command to create a new hotspot (WISPr) with 802.1X WLAN.
Body
{
"name": "wispr8021XWlan",
"ssid": "wispr8021XWlan",
"description": "wlanDescription",
"authServiceOrProfile": {
"throughController": true,
"realmBasedAuth": true,
"id": "realmBasedProfileUUID",
"name": "realmBasedProfileName",
"authenticationOption": null,
"backupAuthenticationId": "otherAuthServiceUUID",
"backupAuthenticationOption": null
},
"accountingServiceOrProfile": {
"accountingDelayEnabled": false,
"interimUpdateMin": 10,
"throughController": true,
"realmBasedAcct": true,
"name": "realmBasedProfileName"
},
"portalServiceProfile": {
"id": "portalServiceUUID",
"name": "portalServiceName"
},
"accessTunnelType": "RuckusGRE",
"accessTunnelProfile": {
"id": "f5b92938-aa4e-4d02-90ea-273799ff689b",
"name": "Default Tunnel Profile"
},
"splitTunnelProfileId": "38119bac-49e1-4410-ab8e-1c1bc88dd770",
"coreTunnelProfile": {
"type": "Bridge",
"id": "forwardingUUID",
"name": "forwardingName"
},
"encryption": {
"method": "WPA2",
"algorithm": "AES",
"passphrase": "password",
"mfp": "disabled",
"support80211rEnabled": true,
"mobilityDomainId": 3
},
"operatorRealm": "operator realm",
"defaultUserTrafficProfile": {
"id": "userTrafficUUID",
"name": "userTrafficName"
},
"precedenceProfileId": "c514d450-c839-9527-afc9-525400d12345",
"portalDetectionProfileId": "de0fa30c-9565-11e8-9eb6-529269fb1459",
"schedule": {
"type": "Customized",
"id": "ServiceUUID",
"name": "ServiceName"
},
"vlan": {
"accessVlan": 23,
"coreQinQEnabled": false,
"coreSVlan": 1,
"vlanPooling": null
},
"l2ACL": {
"id": "l2ACLUUID",
"name": "l2ACLName"
},
"devicePolicy": {
"id": "devicePolicyUUID",
"name": "devicePolicyName"
},
"radiusOptions": {
"nasIdType": "Customized",
"customizedNasId": "nasId",
"nasRequestTimeoutSec": 12,
"nasMaxRetry": 3,
"nasReconnectPrimaryMin": 30,
"calledStaIdType": "WLAN_BSSID",
"nasIpType": "disabled",
"nasIpUserDefined": "192.168.1.1"
},
"advancedOptions": {
"clientIsolationEnabled": true,
"clientIsolationUnicastEnabled": true,
"clientIsolationMulticastEnabled": false,
"clientIsolationAutoVrrpEnabled": false,
"clientIsolationWhitelist": {
"id": "b89323e1-3168-11e7-b027-5254009ae3f0",
"name": "myWhitelist"
},
"priority": "High",
"hideSsidEnabled": true,
"maxClientsPerRadio": 12,
"clientIdleTimeoutSec": 60,
"clientLoadBalancingEnabled": true,
"proxyARPEnabled": true,
"ndProxyEnabled": false,
"suppressNsEnabled": false,
"raProxyEnabled": false,
"rsraGuardEnabled": false,
"raThrottlingEnabled": false,
"maxAllowedRA": 10,
"raInterval": 10,
"support80211dEnabled": false,
"support80211kEnabled": true,
"forceClientDHCPTimeoutSec": 5,
"dhcpOption82Enabled": true,
"dhcp82Format": "RUCKUS_DEFAULT",
"unauthClientStatsEnabled": false,
"clientFingerprintingEnabled": true,
"ofdmOnlyEnabled": false,
"bandBalancing": "UseZoneSetting",
"bssMinRateMbps": "Disable",
"mgmtTxRateMbps": "2 mbps",
"avcEnabled": true,
"urlFilteringPolicyEnabled": false,
"urlFilteringPolicyId": "",
"wifiCallingPolicyEnabled": false,
"wifiCallingPolicyIds": [],
"uplinkEnabled": true,
"uplinkRate": 100,
"downlinkEnabled": true,
"downlinkRate": 200,
"ratePerSTAUplink": "650mbps",
"ratePerSTADownlink": "1mbps"
},
"diffServProfile": {
"id": "diffServId",
"name": "diffServName"
},
"qosMaps": [
{
"enable": true,
"priority": 0,
"low": 0,
"high": 7,
"excepts": null
},
{
"enable": true,
"priority": 1,
"low": 8,
"high": 15,
"excepts": null
},
{
"enable": true,
"priority": 2,
"low": 16,
"high": 23,
"excepts": null
},
{
"enable": true,
"priority": 3,
"low": 0,
"high": 32,
"excepts": [
43,
45,
60
]
},
{
"enable": true,
"priority": 4,
"low": 32,
"high": 39,
"excepts": null
},
{
"enable": true,
"priority": 5,
"low": 40,
"high": 47,
"excepts": null
},
{
"enable": true,
"priority": 6,
"low": 48,
"high": 55,
"excepts": [
46
]
},
{
"enable": true,
"priority": 7,
"low": 56,
"high": 63,
"excepts": null
}
],
"dnsServerProfile": {
"id": "DNS server profile UUID",
"name": "DNS server profile name"
},
"dpsk": {
"dpskEnabled": false,
"length": 8,
"dpskType": "Secure",
"expiration": "OneDay",
"dpskFromType": "FirstUse"
},
"externalDpsk": {
"enabled": true,
"encryption": {
"method": "WPA2",
"algorithm": "AES"
},
"authService": {
"id": "authServiceUUID"
}
}
}Schema
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"name" : {
"description" : "Name of the WLAN",
"type" : "string",
"minLength" : 1,
"maxLength" : 32
},
"ssid" : {
"description" : "SSID of the WLAN",
"type" : "string",
"minLength" : 1,
"maxLength" : 32
},
"hessid" : {
"description" : "HESSID of the WLAN",
"type" : "string",
"pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$"
},
"description" : {
"description" : "Description of the WLAN",
"type" : [ "string", "null" ],
"maxLength" : 64
},
"bypassCNA" : {
"description" : "Bypass Capitive Network Assitance",
"type" : "boolean",
"default" : false
},
"caleaEnabled" : {
"description" : "DP CALEA Server Enabled",
"type" : "boolean"
},
"dpTunnelNatEnabled" : {
"description" : "DP Tunnel NAT Enabled",
"type" : "boolean"
},
"dpTunnelDhcpEnabled" : {
"description" : "DP Tunnel DHCP Enabled",
"type" : "boolean"
},
"awsExtNasIPEnable" : {
"description" : "Aws ExtNasIP Enable",
"type" : "boolean"
},
"awsVenueEnable" : {
"description" : "Aws Venue Enable",
"type" : "boolean"
},
"accessTunnelType" : {
"description" : "Access tunnel type of the WLAN. APLBO means AP local breakout, RuckusGRE means RuckusGRE tunnel to the data plane, and SoftGRE means AP direct SoftGRE tunnel",
"type" : "string",
"enum" : [ "APLBO", "RuckusGRE", "SoftGRE" ]
},
"coreTunnelProfile" : {
"description" : "Core tunnel of the WLAN. This only applies when the access tunnel type is set to RuckusGRE.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"type" : {
"description" : "Tunnel type",
"type" : "string",
"enum" : [ "Bridge", "L2oGRE", "TTG_PDG", "Mixed" ]
},
"id" : {
"description" : "Identifier of the forwarding profile. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the forwarding profile. At least one ID or name is required in the request.",
"type" : "string"
},
"operatorRealm" : {
"description" : "Operator realm, deprecated coreTunnelProfile.operatorRealm from version3.1, prepare remove",
"type" : "string",
"maxLength" : 255,
"pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
}
},
"required" : [ "type" ]
},
"macAuth" : {
"description" : "MAC address authentication settings of the WLAN. This only applies to standard MAC and Hotspot MAC bypass WLAN.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"macAuthMacFormat" : {
"description" : "MAC address format. The default format is 0010a42319c0 and the 802.1X format is 00-10-A4-23-19-C0.",
"type" : "string",
"enum" : [ "Default", "802.1X", "UpperColon", "Upper", "LowerDash", "LowerColon" ]
},
"customizedPassword" : {
"description" : "User defined password. When this field is set to an empty string, the MAC address is used as password.",
"type" : "string",
"maxLength" : 64,
"pattern" : "^([!-;=?-~]([ -;=?-~]){0,62}[!-;=?-~]|[!-;=?-~]{1,1}|\s{0,0})$"
}
}
},
"encryption" : {
"description" : "Encryption of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"method" : {
"description" : "Encryption method",
"type" : "string",
"enum" : [ "WPA2", "WPA_Mixed", "WEP_64", "WEP_128", "None" ],
"default" : "None"
},
"algorithm" : {
"description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
"type" : "string",
"enum" : [ "AES", "TKIP_AES" ]
},
"passphrase" : {
"description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
"type" : "string"
},
"mfp" : {
"description" : "Management frame protection. This only applies to WPA2 + AES",
"type" : "string",
"enum" : [ "disabled", "capable", "required" ]
},
"keyIndex" : {
"description" : "Key index. This only applies to WEP64 and WEP128.",
"type" : "integer"
},
"keyInHex" : {
"description" : "Key in hex format. This only applies to WEP64 and WEP128.",
"type" : "string"
},
"support80211rEnabled" : {
"description" : "Enable 802.11r Fast BSS Transition, fast Romaing.",
"type" : "boolean"
},
"mobilityDomainId" : {
"description" : "mobility Domain Id.",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
}
},
"required" : [ "method" ]
},
"authServiceOrProfile" : {
"description" : "Authentication of the WLAN. The hotspot WLAN requires authentication messages to be sent through the controller. The ID or name of the authentication services configured globally is required.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"throughController" : {
"description" : "Indicates whether authentication messages were sent through the controller or not",
"type" : "boolean"
},
"realmBasedAuth" : {
"type" : "boolean"
},
"id" : {
"description" : "Identifier of the authentication service or profile. At least one ID or name or authenticationOption is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the authentication service or profile. At least one ID or name or authenticationOption is required in the request. Or could input the 'Always Accept' or 'Local DB'.",
"type" : "string"
},
"authenticationOption" : {
"description" : "Option of the authentication service or profile, At least one ID or name or authenticationOption is required in the request. This only applies to hotspot and guest WLANs.",
"type" : [ "string", "null" ],
"enum" : [ "Local DB", "Guest", "Always Accept", null ]
},
"locationDeliveryEnabled" : {
"description" : "RFC5580 location delivery support",
"type" : "boolean"
},
"backupAuthenticationId" : {
"description" : "Identifier of the backup authentication service or profile. At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service.",
"type" : "string"
},
"backupAuthenticationName" : {
"description" : "Name of the backup authentication service or profile. At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service. Or could input the 'Always Accept'.",
"type" : "string"
},
"backupAuthenticationOption" : {
"description" : "Option of the backup authentication service or profile, At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service. This only applies to hotspot WLANs.",
"type" : [ "string", "null" ],
"enum" : [ "Always Accept", null ]
}
}
},
"operatorRealm" : {
"description" : "Operator realm, operatorRealm only supports coreTunnelProfile type is authServiceOrProfile.locationDeliveryEnabled is true",
"type" : "string",
"maxLength" : 255,
"pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
},
"accountingServiceOrProfile" : {
"description" : "Accounting of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"throughController" : {
"description" : "Indicates whether accounting messages were sent through the controller",
"type" : "boolean"
},
"realmBasedAcct" : {
"type" : "boolean"
},
"id" : {
"description" : "Accounting service or profile ID. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Accounting service or profile name. At least one ID or name is required in the request.",
"type" : "string"
},
"interimUpdateMin" : {
"description" : "Interval (in minutes) for sending interim updates",
"type" : "integer",
"minimum" : 0,
"maximum" : 1440
},
"accountingDelayEnabled" : {
"description" : "Indicates whether accounting delay time is enabled",
"type" : "boolean"
},
"accountingTTGSessionEnabled" : {
"description" : "Indicates whether accounting for TTG sessions is to enabled",
"type" : "boolean"
},
"backupAccountingId" : {
"description" : "Backup accounting service or profile ID. At least one backupAccountingId or backupAccountingName is required in the request when setting backup accounting service.",
"type" : "string"
},
"backupAccountingName" : {
"description" : "Backup accounting service or profile name. At least one backupAccountingId or backupAccountingName is required in the request when setting backup accounting service.",
"type" : "string"
}
}
},
"portalServiceProfile" : {
"description" : "Hotspot portal service of the WLAN. The ID or name of the hotspot portal services within the zone is required.",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"hotspot20Profile" : {
"description" : "Hotspot 2.0 operator profile of the WLAN. id or name of the hotspot 2.0 operator profiles within the zone is required.",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"defaultUserTrafficProfile" : {
"description" : "User traffic profile of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"precedenceProfileId" : {
"description" : "Precedence profile of the WLAN",
"type" : "string"
},
"flexiVpnProfile" : {
"description" : "Flexi-VPN profile of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"wlanId" : {
"type" : "string",
"description" : "Wlan ID"
},
"zoneAffinityId" : {
"type" : "string",
"description" : "Zone Affinity ID"
}
},
"required" : [ "zoneAffinityId" ]
},
"schedule" : {
"description" : "Schedule of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"type" : {
"description" : "Type of WLAN schedule",
"type" : "string",
"enum" : [ "AlwaysOn", "AlwaysOff", "Customized" ],
"default" : "AlwaysOn"
},
"id" : {
"description" : "Identifier of the schedule profile. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the schedule profile. At least one ID or name is required in the request.",
"type" : "string"
}
},
"required" : [ "type" ]
},
"vlan" : {
"description" : "VLAN (access and/or core) of the WLAN.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"accessVlan" : {
"description" : "Access VLAN ID",
"type" : "integer",
"minimum" : 1,
"maximum" : 4094,
"default" : 1
},
"aaaVlanOverride" : {
"description" : "Indicates whether the AAA VLAN settings can be overriden or not",
"type" : "boolean"
},
"coreQinQEnabled" : {
"description" : "Indicates whether Q-in-Q is allowed at the core network or not",
"type" : "boolean"
},
"coreSVlan" : {
"description" : "Core SVLAN ID. This only applies when core Q-in-Q is enabled",
"type" : "integer",
"minimum" : 1,
"maximum" : 4094
},
"vlanPooling" : {
"description" : "Vlan pooling",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
}
}
},
"l2ACL" : {
"description" : "Layer 2 ACL of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"devicePolicy" : {
"description" : "Device policy of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"radiusOptions" : {
"description" : "RADIUS options of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"nasIdType" : {
"description" : "NAS ID type",
"type" : "string",
"enum" : [ "WLAN_BSSID", "AP_MAC", "Customized" ],
"default" : "WLAN_BSSID"
},
"customizedNasId" : {
"description" : "User defined NAS ID",
"type" : "string",
"maxLength" : 64,
"pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$"
},
"nasRequestTimeoutSec" : {
"description" : "NAS request timeout in seconds",
"type" : "integer",
"default" : 3,
"minimum" : 2,
"maximum" : 20
},
"nasMaxRetry" : {
"description" : "NAS request maximum retry",
"type" : "integer",
"default" : 2,
"minimum" : 2,
"maximum" : 10
},
"nasReconnectPrimaryMin" : {
"description" : "NAS reconnect primary time in minutes",
"type" : "integer",
"default" : 5,
"minimum" : 1,
"maximum" : 60
},
"calledStaIdType" : {
"description" : "Called station ID type",
"type" : "string",
"enum" : [ "WLAN_BSSID", "AP_MAC", "NONE" ],
"default" : "WLAN_BSSID"
},
"nasIpType" : {
"description" : "NAS IP type",
"type" : "string",
"enum" : [ "disabled", "control", "management", "userDefined" ],
"default" : "disabled"
},
"nasIpUserDefined" : {
"description" : "User-defined NAS IP",
"type" : "string",
"maxLength" : 45
},
"singleSessionIdAcctEnabled" : {
"description" : "When Single Accounting Session ID is enabled, APs will maintain one accounting session for client roaming",
"type" : "boolean",
"default" : false
}
}
},
"advancedOptions" : {
"description" : "Advanced settings for the WLAN.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"clientIsolationEnabled" : {
"description" : "Indicates whether wireless client isolation is enabled or disabled",
"type" : "boolean",
"default" : false
},
"clientIsolationUnicastEnabled" : {
"description" : "Indicates whether isolate unicast of wireless client isolation is enabled or disabled",
"type" : "boolean",
"default" : true
},
"clientIsolationMulticastEnabled" : {
"description" : "Indicates whether isolate multicast of wireless client isolation is enabled or disabled",
"type" : "boolean"
},
"clientIsolationAutoVrrpEnabled" : {
"description" : "Indicates whether Automatic support for VRRP of wireless client isolation is enabled or disabled",
"type" : "boolean",
"default" : false
},
"clientIsolationWhitelist" : {
"description" : "Indicates wireless client isolation whitelist",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"priority" : {
"description" : "Priority of the WLAN",
"type" : "string",
"enum" : [ "High", "Low" ],
"default" : "High"
},
"hideSsidEnabled" : {
"description" : "Indicates whether the SSID is hidden or broadcast",
"type" : "boolean",
"default" : false
},
"hs20Onboarding" : {
"description" : "Allow WISPr WLAN for Hotspot 2.0 Onboarding",
"type" : "boolean",
"default" : false
},
"maxClientsPerRadio" : {
"description" : "Maximum number of clients per radio",
"type" : "integer",
"default" : 100,
"minimum" : 1,
"maximum" : 512
},
"clientIdleTimeoutSec" : {
"description" : "Client idle timeout in seconds",
"type" : "integer",
"minimum" : 60,
"maximum" : 1000,
"default" : 120
},
"dgafEnabled" : {
"description" : "Indicates whether dgaf is enabled or disabled",
"type" : "boolean"
},
"clientLoadBalancingEnabled" : {
"description" : "Indicates whether Client Load Balancing is enabled or disabled",
"type" : "boolean",
"default" : true
},
"proxyARPEnabled" : {
"description" : "Indicates whether proxy ARP is enabled or disabled",
"type" : "boolean",
"default" : false
},
"ndProxyEnabled" : {
"description" : "Indicates whether ND Proxy is enabled or disabled",
"type" : "boolean",
"default" : false
},
"suppressNsEnabled" : {
"description" : "Indicates whether supperssNS is enabled or disabled",
"type" : "boolean",
"default" : false
},
"raProxyEnabled" : {
"description" : "Indicates whether RA proxy is enabled or disabled",
"type" : "boolean",
"default" : false
},
"rsraGuardEnabled" : {
"description" : "Indicates whether RS/RA Guard is enabled or disabled",
"type" : "boolean",
"default" : false
},
"raThrottlingEnabled" : {
"description" : "Indicates whether RA Throttling is enabled or disabled",
"type" : "boolean",
"default" : false
},
"maxAllowedRA" : {
"description" : "Max Allowed RAs",
"type" : "integer",
"minimum" : 1,
"maximum" : 1440,
"default" : 10
},
"raInterval" : {
"description" : "A timer that RA proxy runs and once receives unsolicited RA checks against the configured time and allow/drop RA based on next timeout",
"type" : "integer",
"minimum" : 1,
"maximum" : 256,
"default" : 10
},
"support80211dEnabled" : {
"description" : "Indicates whether support for 802.11d is enabled or disabled",
"type" : "boolean",
"default" : true
},
"support80211kEnabled" : {
"description" : "Indicates whether support for 802.11k is enabled or disabled",
"type" : "boolean",
"default" : true
},
"antiSpoofingEnabled" : {
"description" : "Anti-Spoofing enabled",
"type" : "boolean",
"default" : false
},
"arpRequestRateLimit" : {
"description" : "ARP packets request rate limit, default value will be 15 if both rate limit not being set.",
"type" : "integer",
"minimum" : 0,
"maximum" : 100
},
"dhcpRequestRateLimit" : {
"description" : "DHCP packets request rate limit, default value will be 15 if both rate limit not being set.",
"type" : "integer",
"minimum" : 0,
"maximum" : 100
},
"forceClientDHCPTimeoutSec" : {
"description" : "Force DHCP disconnects the client if the client does not obtain a valid IP address within the timeout peroid. To disable force DHCP, set this value to zero (0).",
"type" : "integer",
"enum" : [ 0, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15 ],
"default" : 0
},
"dhcpOption82Enabled" : {
"description" : "Indicates whether DCHP Option 82 is enabled or disabled",
"type" : "boolean",
"default" : false
},
"dhcp82Format" : {
"description" : "DHCP Option 82 format",
"type" : "string",
"enum" : [ "RUCKUS_DEFAULT", "SOFTGRE_CUSTOMIZED" ]
},
"unauthClientStatsEnabled" : {
"description" : "Indicates whether to send statistics of unauthorized clients or not",
"type" : "boolean",
"default" : false
},
"clientFingerprintingEnabled" : {
"description" : "Indicates whether client fingerprinting is enabled or disabled",
"type" : "boolean",
"default" : false
},
"ofdmOnlyEnabled" : {
"description" : "Indicates whether OFDM only is enabled or disabled",
"type" : "boolean",
"default" : false
},
"bandBalancing" : {
"description" : "Indicates whether band balancing is enabled or disabled",
"type" : "string",
"enum" : [ "Disabled", "UseZoneSetting" ],
"default" : "UseZoneSetting"
},
"bssMinRateMbps" : {
"description" : "BSS minimum rate (mbps)",
"type" : "string",
"enum" : [ "Disable", "1 mbps", "2 mbps", "5.5 mbps", "12 mbps", "24 mbps" ],
"default" : "Disable"
},
"mgmtTxRateMbps" : {
"description" : "Management TX rate (mbps)",
"type" : "string",
"enum" : [ "1 mbps", "2 mbps", "5.5 mbps", "6 mbps", "9 mbps", "11 mbps", "12 mbps", "18 mbps", "24 mbps", "36 mbps", "48 mbps", "54 mbps" ],
"default" : "2 mbps"
},
"pmkCachingEnabled" : {
"description" : "Indicator of whether PKM caching support is enabled or disabled. The default value is true when the WLAN is WPA+AES non open WLAN.",
"type" : "boolean"
},
"okcEnabled" : {
"description" : "Indicator of whether OKC support is enabled or disabled. The default value is true when the WLAN is WPA+AES non open WLAN.",
"type" : "boolean"
},
"avcEnabled" : {
"description" : "Indicator of whether ARC support is enabled or disabled",
"type" : "boolean",
"default" : false
},
"urlFilteringPolicyEnabled" : {
"description" : "Indicator of whether URL Filtering is enabled or disabled",
"type" : "boolean",
"default" : false
},
"urlFilteringPolicyId" : {
"description" : "The URL Filtering policy ID.",
"type" : "string"
},
"wifiCallingPolicyEnabled" : {
"description" : "Indicator of whether Wi-Fi Calling is enabled or disabled",
"type" : "boolean",
"default" : false
},
"wifiCallingPolicyIds" : {
"description" : "The Wi-Fi Calling policy IDs. (Maximum allowed number is 5)",
"type" : "array",
"items" : {
"type" : "string"
}
},
"uplinkEnabled" : {
"description" : "SSID Rate Limiting uplink enabled.",
"type" : "boolean",
"default" : false
},
"uplinkRate" : {
"description" : "SSID Rate Limiting uplink.",
"type" : "number",
"default" : 0.0
},
"downlinkEnabled" : {
"description" : "SSID Rate Limiting downlink enabled.",
"type" : "boolean",
"default" : false
},
"downlinkRate" : {
"description" : "SSID Rate Limiting downlink.",
"type" : "number",
"default" : 0.0
},
"ratePerSTAUplink" : {
"description" : "UE Rate Limiting uplink.",
"type" : "string"
},
"ratePerSTADownlink" : {
"description" : "UE Rate Limiting downlink.",
"type" : "string"
},
"dtimInterval" : {
"description" : "DTIM Interval",
"type" : "integer",
"minimum" : 1,
"maximum" : 255,
"default" : 1
},
"directedThreshold" : {
"description" : "Directed Threshold Setting, Defines the client count at which an AP will stop converting group addressed data traffic to unicast.",
"type" : "integer",
"minimum" : 0,
"maximum" : 128,
"default" : 5
},
"flowLogEnabled" : {
"description" : "Flow log enabled.",
"type" : "boolean",
"default" : false
},
"hdOverheadOptimizeEnable" : {
"description" : "Airtime decongestion enabled.",
"type" : "boolean",
"default" : false
},
"probeRssiThr" : {
"type" : "integer",
"description" : "Join RSSI threshold.",
"minimum" : -90,
"maximum" : -60,
"default" : -85
},
"transientClientMgmtEnable" : {
"description" : "Transient Client Management enabled.",
"type" : "boolean",
"default" : false
},
"joinIgnoreTimeout" : {
"description" : "Join wait time.",
"type" : "integer",
"minimum" : 1,
"maximum" : 60,
"default" : 30
},
"joinAcceptTimeout" : {
"description" : "Join expire time.",
"type" : "integer",
"minimum" : 1,
"maximum" : 300,
"default" : 300
},
"joinIgnoreThr" : {
"description" : "Join wait threshold.",
"type" : "integer",
"minimum" : 1,
"maximum" : 50,
"default" : 10
},
"authRssiThr" : {
"description" : "Auth RSSI threshold.",
"type" : "integer",
"minimum" : -90,
"maximum" : -60
},
"assocRssiThr" : {
"description" : "Assoc RSSI threshold.",
"type" : "integer",
"minimum" : -90,
"maximum" : -60
},
"oceEnabled" : {
"description" : "Optimized Connectivity Experience(OCE) enabled.",
"type" : "boolean",
"default" : false
},
"oceBroadcastProbeResponseDelay" : {
"description" : "Broadcast probe response delay.",
"type" : "integer",
"minimum" : 8,
"maximum" : 120,
"default" : 15
},
"oceRssiBasedAssociationRejectionThreshold" : {
"description" : "RSSI-based association rejection threshold.",
"type" : "integer",
"minimum" : -90,
"maximum" : -60,
"default" : -75
}
}
},
"diffServProfile" : {
"description" : "DiffServ profile of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"qosMaps" : {
"description" : "Qos map set of the WLAN.",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"enable" : {
"description" : "Enabled or disabled",
"type" : "boolean"
},
"priority" : {
"description" : "Priority",
"type" : "integer"
},
"low" : {
"description" : "DSCP range - low",
"type" : [ "integer", "null" ],
"minimum" : 0,
"maximum" : 255
},
"high" : {
"description" : "DSCP range - high",
"type" : [ "integer", "null" ],
"minimum" : 0,
"maximum" : 255
},
"excepts" : {
"type" : [ "array", "null" ],
"items" : {
"type" : "integer",
"minimum" : 0,
"maximum" : 63
}
}
},
"required" : [ "enable", "priority" ]
}
},
"dpsk" : {
"description" : "DPSK Setting",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"dpskEnabled" : {
"description" : "DPSK enabled",
"type" : "boolean",
"default" : false
},
"length" : {
"description" : "Length of DPSK key",
"type" : "integer",
"default" : 62
},
"dpskType" : {
"description" : "Type of DPSK key",
"type" : "string",
"enum" : [ "Secure", "KeyboardFriendly", "NumbersOnly" ],
"default" : "Secure"
},
"expiration" : {
"description" : "Expiration of DPSK key",
"type" : "string",
"enum" : [ "Unlimited", "OneDay", "TwoDays", "OneWeek", "TwoWeeks", "OneMonth", "SixMonths", "OneYear", "TwoYears" ],
"default" : "Unlimited"
},
"dpskFromType" : {
"description" : "Type of expiration start from",
"type" : "string",
"enum" : [ "CreateTime", "FirstUse" ],
"default" : "CreateTime"
}
}
},
"externalDpsk" : {
"description" : "External DPSK Enabled",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"enabled" : {
"description" : "Enable External DPSK",
"type" : "boolean",
"default" : false
},
"encryption" : {
"description" : "Encryption of the WLAN relate to external DPSK",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"method" : {
"description" : "Encryption method",
"type" : "string",
"enum" : [ "WPA2", "WPA_Mixed", "None" ]
},
"algorithm" : {
"description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
"type" : "string",
"enum" : [ "AES", "TKIP_AES" ]
}
}
},
"authService" : {
"description" : "Autentication of the WLAN relate to external DPSK",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Identifier of the authentication service. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the authentication service. At least one ID or name is required in the request.",
"type" : "string"
}
}
}
},
"required" : [ "enabled" ]
},
"dnsServerProfile" : {
"description" : "DNS server profile of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"accessTunnelProfile" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"accessIpsecProfile" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"splitTunnelProfileId" : {
"type" : "string"
},
"portalDetectionProfileId" : {
"type" : "string"
}
},
"required" : [ "name", "ssid", "authServiceOrProfile", "portalServiceProfile" ]
}201Body
{
"id": "wlanID"
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
}
}
}Create - Wechat ¶
POST/v8_0/rkszones/{zoneId}/wlans/wechat
Use this API command to create a new wechat WLAN.
Body
{
"name": "wlanName",
"ssid": "wlanSSID",
"description": "wlanDescription",
"portalServiceProfile": {
"id": "portalServiceUUID",
"name": "portalServiceName"
},
"accessTunnelType": "RuckusGRE",
"accessTunnelProfile": {
"id": "f5b92938-aa4e-4d02-90ea-273799ff689b",
"name": "Default Tunnel Profile"
},
"splitTunnelProfileId": "38119bac-49e1-4410-ab8e-1c1bc88dd770",
"coreTunnelProfile": {
"type": "Bridge",
"id": "forwardingUUID",
"name": "forwardingName"
},
"encryption": {
"method": "None"
},
"operatorRealm": "operator realm",
"defaultUserTrafficProfile": {
"id": "userTrafficUUID",
"name": "userTrafficName"
},
"precedenceProfileId": "c514d450-c839-9527-afc9-525400d12345",
"portalDetectionProfileId": "de0fa30c-9565-11e8-9eb6-529269fb1459",
"schedule": {
"type": "Customized",
"id": "ServiceUUID",
"name": "ServiceName"
},
"vlan": {
"accessVlan": 23,
"coreQinQEnabled": false,
"coreSVlan": 1,
"vlanPooling": null
},
"l2ACL": {
"id": "l2ACLUUID",
"name": "l2ACLName"
},
"devicePolicy": {
"id": "devicePolicyUUID",
"name": "devicePolicyName"
},
"radiusOptions": {
"nasIdType": "Customized",
"customizedNasId": "nasId",
"nasRequestTimeoutSec": 12,
"nasMaxRetry": 3,
"nasReconnectPrimaryMin": 30,
"calledStaIdType": "WLAN_BSSID",
"nasIpType": "disabled",
"nasIpUserDefined": "192.168.1.1"
},
"advancedOptions": {
"clientIsolationEnabled": true,
"clientIsolationUnicastEnabled": true,
"clientIsolationMulticastEnabled": false,
"clientIsolationAutoVrrpEnabled": false,
"clientIsolationWhitelist": {
"id": "b89323e1-3168-11e7-b027-5254009ae3f0",
"name": "myWhitelist"
},
"priority": "High",
"hideSsidEnabled": true,
"maxClientsPerRadio": 12,
"clientIdleTimeoutSec": 60,
"clientLoadBalancingEnabled": true,
"proxyARPEnabled": true,
"ndProxyEnabled": false,
"suppressNsEnabled": false,
"raProxyEnabled": false,
"rsraGuardEnabled": false,
"raThrottlingEnabled": false,
"maxAllowedRA": 10,
"raInterval": 10,
"support80211dEnabled": false,
"support80211kEnabled": true,
"forceClientDHCPTimeoutSec": 5,
"dhcpOption82Enabled": true,
"dhcp82Format": "RUCKUS_DEFAULT",
"unauthClientStatsEnabled": false,
"clientFingerprintingEnabled": true,
"ofdmOnlyEnabled": false,
"bandBalancing": "UseZoneSetting",
"bssMinRateMbps": "Disable",
"mgmtTxRateMbps": "2 mbps",
"avcEnabled": true,
"urlFilteringPolicyEnabled": false,
"urlFilteringPolicyId": "",
"wifiCallingPolicyEnabled": false,
"wifiCallingPolicyIds": [],
"uplinkEnabled": true,
"uplinkRate": 100,
"downlinkEnabled": true,
"downlinkRate": 200,
"ratePerSTAUplink": "650mbps",
"ratePerSTADownlink": "1mbps"
},
"diffServProfile": {
"id": "diffServId",
"name": "diffServName"
},
"qosMaps": [
{
"enable": true,
"priority": 0,
"low": 0,
"high": 7,
"excepts": null
},
{
"enable": true,
"priority": 1,
"low": 8,
"high": 15,
"excepts": null
},
{
"enable": true,
"priority": 2,
"low": 16,
"high": 23,
"excepts": null
},
{
"enable": true,
"priority": 3,
"low": 0,
"high": 32,
"excepts": [
43,
45,
60
]
},
{
"enable": true,
"priority": 4,
"low": 32,
"high": 39,
"excepts": null
},
{
"enable": true,
"priority": 5,
"low": 40,
"high": 47,
"excepts": null
},
{
"enable": true,
"priority": 6,
"low": 48,
"high": 55,
"excepts": [
46
]
},
{
"enable": true,
"priority": 7,
"low": 56,
"high": 63,
"excepts": null
}
],
"dnsServerProfile": {
"id": "DNS server profile UUID",
"name": "DNS server profile name"
},
"dpsk": {
"dpskEnabled": false,
"length": 8,
"dpskType": "Secure",
"expiration": "OneDay",
"dpskFromType": "FirstUse"
},
"externalDpsk": {
"enabled": true,
"encryption": {
"method": "WPA2",
"algorithm": "AES"
},
"authService": {
"id": "authServiceUUID"
}
}
}Schema
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"name" : {
"description" : "Name of the WLAN",
"type" : "string",
"minLength" : 1,
"maxLength" : 32
},
"ssid" : {
"description" : "SSID of the WLAN",
"type" : "string",
"minLength" : 1,
"maxLength" : 32
},
"hessid" : {
"description" : "HESSID of the WLAN",
"type" : "string",
"pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$"
},
"description" : {
"description" : "Description of the WLAN",
"type" : [ "string", "null" ],
"maxLength" : 64
},
"caleaEnabled" : {
"description" : "DP CALEA Server Enabled",
"type" : "boolean"
},
"dpTunnelNatEnabled" : {
"description" : "DP Tunnel NAT Enabled",
"type" : "boolean"
},
"dpTunnelDhcpEnabled" : {
"description" : "DP Tunnel DHCP Enabled",
"type" : "boolean"
},
"awsExtNasIPEnable" : {
"description" : "Aws ExtNasIP Enable",
"type" : "boolean"
},
"awsVenueEnable" : {
"description" : "Aws Venue Enable",
"type" : "boolean"
},
"accessTunnelType" : {
"description" : "Access tunnel type of the WLAN. APLBO means AP local breakout, RuckusGRE means RuckusGRE tunnel to the data plane, and SoftGRE means AP direct SoftGRE tunnel",
"type" : "string",
"enum" : [ "APLBO", "RuckusGRE", "SoftGRE" ]
},
"coreTunnelProfile" : {
"description" : "Core tunnel of the WLAN. This only applies when the access tunnel type is set to RuckusGRE.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"type" : {
"description" : "Tunnel type",
"type" : "string",
"enum" : [ "Bridge", "L2oGRE", "TTG_PDG", "Mixed" ]
},
"id" : {
"description" : "Identifier of the forwarding profile. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the forwarding profile. At least one ID or name is required in the request.",
"type" : "string"
},
"operatorRealm" : {
"description" : "Operator realm, deprecated coreTunnelProfile.operatorRealm from version3.1, prepare remove",
"type" : "string",
"maxLength" : 255,
"pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
}
},
"required" : [ "type" ]
},
"macAuth" : {
"description" : "MAC address authentication settings of the WLAN. This only applies to standard MAC and Hotspot MAC bypass WLAN.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"macAuthMacFormat" : {
"description" : "MAC address format. The default format is 0010a42319c0 and the 802.1X format is 00-10-A4-23-19-C0.",
"type" : "string",
"enum" : [ "Default", "802.1X", "UpperColon", "Upper", "LowerDash", "LowerColon" ]
},
"customizedPassword" : {
"description" : "User defined password. When this field is set to an empty string, the MAC address is used as password.",
"type" : "string",
"maxLength" : 64,
"pattern" : "^([!-;=?-~]([ -;=?-~]){0,62}[!-;=?-~]|[!-;=?-~]{1,1}|\s{0,0})$"
}
}
},
"encryption" : {
"description" : "Encryption of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"method" : {
"description" : "Encryption method",
"type" : "string",
"enum" : [ "WPA2", "WPA_Mixed", "WEP_64", "WEP_128", "None" ],
"default" : "None"
},
"algorithm" : {
"description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
"type" : "string",
"enum" : [ "AES", "TKIP_AES" ]
},
"passphrase" : {
"description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
"type" : "string"
},
"mfp" : {
"description" : "Management frame protection. This only applies to WPA2 + AES",
"type" : "string",
"enum" : [ "disabled", "capable", "required" ]
},
"keyIndex" : {
"description" : "Key index. This only applies to WEP64 and WEP128.",
"type" : "integer"
},
"keyInHex" : {
"description" : "Key in hex format. This only applies to WEP64 and WEP128.",
"type" : "string"
},
"support80211rEnabled" : {
"description" : "Enable 802.11r Fast BSS Transition, fast Romaing.",
"type" : "boolean"
},
"mobilityDomainId" : {
"description" : "mobility Domain Id.",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
}
},
"required" : [ "method" ]
},
"authServiceOrProfile" : {
"description" : "Authentication of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"throughController" : {
"description" : "Indicates whether authentication messages were sent through the controller or not",
"type" : "boolean"
},
"realmBasedAuth" : {
"type" : "boolean"
},
"id" : {
"description" : "Identifier of the authentication service or profile. At least one ID or name or authenticationOption is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the authentication service or profile. At least one ID or name or authenticationOption is required in the request. Or could input the 'Always Accept' or 'Local DB'.",
"type" : "string"
},
"authenticationOption" : {
"description" : "Option of the authentication service or profile, At least one ID or name or authenticationOption is required in the request. This only applies to hotspot and guest WLANs.",
"type" : [ "string", "null" ],
"enum" : [ "Local DB", "Guest", "Always Accept", null ]
},
"locationDeliveryEnabled" : {
"description" : "RFC5580 location delivery support",
"type" : "boolean"
},
"backupAuthenticationId" : {
"description" : "Identifier of the backup authentication service or profile. At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service.",
"type" : "string"
},
"backupAuthenticationName" : {
"description" : "Name of the backup authentication service or profile. At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service. Or could input the 'Always Accept'.",
"type" : "string"
},
"backupAuthenticationOption" : {
"description" : "Option of the backup authentication service or profile, At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service. This only applies to hotspot WLANs.",
"type" : [ "string", "null" ],
"enum" : [ "Always Accept", null ]
}
}
},
"operatorRealm" : {
"description" : "Operator realm, operatorRealm only supports coreTunnelProfile type is authServiceOrProfile.locationDeliveryEnabled is true",
"type" : "string",
"maxLength" : 255,
"pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
},
"accountingServiceOrProfile" : {
"description" : "Accounting of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"throughController" : {
"description" : "Indicates whether accounting messages were sent through the controller",
"type" : "boolean"
},
"realmBasedAcct" : {
"type" : "boolean"
},
"id" : {
"description" : "Accounting service or profile ID. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Accounting service or profile name. At least one ID or name is required in the request.",
"type" : "string"
},
"interimUpdateMin" : {
"description" : "Interval (in minutes) for sending interim updates",
"type" : "integer",
"minimum" : 0,
"maximum" : 1440
},
"accountingDelayEnabled" : {
"description" : "Indicates whether accounting delay time is enabled",
"type" : "boolean"
},
"accountingTTGSessionEnabled" : {
"description" : "Indicates whether accounting for TTG sessions is to enabled",
"type" : "boolean"
},
"backupAccountingId" : {
"description" : "Backup accounting service or profile ID. At least one backupAccountingId or backupAccountingName is required in the request when setting backup accounting service.",
"type" : "string"
},
"backupAccountingName" : {
"description" : "Backup accounting service or profile name. At least one backupAccountingId or backupAccountingName is required in the request when setting backup accounting service.",
"type" : "string"
}
}
},
"portalServiceProfile" : {
"description" : "Wechat portal service of the WLAN. The ID or name of the wechat portal services within the zone is required.",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"hotspot20Profile" : {
"description" : "Hotspot 2.0 operator profile of the WLAN. id or name of the hotspot 2.0 operator profiles within the zone is required.",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"defaultUserTrafficProfile" : {
"description" : "User traffic profile of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"precedenceProfileId" : {
"description" : "Precedence profile of the WLAN",
"type" : "string"
},
"schedule" : {
"description" : "Schedule of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"type" : {
"description" : "Type of WLAN schedule",
"type" : "string",
"enum" : [ "AlwaysOn", "AlwaysOff", "Customized" ],
"default" : "AlwaysOn"
},
"id" : {
"description" : "Identifier of the schedule profile. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the schedule profile. At least one ID or name is required in the request.",
"type" : "string"
}
},
"required" : [ "type" ]
},
"vlan" : {
"description" : "VLAN (access and/or core) of the WLAN.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"accessVlan" : {
"description" : "Access VLAN ID",
"type" : "integer",
"minimum" : 1,
"maximum" : 4094,
"default" : 1
},
"aaaVlanOverride" : {
"description" : "Indicates whether the AAA VLAN settings can be overriden or not",
"type" : "boolean"
},
"coreQinQEnabled" : {
"description" : "Indicates whether Q-in-Q is allowed at the core network or not",
"type" : "boolean"
},
"coreSVlan" : {
"description" : "Core SVLAN ID. This only applies when core Q-in-Q is enabled",
"type" : "integer",
"minimum" : 1,
"maximum" : 4094
},
"vlanPooling" : {
"description" : "Vlan pooling",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
}
}
},
"l2ACL" : {
"description" : "Layer 2 ACL of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"devicePolicy" : {
"description" : "Device policy of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"radiusOptions" : {
"description" : "RADIUS options of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"nasIdType" : {
"description" : "NAS ID type",
"type" : "string",
"enum" : [ "WLAN_BSSID", "AP_MAC", "Customized" ],
"default" : "WLAN_BSSID"
},
"customizedNasId" : {
"description" : "User defined NAS ID",
"type" : "string",
"maxLength" : 64,
"pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$"
},
"nasRequestTimeoutSec" : {
"description" : "NAS request timeout in seconds",
"type" : "integer",
"default" : 3,
"minimum" : 2,
"maximum" : 20
},
"nasMaxRetry" : {
"description" : "NAS request maximum retry",
"type" : "integer",
"default" : 2,
"minimum" : 2,
"maximum" : 10
},
"nasReconnectPrimaryMin" : {
"description" : "NAS reconnect primary time in minutes",
"type" : "integer",
"default" : 5,
"minimum" : 1,
"maximum" : 60
},
"calledStaIdType" : {
"description" : "Called station ID type",
"type" : "string",
"enum" : [ "WLAN_BSSID", "AP_MAC", "NONE" ],
"default" : "WLAN_BSSID"
},
"nasIpType" : {
"description" : "NAS IP type",
"type" : "string",
"enum" : [ "disabled", "control", "management", "userDefined" ],
"default" : "disabled"
},
"nasIpUserDefined" : {
"description" : "User-defined NAS IP",
"type" : "string",
"maxLength" : 45
},
"singleSessionIdAcctEnabled" : {
"description" : "When Single Accounting Session ID is enabled, APs will maintain one accounting session for client roaming",
"type" : "boolean",
"default" : false
}
}
},
"advancedOptions" : {
"description" : "Advanced settings for the WLAN.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"clientIsolationEnabled" : {
"description" : "Indicates whether wireless client isolation is enabled or disabled",
"type" : "boolean",
"default" : false
},
"clientIsolationUnicastEnabled" : {
"description" : "Indicates whether isolate unicast of wireless client isolation is enabled or disabled",
"type" : "boolean",
"default" : true
},
"clientIsolationMulticastEnabled" : {
"description" : "Indicates whether isolate multicast of wireless client isolation is enabled or disabled",
"type" : "boolean"
},
"clientIsolationAutoVrrpEnabled" : {
"description" : "Indicates whether Automatic support for VRRP of wireless client isolation is enabled or disabled",
"type" : "boolean",
"default" : false
},
"clientIsolationWhitelist" : {
"description" : "Indicates wireless client isolation whitelist",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"priority" : {
"description" : "Priority of the WLAN",
"type" : "string",
"enum" : [ "High", "Low" ],
"default" : "High"
},
"hideSsidEnabled" : {
"description" : "Indicates whether the SSID is hidden or broadcast",
"type" : "boolean",
"default" : false
},
"hs20Onboarding" : {
"description" : "Allow WISPr WLAN for Hotspot 2.0 Onboarding",
"type" : "boolean",
"default" : false
},
"maxClientsPerRadio" : {
"description" : "Maximum number of clients per radio",
"type" : "integer",
"default" : 100,
"minimum" : 1,
"maximum" : 512
},
"clientIdleTimeoutSec" : {
"description" : "Client idle timeout in seconds",
"type" : "integer",
"minimum" : 60,
"maximum" : 1000,
"default" : 120
},
"dgafEnabled" : {
"description" : "Indicates whether dgaf is enabled or disabled",
"type" : "boolean"
},
"clientLoadBalancingEnabled" : {
"description" : "Indicates whether Client Load Balancing is enabled or disabled",
"type" : "boolean",
"default" : true
},
"proxyARPEnabled" : {
"description" : "Indicates whether proxy ARP is enabled or disabled",
"type" : "boolean",
"default" : false
},
"ndProxyEnabled" : {
"description" : "Indicates whether ND Proxy is enabled or disabled",
"type" : "boolean",
"default" : false
},
"suppressNsEnabled" : {
"description" : "Indicates whether supperssNS is enabled or disabled",
"type" : "boolean",
"default" : false
},
"raProxyEnabled" : {
"description" : "Indicates whether RA proxy is enabled or disabled",
"type" : "boolean",
"default" : false
},
"rsraGuardEnabled" : {
"description" : "Indicates whether RS/RA Guard is enabled or disabled",
"type" : "boolean",
"default" : false
},
"raThrottlingEnabled" : {
"description" : "Indicates whether RA Throttling is enabled or disabled",
"type" : "boolean",
"default" : false
},
"maxAllowedRA" : {
"description" : "Max Allowed RAs",
"type" : "integer",
"minimum" : 1,
"maximum" : 1440,
"default" : 10
},
"raInterval" : {
"description" : "A timer that RA proxy runs and once receives unsolicited RA checks against the configured time and allow/drop RA based on next timeout",
"type" : "integer",
"minimum" : 1,
"maximum" : 256,
"default" : 10
},
"support80211dEnabled" : {
"description" : "Indicates whether support for 802.11d is enabled or disabled",
"type" : "boolean",
"default" : true
},
"support80211kEnabled" : {
"description" : "Indicates whether support for 802.11k is enabled or disabled",
"type" : "boolean",
"default" : true
},
"antiSpoofingEnabled" : {
"description" : "Anti-Spoofing enabled",
"type" : "boolean",
"default" : false
},
"arpRequestRateLimit" : {
"description" : "ARP packets request rate limit, default value will be 15 if both rate limit not being set.",
"type" : "integer",
"minimum" : 0,
"maximum" : 100
},
"dhcpRequestRateLimit" : {
"description" : "DHCP packets request rate limit, default value will be 15 if both rate limit not being set.",
"type" : "integer",
"minimum" : 0,
"maximum" : 100
},
"forceClientDHCPTimeoutSec" : {
"description" : "Force DHCP disconnects the client if the client does not obtain a valid IP address within the timeout peroid. To disable force DHCP, set this value to zero (0).",
"type" : "integer",
"enum" : [ 0, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15 ],
"default" : 0
},
"dhcpOption82Enabled" : {
"description" : "Indicates whether DCHP Option 82 is enabled or disabled",
"type" : "boolean",
"default" : false
},
"dhcp82Format" : {
"description" : "DHCP Option 82 format",
"type" : "string",
"enum" : [ "RUCKUS_DEFAULT", "SOFTGRE_CUSTOMIZED" ]
},
"unauthClientStatsEnabled" : {
"description" : "Indicates whether to send statistics of unauthorized clients or not",
"type" : "boolean",
"default" : false
},
"clientFingerprintingEnabled" : {
"description" : "Indicates whether client fingerprinting is enabled or disabled",
"type" : "boolean",
"default" : false
},
"ofdmOnlyEnabled" : {
"description" : "Indicates whether OFDM only is enabled or disabled",
"type" : "boolean",
"default" : false
},
"bandBalancing" : {
"description" : "Indicates whether band balancing is enabled or disabled",
"type" : "string",
"enum" : [ "Disabled", "UseZoneSetting" ],
"default" : "UseZoneSetting"
},
"bssMinRateMbps" : {
"description" : "BSS minimum rate (mbps)",
"type" : "string",
"enum" : [ "Disable", "1 mbps", "2 mbps", "5.5 mbps", "12 mbps", "24 mbps" ],
"default" : "Disable"
},
"mgmtTxRateMbps" : {
"description" : "Management TX rate (mbps)",
"type" : "string",
"enum" : [ "1 mbps", "2 mbps", "5.5 mbps", "6 mbps", "9 mbps", "11 mbps", "12 mbps", "18 mbps", "24 mbps", "36 mbps", "48 mbps", "54 mbps" ],
"default" : "2 mbps"
},
"pmkCachingEnabled" : {
"description" : "Indicator of whether PKM caching support is enabled or disabled. The default value is true when the WLAN is WPA+AES non open WLAN.",
"type" : "boolean"
},
"okcEnabled" : {
"description" : "Indicator of whether OKC support is enabled or disabled. The default value is true when the WLAN is WPA+AES non open WLAN.",
"type" : "boolean"
},
"avcEnabled" : {
"description" : "Indicator of whether ARC support is enabled or disabled",
"type" : "boolean",
"default" : false
},
"urlFilteringPolicyEnabled" : {
"description" : "Indicator of whether URL Filtering is enabled or disabled",
"type" : "boolean",
"default" : false
},
"urlFilteringPolicyId" : {
"description" : "The URL Filtering policy ID.",
"type" : "string"
},
"wifiCallingPolicyEnabled" : {
"description" : "Indicator of whether Wi-Fi Calling is enabled or disabled",
"type" : "boolean",
"default" : false
},
"wifiCallingPolicyIds" : {
"description" : "The Wi-Fi Calling policy IDs. (Maximum allowed number is 5)",
"type" : "array",
"items" : {
"type" : "string"
}
},
"uplinkEnabled" : {
"description" : "SSID Rate Limiting uplink enabled.",
"type" : "boolean",
"default" : false
},
"uplinkRate" : {
"description" : "SSID Rate Limiting uplink.",
"type" : "number",
"default" : 0.0
},
"downlinkEnabled" : {
"description" : "SSID Rate Limiting downlink enabled.",
"type" : "boolean",
"default" : false
},
"downlinkRate" : {
"description" : "SSID Rate Limiting downlink.",
"type" : "number",
"default" : 0.0
},
"ratePerSTAUplink" : {
"description" : "UE Rate Limiting uplink.",
"type" : "string"
},
"ratePerSTADownlink" : {
"description" : "UE Rate Limiting downlink.",
"type" : "string"
},
"dtimInterval" : {
"description" : "DTIM Interval",
"type" : "integer",
"minimum" : 1,
"maximum" : 255,
"default" : 1
},
"directedThreshold" : {
"description" : "Directed Threshold Setting, Defines the client count at which an AP will stop converting group addressed data traffic to unicast.",
"type" : "integer",
"minimum" : 0,
"maximum" : 128,
"default" : 5
},
"flowLogEnabled" : {
"description" : "Flow log enabled.",
"type" : "boolean",
"default" : false
},
"hdOverheadOptimizeEnable" : {
"description" : "Airtime decongestion enabled.",
"type" : "boolean",
"default" : false
},
"probeRssiThr" : {
"type" : "integer",
"description" : "Join RSSI threshold.",
"minimum" : -90,
"maximum" : -60,
"default" : -85
},
"transientClientMgmtEnable" : {
"description" : "Transient Client Management enabled.",
"type" : "boolean",
"default" : false
},
"joinIgnoreTimeout" : {
"description" : "Join wait time.",
"type" : "integer",
"minimum" : 1,
"maximum" : 60,
"default" : 30
},
"joinAcceptTimeout" : {
"description" : "Join expire time.",
"type" : "integer",
"minimum" : 1,
"maximum" : 300,
"default" : 300
},
"joinIgnoreThr" : {
"description" : "Join wait threshold.",
"type" : "integer",
"minimum" : 1,
"maximum" : 50,
"default" : 10
},
"authRssiThr" : {
"description" : "Auth RSSI threshold.",
"type" : "integer",
"minimum" : -90,
"maximum" : -60
},
"assocRssiThr" : {
"description" : "Assoc RSSI threshold.",
"type" : "integer",
"minimum" : -90,
"maximum" : -60
},
"oceEnabled" : {
"description" : "Optimized Connectivity Experience(OCE) enabled.",
"type" : "boolean",
"default" : false
},
"oceBroadcastProbeResponseDelay" : {
"description" : "Broadcast probe response delay.",
"type" : "integer",
"minimum" : 8,
"maximum" : 120,
"default" : 15
},
"oceRssiBasedAssociationRejectionThreshold" : {
"description" : "RSSI-based association rejection threshold.",
"type" : "integer",
"minimum" : -90,
"maximum" : -60,
"default" : -75
}
}
},
"diffServProfile" : {
"description" : "DiffServ profile of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"qosMaps" : {
"description" : "Qos map set of the WLAN.",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"enable" : {
"description" : "Enabled or disabled",
"type" : "boolean"
},
"priority" : {
"description" : "Priority",
"type" : "integer"
},
"low" : {
"description" : "DSCP range - low",
"type" : [ "integer", "null" ],
"minimum" : 0,
"maximum" : 255
},
"high" : {
"description" : "DSCP range - high",
"type" : [ "integer", "null" ],
"minimum" : 0,
"maximum" : 255
},
"excepts" : {
"type" : [ "array", "null" ],
"items" : {
"type" : "integer",
"minimum" : 0,
"maximum" : 63
}
}
},
"required" : [ "enable", "priority" ]
}
},
"dpsk" : {
"description" : "DPSK Setting",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"dpskEnabled" : {
"description" : "DPSK enabled",
"type" : "boolean",
"default" : false
},
"length" : {
"description" : "Length of DPSK key",
"type" : "integer",
"default" : 62
},
"dpskType" : {
"description" : "Type of DPSK key",
"type" : "string",
"enum" : [ "Secure", "KeyboardFriendly", "NumbersOnly" ],
"default" : "Secure"
},
"expiration" : {
"description" : "Expiration of DPSK key",
"type" : "string",
"enum" : [ "Unlimited", "OneDay", "TwoDays", "OneWeek", "TwoWeeks", "OneMonth", "SixMonths", "OneYear", "TwoYears" ],
"default" : "Unlimited"
},
"dpskFromType" : {
"description" : "Type of expiration start from",
"type" : "string",
"enum" : [ "CreateTime", "FirstUse" ],
"default" : "CreateTime"
}
}
},
"externalDpsk" : {
"description" : "External DPSK Enabled",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"enabled" : {
"description" : "Enable External DPSK",
"type" : "boolean",
"default" : false
},
"encryption" : {
"description" : "Encryption of the WLAN relate to external DPSK",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"method" : {
"description" : "Encryption method",
"type" : "string",
"enum" : [ "WPA2", "WPA_Mixed", "None" ]
},
"algorithm" : {
"description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
"type" : "string",
"enum" : [ "AES", "TKIP_AES" ]
}
}
},
"authService" : {
"description" : "Autentication of the WLAN relate to external DPSK",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Identifier of the authentication service. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the authentication service. At least one ID or name is required in the request.",
"type" : "string"
}
}
}
},
"required" : [ "enabled" ]
},
"dnsServerProfile" : {
"description" : "DNS server profile of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"accessTunnelProfile" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"accessIpsecProfile" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"splitTunnelProfileId" : {
"type" : "string"
},
"portalDetectionProfileId" : {
"type" : "string"
}
},
"required" : [ "name", "ssid", "portalServiceProfile" ]
}201Body
{
"id": "wlanID"
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
}
}
}Create - Guest Access ¶
POST/v8_0/rkszones/{zoneId}/wlans/guest
Use this API command to create a new guest access WLAN.
Body
‧ Sample : Create a Guest WLAN with default configurations
{
"name" : "wlanName",
"ssid" : "wlanSSID",
"description" : "wlanDescription",
"authServiceOrProfile" : {
"throughController" : false,
"id" : "authServiceUUID",
"name" : "authServiceName",
"authenticationOption" : null
},
"portalServiceProfile" : {
"id" : "portalServiceUUID",
"name" : "portalServiceName"
},
"accessTunnelType" : "RuckusGRE",
"accessTunnelProfile" : {
"id" : "f5b92938-aa4e-4d02-90ea-273799ff689b",
"name" : "Default Tunnel Profile"
},
"splitTunnelProfileId" : "38119bac-49e1-4410-ab8e-1c1bc88dd770",
"coreTunnelProfile" : {
"type" : "Bridge",
"id" : "forwardingUUID",
"name" : "forwardingName"
},
"encryption" : {
"method" : "WPA2",
"algorithm" : "AES",
"passphrase" : "password",
"mfp" : "disabled",
"support80211rEnabled" : true,
"mobilityDomainId" : 3
},
"operatorRealm" : "operator realm",
"defaultUserTrafficProfile" : {
"id" : "userTrafficUUID",
"name" : "userTrafficName"
},
"precedenceProfileId" : "c514d450-c839-9527-afc9-525400d12345",
"portalDetectionProfileId" : "de0fa30c-9565-11e8-9eb6-529269fb1459",
"schedule" : {
"type" : "Customized",
"id" : "ServiceUUID",
"name" : "ServiceName"
},
"vlan" : {
"accessVlan" : 23,
"coreQinQEnabled" : false,
"coreSVlan" : 1,
"vlanPooling" : null
},
"l2ACL" : {
"id" : "l2ACLUUID",
"name" : "l2ACLName"
},
"radiusOptions" : {
"nasIdType" : "Customized",
"customizedNasId" : "nasId",
"nasRequestTimeoutSec" : 12,
"nasMaxRetry" : 3,
"nasReconnectPrimaryMin" : 30,
"calledStaIdType" : "WLAN_BSSID",
"nasIpType" : "disabled",
"nasIpUserDefined" : "192.168.1.1"
},
"advancedOptions" : {
"clientIsolationEnabled" : true,
"clientIsolationUnicastEnabled" : true,
"clientIsolationMulticastEnabled" : false,
"clientIsolationAutoVrrpEnabled" : false,
"clientIsolationWhitelist" : {
"id" : "b89323e1-3168-11e7-b027-5254009ae3f0",
"name" : "myWhitelist"
},
"priority" : "High",
"hideSsidEnabled" : true,
"maxClientsPerRadio" : 12,
"clientIdleTimeoutSec" : 60,
"clientLoadBalancingEnabled" : true,
"proxyARPEnabled" : true,
"ndProxyEnabled" : false,
"suppressNsEnabled" : false,
"raProxyEnabled" : false,
"rsraGuardEnabled" : false,
"raThrottlingEnabled" : false,
"maxAllowedRA" : 10,
"raInterval" : 10,
"support80211dEnabled" : false,
"support80211kEnabled" : true,
"forceClientDHCPTimeoutSec" : 5,
"dhcpOption82Enabled" : true,
"dhcp82Format" : "RUCKUS_DEFAULT",
"unauthClientStatsEnabled" : false,
"clientFingerprintingEnabled" : true,
"ofdmOnlyEnabled" : false,
"bandBalancing" : "UseZoneSetting",
"bssMinRateMbps" : "Disable",
"mgmtTxRateMbps" : "2 mbps",
"avcEnabled" : true,
"urlFilteringPolicyEnabled" : false,
"urlFilteringPolicyId" : "",
"wifiCallingPolicyEnabled" : false,
"wifiCallingPolicyIds" : [ ],
"uplinkEnabled" : true,
"uplinkRate" : 100,
"downlinkEnabled" : true,
"downlinkRate" : 200,
"ratePerSTAUplink" : "650mbps",
"ratePerSTADownlink" : "1mbps"
},
"diffServProfile" : {
"id" : "diffServId",
"name" : "diffServName"
},
"qosMaps" : [ {
"enable" : true,
"priority" : 0,
"low" : 0,
"high" : 7,
"excepts" : null
}, {
"enable" : true,
"priority" : 1,
"low" : 8,
"high" : 15,
"excepts" : null
}, {
"enable" : true,
"priority" : 2,
"low" : 16,
"high" : 23,
"excepts" : null
}, {
"enable" : true,
"priority" : 3,
"low" : 0,
"high" : 32,
"excepts" : [ 43, 45, 60 ]
}, {
"enable" : true,
"priority" : 4,
"low" : 32,
"high" : 39,
"excepts" : null
}, {
"enable" : true,
"priority" : 5,
"low" : 40,
"high" : 47,
"excepts" : null
}, {
"enable" : true,
"priority" : 6,
"low" : 48,
"high" : 55,
"excepts" : [ 46 ]
}, {
"enable" : true,
"priority" : 7,
"low" : 56,
"high" : 63,
"excepts" : null
} ],
"dnsServerProfile" : {
"id" : "DNS server profile UUID",
"name" : "DNS server profile name"
},
"dpsk" : {
"dpskEnabled" : false,
"length" : 8,
"dpskType" : "Secure",
"expiration" : "OneDay",
"dpskFromType" : "FirstUse"
},
"externalDpsk" : {
"enabled" : true,
"encryption" : {
"method" : "WPA2",
"algorithm" : "AES"
},
"authService" : {
"id" : "authServiceUUID"
}
}
}
‧ Sample : Create a Guest WLAN with authenticationOption configurations
{
"name" : "wlanName",
"ssid" : "wlanSSID",
"description" : "wlanDescription",
"authServiceOrProfile" : {
"throughController" : true,
"authenticationOption" : "Guest"
},
"portalServiceProfile" : {
"id" : "portalServiceUUID",
"name" : "portalServiceName"
}
}Schema
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"name" : {
"description" : "Name of the WLAN",
"type" : "string",
"minLength" : 1,
"maxLength" : 32
},
"ssid" : {
"description" : "SSID of the WLAN",
"type" : "string",
"minLength" : 1,
"maxLength" : 32
},
"hessid" : {
"description" : "HESSID of the WLAN",
"type" : "string",
"pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$"
},
"description" : {
"description" : "Description of the WLAN",
"type" : [ "string", "null" ],
"maxLength" : 64
},
"bypassCNA" : {
"description" : "Bypass Capitive Network Assitance",
"type" : "boolean",
"default" : false
},
"caleaEnabled" : {
"description" : "DP CALEA Server Enabled",
"type" : "boolean"
},
"dpTunnelNatEnabled" : {
"description" : "DP Tunnel NAT Enabled",
"type" : "boolean"
},
"dpTunnelDhcpEnabled" : {
"description" : "DP Tunnel DHCP Enabled",
"type" : "boolean"
},
"awsExtNasIPEnable" : {
"description" : "Aws ExtNasIP Enable",
"type" : "boolean"
},
"awsVenueEnable" : {
"description" : "Aws Venue Enable",
"type" : "boolean"
},
"accessTunnelType" : {
"description" : "Access tunnel type of the WLAN. APLBO means AP local breakout, RuckusGRE means RuckusGRE tunnel to the data plane, and SoftGRE means AP direct SoftGRE tunnel",
"type" : "string",
"enum" : [ "APLBO", "RuckusGRE", "SoftGRE" ]
},
"coreTunnelProfile" : {
"description" : "Core tunnel of the WLAN. This only applies when the access tunnel type is set to RuckusGRE.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"type" : {
"description" : "Tunnel type",
"type" : "string",
"enum" : [ "Bridge", "L2oGRE", "TTG_PDG", "Mixed" ]
},
"id" : {
"description" : "Identifier of the forwarding profile. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the forwarding profile. At least one ID or name is required in the request.",
"type" : "string"
},
"operatorRealm" : {
"description" : "Operator realm, deprecated coreTunnelProfile.operatorRealm from version3.1, prepare remove",
"type" : "string",
"maxLength" : 255,
"pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
}
},
"required" : [ "type" ]
},
"macAuth" : {
"description" : "MAC address authentication settings of the WLAN. This only applies to standard MAC and Hotspot MAC bypass WLAN.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"macAuthMacFormat" : {
"description" : "MAC address format. The default format is 0010a42319c0 and the 802.1X format is 00-10-A4-23-19-C0.",
"type" : "string",
"enum" : [ "Default", "802.1X", "UpperColon", "Upper", "LowerDash", "LowerColon" ]
},
"customizedPassword" : {
"description" : "User defined password. When this field is set to an empty string, the MAC address is used as password.",
"type" : "string",
"maxLength" : 64,
"pattern" : "^([!-;=?-~]([ -;=?-~]){0,62}[!-;=?-~]|[!-;=?-~]{1,1}|\s{0,0})$"
}
}
},
"encryption" : {
"description" : "Encryption of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"method" : {
"description" : "Encryption method",
"type" : "string",
"enum" : [ "WPA2", "WPA_Mixed", "WEP_64", "WEP_128", "None" ],
"default" : "None"
},
"algorithm" : {
"description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
"type" : "string",
"enum" : [ "AES", "TKIP_AES" ]
},
"passphrase" : {
"description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
"type" : "string"
},
"mfp" : {
"description" : "Management frame protection. This only applies to WPA2 + AES",
"type" : "string",
"enum" : [ "disabled", "capable", "required" ]
},
"keyIndex" : {
"description" : "Key index. This only applies to WEP64 and WEP128.",
"type" : "integer"
},
"keyInHex" : {
"description" : "Key in hex format. This only applies to WEP64 and WEP128.",
"type" : "string"
},
"support80211rEnabled" : {
"description" : "Enable 802.11r Fast BSS Transition, fast Romaing.",
"type" : "boolean"
},
"mobilityDomainId" : {
"description" : "mobility Domain Id.",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
}
},
"required" : [ "method" ]
},
"authServiceOrProfile" : {
"description" : "Authentication of the WLAN. Guest WLANs only accept two names: Local DB and Always Accept.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"throughController" : {
"description" : "Indicates whether authentication messages were sent through the controller or not",
"type" : "boolean"
},
"realmBasedAuth" : {
"type" : "boolean"
},
"id" : {
"description" : "Identifier of the authentication service or profile. At least one ID or name or authenticationOption is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the authentication service or profile. At least one ID or name or authenticationOption is required in the request. Or could input the 'Always Accept' or 'Local DB'.",
"type" : "string"
},
"authenticationOption" : {
"description" : "Option of the authentication service or profile, At least one ID or name or authenticationOption is required in the request. This only applies to hotspot and guest WLANs.",
"type" : [ "string", "null" ],
"enum" : [ "Local DB", "Guest", "Always Accept", null ]
},
"locationDeliveryEnabled" : {
"description" : "RFC5580 location delivery support",
"type" : "boolean"
},
"backupAuthenticationId" : {
"description" : "Identifier of the backup authentication service or profile. At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service.",
"type" : "string"
},
"backupAuthenticationName" : {
"description" : "Name of the backup authentication service or profile. At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service. Or could input the 'Always Accept'.",
"type" : "string"
},
"backupAuthenticationOption" : {
"description" : "Option of the backup authentication service or profile, At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service. This only applies to hotspot WLANs.",
"type" : [ "string", "null" ],
"enum" : [ "Always Accept", null ]
}
}
},
"operatorRealm" : {
"description" : "Operator realm, operatorRealm only supports coreTunnelProfile type is authServiceOrProfile.locationDeliveryEnabled is true",
"type" : "string",
"maxLength" : 255,
"pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
},
"accountingServiceOrProfile" : {
"description" : "Accounting of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"throughController" : {
"description" : "Indicates whether accounting messages were sent through the controller",
"type" : "boolean"
},
"realmBasedAcct" : {
"type" : "boolean"
},
"id" : {
"description" : "Accounting service or profile ID. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Accounting service or profile name. At least one ID or name is required in the request.",
"type" : "string"
},
"interimUpdateMin" : {
"description" : "Interval (in minutes) for sending interim updates",
"type" : "integer",
"minimum" : 0,
"maximum" : 1440
},
"accountingDelayEnabled" : {
"description" : "Indicates whether accounting delay time is enabled",
"type" : "boolean"
},
"accountingTTGSessionEnabled" : {
"description" : "Indicates whether accounting for TTG sessions is to enabled",
"type" : "boolean"
},
"backupAccountingId" : {
"description" : "Backup accounting service or profile ID. At least one backupAccountingId or backupAccountingName is required in the request when setting backup accounting service.",
"type" : "string"
},
"backupAccountingName" : {
"description" : "Backup accounting service or profile name. At least one backupAccountingId or backupAccountingName is required in the request when setting backup accounting service.",
"type" : "string"
}
}
},
"portalServiceProfile" : {
"description" : "Guest portal service of the WLAN. The ID or name of the guest portal services within the zone is required.",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"hotspot20Profile" : {
"description" : "Hotspot 2.0 operator profile of the WLAN. id or name of the hotspot 2.0 operator profiles within the zone is required.",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"defaultUserTrafficProfile" : {
"description" : "User traffic profile of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"precedenceProfileId" : {
"description" : "Precedence profile of the WLAN",
"type" : "string"
},
"flexiVpnProfile" : {
"description" : "Flexi-VPN profile of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"wlanId" : {
"type" : "string",
"description" : "Wlan ID"
},
"zoneAffinityId" : {
"type" : "string",
"description" : "Zone Affinity ID"
}
},
"required" : [ "zoneAffinityId" ]
},
"schedule" : {
"description" : "Schedule of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"type" : {
"description" : "Type of WLAN schedule",
"type" : "string",
"enum" : [ "AlwaysOn", "AlwaysOff", "Customized" ],
"default" : "AlwaysOn"
},
"id" : {
"description" : "Identifier of the schedule profile. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the schedule profile. At least one ID or name is required in the request.",
"type" : "string"
}
},
"required" : [ "type" ]
},
"vlan" : {
"description" : "VLAN (access and/or core) of the WLAN.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"accessVlan" : {
"description" : "Access VLAN ID",
"type" : "integer",
"minimum" : 1,
"maximum" : 4094,
"default" : 1
},
"aaaVlanOverride" : {
"description" : "Indicates whether the AAA VLAN settings can be overriden or not",
"type" : "boolean"
},
"coreQinQEnabled" : {
"description" : "Indicates whether Q-in-Q is allowed at the core network or not",
"type" : "boolean"
},
"coreSVlan" : {
"description" : "Core SVLAN ID. This only applies when core Q-in-Q is enabled",
"type" : "integer",
"minimum" : 1,
"maximum" : 4094
},
"vlanPooling" : {
"description" : "Vlan pooling",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
}
}
},
"l2ACL" : {
"description" : "Layer 2 ACL of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"devicePolicy" : {
"description" : "Device policy of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"radiusOptions" : {
"description" : "RADIUS options of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"nasIdType" : {
"description" : "NAS ID type",
"type" : "string",
"enum" : [ "WLAN_BSSID", "AP_MAC", "Customized" ],
"default" : "WLAN_BSSID"
},
"customizedNasId" : {
"description" : "User defined NAS ID",
"type" : "string",
"maxLength" : 64,
"pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$"
},
"nasRequestTimeoutSec" : {
"description" : "NAS request timeout in seconds",
"type" : "integer",
"default" : 3,
"minimum" : 2,
"maximum" : 20
},
"nasMaxRetry" : {
"description" : "NAS request maximum retry",
"type" : "integer",
"default" : 2,
"minimum" : 2,
"maximum" : 10
},
"nasReconnectPrimaryMin" : {
"description" : "NAS reconnect primary time in minutes",
"type" : "integer",
"default" : 5,
"minimum" : 1,
"maximum" : 60
},
"calledStaIdType" : {
"description" : "Called station ID type",
"type" : "string",
"enum" : [ "WLAN_BSSID", "AP_MAC", "NONE" ],
"default" : "WLAN_BSSID"
},
"nasIpType" : {
"description" : "NAS IP type",
"type" : "string",
"enum" : [ "disabled", "control", "management", "userDefined" ],
"default" : "disabled"
},
"nasIpUserDefined" : {
"description" : "User-defined NAS IP",
"type" : "string",
"maxLength" : 45
},
"singleSessionIdAcctEnabled" : {
"description" : "When Single Accounting Session ID is enabled, APs will maintain one accounting session for client roaming",
"type" : "boolean",
"default" : false
}
}
},
"advancedOptions" : {
"description" : "Advanced settings for the WLAN.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"clientIsolationEnabled" : {
"description" : "Indicates whether wireless client isolation is enabled or disabled",
"type" : "boolean",
"default" : false
},
"clientIsolationUnicastEnabled" : {
"description" : "Indicates whether isolate unicast of wireless client isolation is enabled or disabled",
"type" : "boolean",
"default" : true
},
"clientIsolationMulticastEnabled" : {
"description" : "Indicates whether isolate multicast of wireless client isolation is enabled or disabled",
"type" : "boolean"
},
"clientIsolationAutoVrrpEnabled" : {
"description" : "Indicates whether Automatic support for VRRP of wireless client isolation is enabled or disabled",
"type" : "boolean",
"default" : false
},
"clientIsolationWhitelist" : {
"description" : "Indicates wireless client isolation whitelist",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"priority" : {
"description" : "Priority of the WLAN",
"type" : "string",
"enum" : [ "High", "Low" ],
"default" : "High"
},
"hideSsidEnabled" : {
"description" : "Indicates whether the SSID is hidden or broadcast",
"type" : "boolean",
"default" : false
},
"hs20Onboarding" : {
"description" : "Allow WISPr WLAN for Hotspot 2.0 Onboarding",
"type" : "boolean",
"default" : false
},
"maxClientsPerRadio" : {
"description" : "Maximum number of clients per radio",
"type" : "integer",
"default" : 100,
"minimum" : 1,
"maximum" : 512
},
"clientIdleTimeoutSec" : {
"description" : "Client idle timeout in seconds",
"type" : "integer",
"minimum" : 60,
"maximum" : 1000,
"default" : 120
},
"dgafEnabled" : {
"description" : "Indicates whether dgaf is enabled or disabled",
"type" : "boolean"
},
"clientLoadBalancingEnabled" : {
"description" : "Indicates whether Client Load Balancing is enabled or disabled",
"type" : "boolean",
"default" : true
},
"proxyARPEnabled" : {
"description" : "Indicates whether proxy ARP is enabled or disabled",
"type" : "boolean",
"default" : false
},
"ndProxyEnabled" : {
"description" : "Indicates whether ND Proxy is enabled or disabled",
"type" : "boolean",
"default" : false
},
"suppressNsEnabled" : {
"description" : "Indicates whether supperssNS is enabled or disabled",
"type" : "boolean",
"default" : false
},
"raProxyEnabled" : {
"description" : "Indicates whether RA proxy is enabled or disabled",
"type" : "boolean",
"default" : false
},
"rsraGuardEnabled" : {
"description" : "Indicates whether RS/RA Guard is enabled or disabled",
"type" : "boolean",
"default" : false
},
"raThrottlingEnabled" : {
"description" : "Indicates whether RA Throttling is enabled or disabled",
"type" : "boolean",
"default" : false
},
"maxAllowedRA" : {
"description" : "Max Allowed RAs",
"type" : "integer",
"minimum" : 1,
"maximum" : 1440,
"default" : 10
},
"raInterval" : {
"description" : "A timer that RA proxy runs and once receives unsolicited RA checks against the configured time and allow/drop RA based on next timeout",
"type" : "integer",
"minimum" : 1,
"maximum" : 256,
"default" : 10
},
"support80211dEnabled" : {
"description" : "Indicates whether support for 802.11d is enabled or disabled",
"type" : "boolean",
"default" : true
},
"support80211kEnabled" : {
"description" : "Indicates whether support for 802.11k is enabled or disabled",
"type" : "boolean",
"default" : true
},
"antiSpoofingEnabled" : {
"description" : "Anti-Spoofing enabled",
"type" : "boolean",
"default" : false
},
"arpRequestRateLimit" : {
"description" : "ARP packets request rate limit, default value will be 15 if both rate limit not being set.",
"type" : "integer",
"minimum" : 0,
"maximum" : 100
},
"dhcpRequestRateLimit" : {
"description" : "DHCP packets request rate limit, default value will be 15 if both rate limit not being set.",
"type" : "integer",
"minimum" : 0,
"maximum" : 100
},
"forceClientDHCPTimeoutSec" : {
"description" : "Force DHCP disconnects the client if the client does not obtain a valid IP address within the timeout peroid. To disable force DHCP, set this value to zero (0).",
"type" : "integer",
"enum" : [ 0, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15 ],
"default" : 0
},
"dhcpOption82Enabled" : {
"description" : "Indicates whether DCHP Option 82 is enabled or disabled",
"type" : "boolean",
"default" : false
},
"dhcp82Format" : {
"description" : "DHCP Option 82 format",
"type" : "string",
"enum" : [ "RUCKUS_DEFAULT", "SOFTGRE_CUSTOMIZED" ]
},
"unauthClientStatsEnabled" : {
"description" : "Indicates whether to send statistics of unauthorized clients or not",
"type" : "boolean",
"default" : false
},
"clientFingerprintingEnabled" : {
"description" : "Indicates whether client fingerprinting is enabled or disabled",
"type" : "boolean",
"default" : false
},
"ofdmOnlyEnabled" : {
"description" : "Indicates whether OFDM only is enabled or disabled",
"type" : "boolean",
"default" : false
},
"bandBalancing" : {
"description" : "Indicates whether band balancing is enabled or disabled",
"type" : "string",
"enum" : [ "Disabled", "UseZoneSetting" ],
"default" : "UseZoneSetting"
},
"bssMinRateMbps" : {
"description" : "BSS minimum rate (mbps)",
"type" : "string",
"enum" : [ "Disable", "1 mbps", "2 mbps", "5.5 mbps", "12 mbps", "24 mbps" ],
"default" : "Disable"
},
"mgmtTxRateMbps" : {
"description" : "Management TX rate (mbps)",
"type" : "string",
"enum" : [ "1 mbps", "2 mbps", "5.5 mbps", "6 mbps", "9 mbps", "11 mbps", "12 mbps", "18 mbps", "24 mbps", "36 mbps", "48 mbps", "54 mbps" ],
"default" : "2 mbps"
},
"pmkCachingEnabled" : {
"description" : "Indicator of whether PKM caching support is enabled or disabled. The default value is true when the WLAN is WPA+AES non open WLAN.",
"type" : "boolean"
},
"okcEnabled" : {
"description" : "Indicator of whether OKC support is enabled or disabled. The default value is true when the WLAN is WPA+AES non open WLAN.",
"type" : "boolean"
},
"avcEnabled" : {
"description" : "Indicator of whether ARC support is enabled or disabled",
"type" : "boolean",
"default" : false
},
"urlFilteringPolicyEnabled" : {
"description" : "Indicator of whether URL Filtering is enabled or disabled",
"type" : "boolean",
"default" : false
},
"urlFilteringPolicyId" : {
"description" : "The URL Filtering policy ID.",
"type" : "string"
},
"wifiCallingPolicyEnabled" : {
"description" : "Indicator of whether Wi-Fi Calling is enabled or disabled",
"type" : "boolean",
"default" : false
},
"wifiCallingPolicyIds" : {
"description" : "The Wi-Fi Calling policy IDs. (Maximum allowed number is 5)",
"type" : "array",
"items" : {
"type" : "string"
}
},
"uplinkEnabled" : {
"description" : "SSID Rate Limiting uplink enabled.",
"type" : "boolean",
"default" : false
},
"uplinkRate" : {
"description" : "SSID Rate Limiting uplink.",
"type" : "number",
"default" : 0.0
},
"downlinkEnabled" : {
"description" : "SSID Rate Limiting downlink enabled.",
"type" : "boolean",
"default" : false
},
"downlinkRate" : {
"description" : "SSID Rate Limiting downlink.",
"type" : "number",
"default" : 0.0
},
"ratePerSTAUplink" : {
"description" : "UE Rate Limiting uplink.",
"type" : "string"
},
"ratePerSTADownlink" : {
"description" : "UE Rate Limiting downlink.",
"type" : "string"
},
"dtimInterval" : {
"description" : "DTIM Interval",
"type" : "integer",
"minimum" : 1,
"maximum" : 255,
"default" : 1
},
"directedThreshold" : {
"description" : "Directed Threshold Setting, Defines the client count at which an AP will stop converting group addressed data traffic to unicast.",
"type" : "integer",
"minimum" : 0,
"maximum" : 128,
"default" : 5
},
"flowLogEnabled" : {
"description" : "Flow log enabled.",
"type" : "boolean",
"default" : false
},
"hdOverheadOptimizeEnable" : {
"description" : "Airtime decongestion enabled.",
"type" : "boolean",
"default" : false
},
"probeRssiThr" : {
"type" : "integer",
"description" : "Join RSSI threshold.",
"minimum" : -90,
"maximum" : -60,
"default" : -85
},
"transientClientMgmtEnable" : {
"description" : "Transient Client Management enabled.",
"type" : "boolean",
"default" : false
},
"joinIgnoreTimeout" : {
"description" : "Join wait time.",
"type" : "integer",
"minimum" : 1,
"maximum" : 60,
"default" : 30
},
"joinAcceptTimeout" : {
"description" : "Join expire time.",
"type" : "integer",
"minimum" : 1,
"maximum" : 300,
"default" : 300
},
"joinIgnoreThr" : {
"description" : "Join wait threshold.",
"type" : "integer",
"minimum" : 1,
"maximum" : 50,
"default" : 10
},
"authRssiThr" : {
"description" : "Auth RSSI threshold.",
"type" : "integer",
"minimum" : -90,
"maximum" : -60
},
"assocRssiThr" : {
"description" : "Assoc RSSI threshold.",
"type" : "integer",
"minimum" : -90,
"maximum" : -60
},
"oceEnabled" : {
"description" : "Optimized Connectivity Experience(OCE) enabled.",
"type" : "boolean",
"default" : false
},
"oceBroadcastProbeResponseDelay" : {
"description" : "Broadcast probe response delay.",
"type" : "integer",
"minimum" : 8,
"maximum" : 120,
"default" : 15
},
"oceRssiBasedAssociationRejectionThreshold" : {
"description" : "RSSI-based association rejection threshold.",
"type" : "integer",
"minimum" : -90,
"maximum" : -60,
"default" : -75
}
}
},
"diffServProfile" : {
"description" : "DiffServ profile of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"qosMaps" : {
"description" : "Qos map set of the WLAN.",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"enable" : {
"description" : "Enabled or disabled",
"type" : "boolean"
},
"priority" : {
"description" : "Priority",
"type" : "integer"
},
"low" : {
"description" : "DSCP range - low",
"type" : [ "integer", "null" ],
"minimum" : 0,
"maximum" : 255
},
"high" : {
"description" : "DSCP range - high",
"type" : [ "integer", "null" ],
"minimum" : 0,
"maximum" : 255
},
"excepts" : {
"type" : [ "array", "null" ],
"items" : {
"type" : "integer",
"minimum" : 0,
"maximum" : 63
}
}
},
"required" : [ "enable", "priority" ]
}
},
"dpsk" : {
"description" : "DPSK Setting",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"dpskEnabled" : {
"description" : "DPSK enabled",
"type" : "boolean",
"default" : false
},
"length" : {
"description" : "Length of DPSK key",
"type" : "integer",
"default" : 62
},
"dpskType" : {
"description" : "Type of DPSK key",
"type" : "string",
"enum" : [ "Secure", "KeyboardFriendly", "NumbersOnly" ],
"default" : "Secure"
},
"expiration" : {
"description" : "Expiration of DPSK key",
"type" : "string",
"enum" : [ "Unlimited", "OneDay", "TwoDays", "OneWeek", "TwoWeeks", "OneMonth", "SixMonths", "OneYear", "TwoYears" ],
"default" : "Unlimited"
},
"dpskFromType" : {
"description" : "Type of expiration start from",
"type" : "string",
"enum" : [ "CreateTime", "FirstUse" ],
"default" : "CreateTime"
}
}
},
"externalDpsk" : {
"description" : "External DPSK Enabled",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"enabled" : {
"description" : "Enable External DPSK",
"type" : "boolean",
"default" : false
},
"encryption" : {
"description" : "Encryption of the WLAN relate to external DPSK",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"method" : {
"description" : "Encryption method",
"type" : "string",
"enum" : [ "WPA2", "WPA_Mixed", "None" ]
},
"algorithm" : {
"description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
"type" : "string",
"enum" : [ "AES", "TKIP_AES" ]
}
}
},
"authService" : {
"description" : "Autentication of the WLAN relate to external DPSK",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Identifier of the authentication service. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the authentication service. At least one ID or name is required in the request.",
"type" : "string"
}
}
}
},
"required" : [ "enabled" ]
},
"dnsServerProfile" : {
"description" : "DNS server profile of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"accessTunnelProfile" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"accessIpsecProfile" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"splitTunnelProfileId" : {
"type" : "string"
},
"portalDetectionProfileId" : {
"type" : "string"
}
},
"required" : [ "name", "ssid", "authServiceOrProfile", "portalServiceProfile" ]
}201Body
{
"id": "wlanID"
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
}
}
}Create - Web Auth ¶
POST/v8_0/rkszones/{zoneId}/wlans/webauth
Use this API command to creates new web authentication WLAN.
Body
{
"name": "wlanName",
"ssid": "wlanSSID",
"description": "wlanDescription",
"authServiceOrProfile": {
"throughController": false,
"id": "authServiceUUID",
"name": "authServiceName",
"authenticationOption": null
},
"portalServiceProfile": {
"id": "portalServiceUUID",
"name": "portalServiceName"
},
"accessTunnelType": "RuckusGRE",
"accessTunnelProfile": {
"id": "f5b92938-aa4e-4d02-90ea-273799ff689b",
"name": "Default Tunnel Profile"
},
"splitTunnelProfileId": "38119bac-49e1-4410-ab8e-1c1bc88dd770",
"coreTunnelProfile": {
"type": "Bridge",
"id": "forwardingUUID",
"name": "forwardingName"
},
"encryption": {
"method": "WPA2",
"algorithm": "AES",
"passphrase": "password",
"mfp": "disabled",
"support80211rEnabled": true,
"mobilityDomainId": 3
},
"operatorRealm": "operator realm",
"defaultUserTrafficProfile": {
"id": "userTrafficUUID",
"name": "userTrafficName"
},
"precedenceProfileId": "c514d450-c839-9527-afc9-525400d12345",
"portalDetectionProfileId": "de0fa30c-9565-11e8-9eb6-529269fb1459",
"schedule": {
"type": "Customized",
"id": "ServiceUUID",
"name": "ServiceName"
},
"vlan": {
"accessVlan": 23,
"coreQinQEnabled": false,
"coreSVlan": 1,
"vlanPooling": null
},
"l2ACL": {
"id": "l2ACLUUID",
"name": "l2ACLName"
},
"radiusOptions": {
"nasIdType": "Customized",
"customizedNasId": "nasId",
"nasRequestTimeoutSec": 12,
"nasMaxRetry": 3,
"nasReconnectPrimaryMin": 30,
"calledStaIdType": "WLAN_BSSID",
"nasIpType": "disabled",
"nasIpUserDefined": "192.168.1.1"
},
"advancedOptions": {
"clientIsolationEnabled": true,
"clientIsolationUnicastEnabled": true,
"clientIsolationMulticastEnabled": false,
"clientIsolationAutoVrrpEnabled": false,
"clientIsolationWhitelist": {
"id": "b89323e1-3168-11e7-b027-5254009ae3f0",
"name": "myWhitelist"
},
"priority": "High",
"hideSsidEnabled": true,
"maxClientsPerRadio": 12,
"clientIdleTimeoutSec": 60,
"clientLoadBalancingEnabled": true,
"proxyARPEnabled": true,
"ndProxyEnabled": false,
"suppressNsEnabled": false,
"raProxyEnabled": false,
"rsraGuardEnabled": false,
"raThrottlingEnabled": false,
"maxAllowedRA": 10,
"raInterval": 10,
"support80211dEnabled": false,
"support80211kEnabled": true,
"forceClientDHCPTimeoutSec": 5,
"dhcpOption82Enabled": true,
"dhcp82Format": "RUCKUS_DEFAULT",
"unauthClientStatsEnabled": false,
"clientFingerprintingEnabled": true,
"ofdmOnlyEnabled": false,
"bandBalancing": "UseZoneSetting",
"bssMinRateMbps": "Disable",
"mgmtTxRateMbps": "2 mbps",
"avcEnabled": true,
"urlFilteringPolicyEnabled": false,
"urlFilteringPolicyId": "",
"wifiCallingPolicyEnabled": false,
"wifiCallingPolicyIds": [],
"uplinkEnabled": true,
"uplinkRate": 100,
"downlinkEnabled": true,
"downlinkRate": 200,
"ratePerSTAUplink": "650mbps",
"ratePerSTADownlink": "1mbps"
},
"diffServProfile": {
"id": "diffServId",
"name": "diffServName"
},
"qosMaps": [
{
"enable": true,
"priority": 0,
"low": 0,
"high": 7,
"excepts": null
},
{
"enable": true,
"priority": 1,
"low": 8,
"high": 15,
"excepts": null
},
{
"enable": true,
"priority": 2,
"low": 16,
"high": 23,
"excepts": null
},
{
"enable": true,
"priority": 3,
"low": 0,
"high": 32,
"excepts": [
43,
45,
60
]
},
{
"enable": true,
"priority": 4,
"low": 32,
"high": 39,
"excepts": null
},
{
"enable": true,
"priority": 5,
"low": 40,
"high": 47,
"excepts": null
},
{
"enable": true,
"priority": 6,
"low": 48,
"high": 55,
"excepts": [
46
]
},
{
"enable": true,
"priority": 7,
"low": 56,
"high": 63,
"excepts": null
}
],
"dnsServerProfile": {
"id": "DNS server profile UUID",
"name": "DNS server profile name"
},
"dpsk": {
"dpskEnabled": false,
"length": 8,
"dpskType": "Secure",
"expiration": "OneDay",
"dpskFromType": "FirstUse"
},
"externalDpsk": {
"enabled": true,
"encryption": {
"method": "WPA2",
"algorithm": "AES"
},
"authService": {
"id": "authServiceUUID"
}
}
}Schema
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"name" : {
"description" : "Name of the WLAN",
"type" : "string",
"minLength" : 1,
"maxLength" : 32
},
"ssid" : {
"description" : "SSID of the WLAN",
"type" : "string",
"minLength" : 1,
"maxLength" : 32
},
"hessid" : {
"description" : "HESSID of the WLAN",
"type" : "string",
"pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$"
},
"description" : {
"description" : "Description of the WLAN",
"type" : [ "string", "null" ],
"maxLength" : 64
},
"bypassCNA" : {
"description" : "Bypass Capitive Network Assitance",
"type" : "boolean",
"default" : false
},
"caleaEnabled" : {
"description" : "DP CALEA Server Enabled",
"type" : "boolean"
},
"dpTunnelNatEnabled" : {
"description" : "DP Tunnel NAT Enabled",
"type" : "boolean"
},
"dpTunnelDhcpEnabled" : {
"description" : "DP Tunnel DHCP Enabled",
"type" : "boolean"
},
"awsExtNasIPEnable" : {
"description" : "Aws ExtNasIP Enable",
"type" : "boolean"
},
"awsVenueEnable" : {
"description" : "Aws Venue Enable",
"type" : "boolean"
},
"accessTunnelType" : {
"description" : "Access tunnel type of the WLAN. APLBO means AP local breakout, RuckusGRE means RuckusGRE tunnel to the data plane, and SoftGRE means AP direct SoftGRE tunnel",
"type" : "string",
"enum" : [ "APLBO", "RuckusGRE", "SoftGRE" ]
},
"coreTunnelProfile" : {
"description" : "Core tunnel of the WLAN. This only applies when the access tunnel type is set to RuckusGRE.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"type" : {
"description" : "Tunnel type",
"type" : "string",
"enum" : [ "Bridge", "L2oGRE", "TTG_PDG", "Mixed" ]
},
"id" : {
"description" : "Identifier of the forwarding profile. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the forwarding profile. At least one ID or name is required in the request.",
"type" : "string"
},
"operatorRealm" : {
"description" : "Operator realm, deprecated coreTunnelProfile.operatorRealm from version3.1, prepare remove",
"type" : "string",
"maxLength" : 255,
"pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
}
},
"required" : [ "type" ]
},
"macAuth" : {
"description" : "MAC address authentication settings of the WLAN. This only applies to standard MAC and Hotspot MAC bypass WLAN.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"macAuthMacFormat" : {
"description" : "MAC address format. The default format is 0010a42319c0 and the 802.1X format is 00-10-A4-23-19-C0.",
"type" : "string",
"enum" : [ "Default", "802.1X", "UpperColon", "Upper", "LowerDash", "LowerColon" ]
},
"customizedPassword" : {
"description" : "User defined password. When this field is set to an empty string, the MAC address is used as password.",
"type" : "string",
"maxLength" : 64,
"pattern" : "^([!-;=?-~]([ -;=?-~]){0,62}[!-;=?-~]|[!-;=?-~]{1,1}|\s{0,0})$"
}
}
},
"encryption" : {
"description" : "Encryption of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"method" : {
"description" : "Encryption method",
"type" : "string",
"enum" : [ "WPA2", "WPA_Mixed", "WEP_64", "WEP_128", "None" ],
"default" : "None"
},
"algorithm" : {
"description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
"type" : "string",
"enum" : [ "AES", "TKIP_AES" ]
},
"passphrase" : {
"description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
"type" : "string"
},
"mfp" : {
"description" : "Management frame protection. This only applies to WPA2 + AES",
"type" : "string",
"enum" : [ "disabled", "capable", "required" ]
},
"keyIndex" : {
"description" : "Key index. This only applies to WEP64 and WEP128.",
"type" : "integer"
},
"keyInHex" : {
"description" : "Key in hex format. This only applies to WEP64 and WEP128.",
"type" : "string"
},
"support80211rEnabled" : {
"description" : "Enable 802.11r Fast BSS Transition, fast Romaing.",
"type" : "boolean"
},
"mobilityDomainId" : {
"description" : "mobility Domain Id.",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
}
},
"required" : [ "method" ]
},
"authServiceOrProfile" : {
"description" : "Authentication of the WLAN. If authentication messages are sent through the controller, the ID or name of the global authentication profiles is required. If authentication messages are not sent through the controller, the ID or name of the authentication services configured within the zone is required.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"throughController" : {
"description" : "Indicates whether authentication messages were sent through the controller or not",
"type" : "boolean"
},
"realmBasedAuth" : {
"type" : "boolean"
},
"id" : {
"description" : "Identifier of the authentication service or profile. At least one ID or name or authenticationOption is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the authentication service or profile. At least one ID or name or authenticationOption is required in the request. Or could input the 'Always Accept' or 'Local DB'.",
"type" : "string"
},
"authenticationOption" : {
"description" : "Option of the authentication service or profile, At least one ID or name or authenticationOption is required in the request. This only applies to hotspot and guest WLANs.",
"type" : [ "string", "null" ],
"enum" : [ "Local DB", "Guest", "Always Accept", null ]
},
"locationDeliveryEnabled" : {
"description" : "RFC5580 location delivery support",
"type" : "boolean"
},
"backupAuthenticationId" : {
"description" : "Identifier of the backup authentication service or profile. At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service.",
"type" : "string"
},
"backupAuthenticationName" : {
"description" : "Name of the backup authentication service or profile. At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service. Or could input the 'Always Accept'.",
"type" : "string"
},
"backupAuthenticationOption" : {
"description" : "Option of the backup authentication service or profile, At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service. This only applies to hotspot WLANs.",
"type" : [ "string", "null" ],
"enum" : [ "Always Accept", null ]
}
}
},
"operatorRealm" : {
"description" : "Operator realm, operatorRealm only supports coreTunnelProfile type is authServiceOrProfile.locationDeliveryEnabled is true",
"type" : "string",
"maxLength" : 255,
"pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
},
"accountingServiceOrProfile" : {
"description" : "Accounting of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"throughController" : {
"description" : "Indicates whether accounting messages were sent through the controller",
"type" : "boolean"
},
"realmBasedAcct" : {
"type" : "boolean"
},
"id" : {
"description" : "Accounting service or profile ID. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Accounting service or profile name. At least one ID or name is required in the request.",
"type" : "string"
},
"interimUpdateMin" : {
"description" : "Interval (in minutes) for sending interim updates",
"type" : "integer",
"minimum" : 0,
"maximum" : 1440
},
"accountingDelayEnabled" : {
"description" : "Indicates whether accounting delay time is enabled",
"type" : "boolean"
},
"accountingTTGSessionEnabled" : {
"description" : "Indicates whether accounting for TTG sessions is to enabled",
"type" : "boolean"
},
"backupAccountingId" : {
"description" : "Backup accounting service or profile ID. At least one backupAccountingId or backupAccountingName is required in the request when setting backup accounting service.",
"type" : "string"
},
"backupAccountingName" : {
"description" : "Backup accounting service or profile name. At least one backupAccountingId or backupAccountingName is required in the request when setting backup accounting service.",
"type" : "string"
}
}
},
"portalServiceProfile" : {
"description" : "Web authorizationn portal service of the WLAN. The ID or name of the guest portal services within the zone is required.",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"hotspot20Profile" : {
"description" : "Hotspot 2.0 operator profile of the WLAN. id or name of the hotspot 2.0 operator profiles within the zone is required.",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"defaultUserTrafficProfile" : {
"description" : "User traffic profile of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"precedenceProfileId" : {
"description" : "Precedence profile of the WLAN",
"type" : "string"
},
"flexiVpnProfile" : {
"description" : "Flexi-VPN profile of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"wlanId" : {
"type" : "string",
"description" : "Wlan ID"
},
"zoneAffinityId" : {
"type" : "string",
"description" : "Zone Affinity ID"
}
},
"required" : [ "zoneAffinityId" ]
},
"schedule" : {
"description" : "Schedule of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"type" : {
"description" : "Type of WLAN schedule",
"type" : "string",
"enum" : [ "AlwaysOn", "AlwaysOff", "Customized" ],
"default" : "AlwaysOn"
},
"id" : {
"description" : "Identifier of the schedule profile. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the schedule profile. At least one ID or name is required in the request.",
"type" : "string"
}
},
"required" : [ "type" ]
},
"vlan" : {
"description" : "VLAN (access and/or core) of the WLAN.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"accessVlan" : {
"description" : "Access VLAN ID",
"type" : "integer",
"minimum" : 1,
"maximum" : 4094,
"default" : 1
},
"aaaVlanOverride" : {
"description" : "Indicates whether the AAA VLAN settings can be overriden or not",
"type" : "boolean"
},
"coreQinQEnabled" : {
"description" : "Indicates whether Q-in-Q is allowed at the core network or not",
"type" : "boolean"
},
"coreSVlan" : {
"description" : "Core SVLAN ID. This only applies when core Q-in-Q is enabled",
"type" : "integer",
"minimum" : 1,
"maximum" : 4094
},
"vlanPooling" : {
"description" : "Vlan pooling",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
}
}
},
"l2ACL" : {
"description" : "Layer 2 ACL of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"devicePolicy" : {
"description" : "Device policy of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"radiusOptions" : {
"description" : "RADIUS options of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"nasIdType" : {
"description" : "NAS ID type",
"type" : "string",
"enum" : [ "WLAN_BSSID", "AP_MAC", "Customized" ],
"default" : "WLAN_BSSID"
},
"customizedNasId" : {
"description" : "User defined NAS ID",
"type" : "string",
"maxLength" : 64,
"pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$"
},
"nasRequestTimeoutSec" : {
"description" : "NAS request timeout in seconds",
"type" : "integer",
"default" : 3,
"minimum" : 2,
"maximum" : 20
},
"nasMaxRetry" : {
"description" : "NAS request maximum retry",
"type" : "integer",
"default" : 2,
"minimum" : 2,
"maximum" : 10
},
"nasReconnectPrimaryMin" : {
"description" : "NAS reconnect primary time in minutes",
"type" : "integer",
"default" : 5,
"minimum" : 1,
"maximum" : 60
},
"calledStaIdType" : {
"description" : "Called station ID type",
"type" : "string",
"enum" : [ "WLAN_BSSID", "AP_MAC", "NONE" ],
"default" : "WLAN_BSSID"
},
"nasIpType" : {
"description" : "NAS IP type",
"type" : "string",
"enum" : [ "disabled", "control", "management", "userDefined" ],
"default" : "disabled"
},
"nasIpUserDefined" : {
"description" : "User-defined NAS IP",
"type" : "string",
"maxLength" : 45
},
"singleSessionIdAcctEnabled" : {
"description" : "When Single Accounting Session ID is enabled, APs will maintain one accounting session for client roaming",
"type" : "boolean",
"default" : false
}
}
},
"advancedOptions" : {
"description" : "Advanced settings for the WLAN.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"clientIsolationEnabled" : {
"description" : "Indicates whether wireless client isolation is enabled or disabled",
"type" : "boolean",
"default" : false
},
"clientIsolationUnicastEnabled" : {
"description" : "Indicates whether isolate unicast of wireless client isolation is enabled or disabled",
"type" : "boolean",
"default" : true
},
"clientIsolationMulticastEnabled" : {
"description" : "Indicates whether isolate multicast of wireless client isolation is enabled or disabled",
"type" : "boolean"
},
"clientIsolationAutoVrrpEnabled" : {
"description" : "Indicates whether Automatic support for VRRP of wireless client isolation is enabled or disabled",
"type" : "boolean",
"default" : false
},
"clientIsolationWhitelist" : {
"description" : "Indicates wireless client isolation whitelist",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"priority" : {
"description" : "Priority of the WLAN",
"type" : "string",
"enum" : [ "High", "Low" ],
"default" : "High"
},
"hideSsidEnabled" : {
"description" : "Indicates whether the SSID is hidden or broadcast",
"type" : "boolean",
"default" : false
},
"hs20Onboarding" : {
"description" : "Allow WISPr WLAN for Hotspot 2.0 Onboarding",
"type" : "boolean",
"default" : false
},
"maxClientsPerRadio" : {
"description" : "Maximum number of clients per radio",
"type" : "integer",
"default" : 100,
"minimum" : 1,
"maximum" : 512
},
"clientIdleTimeoutSec" : {
"description" : "Client idle timeout in seconds",
"type" : "integer",
"minimum" : 60,
"maximum" : 1000,
"default" : 120
},
"dgafEnabled" : {
"description" : "Indicates whether dgaf is enabled or disabled",
"type" : "boolean"
},
"clientLoadBalancingEnabled" : {
"description" : "Indicates whether Client Load Balancing is enabled or disabled",
"type" : "boolean",
"default" : true
},
"proxyARPEnabled" : {
"description" : "Indicates whether proxy ARP is enabled or disabled",
"type" : "boolean",
"default" : false
},
"ndProxyEnabled" : {
"description" : "Indicates whether ND Proxy is enabled or disabled",
"type" : "boolean",
"default" : false
},
"suppressNsEnabled" : {
"description" : "Indicates whether supperssNS is enabled or disabled",
"type" : "boolean",
"default" : false
},
"raProxyEnabled" : {
"description" : "Indicates whether RA proxy is enabled or disabled",
"type" : "boolean",
"default" : false
},
"rsraGuardEnabled" : {
"description" : "Indicates whether RS/RA Guard is enabled or disabled",
"type" : "boolean",
"default" : false
},
"raThrottlingEnabled" : {
"description" : "Indicates whether RA Throttling is enabled or disabled",
"type" : "boolean",
"default" : false
},
"maxAllowedRA" : {
"description" : "Max Allowed RAs",
"type" : "integer",
"minimum" : 1,
"maximum" : 1440,
"default" : 10
},
"raInterval" : {
"description" : "A timer that RA proxy runs and once receives unsolicited RA checks against the configured time and allow/drop RA based on next timeout",
"type" : "integer",
"minimum" : 1,
"maximum" : 256,
"default" : 10
},
"support80211dEnabled" : {
"description" : "Indicates whether support for 802.11d is enabled or disabled",
"type" : "boolean",
"default" : true
},
"support80211kEnabled" : {
"description" : "Indicates whether support for 802.11k is enabled or disabled",
"type" : "boolean",
"default" : true
},
"antiSpoofingEnabled" : {
"description" : "Anti-Spoofing enabled",
"type" : "boolean",
"default" : false
},
"arpRequestRateLimit" : {
"description" : "ARP packets request rate limit, default value will be 15 if both rate limit not being set.",
"type" : "integer",
"minimum" : 0,
"maximum" : 100
},
"dhcpRequestRateLimit" : {
"description" : "DHCP packets request rate limit, default value will be 15 if both rate limit not being set.",
"type" : "integer",
"minimum" : 0,
"maximum" : 100
},
"forceClientDHCPTimeoutSec" : {
"description" : "Force DHCP disconnects the client if the client does not obtain a valid IP address within the timeout peroid. To disable force DHCP, set this value to zero (0).",
"type" : "integer",
"enum" : [ 0, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15 ],
"default" : 0
},
"dhcpOption82Enabled" : {
"description" : "Indicates whether DCHP Option 82 is enabled or disabled",
"type" : "boolean",
"default" : false
},
"dhcp82Format" : {
"description" : "DHCP Option 82 format",
"type" : "string",
"enum" : [ "RUCKUS_DEFAULT", "SOFTGRE_CUSTOMIZED" ]
},
"unauthClientStatsEnabled" : {
"description" : "Indicates whether to send statistics of unauthorized clients or not",
"type" : "boolean",
"default" : false
},
"clientFingerprintingEnabled" : {
"description" : "Indicates whether client fingerprinting is enabled or disabled",
"type" : "boolean",
"default" : false
},
"ofdmOnlyEnabled" : {
"description" : "Indicates whether OFDM only is enabled or disabled",
"type" : "boolean",
"default" : false
},
"bandBalancing" : {
"description" : "Indicates whether band balancing is enabled or disabled",
"type" : "string",
"enum" : [ "Disabled", "UseZoneSetting" ],
"default" : "UseZoneSetting"
},
"bssMinRateMbps" : {
"description" : "BSS minimum rate (mbps)",
"type" : "string",
"enum" : [ "Disable", "1 mbps", "2 mbps", "5.5 mbps", "12 mbps", "24 mbps" ],
"default" : "Disable"
},
"mgmtTxRateMbps" : {
"description" : "Management TX rate (mbps)",
"type" : "string",
"enum" : [ "1 mbps", "2 mbps", "5.5 mbps", "6 mbps", "9 mbps", "11 mbps", "12 mbps", "18 mbps", "24 mbps", "36 mbps", "48 mbps", "54 mbps" ],
"default" : "2 mbps"
},
"pmkCachingEnabled" : {
"description" : "Indicator of whether PKM caching support is enabled or disabled. The default value is true when the WLAN is WPA+AES non open WLAN.",
"type" : "boolean"
},
"okcEnabled" : {
"description" : "Indicator of whether OKC support is enabled or disabled. The default value is true when the WLAN is WPA+AES non open WLAN.",
"type" : "boolean"
},
"avcEnabled" : {
"description" : "Indicator of whether ARC support is enabled or disabled",
"type" : "boolean",
"default" : false
},
"urlFilteringPolicyEnabled" : {
"description" : "Indicator of whether URL Filtering is enabled or disabled",
"type" : "boolean",
"default" : false
},
"urlFilteringPolicyId" : {
"description" : "The URL Filtering policy ID.",
"type" : "string"
},
"wifiCallingPolicyEnabled" : {
"description" : "Indicator of whether Wi-Fi Calling is enabled or disabled",
"type" : "boolean",
"default" : false
},
"wifiCallingPolicyIds" : {
"description" : "The Wi-Fi Calling policy IDs. (Maximum allowed number is 5)",
"type" : "array",
"items" : {
"type" : "string"
}
},
"uplinkEnabled" : {
"description" : "SSID Rate Limiting uplink enabled.",
"type" : "boolean",
"default" : false
},
"uplinkRate" : {
"description" : "SSID Rate Limiting uplink.",
"type" : "number",
"default" : 0.0
},
"downlinkEnabled" : {
"description" : "SSID Rate Limiting downlink enabled.",
"type" : "boolean",
"default" : false
},
"downlinkRate" : {
"description" : "SSID Rate Limiting downlink.",
"type" : "number",
"default" : 0.0
},
"ratePerSTAUplink" : {
"description" : "UE Rate Limiting uplink.",
"type" : "string"
},
"ratePerSTADownlink" : {
"description" : "UE Rate Limiting downlink.",
"type" : "string"
},
"dtimInterval" : {
"description" : "DTIM Interval",
"type" : "integer",
"minimum" : 1,
"maximum" : 255,
"default" : 1
},
"directedThreshold" : {
"description" : "Directed Threshold Setting, Defines the client count at which an AP will stop converting group addressed data traffic to unicast.",
"type" : "integer",
"minimum" : 0,
"maximum" : 128,
"default" : 5
},
"flowLogEnabled" : {
"description" : "Flow log enabled.",
"type" : "boolean",
"default" : false
},
"hdOverheadOptimizeEnable" : {
"description" : "Airtime decongestion enabled.",
"type" : "boolean",
"default" : false
},
"probeRssiThr" : {
"type" : "integer",
"description" : "Join RSSI threshold.",
"minimum" : -90,
"maximum" : -60,
"default" : -85
},
"transientClientMgmtEnable" : {
"description" : "Transient Client Management enabled.",
"type" : "boolean",
"default" : false
},
"joinIgnoreTimeout" : {
"description" : "Join wait time.",
"type" : "integer",
"minimum" : 1,
"maximum" : 60,
"default" : 30
},
"joinAcceptTimeout" : {
"description" : "Join expire time.",
"type" : "integer",
"minimum" : 1,
"maximum" : 300,
"default" : 300
},
"joinIgnoreThr" : {
"description" : "Join wait threshold.",
"type" : "integer",
"minimum" : 1,
"maximum" : 50,
"default" : 10
},
"authRssiThr" : {
"description" : "Auth RSSI threshold.",
"type" : "integer",
"minimum" : -90,
"maximum" : -60
},
"assocRssiThr" : {
"description" : "Assoc RSSI threshold.",
"type" : "integer",
"minimum" : -90,
"maximum" : -60
},
"oceEnabled" : {
"description" : "Optimized Connectivity Experience(OCE) enabled.",
"type" : "boolean",
"default" : false
},
"oceBroadcastProbeResponseDelay" : {
"description" : "Broadcast probe response delay.",
"type" : "integer",
"minimum" : 8,
"maximum" : 120,
"default" : 15
},
"oceRssiBasedAssociationRejectionThreshold" : {
"description" : "RSSI-based association rejection threshold.",
"type" : "integer",
"minimum" : -90,
"maximum" : -60,
"default" : -75
}
}
},
"diffServProfile" : {
"description" : "DiffServ profile of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"qosMaps" : {
"description" : "Qos map set of the WLAN.",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"enable" : {
"description" : "Enabled or disabled",
"type" : "boolean"
},
"priority" : {
"description" : "Priority",
"type" : "integer"
},
"low" : {
"description" : "DSCP range - low",
"type" : [ "integer", "null" ],
"minimum" : 0,
"maximum" : 255
},
"high" : {
"description" : "DSCP range - high",
"type" : [ "integer", "null" ],
"minimum" : 0,
"maximum" : 255
},
"excepts" : {
"type" : [ "array", "null" ],
"items" : {
"type" : "integer",
"minimum" : 0,
"maximum" : 63
}
}
},
"required" : [ "enable", "priority" ]
}
},
"dpsk" : {
"description" : "DPSK Setting",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"dpskEnabled" : {
"description" : "DPSK enabled",
"type" : "boolean",
"default" : false
},
"length" : {
"description" : "Length of DPSK key",
"type" : "integer",
"default" : 62
},
"dpskType" : {
"description" : "Type of DPSK key",
"type" : "string",
"enum" : [ "Secure", "KeyboardFriendly", "NumbersOnly" ],
"default" : "Secure"
},
"expiration" : {
"description" : "Expiration of DPSK key",
"type" : "string",
"enum" : [ "Unlimited", "OneDay", "TwoDays", "OneWeek", "TwoWeeks", "OneMonth", "SixMonths", "OneYear", "TwoYears" ],
"default" : "Unlimited"
},
"dpskFromType" : {
"description" : "Type of expiration start from",
"type" : "string",
"enum" : [ "CreateTime", "FirstUse" ],
"default" : "CreateTime"
}
}
},
"externalDpsk" : {
"description" : "External DPSK Enabled",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"enabled" : {
"description" : "Enable External DPSK",
"type" : "boolean",
"default" : false
},
"encryption" : {
"description" : "Encryption of the WLAN relate to external DPSK",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"method" : {
"description" : "Encryption method",
"type" : "string",
"enum" : [ "WPA2", "WPA_Mixed", "None" ]
},
"algorithm" : {
"description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
"type" : "string",
"enum" : [ "AES", "TKIP_AES" ]
}
}
},
"authService" : {
"description" : "Autentication of the WLAN relate to external DPSK",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Identifier of the authentication service. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the authentication service. At least one ID or name is required in the request.",
"type" : "string"
}
}
}
},
"required" : [ "enabled" ]
},
"dnsServerProfile" : {
"description" : "DNS server profile of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"accessTunnelProfile" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"accessIpsecProfile" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"splitTunnelProfileId" : {
"type" : "string"
},
"portalDetectionProfileId" : {
"type" : "string"
}
},
"required" : [ "name", "ssid", "authServiceOrProfile", "portalServiceProfile" ]
}201Body
{
"id": "wlanID"
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
}
}
}Create - Hotspot 2.0 ¶
POST/v8_0/rkszones/{zoneId}/wlans/hotspot20
Use this API command to create a new Hotspot 2.0 access WLAN.
Body
{
"name": "wlanName",
"ssid": "wlanSSID",
"description": "wlanDescription",
"hotspot20Profile": {
"id": "hotspot20ServiceUUID",
"name": "hotspot20ServiceName"
},
"accessTunnelType": "RuckusGRE",
"accessTunnelProfile": {
"id": "f5b92938-aa4e-4d02-90ea-273799ff689b",
"name": "Default Tunnel Profile"
},
"splitTunnelProfileId": "38119bac-49e1-4410-ab8e-1c1bc88dd770",
"coreTunnelProfile": {
"type": "Bridge",
"id": "forwardingUUID",
"name": "forwardingName"
},
"encryption": {
"method": "WPA2",
"algorithm": "AES",
"mfp": "disabled",
"support80211rEnabled": true,
"mobilityDomainId": 3
},
"operatorRealm": "operator realm",
"defaultUserTrafficProfile": {
"id": "userTrafficUUID",
"name": "userTrafficName"
},
"precedenceProfileId": "c514d450-c839-9527-afc9-525400d12345",
"portalDetectionProfileId": "de0fa30c-9565-11e8-9eb6-529269fb1459",
"schedule": {
"type": "Customized",
"id": "ServiceUUID",
"name": "ServiceName"
},
"vlan": {
"accessVlan": 23,
"aaaVlanOverride": true,
"coreQinQEnabled": false,
"coreSVlan": 1,
"vlanPooling": null
},
"l2ACL": {
"id": "l2ACLUUID",
"name": "l2ACLName"
},
"devicePolicy": {
"id": "devicePolicyUUID",
"name": "devicePolicyName"
},
"radiusOptions": {
"nasIdType": "Customized",
"customizedNasId": "nasId",
"nasRequestTimeoutSec": 12,
"nasMaxRetry": 3,
"nasReconnectPrimaryMin": 30,
"calledStaIdType": "WLAN_BSSID",
"nasIpType": "disabled",
"nasIpUserDefined": "192.168.1.1"
},
"advancedOptions": {
"clientIsolationEnabled": true,
"clientIsolationUnicastEnabled": true,
"clientIsolationMulticastEnabled": false,
"clientIsolationAutoVrrpEnabled": false,
"clientIsolationWhitelist": {
"id": "b89323e1-3168-11e7-b027-5254009ae3f0",
"name": "myWhitelist"
},
"priority": "High",
"hideSsidEnabled": true,
"maxClientsPerRadio": 12,
"clientIdleTimeoutSec": 60,
"clientLoadBalancingEnabled": true,
"proxyARPEnabled": true,
"ndProxyEnabled": false,
"suppressNsEnabled": false,
"raProxyEnabled": false,
"rsraGuardEnabled": false,
"raThrottlingEnabled": false,
"maxAllowedRA": 10,
"raInterval": 10,
"support80211dEnabled": false,
"support80211kEnabled": true,
"forceClientDHCPTimeoutSec": 5,
"dhcpOption82Enabled": true,
"dhcp82Format": "RUCKUS_DEFAULT",
"unauthClientStatsEnabled": false,
"clientFingerprintingEnabled": true,
"ofdmOnlyEnabled": false,
"bandBalancing": "UseZoneSetting",
"bssMinRateMbps": "Disable",
"mgmtTxRateMbps": "2 mbps",
"avcEnabled": true,
"urlFilteringPolicyEnabled": false,
"urlFilteringPolicyId": "",
"wifiCallingPolicyEnabled": false,
"wifiCallingPolicyIds": [],
"uplinkEnabled": true,
"uplinkRate": 100,
"downlinkEnabled": true,
"downlinkRate": 200,
"ratePerSTAUplink": "650mbps",
"ratePerSTADownlink": "1mbps"
},
"diffServProfile": {
"id": "diffServId",
"name": "diffServName"
},
"qosMaps": [
{
"enable": true,
"priority": 0,
"low": 0,
"high": 7,
"excepts": null
},
{
"enable": true,
"priority": 1,
"low": 8,
"high": 15,
"excepts": null
},
{
"enable": true,
"priority": 2,
"low": 16,
"high": 23,
"excepts": null
},
{
"enable": true,
"priority": 3,
"low": 0,
"high": 32,
"excepts": [
43,
45,
60
]
},
{
"enable": true,
"priority": 4,
"low": 32,
"high": 39,
"excepts": null
},
{
"enable": true,
"priority": 5,
"low": 40,
"high": 47,
"excepts": null
},
{
"enable": true,
"priority": 6,
"low": 48,
"high": 55,
"excepts": [
46
]
},
{
"enable": true,
"priority": 7,
"low": 56,
"high": 63,
"excepts": null
}
],
"dnsServerProfile": {
"id": "DNS server profile UUID",
"name": "DNS server profile name"
},
"dpsk": {
"dpskEnabled": false,
"length": 8,
"dpskType": "Secure",
"expiration": "OneDay",
"dpskFromType": "FirstUse"
},
"externalDpsk": {
"enabled": true,
"encryption": {
"method": "WPA2",
"algorithm": "AES"
},
"authService": {
"id": "authServiceUUID"
}
}
}Schema
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"name" : {
"description" : "Name of the WLAN",
"type" : "string",
"minLength" : 1,
"maxLength" : 32
},
"ssid" : {
"description" : "SSID of the WLAN",
"type" : "string",
"minLength" : 1,
"maxLength" : 32
},
"hessid" : {
"description" : "HESSID of the WLAN",
"type" : "string",
"pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$"
},
"description" : {
"description" : "Description of the WLAN",
"type" : [ "string", "null" ],
"maxLength" : 64
},
"caleaEnabled" : {
"description" : "DP CALEA Server Enabled",
"type" : "boolean"
},
"dpTunnelNatEnabled" : {
"description" : "DP Tunnel NAT Enabled",
"type" : "boolean"
},
"dpTunnelDhcpEnabled" : {
"description" : "DP Tunnel DHCP Enabled",
"type" : "boolean"
},
"awsExtNasIPEnable" : {
"description" : "Aws ExtNasIP Enable",
"type" : "boolean"
},
"awsVenueEnable" : {
"description" : "Aws Venue Enable",
"type" : "boolean"
},
"accessTunnelType" : {
"description" : "Access tunnel type of the WLAN. APLBO means AP local breakout, RuckusGRE means RuckusGRE tunnel to the data plane, and SoftGRE means AP direct SoftGRE tunnel",
"type" : "string",
"enum" : [ "APLBO", "RuckusGRE", "SoftGRE" ]
},
"coreTunnelProfile" : {
"description" : "Core tunnel of the WLAN. This only applies when the access tunnel type is set to RuckusGRE.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"type" : {
"description" : "Tunnel type",
"type" : "string",
"enum" : [ "Bridge", "L2oGRE", "TTG_PDG", "Mixed" ]
},
"id" : {
"description" : "Identifier of the forwarding profile. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the forwarding profile. At least one ID or name is required in the request.",
"type" : "string"
},
"operatorRealm" : {
"description" : "Operator realm, deprecated coreTunnelProfile.operatorRealm from version3.1, prepare remove",
"type" : "string",
"maxLength" : 255,
"pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
}
},
"required" : [ "type" ]
},
"macAuth" : {
"description" : "MAC address authentication settings of the WLAN. This only applies to standard MAC and Hotspot MAC bypass WLAN.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"macAuthMacFormat" : {
"description" : "MAC address format. The default format is 0010a42319c0 and the 802.1X format is 00-10-A4-23-19-C0.",
"type" : "string",
"enum" : [ "Default", "802.1X", "UpperColon", "Upper", "LowerDash", "LowerColon" ]
},
"customizedPassword" : {
"description" : "User defined password. When this field is set to an empty string, the MAC address is used as password.",
"type" : "string",
"maxLength" : 64,
"pattern" : "^([!-;=?-~]([ -;=?-~]){0,62}[!-;=?-~]|[!-;=?-~]{1,1}|\s{0,0})$"
}
}
},
"encryption" : {
"description" : "Encryption of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"method" : {
"description" : "Encryption method",
"type" : "string",
"enum" : [ "WPA2", "WPA_Mixed", "WEP_64", "WEP_128", "None" ],
"default" : "None"
},
"algorithm" : {
"description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
"type" : "string",
"enum" : [ "AES", "TKIP_AES" ]
},
"passphrase" : {
"description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
"type" : "string"
},
"mfp" : {
"description" : "Management frame protection. This only applies to WPA2 + AES",
"type" : "string",
"enum" : [ "disabled", "capable", "required" ]
},
"keyIndex" : {
"description" : "Key index. This only applies to WEP64 and WEP128.",
"type" : "integer"
},
"keyInHex" : {
"description" : "Key in hex format. This only applies to WEP64 and WEP128.",
"type" : "string"
},
"support80211rEnabled" : {
"description" : "Enable 802.11r Fast BSS Transition, fast Romaing.",
"type" : "boolean"
},
"mobilityDomainId" : {
"description" : "mobility Domain Id.",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
}
},
"required" : [ "method" ]
},
"authServiceOrProfile" : {
"description" : "Authentication of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"throughController" : {
"description" : "Indicates whether authentication messages were sent through the controller or not",
"type" : "boolean"
},
"realmBasedAuth" : {
"type" : "boolean"
},
"id" : {
"description" : "Identifier of the authentication service or profile. At least one ID or name or authenticationOption is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the authentication service or profile. At least one ID or name or authenticationOption is required in the request. Or could input the 'Always Accept' or 'Local DB'.",
"type" : "string"
},
"authenticationOption" : {
"description" : "Option of the authentication service or profile, At least one ID or name or authenticationOption is required in the request. This only applies to hotspot and guest WLANs.",
"type" : [ "string", "null" ],
"enum" : [ "Local DB", "Guest", "Always Accept", null ]
},
"locationDeliveryEnabled" : {
"description" : "RFC5580 location delivery support",
"type" : "boolean"
},
"backupAuthenticationId" : {
"description" : "Identifier of the backup authentication service or profile. At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service.",
"type" : "string"
},
"backupAuthenticationName" : {
"description" : "Name of the backup authentication service or profile. At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service. Or could input the 'Always Accept'.",
"type" : "string"
},
"backupAuthenticationOption" : {
"description" : "Option of the backup authentication service or profile, At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service. This only applies to hotspot WLANs.",
"type" : [ "string", "null" ],
"enum" : [ "Always Accept", null ]
}
}
},
"operatorRealm" : {
"description" : "Operator realm, operatorRealm only supports coreTunnelProfile type is authServiceOrProfile.locationDeliveryEnabled is true",
"type" : "string",
"maxLength" : 255,
"pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
},
"accountingServiceOrProfile" : {
"description" : "Accounting of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"throughController" : {
"description" : "Indicates whether accounting messages were sent through the controller",
"type" : "boolean"
},
"realmBasedAcct" : {
"type" : "boolean"
},
"id" : {
"description" : "Accounting service or profile ID. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Accounting service or profile name. At least one ID or name is required in the request.",
"type" : "string"
},
"interimUpdateMin" : {
"description" : "Interval (in minutes) for sending interim updates",
"type" : "integer",
"minimum" : 0,
"maximum" : 1440
},
"accountingDelayEnabled" : {
"description" : "Indicates whether accounting delay time is enabled",
"type" : "boolean"
},
"accountingTTGSessionEnabled" : {
"description" : "Indicates whether accounting for TTG sessions is to enabled",
"type" : "boolean"
},
"backupAccountingId" : {
"description" : "Backup accounting service or profile ID. At least one backupAccountingId or backupAccountingName is required in the request when setting backup accounting service.",
"type" : "string"
},
"backupAccountingName" : {
"description" : "Backup accounting service or profile name. At least one backupAccountingId or backupAccountingName is required in the request when setting backup accounting service.",
"type" : "string"
}
}
},
"portalServiceProfile" : {
"description" : "Portal service of the WLAN. This only applies to hotspot, hotspot MAC bypass, guest and web auth WLANs.",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"hotspot20Profile" : {
"description" : "Hotspot 2.0 operator profile of the WLAN. The ID or name of the Hotspot 2.0 operator profiles within the zone is required.",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"defaultUserTrafficProfile" : {
"description" : "User traffic profile of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"precedenceProfileId" : {
"description" : "Precedence profile of the WLAN",
"type" : "string"
},
"schedule" : {
"description" : "Schedule of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"type" : {
"description" : "Type of WLAN schedule",
"type" : "string",
"enum" : [ "AlwaysOn", "AlwaysOff", "Customized" ],
"default" : "AlwaysOn"
},
"id" : {
"description" : "Identifier of the schedule profile. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the schedule profile. At least one ID or name is required in the request.",
"type" : "string"
}
},
"required" : [ "type" ]
},
"vlan" : {
"description" : "VLAN (access and/or core) of the WLAN.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"accessVlan" : {
"description" : "Access VLAN ID",
"type" : "integer",
"minimum" : 1,
"maximum" : 4094,
"default" : 1
},
"aaaVlanOverride" : {
"description" : "Indicates whether the AAA VLAN settings can be overriden or not",
"type" : "boolean"
},
"coreQinQEnabled" : {
"description" : "Indicates whether Q-in-Q is allowed at the core network or not",
"type" : "boolean"
},
"coreSVlan" : {
"description" : "Core SVLAN ID. This only applies when core Q-in-Q is enabled",
"type" : "integer",
"minimum" : 1,
"maximum" : 4094
},
"vlanPooling" : {
"description" : "Vlan pooling",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
}
}
},
"l2ACL" : {
"description" : "Layer 2 ACL of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"devicePolicy" : {
"description" : "Device policy of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"radiusOptions" : {
"description" : "RADIUS options of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"nasIdType" : {
"description" : "NAS ID type",
"type" : "string",
"enum" : [ "WLAN_BSSID", "AP_MAC", "Customized" ],
"default" : "WLAN_BSSID"
},
"customizedNasId" : {
"description" : "User defined NAS ID",
"type" : "string",
"maxLength" : 64,
"pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$"
},
"nasRequestTimeoutSec" : {
"description" : "NAS request timeout in seconds",
"type" : "integer",
"default" : 3,
"minimum" : 2,
"maximum" : 20
},
"nasMaxRetry" : {
"description" : "NAS request maximum retry",
"type" : "integer",
"default" : 2,
"minimum" : 2,
"maximum" : 10
},
"nasReconnectPrimaryMin" : {
"description" : "NAS reconnect primary time in minutes",
"type" : "integer",
"default" : 5,
"minimum" : 1,
"maximum" : 60
},
"calledStaIdType" : {
"description" : "Called station ID type",
"type" : "string",
"enum" : [ "WLAN_BSSID", "AP_MAC", "NONE" ],
"default" : "WLAN_BSSID"
},
"nasIpType" : {
"description" : "NAS IP type",
"type" : "string",
"enum" : [ "disabled", "control", "management", "userDefined" ],
"default" : "disabled"
},
"nasIpUserDefined" : {
"description" : "User-defined NAS IP",
"type" : "string",
"maxLength" : 45
},
"singleSessionIdAcctEnabled" : {
"description" : "When Single Accounting Session ID is enabled, APs will maintain one accounting session for client roaming",
"type" : "boolean",
"default" : false
}
}
},
"advancedOptions" : {
"description" : "Advanced settings for the WLAN.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"clientIsolationEnabled" : {
"description" : "Indicates whether wireless client isolation is enabled or disabled",
"type" : "boolean",
"default" : false
},
"clientIsolationUnicastEnabled" : {
"description" : "Indicates whether isolate unicast of wireless client isolation is enabled or disabled",
"type" : "boolean",
"default" : true
},
"clientIsolationMulticastEnabled" : {
"description" : "Indicates whether isolate multicast of wireless client isolation is enabled or disabled",
"type" : "boolean"
},
"clientIsolationAutoVrrpEnabled" : {
"description" : "Indicates whether Automatic support for VRRP of wireless client isolation is enabled or disabled",
"type" : "boolean",
"default" : false
},
"clientIsolationWhitelist" : {
"description" : "Indicates wireless client isolation whitelist",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"priority" : {
"description" : "Priority of the WLAN",
"type" : "string",
"enum" : [ "High", "Low" ],
"default" : "High"
},
"hideSsidEnabled" : {
"description" : "Indicates whether the SSID is hidden or broadcast",
"type" : "boolean",
"default" : false
},
"hs20Onboarding" : {
"description" : "Allow WISPr WLAN for Hotspot 2.0 Onboarding",
"type" : "boolean",
"default" : false
},
"maxClientsPerRadio" : {
"description" : "Maximum number of clients per radio",
"type" : "integer",
"default" : 100,
"minimum" : 1,
"maximum" : 512
},
"clientIdleTimeoutSec" : {
"description" : "Client idle timeout in seconds",
"type" : "integer",
"minimum" : 60,
"maximum" : 1000,
"default" : 120
},
"dgafEnabled" : {
"description" : "Indicates whether dgaf is enabled or disabled",
"type" : "boolean"
},
"clientLoadBalancingEnabled" : {
"description" : "Indicates whether Client Load Balancing is enabled or disabled",
"type" : "boolean",
"default" : true
},
"proxyARPEnabled" : {
"description" : "Indicates whether proxy ARP is enabled or disabled",
"type" : "boolean",
"default" : false
},
"ndProxyEnabled" : {
"description" : "Indicates whether ND Proxy is enabled or disabled",
"type" : "boolean",
"default" : false
},
"suppressNsEnabled" : {
"description" : "Indicates whether supperssNS is enabled or disabled",
"type" : "boolean",
"default" : false
},
"raProxyEnabled" : {
"description" : "Indicates whether RA proxy is enabled or disabled",
"type" : "boolean",
"default" : false
},
"rsraGuardEnabled" : {
"description" : "Indicates whether RS/RA Guard is enabled or disabled",
"type" : "boolean",
"default" : false
},
"raThrottlingEnabled" : {
"description" : "Indicates whether RA Throttling is enabled or disabled",
"type" : "boolean",
"default" : false
},
"maxAllowedRA" : {
"description" : "Max Allowed RAs",
"type" : "integer",
"minimum" : 1,
"maximum" : 1440,
"default" : 10
},
"raInterval" : {
"description" : "A timer that RA proxy runs and once receives unsolicited RA checks against the configured time and allow/drop RA based on next timeout",
"type" : "integer",
"minimum" : 1,
"maximum" : 256,
"default" : 10
},
"support80211dEnabled" : {
"description" : "Indicates whether support for 802.11d is enabled or disabled",
"type" : "boolean",
"default" : true
},
"support80211kEnabled" : {
"description" : "Indicates whether support for 802.11k is enabled or disabled",
"type" : "boolean",
"default" : true
},
"antiSpoofingEnabled" : {
"description" : "Anti-Spoofing enabled",
"type" : "boolean",
"default" : false
},
"arpRequestRateLimit" : {
"description" : "ARP packets request rate limit, default value will be 15 if both rate limit not being set.",
"type" : "integer",
"minimum" : 0,
"maximum" : 100
},
"dhcpRequestRateLimit" : {
"description" : "DHCP packets request rate limit, default value will be 15 if both rate limit not being set.",
"type" : "integer",
"minimum" : 0,
"maximum" : 100
},
"forceClientDHCPTimeoutSec" : {
"description" : "Force DHCP disconnects the client if the client does not obtain a valid IP address within the timeout peroid. To disable force DHCP, set this value to zero (0).",
"type" : "integer",
"enum" : [ 0, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15 ],
"default" : 0
},
"dhcpOption82Enabled" : {
"description" : "Indicates whether DCHP Option 82 is enabled or disabled",
"type" : "boolean",
"default" : false
},
"dhcp82Format" : {
"description" : "DHCP Option 82 format",
"type" : "string",
"enum" : [ "RUCKUS_DEFAULT", "SOFTGRE_CUSTOMIZED" ]
},
"unauthClientStatsEnabled" : {
"description" : "Indicates whether to send statistics of unauthorized clients or not",
"type" : "boolean",
"default" : false
},
"clientFingerprintingEnabled" : {
"description" : "Indicates whether client fingerprinting is enabled or disabled",
"type" : "boolean",
"default" : false
},
"ofdmOnlyEnabled" : {
"description" : "Indicates whether OFDM only is enabled or disabled",
"type" : "boolean",
"default" : false
},
"bandBalancing" : {
"description" : "Indicates whether band balancing is enabled or disabled",
"type" : "string",
"enum" : [ "Disabled", "UseZoneSetting" ],
"default" : "UseZoneSetting"
},
"bssMinRateMbps" : {
"description" : "BSS minimum rate (mbps)",
"type" : "string",
"enum" : [ "Disable", "1 mbps", "2 mbps", "5.5 mbps", "12 mbps", "24 mbps" ],
"default" : "Disable"
},
"mgmtTxRateMbps" : {
"description" : "Management TX rate (mbps)",
"type" : "string",
"enum" : [ "1 mbps", "2 mbps", "5.5 mbps", "6 mbps", "9 mbps", "11 mbps", "12 mbps", "18 mbps", "24 mbps", "36 mbps", "48 mbps", "54 mbps" ],
"default" : "2 mbps"
},
"pmkCachingEnabled" : {
"description" : "Indicator of whether PKM caching support is enabled or disabled. The default value is true when the WLAN is WPA+AES non open WLAN.",
"type" : "boolean"
},
"okcEnabled" : {
"description" : "Indicator of whether OKC support is enabled or disabled. The default value is true when the WLAN is WPA+AES non open WLAN.",
"type" : "boolean"
},
"avcEnabled" : {
"description" : "Indicator of whether ARC support is enabled or disabled",
"type" : "boolean",
"default" : false
},
"urlFilteringPolicyEnabled" : {
"description" : "Indicator of whether URL Filtering is enabled or disabled",
"type" : "boolean",
"default" : false
},
"urlFilteringPolicyId" : {
"description" : "The URL Filtering policy ID.",
"type" : "string"
},
"wifiCallingPolicyEnabled" : {
"description" : "Indicator of whether Wi-Fi Calling is enabled or disabled",
"type" : "boolean",
"default" : false
},
"wifiCallingPolicyIds" : {
"description" : "The Wi-Fi Calling policy IDs. (Maximum allowed number is 5)",
"type" : "array",
"items" : {
"type" : "string"
}
},
"uplinkEnabled" : {
"description" : "SSID Rate Limiting uplink enabled.",
"type" : "boolean",
"default" : false
},
"uplinkRate" : {
"description" : "SSID Rate Limiting uplink.",
"type" : "number",
"default" : 0.0
},
"downlinkEnabled" : {
"description" : "SSID Rate Limiting downlink enabled.",
"type" : "boolean",
"default" : false
},
"downlinkRate" : {
"description" : "SSID Rate Limiting downlink.",
"type" : "number",
"default" : 0.0
},
"ratePerSTAUplink" : {
"description" : "UE Rate Limiting uplink.",
"type" : "string"
},
"ratePerSTADownlink" : {
"description" : "UE Rate Limiting downlink.",
"type" : "string"
},
"dtimInterval" : {
"description" : "DTIM Interval",
"type" : "integer",
"minimum" : 1,
"maximum" : 255,
"default" : 1
},
"directedThreshold" : {
"description" : "Directed Threshold Setting, Defines the client count at which an AP will stop converting group addressed data traffic to unicast.",
"type" : "integer",
"minimum" : 0,
"maximum" : 128,
"default" : 5
},
"flowLogEnabled" : {
"description" : "Flow log enabled.",
"type" : "boolean",
"default" : false
},
"hdOverheadOptimizeEnable" : {
"description" : "Airtime decongestion enabled.",
"type" : "boolean",
"default" : false
},
"probeRssiThr" : {
"type" : "integer",
"description" : "Join RSSI threshold.",
"minimum" : -90,
"maximum" : -60,
"default" : -85
},
"transientClientMgmtEnable" : {
"description" : "Transient Client Management enabled.",
"type" : "boolean",
"default" : false
},
"joinIgnoreTimeout" : {
"description" : "Join wait time.",
"type" : "integer",
"minimum" : 1,
"maximum" : 60,
"default" : 30
},
"joinAcceptTimeout" : {
"description" : "Join expire time.",
"type" : "integer",
"minimum" : 1,
"maximum" : 300,
"default" : 300
},
"joinIgnoreThr" : {
"description" : "Join wait threshold.",
"type" : "integer",
"minimum" : 1,
"maximum" : 50,
"default" : 10
},
"authRssiThr" : {
"description" : "Auth RSSI threshold.",
"type" : "integer",
"minimum" : -90,
"maximum" : -60
},
"assocRssiThr" : {
"description" : "Assoc RSSI threshold.",
"type" : "integer",
"minimum" : -90,
"maximum" : -60
},
"oceEnabled" : {
"description" : "Optimized Connectivity Experience(OCE) enabled.",
"type" : "boolean",
"default" : false
},
"oceBroadcastProbeResponseDelay" : {
"description" : "Broadcast probe response delay.",
"type" : "integer",
"minimum" : 8,
"maximum" : 120,
"default" : 15
},
"oceRssiBasedAssociationRejectionThreshold" : {
"description" : "RSSI-based association rejection threshold.",
"type" : "integer",
"minimum" : -90,
"maximum" : -60,
"default" : -75
}
}
},
"diffServProfile" : {
"description" : "DiffServ profile of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"qosMaps" : {
"description" : "Qos map set of the WLAN.",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"enable" : {
"description" : "Enabled or disabled",
"type" : "boolean"
},
"priority" : {
"description" : "Priority",
"type" : "integer"
},
"low" : {
"description" : "DSCP range - low",
"type" : [ "integer", "null" ],
"minimum" : 0,
"maximum" : 255
},
"high" : {
"description" : "DSCP range - high",
"type" : [ "integer", "null" ],
"minimum" : 0,
"maximum" : 255
},
"excepts" : {
"type" : [ "array", "null" ],
"items" : {
"type" : "integer",
"minimum" : 0,
"maximum" : 63
}
}
},
"required" : [ "enable", "priority" ]
}
},
"dpsk" : {
"description" : "DPSK Setting",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"dpskEnabled" : {
"description" : "DPSK enabled",
"type" : "boolean",
"default" : false
},
"length" : {
"description" : "Length of DPSK key",
"type" : "integer",
"default" : 62
},
"dpskType" : {
"description" : "Type of DPSK key",
"type" : "string",
"enum" : [ "Secure", "KeyboardFriendly", "NumbersOnly" ],
"default" : "Secure"
},
"expiration" : {
"description" : "Expiration of DPSK key",
"type" : "string",
"enum" : [ "Unlimited", "OneDay", "TwoDays", "OneWeek", "TwoWeeks", "OneMonth", "SixMonths", "OneYear", "TwoYears" ],
"default" : "Unlimited"
},
"dpskFromType" : {
"description" : "Type of expiration start from",
"type" : "string",
"enum" : [ "CreateTime", "FirstUse" ],
"default" : "CreateTime"
}
}
},
"externalDpsk" : {
"description" : "External DPSK Enabled",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"enabled" : {
"description" : "Enable External DPSK",
"type" : "boolean",
"default" : false
},
"encryption" : {
"description" : "Encryption of the WLAN relate to external DPSK",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"method" : {
"description" : "Encryption method",
"type" : "string",
"enum" : [ "WPA2", "WPA_Mixed", "None" ]
},
"algorithm" : {
"description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
"type" : "string",
"enum" : [ "AES", "TKIP_AES" ]
}
}
},
"authService" : {
"description" : "Autentication of the WLAN relate to external DPSK",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Identifier of the authentication service. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the authentication service. At least one ID or name is required in the request.",
"type" : "string"
}
}
}
},
"required" : [ "enabled" ]
},
"dnsServerProfile" : {
"description" : "DNS server profile of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"accessTunnelProfile" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"accessIpsecProfile" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"splitTunnelProfileId" : {
"type" : "string"
},
"portalDetectionProfileId" : {
"type" : "string"
}
},
"required" : [ "name", "ssid", "hotspot20Profile" ]
}201Body
{
"id": "wlanID"
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
}
}
}Create - Hotspot 2.0 Open ¶
POST/v8_0/rkszones/{zoneId}/wlans/hotspot20open
Use this API command to create a new Hotspot 2.0 Onboarding WLAN with Authentication Method as ‘Open’.
Body
{
"name": "api-test-wlanhs20open",
"ssid": "api-test-wlanhs20open",
"description": "wlanDescription"
}Schema
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"name" : {
"description" : "Name of the WLAN",
"type" : "string",
"minLength" : 1,
"maxLength" : 32
},
"ssid" : {
"description" : "SSID of the WLAN",
"type" : "string",
"minLength" : 1,
"maxLength" : 32
},
"hessid" : {
"description" : "HESSID of the WLAN",
"type" : "string",
"pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$"
},
"description" : {
"description" : "Description of the WLAN",
"type" : [ "string", "null" ],
"maxLength" : 64
},
"caleaEnabled" : {
"description" : "DP CALEA Server Enabled",
"type" : "boolean"
},
"dpTunnelNatEnabled" : {
"description" : "DP Tunnel NAT Enabled",
"type" : "boolean"
},
"dpTunnelDhcpEnabled" : {
"description" : "DP Tunnel DHCP Enabled",
"type" : "boolean"
},
"awsExtNasIPEnable" : {
"description" : "Aws ExtNasIP Enable",
"type" : "boolean"
},
"awsVenueEnable" : {
"description" : "Aws Venue Enable",
"type" : "boolean"
},
"accessTunnelType" : {
"description" : "Access tunnel type of the WLAN. APLBO means AP local breakout, RuckusGRE means RuckusGRE tunnel to the data plane, and SoftGRE means AP direct SoftGRE tunnel",
"type" : "string",
"enum" : [ "APLBO", "RuckusGRE", "SoftGRE" ]
},
"coreTunnelProfile" : {
"description" : "Core tunnel of the WLAN. This only applies when the access tunnel type is set to RuckusGRE.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"type" : {
"description" : "Tunnel type",
"type" : "string",
"enum" : [ "Bridge", "L2oGRE", "TTG_PDG", "Mixed" ]
},
"id" : {
"description" : "Identifier of the forwarding profile. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the forwarding profile. At least one ID or name is required in the request.",
"type" : "string"
},
"operatorRealm" : {
"description" : "Operator realm, deprecated coreTunnelProfile.operatorRealm from version3.1, prepare remove",
"type" : "string",
"maxLength" : 255,
"pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
}
},
"required" : [ "type" ]
},
"macAuth" : {
"description" : "MAC address authentication settings of the WLAN. This only applies to standard MAC and Hotspot MAC bypass WLAN.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"macAuthMacFormat" : {
"description" : "MAC address format. The default format is 0010a42319c0 and the 802.1X format is 00-10-A4-23-19-C0.",
"type" : "string",
"enum" : [ "Default", "802.1X", "UpperColon", "Upper", "LowerDash", "LowerColon" ]
},
"customizedPassword" : {
"description" : "User defined password. When this field is set to an empty string, the MAC address is used as password.",
"type" : "string",
"maxLength" : 64,
"pattern" : "^([!-;=?-~]([ -;=?-~]){0,62}[!-;=?-~]|[!-;=?-~]{1,1}|\s{0,0})$"
}
}
},
"encryption" : {
"description" : "Encryption of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"method" : {
"description" : "Encryption method",
"type" : "string",
"enum" : [ "WPA2", "WPA_Mixed", "WEP_64", "WEP_128", "None" ],
"default" : "None"
},
"algorithm" : {
"description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
"type" : "string",
"enum" : [ "AES", "TKIP_AES" ]
},
"passphrase" : {
"description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
"type" : "string"
},
"mfp" : {
"description" : "Management frame protection. This only applies to WPA2 + AES",
"type" : "string",
"enum" : [ "disabled", "capable", "required" ]
},
"keyIndex" : {
"description" : "Key index. This only applies to WEP64 and WEP128.",
"type" : "integer"
},
"keyInHex" : {
"description" : "Key in hex format. This only applies to WEP64 and WEP128.",
"type" : "string"
},
"support80211rEnabled" : {
"description" : "Enable 802.11r Fast BSS Transition, fast Romaing.",
"type" : "boolean"
},
"mobilityDomainId" : {
"description" : "mobility Domain Id.",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
}
},
"required" : [ "method" ]
},
"authServiceOrProfile" : {
"description" : "Authentication of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"throughController" : {
"description" : "Indicates whether authentication messages were sent through the controller or not",
"type" : "boolean"
},
"realmBasedAuth" : {
"type" : "boolean"
},
"id" : {
"description" : "Identifier of the authentication service or profile. At least one ID or name or authenticationOption is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the authentication service or profile. At least one ID or name or authenticationOption is required in the request. Or could input the 'Always Accept' or 'Local DB'.",
"type" : "string"
},
"authenticationOption" : {
"description" : "Option of the authentication service or profile, At least one ID or name or authenticationOption is required in the request. This only applies to hotspot and guest WLANs.",
"type" : [ "string", "null" ],
"enum" : [ "Local DB", "Guest", "Always Accept", null ]
},
"locationDeliveryEnabled" : {
"description" : "RFC5580 location delivery support",
"type" : "boolean"
},
"backupAuthenticationId" : {
"description" : "Identifier of the backup authentication service or profile. At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service.",
"type" : "string"
},
"backupAuthenticationName" : {
"description" : "Name of the backup authentication service or profile. At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service. Or could input the 'Always Accept'.",
"type" : "string"
},
"backupAuthenticationOption" : {
"description" : "Option of the backup authentication service or profile, At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service. This only applies to hotspot WLANs.",
"type" : [ "string", "null" ],
"enum" : [ "Always Accept", null ]
}
}
},
"operatorRealm" : {
"description" : "Operator realm, operatorRealm only supports coreTunnelProfile type is authServiceOrProfile.locationDeliveryEnabled is true",
"type" : "string",
"maxLength" : 255,
"pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
},
"accountingServiceOrProfile" : {
"description" : "Accounting of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"throughController" : {
"description" : "Indicates whether accounting messages were sent through the controller",
"type" : "boolean"
},
"realmBasedAcct" : {
"type" : "boolean"
},
"id" : {
"description" : "Accounting service or profile ID. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Accounting service or profile name. At least one ID or name is required in the request.",
"type" : "string"
},
"interimUpdateMin" : {
"description" : "Interval (in minutes) for sending interim updates",
"type" : "integer",
"minimum" : 0,
"maximum" : 1440
},
"accountingDelayEnabled" : {
"description" : "Indicates whether accounting delay time is enabled",
"type" : "boolean"
},
"accountingTTGSessionEnabled" : {
"description" : "Indicates whether accounting for TTG sessions is to enabled",
"type" : "boolean"
},
"backupAccountingId" : {
"description" : "Backup accounting service or profile ID. At least one backupAccountingId or backupAccountingName is required in the request when setting backup accounting service.",
"type" : "string"
},
"backupAccountingName" : {
"description" : "Backup accounting service or profile name. At least one backupAccountingId or backupAccountingName is required in the request when setting backup accounting service.",
"type" : "string"
}
}
},
"portalServiceProfile" : {
"description" : "Portal service of the WLAN. This only applies to hotspot, hotspot MAC bypass, guest and web auth WLANs.",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"hotspot20Profile" : {
"description" : "Hotspot 2.0 operator profile of the WLAN. id or name of the hotspot 2.0 operator profiles within the zone is required.",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"defaultUserTrafficProfile" : {
"description" : "User traffic profile of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"precedenceProfileId" : {
"description" : "Precedence profile of the WLAN",
"type" : "string"
},
"schedule" : {
"description" : "Schedule of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"type" : {
"description" : "Type of WLAN schedule",
"type" : "string",
"enum" : [ "AlwaysOn", "AlwaysOff", "Customized" ],
"default" : "AlwaysOn"
},
"id" : {
"description" : "Identifier of the schedule profile. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the schedule profile. At least one ID or name is required in the request.",
"type" : "string"
}
},
"required" : [ "type" ]
},
"vlan" : {
"description" : "VLAN (access and/or core) of the WLAN.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"accessVlan" : {
"description" : "Access VLAN ID",
"type" : "integer",
"minimum" : 1,
"maximum" : 4094,
"default" : 1
},
"aaaVlanOverride" : {
"description" : "Indicates whether the AAA VLAN settings can be overriden or not",
"type" : "boolean"
},
"coreQinQEnabled" : {
"description" : "Indicates whether Q-in-Q is allowed at the core network or not",
"type" : "boolean"
},
"coreSVlan" : {
"description" : "Core SVLAN ID. This only applies when core Q-in-Q is enabled",
"type" : "integer",
"minimum" : 1,
"maximum" : 4094
},
"vlanPooling" : {
"description" : "Vlan pooling",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
}
}
},
"l2ACL" : {
"description" : "Layer 2 ACL of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"devicePolicy" : {
"description" : "Device policy of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"radiusOptions" : {
"description" : "RADIUS options of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"nasIdType" : {
"description" : "NAS ID type",
"type" : "string",
"enum" : [ "WLAN_BSSID", "AP_MAC", "Customized" ],
"default" : "WLAN_BSSID"
},
"customizedNasId" : {
"description" : "User defined NAS ID",
"type" : "string",
"maxLength" : 64,
"pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$"
},
"nasRequestTimeoutSec" : {
"description" : "NAS request timeout in seconds",
"type" : "integer",
"default" : 3,
"minimum" : 2,
"maximum" : 20
},
"nasMaxRetry" : {
"description" : "NAS request maximum retry",
"type" : "integer",
"default" : 2,
"minimum" : 2,
"maximum" : 10
},
"nasReconnectPrimaryMin" : {
"description" : "NAS reconnect primary time in minutes",
"type" : "integer",
"default" : 5,
"minimum" : 1,
"maximum" : 60
},
"calledStaIdType" : {
"description" : "Called station ID type",
"type" : "string",
"enum" : [ "WLAN_BSSID", "AP_MAC", "NONE" ],
"default" : "WLAN_BSSID"
},
"nasIpType" : {
"description" : "NAS IP type",
"type" : "string",
"enum" : [ "disabled", "control", "management", "userDefined" ],
"default" : "disabled"
},
"nasIpUserDefined" : {
"description" : "User-defined NAS IP",
"type" : "string",
"maxLength" : 45
},
"singleSessionIdAcctEnabled" : {
"description" : "When Single Accounting Session ID is enabled, APs will maintain one accounting session for client roaming",
"type" : "boolean",
"default" : false
}
}
},
"advancedOptions" : {
"description" : "Advanced settings for the WLAN.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"clientIsolationEnabled" : {
"description" : "Indicates whether wireless client isolation is enabled or disabled",
"type" : "boolean",
"default" : false
},
"clientIsolationUnicastEnabled" : {
"description" : "Indicates whether isolate unicast of wireless client isolation is enabled or disabled",
"type" : "boolean",
"default" : true
},
"clientIsolationMulticastEnabled" : {
"description" : "Indicates whether isolate multicast of wireless client isolation is enabled or disabled",
"type" : "boolean"
},
"clientIsolationAutoVrrpEnabled" : {
"description" : "Indicates whether Automatic support for VRRP of wireless client isolation is enabled or disabled",
"type" : "boolean",
"default" : false
},
"clientIsolationWhitelist" : {
"description" : "Indicates wireless client isolation whitelist",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"priority" : {
"description" : "Priority of the WLAN",
"type" : "string",
"enum" : [ "High", "Low" ],
"default" : "High"
},
"hideSsidEnabled" : {
"description" : "Indicates whether the SSID is hidden or broadcast",
"type" : "boolean",
"default" : false
},
"hs20Onboarding" : {
"description" : "Allow WISPr WLAN for Hotspot 2.0 Onboarding",
"type" : "boolean",
"default" : false
},
"maxClientsPerRadio" : {
"description" : "Maximum number of clients per radio",
"type" : "integer",
"default" : 100,
"minimum" : 1,
"maximum" : 512
},
"clientIdleTimeoutSec" : {
"description" : "Client idle timeout in seconds",
"type" : "integer",
"minimum" : 60,
"maximum" : 1000,
"default" : 120
},
"dgafEnabled" : {
"description" : "Indicates whether dgaf is enabled or disabled",
"type" : "boolean"
},
"clientLoadBalancingEnabled" : {
"description" : "Indicates whether Client Load Balancing is enabled or disabled",
"type" : "boolean",
"default" : true
},
"proxyARPEnabled" : {
"description" : "Indicates whether proxy ARP is enabled or disabled",
"type" : "boolean",
"default" : false
},
"ndProxyEnabled" : {
"description" : "Indicates whether ND Proxy is enabled or disabled",
"type" : "boolean",
"default" : false
},
"suppressNsEnabled" : {
"description" : "Indicates whether supperssNS is enabled or disabled",
"type" : "boolean",
"default" : false
},
"raProxyEnabled" : {
"description" : "Indicates whether RA proxy is enabled or disabled",
"type" : "boolean",
"default" : false
},
"rsraGuardEnabled" : {
"description" : "Indicates whether RS/RA Guard is enabled or disabled",
"type" : "boolean",
"default" : false
},
"raThrottlingEnabled" : {
"description" : "Indicates whether RA Throttling is enabled or disabled",
"type" : "boolean",
"default" : false
},
"maxAllowedRA" : {
"description" : "Max Allowed RAs",
"type" : "integer",
"minimum" : 1,
"maximum" : 1440,
"default" : 10
},
"raInterval" : {
"description" : "A timer that RA proxy runs and once receives unsolicited RA checks against the configured time and allow/drop RA based on next timeout",
"type" : "integer",
"minimum" : 1,
"maximum" : 256,
"default" : 10
},
"support80211dEnabled" : {
"description" : "Indicates whether support for 802.11d is enabled or disabled",
"type" : "boolean",
"default" : true
},
"support80211kEnabled" : {
"description" : "Indicates whether support for 802.11k is enabled or disabled",
"type" : "boolean",
"default" : true
},
"antiSpoofingEnabled" : {
"description" : "Anti-Spoofing enabled",
"type" : "boolean",
"default" : false
},
"arpRequestRateLimit" : {
"description" : "ARP packets request rate limit, default value will be 15 if both rate limit not being set.",
"type" : "integer",
"minimum" : 0,
"maximum" : 100
},
"dhcpRequestRateLimit" : {
"description" : "DHCP packets request rate limit, default value will be 15 if both rate limit not being set.",
"type" : "integer",
"minimum" : 0,
"maximum" : 100
},
"forceClientDHCPTimeoutSec" : {
"description" : "Force DHCP disconnects the client if the client does not obtain a valid IP address within the timeout peroid. To disable force DHCP, set this value to zero (0).",
"type" : "integer",
"enum" : [ 0, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15 ],
"default" : 0
},
"dhcpOption82Enabled" : {
"description" : "Indicates whether DCHP Option 82 is enabled or disabled",
"type" : "boolean",
"default" : false
},
"dhcp82Format" : {
"description" : "DHCP Option 82 format",
"type" : "string",
"enum" : [ "RUCKUS_DEFAULT", "SOFTGRE_CUSTOMIZED" ]
},
"unauthClientStatsEnabled" : {
"description" : "Indicates whether to send statistics of unauthorized clients or not",
"type" : "boolean",
"default" : false
},
"clientFingerprintingEnabled" : {
"description" : "Indicates whether client fingerprinting is enabled or disabled",
"type" : "boolean",
"default" : false
},
"ofdmOnlyEnabled" : {
"description" : "Indicates whether OFDM only is enabled or disabled",
"type" : "boolean",
"default" : false
},
"bandBalancing" : {
"description" : "Indicates whether band balancing is enabled or disabled",
"type" : "string",
"enum" : [ "Disabled", "UseZoneSetting" ],
"default" : "UseZoneSetting"
},
"bssMinRateMbps" : {
"description" : "BSS minimum rate (mbps)",
"type" : "string",
"enum" : [ "Disable", "1 mbps", "2 mbps", "5.5 mbps", "12 mbps", "24 mbps" ],
"default" : "Disable"
},
"mgmtTxRateMbps" : {
"description" : "Management TX rate (mbps)",
"type" : "string",
"enum" : [ "1 mbps", "2 mbps", "5.5 mbps", "6 mbps", "9 mbps", "11 mbps", "12 mbps", "18 mbps", "24 mbps", "36 mbps", "48 mbps", "54 mbps" ],
"default" : "2 mbps"
},
"pmkCachingEnabled" : {
"description" : "Indicator of whether PKM caching support is enabled or disabled. The default value is true when the WLAN is WPA+AES non open WLAN.",
"type" : "boolean"
},
"okcEnabled" : {
"description" : "Indicator of whether OKC support is enabled or disabled. The default value is true when the WLAN is WPA+AES non open WLAN.",
"type" : "boolean"
},
"avcEnabled" : {
"description" : "Indicator of whether ARC support is enabled or disabled",
"type" : "boolean",
"default" : false
},
"urlFilteringPolicyEnabled" : {
"description" : "Indicator of whether URL Filtering is enabled or disabled",
"type" : "boolean",
"default" : false
},
"urlFilteringPolicyId" : {
"description" : "The URL Filtering policy ID.",
"type" : "string"
},
"wifiCallingPolicyEnabled" : {
"description" : "Indicator of whether Wi-Fi Calling is enabled or disabled",
"type" : "boolean",
"default" : false
},
"wifiCallingPolicyIds" : {
"description" : "The Wi-Fi Calling policy IDs. (Maximum allowed number is 5)",
"type" : "array",
"items" : {
"type" : "string"
}
},
"uplinkEnabled" : {
"description" : "SSID Rate Limiting uplink enabled.",
"type" : "boolean",
"default" : false
},
"uplinkRate" : {
"description" : "SSID Rate Limiting uplink.",
"type" : "number",
"default" : 0.0
},
"downlinkEnabled" : {
"description" : "SSID Rate Limiting downlink enabled.",
"type" : "boolean",
"default" : false
},
"downlinkRate" : {
"description" : "SSID Rate Limiting downlink.",
"type" : "number",
"default" : 0.0
},
"ratePerSTAUplink" : {
"description" : "UE Rate Limiting uplink.",
"type" : "string"
},
"ratePerSTADownlink" : {
"description" : "UE Rate Limiting downlink.",
"type" : "string"
},
"dtimInterval" : {
"description" : "DTIM Interval",
"type" : "integer",
"minimum" : 1,
"maximum" : 255,
"default" : 1
},
"directedThreshold" : {
"description" : "Directed Threshold Setting, Defines the client count at which an AP will stop converting group addressed data traffic to unicast.",
"type" : "integer",
"minimum" : 0,
"maximum" : 128,
"default" : 5
},
"flowLogEnabled" : {
"description" : "Flow log enabled.",
"type" : "boolean",
"default" : false
},
"hdOverheadOptimizeEnable" : {
"description" : "Airtime decongestion enabled.",
"type" : "boolean",
"default" : false
},
"probeRssiThr" : {
"type" : "integer",
"description" : "Join RSSI threshold.",
"minimum" : -90,
"maximum" : -60,
"default" : -85
},
"transientClientMgmtEnable" : {
"description" : "Transient Client Management enabled.",
"type" : "boolean",
"default" : false
},
"joinIgnoreTimeout" : {
"description" : "Join wait time.",
"type" : "integer",
"minimum" : 1,
"maximum" : 60,
"default" : 30
},
"joinAcceptTimeout" : {
"description" : "Join expire time.",
"type" : "integer",
"minimum" : 1,
"maximum" : 300,
"default" : 300
},
"joinIgnoreThr" : {
"description" : "Join wait threshold.",
"type" : "integer",
"minimum" : 1,
"maximum" : 50,
"default" : 10
},
"authRssiThr" : {
"description" : "Auth RSSI threshold.",
"type" : "integer",
"minimum" : -90,
"maximum" : -60
},
"assocRssiThr" : {
"description" : "Assoc RSSI threshold.",
"type" : "integer",
"minimum" : -90,
"maximum" : -60
},
"oceEnabled" : {
"description" : "Optimized Connectivity Experience(OCE) enabled.",
"type" : "boolean",
"default" : false
},
"oceBroadcastProbeResponseDelay" : {
"description" : "Broadcast probe response delay.",
"type" : "integer",
"minimum" : 8,
"maximum" : 120,
"default" : 15
},
"oceRssiBasedAssociationRejectionThreshold" : {
"description" : "RSSI-based association rejection threshold.",
"type" : "integer",
"minimum" : -90,
"maximum" : -60,
"default" : -75
}
}
},
"diffServProfile" : {
"description" : "DiffServ profile of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"qosMaps" : {
"description" : "Qos map set of the WLAN.",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"enable" : {
"description" : "Enabled or disabled",
"type" : "boolean"
},
"priority" : {
"description" : "Priority",
"type" : "integer"
},
"low" : {
"description" : "DSCP range - low",
"type" : [ "integer", "null" ],
"minimum" : 0,
"maximum" : 255
},
"high" : {
"description" : "DSCP range - high",
"type" : [ "integer", "null" ],
"minimum" : 0,
"maximum" : 255
},
"excepts" : {
"type" : [ "array", "null" ],
"items" : {
"type" : "integer",
"minimum" : 0,
"maximum" : 63
}
}
},
"required" : [ "enable", "priority" ]
}
},
"dpsk" : {
"description" : "DPSK Setting",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"dpskEnabled" : {
"description" : "DPSK enabled",
"type" : "boolean",
"default" : false
},
"length" : {
"description" : "Length of DPSK key",
"type" : "integer",
"default" : 62
},
"dpskType" : {
"description" : "Type of DPSK key",
"type" : "string",
"enum" : [ "Secure", "KeyboardFriendly", "NumbersOnly" ],
"default" : "Secure"
},
"expiration" : {
"description" : "Expiration of DPSK key",
"type" : "string",
"enum" : [ "Unlimited", "OneDay", "TwoDays", "OneWeek", "TwoWeeks", "OneMonth", "SixMonths", "OneYear", "TwoYears" ],
"default" : "Unlimited"
},
"dpskFromType" : {
"description" : "Type of expiration start from",
"type" : "string",
"enum" : [ "CreateTime", "FirstUse" ],
"default" : "CreateTime"
}
}
},
"externalDpsk" : {
"description" : "External DPSK Enabled",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"enabled" : {
"description" : "Enable External DPSK",
"type" : "boolean",
"default" : false
},
"encryption" : {
"description" : "Encryption of the WLAN relate to external DPSK",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"method" : {
"description" : "Encryption method",
"type" : "string",
"enum" : [ "WPA2", "WPA_Mixed", "None" ]
},
"algorithm" : {
"description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
"type" : "string",
"enum" : [ "AES", "TKIP_AES" ]
}
}
},
"authService" : {
"description" : "Autentication of the WLAN relate to external DPSK",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Identifier of the authentication service. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the authentication service. At least one ID or name is required in the request.",
"type" : "string"
}
}
}
},
"required" : [ "enabled" ]
},
"dnsServerProfile" : {
"description" : "DNS server profile of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"accessTunnelProfile" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"accessIpsecProfile" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"splitTunnelProfileId" : {
"type" : "string"
},
"portalDetectionProfileId" : {
"type" : "string"
}
},
"required" : [ "name", "ssid" ]
}201Body
{
"id": "wlanID"
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
}
}
}Create - Hotspot 2.0 OSEN ¶
POST/v8_0/rkszones/{zoneId}/wlans/hotspot20osen
Use this API command to create a new Hotspot 2.0 Onboarding WLAN with Authentication Method as ‘802.1X’.
Body
{
"name": "api-test-wlanhs20osen",
"ssid": "api-test-wlanhs20osen",
"description": "wlanDescription",
"accessTunnelType": "RuckusGRE",
"accessTunnelProfile": {
"id": "f5b92938-aa4e-4d02-90ea-273799ff689b",
"name": "Default Tunnel Profile"
},
"splitTunnelProfileId": "38119bac-49e1-4410-ab8e-1c1bc88dd770",
"coreTunnelProfile": {
"type": "Bridge",
"id": "forwardingUUID",
"name": "forwardingName"
},
"encryption": {
"method": "WPA2",
"algorithm": "AES",
"mfp": "disabled",
"mobilityDomainId": 3
},
"operatorRealm": "operator realm",
"schedule": {
"type": "Customized",
"id": "ServiceUUID",
"name": "ServiceName"
},
"vlan": {
"accessVlan": 23,
"aaaVlanOverride": true,
"coreQinQEnabled": false,
"coreSVlan": 1,
"vlanPooling": null
},
"l2ACL": {
"id": "l2ACLUUID",
"name": "l2ACLName"
},
"devicePolicy": {
"id": "devicePolicyUUID",
"name": "devicePolicyName"
},
"radiusOptions": {
"nasIdType": "Customized",
"customizedNasId": "nasId",
"nasRequestTimeoutSec": 12,
"nasMaxRetry": 3,
"nasReconnectPrimaryMin": 30,
"calledStaIdType": "WLAN_BSSID",
"nasIpType": "disabled",
"nasIpUserDefined": "192.168.1.1"
},
"advancedOptions": {
"clientIsolationEnabled": true,
"clientIsolationUnicastEnabled": true,
"clientIsolationMulticastEnabled": false,
"clientIsolationAutoVrrpEnabled": false,
"clientIsolationWhitelist": {
"id": "b89323e1-3168-11e7-b027-5254009ae3f0",
"name": "myWhitelist"
},
"priority": "High",
"hideSsidEnabled": true,
"maxClientsPerRadio": 12,
"clientIdleTimeoutSec": 60,
"clientLoadBalancingEnabled": true,
"proxyARPEnabled": true,
"ndProxyEnabled": false,
"suppressNsEnabled": false,
"raProxyEnabled": false,
"rsraGuardEnabled": false,
"raThrottlingEnabled": false,
"maxAllowedRA": 10,
"raInterval": 10,
"support80211dEnabled": false,
"support80211kEnabled": true,
"forceClientDHCPTimeoutSec": 5,
"dhcpOption82Enabled": true,
"dhcp82Format": "RUCKUS_DEFAULT",
"unauthClientStatsEnabled": false,
"clientFingerprintingEnabled": true,
"ofdmOnlyEnabled": false,
"bandBalancing": "UseZoneSetting",
"bssMinRateMbps": "Disable",
"mgmtTxRateMbps": "2 mbps",
"avcEnabled": true,
"urlFilteringPolicyEnabled": false,
"urlFilteringPolicyId": "",
"wifiCallingPolicyEnabled": false,
"wifiCallingPolicyIds": [],
"uplinkEnabled": true,
"uplinkRate": 100,
"downlinkEnabled": true,
"downlinkRate": 200,
"ratePerSTAUplink": "650mbps",
"ratePerSTADownlink": "1mbps"
},
"diffServProfile": {
"id": "diffServId",
"name": "diffServName"
},
"qosMaps": [
{
"enable": true,
"priority": 0,
"low": 0,
"high": 7,
"excepts": null
},
{
"enable": true,
"priority": 1,
"low": 8,
"high": 15,
"excepts": null
},
{
"enable": true,
"priority": 2,
"low": 16,
"high": 23,
"excepts": null
},
{
"enable": true,
"priority": 3,
"low": 0,
"high": 32,
"excepts": [
43,
45,
60
]
},
{
"enable": true,
"priority": 4,
"low": 32,
"high": 39,
"excepts": null
},
{
"enable": true,
"priority": 5,
"low": 40,
"high": 47,
"excepts": null
},
{
"enable": true,
"priority": 6,
"low": 48,
"high": 55,
"excepts": [
46
]
},
{
"enable": true,
"priority": 7,
"low": 56,
"high": 63,
"excepts": null
}
],
"dnsServerProfile": {
"id": "DNS server profile UUID",
"name": "DNS server profile name"
},
"dpsk": {
"dpskEnabled": false,
"length": 8,
"dpskType": "Secure",
"expiration": "OneDay",
"dpskFromType": "FirstUse"
},
"externalDpsk": {
"enabled": true,
"encryption": {
"method": "WPA2",
"algorithm": "AES"
},
"authService": {
"id": "authServiceUUID"
}
}
}Schema
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"name" : {
"description" : "Name of the WLAN",
"type" : "string",
"minLength" : 1,
"maxLength" : 32
},
"ssid" : {
"description" : "SSID of the WLAN",
"type" : "string",
"minLength" : 1,
"maxLength" : 32
},
"hessid" : {
"description" : "HESSID of the WLAN",
"type" : "string",
"pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$"
},
"description" : {
"description" : "Description of the WLAN",
"type" : [ "string", "null" ],
"maxLength" : 64
},
"caleaEnabled" : {
"description" : "DP CALEA Server Enabled",
"type" : "boolean"
},
"dpTunnelNatEnabled" : {
"description" : "DP Tunnel NAT Enabled",
"type" : "boolean"
},
"dpTunnelDhcpEnabled" : {
"description" : "DP Tunnel DHCP Enabled",
"type" : "boolean"
},
"awsExtNasIPEnable" : {
"description" : "Aws ExtNasIP Enable",
"type" : "boolean"
},
"awsVenueEnable" : {
"description" : "Aws Venue Enable",
"type" : "boolean"
},
"accessTunnelType" : {
"description" : "Access tunnel type of the WLAN. APLBO means AP local breakout, RuckusGRE means RuckusGRE tunnel to the data plane, and SoftGRE means AP direct SoftGRE tunnel",
"type" : "string",
"enum" : [ "APLBO", "RuckusGRE", "SoftGRE" ]
},
"coreTunnelProfile" : {
"description" : "Core tunnel of the WLAN. This only applies when the access tunnel type is set to RuckusGRE.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"type" : {
"description" : "Tunnel type",
"type" : "string",
"enum" : [ "Bridge", "L2oGRE", "TTG_PDG", "Mixed" ]
},
"id" : {
"description" : "Identifier of the forwarding profile. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the forwarding profile. At least one ID or name is required in the request.",
"type" : "string"
},
"operatorRealm" : {
"description" : "Operator realm, deprecated coreTunnelProfile.operatorRealm from version3.1, prepare remove",
"type" : "string",
"maxLength" : 255,
"pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
}
},
"required" : [ "type" ]
},
"macAuth" : {
"description" : "MAC address authentication settings of the WLAN. This only applies to standard MAC and Hotspot MAC bypass WLAN.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"macAuthMacFormat" : {
"description" : "MAC address format. The default format is 0010a42319c0 and the 802.1X format is 00-10-A4-23-19-C0.",
"type" : "string",
"enum" : [ "Default", "802.1X", "UpperColon", "Upper", "LowerDash", "LowerColon" ]
},
"customizedPassword" : {
"description" : "User defined password. When this field is set to an empty string, the MAC address is used as password.",
"type" : "string",
"maxLength" : 64,
"pattern" : "^([!-;=?-~]([ -;=?-~]){0,62}[!-;=?-~]|[!-;=?-~]{1,1}|\s{0,0})$"
}
}
},
"encryption" : {
"description" : "Encryption of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"method" : {
"description" : "Encryption method",
"type" : "string",
"enum" : [ "WPA2", "WPA_Mixed", "WEP_64", "WEP_128", "None" ],
"default" : "None"
},
"algorithm" : {
"description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
"type" : "string",
"enum" : [ "AES", "TKIP_AES" ]
},
"passphrase" : {
"description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
"type" : "string"
},
"mfp" : {
"description" : "Management frame protection. This only applies to WPA2 + AES",
"type" : "string",
"enum" : [ "disabled", "capable", "required" ]
},
"keyIndex" : {
"description" : "Key index. This only applies to WEP64 and WEP128.",
"type" : "integer"
},
"keyInHex" : {
"description" : "Key in hex format. This only applies to WEP64 and WEP128.",
"type" : "string"
},
"support80211rEnabled" : {
"description" : "Enable 802.11r Fast BSS Transition, fast Romaing.",
"type" : "boolean"
},
"mobilityDomainId" : {
"description" : "mobility Domain Id.",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
}
},
"required" : [ "method" ]
},
"authServiceOrProfile" : {
"description" : "Authentication of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"throughController" : {
"description" : "Indicates whether authentication messages were sent through the controller or not",
"type" : "boolean"
},
"realmBasedAuth" : {
"type" : "boolean"
},
"id" : {
"description" : "Identifier of the authentication service or profile. At least one ID or name or authenticationOption is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the authentication service or profile. At least one ID or name or authenticationOption is required in the request. Or could input the 'Always Accept' or 'Local DB'.",
"type" : "string"
},
"authenticationOption" : {
"description" : "Option of the authentication service or profile, At least one ID or name or authenticationOption is required in the request. This only applies to hotspot and guest WLANs.",
"type" : [ "string", "null" ],
"enum" : [ "Local DB", "Guest", "Always Accept", null ]
},
"locationDeliveryEnabled" : {
"description" : "RFC5580 location delivery support",
"type" : "boolean"
},
"backupAuthenticationId" : {
"description" : "Identifier of the backup authentication service or profile. At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service.",
"type" : "string"
},
"backupAuthenticationName" : {
"description" : "Name of the backup authentication service or profile. At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service. Or could input the 'Always Accept'.",
"type" : "string"
},
"backupAuthenticationOption" : {
"description" : "Option of the backup authentication service or profile, At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service. This only applies to hotspot WLANs.",
"type" : [ "string", "null" ],
"enum" : [ "Always Accept", null ]
}
}
},
"operatorRealm" : {
"description" : "Operator realm, operatorRealm only supports coreTunnelProfile type is authServiceOrProfile.locationDeliveryEnabled is true",
"type" : "string",
"maxLength" : 255,
"pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
},
"accountingServiceOrProfile" : {
"description" : "Accounting of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"throughController" : {
"description" : "Indicates whether accounting messages were sent through the controller",
"type" : "boolean"
},
"realmBasedAcct" : {
"type" : "boolean"
},
"id" : {
"description" : "Accounting service or profile ID. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Accounting service or profile name. At least one ID or name is required in the request.",
"type" : "string"
},
"interimUpdateMin" : {
"description" : "Interval (in minutes) for sending interim updates",
"type" : "integer",
"minimum" : 0,
"maximum" : 1440
},
"accountingDelayEnabled" : {
"description" : "Indicates whether accounting delay time is enabled",
"type" : "boolean"
},
"accountingTTGSessionEnabled" : {
"description" : "Indicates whether accounting for TTG sessions is to enabled",
"type" : "boolean"
},
"backupAccountingId" : {
"description" : "Backup accounting service or profile ID. At least one backupAccountingId or backupAccountingName is required in the request when setting backup accounting service.",
"type" : "string"
},
"backupAccountingName" : {
"description" : "Backup accounting service or profile name. At least one backupAccountingId or backupAccountingName is required in the request when setting backup accounting service.",
"type" : "string"
}
}
},
"portalServiceProfile" : {
"description" : "Portal service of the WLAN. This only applies to hotspot, hotspot MAC bypass, guest and web auth WLANs.",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"hotspot20Profile" : {
"description" : "Hotspot 2.0 operator profile of the WLAN. id or name of the hotspot 2.0 operator profiles within the zone is required.",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"defaultUserTrafficProfile" : {
"description" : "User traffic profile of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"precedenceProfileId" : {
"description" : "Precedence profile of the WLAN",
"type" : "string"
},
"schedule" : {
"description" : "Schedule of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"type" : {
"description" : "Type of WLAN schedule",
"type" : "string",
"enum" : [ "AlwaysOn", "AlwaysOff", "Customized" ],
"default" : "AlwaysOn"
},
"id" : {
"description" : "Identifier of the schedule profile. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the schedule profile. At least one ID or name is required in the request.",
"type" : "string"
}
},
"required" : [ "type" ]
},
"vlan" : {
"description" : "VLAN (access and/or core) of the WLAN.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"accessVlan" : {
"description" : "Access VLAN ID",
"type" : "integer",
"minimum" : 1,
"maximum" : 4094,
"default" : 1
},
"aaaVlanOverride" : {
"description" : "Indicates whether the AAA VLAN settings can be overriden or not",
"type" : "boolean"
},
"coreQinQEnabled" : {
"description" : "Indicates whether Q-in-Q is allowed at the core network or not",
"type" : "boolean"
},
"coreSVlan" : {
"description" : "Core SVLAN ID. This only applies when core Q-in-Q is enabled",
"type" : "integer",
"minimum" : 1,
"maximum" : 4094
},
"vlanPooling" : {
"description" : "Vlan pooling",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
}
}
},
"l2ACL" : {
"description" : "Layer 2 ACL of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"devicePolicy" : {
"description" : "Device policy of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"radiusOptions" : {
"description" : "RADIUS options of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"nasIdType" : {
"description" : "NAS ID type",
"type" : "string",
"enum" : [ "WLAN_BSSID", "AP_MAC", "Customized" ],
"default" : "WLAN_BSSID"
},
"customizedNasId" : {
"description" : "User defined NAS ID",
"type" : "string",
"maxLength" : 64,
"pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$"
},
"nasRequestTimeoutSec" : {
"description" : "NAS request timeout in seconds",
"type" : "integer",
"default" : 3,
"minimum" : 2,
"maximum" : 20
},
"nasMaxRetry" : {
"description" : "NAS request maximum retry",
"type" : "integer",
"default" : 2,
"minimum" : 2,
"maximum" : 10
},
"nasReconnectPrimaryMin" : {
"description" : "NAS reconnect primary time in minutes",
"type" : "integer",
"default" : 5,
"minimum" : 1,
"maximum" : 60
},
"calledStaIdType" : {
"description" : "Called station ID type",
"type" : "string",
"enum" : [ "WLAN_BSSID", "AP_MAC", "NONE" ],
"default" : "WLAN_BSSID"
},
"nasIpType" : {
"description" : "NAS IP type",
"type" : "string",
"enum" : [ "disabled", "control", "management", "userDefined" ],
"default" : "disabled"
},
"nasIpUserDefined" : {
"description" : "User-defined NAS IP",
"type" : "string",
"maxLength" : 45
},
"singleSessionIdAcctEnabled" : {
"description" : "When Single Accounting Session ID is enabled, APs will maintain one accounting session for client roaming",
"type" : "boolean",
"default" : false
}
}
},
"advancedOptions" : {
"description" : "Advanced settings for the WLAN.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"clientIsolationEnabled" : {
"description" : "Indicates whether wireless client isolation is enabled or disabled",
"type" : "boolean",
"default" : false
},
"clientIsolationUnicastEnabled" : {
"description" : "Indicates whether isolate unicast of wireless client isolation is enabled or disabled",
"type" : "boolean",
"default" : true
},
"clientIsolationMulticastEnabled" : {
"description" : "Indicates whether isolate multicast of wireless client isolation is enabled or disabled",
"type" : "boolean"
},
"clientIsolationAutoVrrpEnabled" : {
"description" : "Indicates whether Automatic support for VRRP of wireless client isolation is enabled or disabled",
"type" : "boolean",
"default" : false
},
"clientIsolationWhitelist" : {
"description" : "Indicates wireless client isolation whitelist",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"priority" : {
"description" : "Priority of the WLAN",
"type" : "string",
"enum" : [ "High", "Low" ],
"default" : "High"
},
"hideSsidEnabled" : {
"description" : "Indicates whether the SSID is hidden or broadcast",
"type" : "boolean",
"default" : false
},
"hs20Onboarding" : {
"description" : "Allow WISPr WLAN for Hotspot 2.0 Onboarding",
"type" : "boolean",
"default" : false
},
"maxClientsPerRadio" : {
"description" : "Maximum number of clients per radio",
"type" : "integer",
"default" : 100,
"minimum" : 1,
"maximum" : 512
},
"clientIdleTimeoutSec" : {
"description" : "Client idle timeout in seconds",
"type" : "integer",
"minimum" : 60,
"maximum" : 1000,
"default" : 120
},
"dgafEnabled" : {
"description" : "Indicates whether dgaf is enabled or disabled",
"type" : "boolean"
},
"clientLoadBalancingEnabled" : {
"description" : "Indicates whether Client Load Balancing is enabled or disabled",
"type" : "boolean",
"default" : true
},
"proxyARPEnabled" : {
"description" : "Indicates whether proxy ARP is enabled or disabled",
"type" : "boolean",
"default" : false
},
"ndProxyEnabled" : {
"description" : "Indicates whether ND Proxy is enabled or disabled",
"type" : "boolean",
"default" : false
},
"suppressNsEnabled" : {
"description" : "Indicates whether supperssNS is enabled or disabled",
"type" : "boolean",
"default" : false
},
"raProxyEnabled" : {
"description" : "Indicates whether RA proxy is enabled or disabled",
"type" : "boolean",
"default" : false
},
"rsraGuardEnabled" : {
"description" : "Indicates whether RS/RA Guard is enabled or disabled",
"type" : "boolean",
"default" : false
},
"raThrottlingEnabled" : {
"description" : "Indicates whether RA Throttling is enabled or disabled",
"type" : "boolean",
"default" : false
},
"maxAllowedRA" : {
"description" : "Max Allowed RAs",
"type" : "integer",
"minimum" : 1,
"maximum" : 1440,
"default" : 10
},
"raInterval" : {
"description" : "A timer that RA proxy runs and once receives unsolicited RA checks against the configured time and allow/drop RA based on next timeout",
"type" : "integer",
"minimum" : 1,
"maximum" : 256,
"default" : 10
},
"support80211dEnabled" : {
"description" : "Indicates whether support for 802.11d is enabled or disabled",
"type" : "boolean",
"default" : true
},
"support80211kEnabled" : {
"description" : "Indicates whether support for 802.11k is enabled or disabled",
"type" : "boolean",
"default" : true
},
"antiSpoofingEnabled" : {
"description" : "Anti-Spoofing enabled",
"type" : "boolean",
"default" : false
},
"arpRequestRateLimit" : {
"description" : "ARP packets request rate limit, default value will be 15 if both rate limit not being set.",
"type" : "integer",
"minimum" : 0,
"maximum" : 100
},
"dhcpRequestRateLimit" : {
"description" : "DHCP packets request rate limit, default value will be 15 if both rate limit not being set.",
"type" : "integer",
"minimum" : 0,
"maximum" : 100
},
"forceClientDHCPTimeoutSec" : {
"description" : "Force DHCP disconnects the client if the client does not obtain a valid IP address within the timeout peroid. To disable force DHCP, set this value to zero (0).",
"type" : "integer",
"enum" : [ 0, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15 ],
"default" : 0
},
"dhcpOption82Enabled" : {
"description" : "Indicates whether DCHP Option 82 is enabled or disabled",
"type" : "boolean",
"default" : false
},
"dhcp82Format" : {
"description" : "DHCP Option 82 format",
"type" : "string",
"enum" : [ "RUCKUS_DEFAULT", "SOFTGRE_CUSTOMIZED" ]
},
"unauthClientStatsEnabled" : {
"description" : "Indicates whether to send statistics of unauthorized clients or not",
"type" : "boolean",
"default" : false
},
"clientFingerprintingEnabled" : {
"description" : "Indicates whether client fingerprinting is enabled or disabled",
"type" : "boolean",
"default" : false
},
"ofdmOnlyEnabled" : {
"description" : "Indicates whether OFDM only is enabled or disabled",
"type" : "boolean",
"default" : false
},
"bandBalancing" : {
"description" : "Indicates whether band balancing is enabled or disabled",
"type" : "string",
"enum" : [ "Disabled", "UseZoneSetting" ],
"default" : "UseZoneSetting"
},
"bssMinRateMbps" : {
"description" : "BSS minimum rate (mbps)",
"type" : "string",
"enum" : [ "Disable", "1 mbps", "2 mbps", "5.5 mbps", "12 mbps", "24 mbps" ],
"default" : "Disable"
},
"mgmtTxRateMbps" : {
"description" : "Management TX rate (mbps)",
"type" : "string",
"enum" : [ "1 mbps", "2 mbps", "5.5 mbps", "6 mbps", "9 mbps", "11 mbps", "12 mbps", "18 mbps", "24 mbps", "36 mbps", "48 mbps", "54 mbps" ],
"default" : "2 mbps"
},
"pmkCachingEnabled" : {
"description" : "Indicator of whether PKM caching support is enabled or disabled. The default value is true when the WLAN is WPA+AES non open WLAN.",
"type" : "boolean"
},
"okcEnabled" : {
"description" : "Indicator of whether OKC support is enabled or disabled. The default value is true when the WLAN is WPA+AES non open WLAN.",
"type" : "boolean"
},
"avcEnabled" : {
"description" : "Indicator of whether ARC support is enabled or disabled",
"type" : "boolean",
"default" : false
},
"urlFilteringPolicyEnabled" : {
"description" : "Indicator of whether URL Filtering is enabled or disabled",
"type" : "boolean",
"default" : false
},
"urlFilteringPolicyId" : {
"description" : "The URL Filtering policy ID.",
"type" : "string"
},
"wifiCallingPolicyEnabled" : {
"description" : "Indicator of whether Wi-Fi Calling is enabled or disabled",
"type" : "boolean",
"default" : false
},
"wifiCallingPolicyIds" : {
"description" : "The Wi-Fi Calling policy IDs. (Maximum allowed number is 5)",
"type" : "array",
"items" : {
"type" : "string"
}
},
"uplinkEnabled" : {
"description" : "SSID Rate Limiting uplink enabled.",
"type" : "boolean",
"default" : false
},
"uplinkRate" : {
"description" : "SSID Rate Limiting uplink.",
"type" : "number",
"default" : 0.0
},
"downlinkEnabled" : {
"description" : "SSID Rate Limiting downlink enabled.",
"type" : "boolean",
"default" : false
},
"downlinkRate" : {
"description" : "SSID Rate Limiting downlink.",
"type" : "number",
"default" : 0.0
},
"ratePerSTAUplink" : {
"description" : "UE Rate Limiting uplink.",
"type" : "string"
},
"ratePerSTADownlink" : {
"description" : "UE Rate Limiting downlink.",
"type" : "string"
},
"dtimInterval" : {
"description" : "DTIM Interval",
"type" : "integer",
"minimum" : 1,
"maximum" : 255,
"default" : 1
},
"directedThreshold" : {
"description" : "Directed Threshold Setting, Defines the client count at which an AP will stop converting group addressed data traffic to unicast.",
"type" : "integer",
"minimum" : 0,
"maximum" : 128,
"default" : 5
},
"flowLogEnabled" : {
"description" : "Flow log enabled.",
"type" : "boolean",
"default" : false
},
"hdOverheadOptimizeEnable" : {
"description" : "Airtime decongestion enabled.",
"type" : "boolean",
"default" : false
},
"probeRssiThr" : {
"type" : "integer",
"description" : "Join RSSI threshold.",
"minimum" : -90,
"maximum" : -60,
"default" : -85
},
"transientClientMgmtEnable" : {
"description" : "Transient Client Management enabled.",
"type" : "boolean",
"default" : false
},
"joinIgnoreTimeout" : {
"description" : "Join wait time.",
"type" : "integer",
"minimum" : 1,
"maximum" : 60,
"default" : 30
},
"joinAcceptTimeout" : {
"description" : "Join expire time.",
"type" : "integer",
"minimum" : 1,
"maximum" : 300,
"default" : 300
},
"joinIgnoreThr" : {
"description" : "Join wait threshold.",
"type" : "integer",
"minimum" : 1,
"maximum" : 50,
"default" : 10
},
"authRssiThr" : {
"description" : "Auth RSSI threshold.",
"type" : "integer",
"minimum" : -90,
"maximum" : -60
},
"assocRssiThr" : {
"description" : "Assoc RSSI threshold.",
"type" : "integer",
"minimum" : -90,
"maximum" : -60
},
"oceEnabled" : {
"description" : "Optimized Connectivity Experience(OCE) enabled.",
"type" : "boolean",
"default" : false
},
"oceBroadcastProbeResponseDelay" : {
"description" : "Broadcast probe response delay.",
"type" : "integer",
"minimum" : 8,
"maximum" : 120,
"default" : 15
},
"oceRssiBasedAssociationRejectionThreshold" : {
"description" : "RSSI-based association rejection threshold.",
"type" : "integer",
"minimum" : -90,
"maximum" : -60,
"default" : -75
}
}
},
"diffServProfile" : {
"description" : "DiffServ profile of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"qosMaps" : {
"description" : "Qos map set of the WLAN.",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"enable" : {
"description" : "Enabled or disabled",
"type" : "boolean"
},
"priority" : {
"description" : "Priority",
"type" : "integer"
},
"low" : {
"description" : "DSCP range - low",
"type" : [ "integer", "null" ],
"minimum" : 0,
"maximum" : 255
},
"high" : {
"description" : "DSCP range - high",
"type" : [ "integer", "null" ],
"minimum" : 0,
"maximum" : 255
},
"excepts" : {
"type" : [ "array", "null" ],
"items" : {
"type" : "integer",
"minimum" : 0,
"maximum" : 63
}
}
},
"required" : [ "enable", "priority" ]
}
},
"dpsk" : {
"description" : "DPSK Setting",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"dpskEnabled" : {
"description" : "DPSK enabled",
"type" : "boolean",
"default" : false
},
"length" : {
"description" : "Length of DPSK key",
"type" : "integer",
"default" : 62
},
"dpskType" : {
"description" : "Type of DPSK key",
"type" : "string",
"enum" : [ "Secure", "KeyboardFriendly", "NumbersOnly" ],
"default" : "Secure"
},
"expiration" : {
"description" : "Expiration of DPSK key",
"type" : "string",
"enum" : [ "Unlimited", "OneDay", "TwoDays", "OneWeek", "TwoWeeks", "OneMonth", "SixMonths", "OneYear", "TwoYears" ],
"default" : "Unlimited"
},
"dpskFromType" : {
"description" : "Type of expiration start from",
"type" : "string",
"enum" : [ "CreateTime", "FirstUse" ],
"default" : "CreateTime"
}
}
},
"externalDpsk" : {
"description" : "External DPSK Enabled",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"enabled" : {
"description" : "Enable External DPSK",
"type" : "boolean",
"default" : false
},
"encryption" : {
"description" : "Encryption of the WLAN relate to external DPSK",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"method" : {
"description" : "Encryption method",
"type" : "string",
"enum" : [ "WPA2", "WPA_Mixed", "None" ]
},
"algorithm" : {
"description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
"type" : "string",
"enum" : [ "AES", "TKIP_AES" ]
}
}
},
"authService" : {
"description" : "Autentication of the WLAN relate to external DPSK",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Identifier of the authentication service. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the authentication service. At least one ID or name is required in the request.",
"type" : "string"
}
}
}
},
"required" : [ "enabled" ]
},
"dnsServerProfile" : {
"description" : "DNS server profile of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"accessTunnelProfile" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"accessIpsecProfile" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"splitTunnelProfileId" : {
"type" : "string"
},
"portalDetectionProfileId" : {
"type" : "string"
}
},
"required" : [ "name", "ssid" ]
}201Body
{
"id": "wlanID"
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
}
}
}Modify ¶
PATCH/v8_0/rkszones/{zoneId}/wlans/{id}
Use this API command to modify the basic information of a WLAN.
Body
{
"name": "wlanName",
"ssid": "wlanSSID",
"description": "wlanDescription",
"accessTunnelType": "RuckusGRE",
"accessTunnelProfile": {
"id": "f5b92938-aa4e-4d02-90ea-273799ff689b",
"name": "Default Tunnel Profile"
},
"splitTunnelProfileId": "38119bac-49e1-4410-ab8e-1c1bc88dd770",
"coreTunnelProfile": {
"type": "Bridge",
"id": "forwardingUUID",
"name": "forwardingName"
},
"macAuth": {
"macAuthMacFormat": "802.1X",
"customizedPassword": "password"
},
"encryption": {
"method": "WPA2",
"algorithm": "AES",
"passphrase": "password",
"mfp": "disabled",
"support80211rEnabled": true,
"mobilityDomainId": 3
},
"authServiceOrProfile": {
"throughController": true,
"id": "authServiceUUID",
"locationDeliveryEnabled": true,
"authenticationOption": null
},
"operatorRealm": "operator realm",
"accountingServiceOrProfile": {
"throughController": false,
"id": "accountingServiceUUID",
"name": "accountingServiceName",
"interimUpdateMin": 10,
"accountingDelayEnabled": false,
"accountingTTGSessionEnabled": false
},
"portalServiceProfile": {
"id": "portalServiceUUID",
"name": "portalServiceName"
},
"hotspot20Profile": {
"id": "hotspot20ServiceUUID",
"name": "hotspot20ServiceName"
},
"defaultUserTrafficProfile": {
"id": "userTrafficUUID",
"name": "userTrafficName"
},
"precedenceProfileId": "c514d450-c839-9527-afc9-525400d12345",
"portalDetectionProfileId": "de0fa30c-9565-11e8-9eb6-529269fb1459",
"schedule": {
"type": "Customized",
"id": "ServiceUUID",
"name": "ServiceName"
},
"vlan": {
"accessVlan": 23,
"aaaVlanOverride": true,
"coreQinQEnabled": false,
"coreSVlan": 10
},
"l2ACL": {
"id": "l2ACLUUID",
"name": "l2ACLName"
},
"devicePolicy": {
"id": "devicePolicyUUID",
"name": "devicePolicyName"
},
"radiusOptions": {
"nasIdType": "Customized",
"customizedNasId": "nasId",
"nasRequestTimeoutSec": 12,
"nasMaxRetry": 3,
"nasReconnectPrimaryMin": 30,
"calledStaIdType": "WLAN_BSSID",
"nasIpType": "disabled",
"nasIpUserDefined": "192.168.1.1",
"singleSessionIdAcctEnabled": false
},
"advancedOptions": {
"clientIsolationEnabled": true,
"clientIsolationUnicastEnabled": true,
"clientIsolationMulticastEnabled": false,
"clientIsolationAutoVrrpEnabled": false,
"clientIsolationWhitelist": {
"id": "24f24c00-0b47-11e4-a9b5-000c29b1347d",
"name": "myWhitelist"
},
"priority": "High",
"hideSsidEnabled": true,
"maxClientsPerRadio": 12,
"clientIdleTimeoutSec": 60,
"clientLoadBalancingEnabled": true,
"proxyARPEnabled": true,
"ndProxyEnabled": false,
"suppressNsEnabled": false,
"raProxyEnabled": false,
"rsraGuardEnabled": false,
"raThrottlingEnabled": false,
"maxAllowedRA": 10,
"raInterval": 10,
"support80211dEnabled": false,
"support80211kEnabled": true,
"forceClientDHCPTimeoutSec": 5,
"dhcpOption82Enabled": true,
"dhcp82Format": "RUCKUS_DEFAULT",
"unauthClientStatsEnabled": false,
"clientFingerprintingEnabled": true,
"ofdmOnlyEnabled": false,
"bandBalancing": "UseZoneSetting",
"bssMinRateMbps": "Disable",
"mgmtTxRateMbps": "2 mbps",
"hs20Onboarding": false,
"avcEnabled": true,
"urlFilteringPolicyEnabled": false,
"urlFilteringPolicyId": "",
"wifiCallingPolicyEnabled": false,
"wifiCallingPolicyIds": [],
"uplinkEnabled": true,
"uplinkRate": 1800,
"downlinkEnabled": true,
"downlinkRate": 2000,
"ratePerSTAUplink": "650mbps",
"ratePerSTADownlink": "1mbps",
"dtimInterval": 1,
"directedThreshold": 5
},
"diffServProfile": {
"id": "diffServId",
"name": "diffServName"
},
"qosMaps": [
{
"enable": true,
"priority": 0,
"low": 0,
"high": 7,
"excepts": null
},
{
"enable": true,
"priority": 1,
"low": 8,
"high": 15,
"excepts": null
},
{
"enable": true,
"priority": 2,
"low": 16,
"high": 23,
"excepts": null
},
{
"enable": true,
"priority": 3,
"low": 0,
"high": 32,
"excepts": [
43,
45,
60
]
},
{
"enable": true,
"priority": 4,
"low": 32,
"high": 39,
"excepts": null
},
{
"enable": true,
"priority": 5,
"low": 40,
"high": 47,
"excepts": null
},
{
"enable": true,
"priority": 6,
"low": 48,
"high": 55,
"excepts": [
46
]
},
{
"enable": true,
"priority": 7,
"low": 56,
"high": 63,
"excepts": null
}
],
"dnsServerProfile": {
"id": "DNS server profile UUID",
"name": "DNS server profile name"
},
"dpsk": {
"dpskEnabled": true,
"length": 8,
"dpskType": "Secure",
"expiration": "OneDay",
"dpskFromType": "FirstUse"
},
"externalDpsk": {
"enabled": true,
"encryption": {
"method": "WPA2",
"algorithm": "AES"
},
"authService": {
"id": "authServiceUUID"
}
}
}Schema
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"name" : {
"description" : "Name of the WLAN",
"type" : "string",
"minLength" : 1,
"maxLength" : 32
},
"ssid" : {
"description" : "SSID of the WLAN",
"type" : "string",
"minLength" : 1,
"maxLength" : 32
},
"hessid" : {
"description" : "HESSID of the WLAN",
"type" : "string",
"pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$"
},
"description" : {
"description" : "Description of the WLAN",
"type" : [ "string", "null" ],
"maxLength" : 64
},
"bypassCNA" : {
"description" : "Bypass Capitive Network Assitance",
"type" : "boolean"
},
"caleaEnabled" : {
"description" : "DP CALEA Server Enabled",
"type" : "boolean"
},
"dpTunnelNatEnabled" : {
"description" : "DP Tunnel NAT Enabled",
"type" : "boolean"
},
"dpTunnelDhcpEnabled" : {
"description" : "DP Tunnel DHCP Enabled",
"type" : "boolean"
},
"awsExtNasIPEnable" : {
"description" : "Aws ExtNasIP Enable",
"type" : "boolean"
},
"awsVenueEnable" : {
"description" : "Aws Venue Enable",
"type" : "boolean"
},
"accessTunnelType" : {
"description" : "Access tunnel type of the WLAN. APLBO means AP local breakout, RuckusGRE means RuckusGRE tunnel to the data plane, and SoftGRE means AP direct SoftGRE tunnel",
"type" : "string",
"enum" : [ "APLBO", "RuckusGRE", "SoftGRE" ]
},
"coreTunnelProfile" : {
"description" : "Core tunnel of the WLAN. This only applies when the access tunnel type is set to RuckusGRE.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"type" : {
"description" : "Tunnel type",
"type" : "string",
"enum" : [ "Bridge", "L2oGRE", "TTG_PDG", "Mixed" ]
},
"id" : {
"description" : "Identifier of the forwarding profile. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the forwarding profile. At least one ID or name is required in the request.",
"type" : "string"
},
"operatorRealm" : {
"description" : "Operator realm, deprecated coreTunnelProfile.operatorRealm from version3.1, prepare remove",
"type" : "string",
"maxLength" : 255,
"pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
}
},
"required" : [ "type" ]
},
"macAuth" : {
"description" : "MAC address authentication settings of the WLAN. This only applies to standard MAC and Hotspot MAC bypass WLAN.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"macAuthMacFormat" : {
"description" : "MAC address format. The default format is 0010a42319c0 and the 802.1X format is 00-10-A4-23-19-C0.",
"type" : "string",
"enum" : [ "Default", "802.1X", "UpperColon", "Upper", "LowerDash", "LowerColon" ]
},
"customizedPassword" : {
"description" : "User defined password. When this field is set to an empty string, the MAC address is used as password.",
"type" : "string",
"maxLength" : 64,
"pattern" : "^([!-;=?-~]([ -;=?-~]){0,62}[!-;=?-~]|[!-;=?-~]{1,1}|\s{0,0})$"
}
}
},
"encryption" : {
"description" : "Encryption of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"method" : {
"description" : "Encryption method",
"type" : "string",
"enum" : [ "WPA2", "WPA_Mixed", "WEP_64", "WEP_128", "None" ]
},
"algorithm" : {
"description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
"type" : "string",
"enum" : [ "AES", "TKIP_AES" ]
},
"passphrase" : {
"description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
"type" : "string"
},
"mfp" : {
"description" : "Management frame protection. This only applies to WPA2 + AES",
"type" : "string",
"enum" : [ "disabled", "capable", "required" ]
},
"keyIndex" : {
"description" : "Key index. This only applies to WEP64 and WEP128.",
"type" : "integer"
},
"keyInHex" : {
"description" : "Key in hex format. This only applies to WEP64 and WEP128.",
"type" : "string"
},
"support80211rEnabled" : {
"description" : "Enable 802.11r Fast BSS Transition, fast Romaing.",
"type" : "boolean"
},
"mobilityDomainId" : {
"description" : "mobility Domain Id.",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
}
},
"required" : [ "method" ]
},
"authServiceOrProfile" : {
"description" : "Authentication of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"throughController" : {
"description" : "Indicates whether authentication messages were sent through the controller or not",
"type" : "boolean"
},
"realmBasedAuth" : {
"type" : "boolean"
},
"id" : {
"description" : "Identifier of the authentication service or profile. At least one ID or name or authenticationOption is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the authentication service or profile. At least one ID or name or authenticationOption is required in the request. Or could input the 'Always Accept' or 'Local DB'.",
"type" : "string"
},
"authenticationOption" : {
"description" : "Option of the authentication service or profile, At least one ID or name or authenticationOption is required in the request. This only applies to hotspot and guest WLANs.",
"type" : [ "string", "null" ],
"enum" : [ "Local DB", "Guest", "Always Accept", null ]
},
"locationDeliveryEnabled" : {
"description" : "RFC5580 location delivery support",
"type" : "boolean"
},
"backupAuthenticationId" : {
"description" : "Identifier of the backup authentication service or profile. At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service.",
"type" : "string"
},
"backupAuthenticationName" : {
"description" : "Name of the backup authentication service or profile. At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service. Or could input the 'Always Accept'.",
"type" : "string"
},
"backupAuthenticationOption" : {
"description" : "Option of the backup authentication service or profile, At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service. This only applies to hotspot WLANs.",
"type" : [ "string", "null" ],
"enum" : [ "Always Accept", null ]
}
}
},
"operatorRealm" : {
"description" : "Operator realm, operatorRealm only supports coreTunnelProfile type is authServiceOrProfile.locationDeliveryEnabled is true",
"type" : "string",
"maxLength" : 255,
"pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
},
"accountingServiceOrProfile" : {
"description" : "Accounting of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"throughController" : {
"description" : "Indicates whether accounting messages were sent through the controller",
"type" : "boolean"
},
"realmBasedAcct" : {
"type" : "boolean"
},
"id" : {
"description" : "Accounting service or profile ID. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Accounting service or profile name. At least one ID or name is required in the request.",
"type" : "string"
},
"interimUpdateMin" : {
"description" : "Interval (in minutes) for sending interim updates",
"type" : "integer",
"minimum" : 0,
"maximum" : 1440
},
"accountingDelayEnabled" : {
"description" : "Indicates whether accounting delay time is enabled",
"type" : "boolean"
},
"accountingTTGSessionEnabled" : {
"description" : "Indicates whether accounting for TTG sessions is to enabled",
"type" : "boolean"
},
"backupAccountingId" : {
"description" : "Backup accounting service or profile ID. At least one backupAccountingId or backupAccountingName is required in the request when setting backup accounting service.",
"type" : "string"
},
"backupAccountingName" : {
"description" : "Backup accounting service or profile name. At least one backupAccountingId or backupAccountingName is required in the request when setting backup accounting service.",
"type" : "string"
}
}
},
"portalServiceProfile" : {
"description" : "Portal service of the WLAN. This only applies to hotspot, hotspot MAC bypass, guest and web auth WLANs.",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"hotspot20Profile" : {
"description" : "Hotspot 2.0 operator profile of the WLAN. id or name of the hotspot 2.0 operator profiles within the zone is required.",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"defaultUserTrafficProfile" : {
"description" : "User traffic profile of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"precedenceProfileId" : {
"description" : "Precedence profile of the WLAN",
"type" : "string"
},
"schedule" : {
"description" : "Schedule of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"type" : {
"description" : "Type of WLAN schedule",
"type" : "string",
"enum" : [ "AlwaysOn", "AlwaysOff", "Customized" ]
},
"id" : {
"description" : "Identifier of the schedule profile. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the schedule profile. At least one ID or name is required in the request.",
"type" : "string"
}
},
"required" : [ "type" ]
},
"vlan" : {
"description" : "VLAN (access and/or core) of the WLAN.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"accessVlan" : {
"description" : "Access VLAN ID",
"type" : "integer",
"minimum" : 1,
"maximum" : 4094
},
"aaaVlanOverride" : {
"description" : "Indicates whether the AAA VLAN settings can be overriden or not",
"type" : "boolean"
},
"coreQinQEnabled" : {
"description" : "Indicates whether Q-in-Q is allowed at the core network or not",
"type" : "boolean"
},
"coreSVlan" : {
"description" : "Core SVLAN ID. This only applies when core Q-in-Q is enabled",
"type" : "integer",
"minimum" : 1,
"maximum" : 4094
},
"vlanPooling" : {
"description" : "Vlan pooling",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
}
}
},
"l2ACL" : {
"description" : "Layer 2 ACL of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"devicePolicy" : {
"description" : "Device policy of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"radiusOptions" : {
"description" : "RADIUS options of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"nasIdType" : {
"description" : "NAS ID type",
"type" : "string",
"enum" : [ "WLAN_BSSID", "AP_MAC", "Customized" ]
},
"customizedNasId" : {
"description" : "User defined NAS ID",
"type" : "string",
"maxLength" : 64,
"pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$"
},
"nasRequestTimeoutSec" : {
"description" : "NAS request timeout in seconds",
"type" : "integer",
"minimum" : 2,
"maximum" : 20
},
"nasMaxRetry" : {
"description" : "NAS request maximum retry",
"type" : "integer",
"minimum" : 2,
"maximum" : 10
},
"nasReconnectPrimaryMin" : {
"description" : "NAS reconnect primary time in minutes",
"type" : "integer",
"minimum" : 1,
"maximum" : 60
},
"calledStaIdType" : {
"description" : "Called station ID type",
"type" : "string",
"enum" : [ "WLAN_BSSID", "AP_MAC", "NONE" ]
},
"nasIpType" : {
"description" : "NAS IP type",
"type" : "string",
"enum" : [ "disabled", "control", "management", "userDefined" ]
},
"nasIpUserDefined" : {
"description" : "User-defined NAS IP",
"type" : "string",
"maxLength" : 45
},
"singleSessionIdAcctEnabled" : {
"description" : "When Single Accounting Session ID is enabled, APs will maintain one accounting session for client roaming",
"type" : "boolean"
}
}
},
"advancedOptions" : {
"description" : "Advanced settings for the WLAN.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"clientIsolationEnabled" : {
"description" : "Indicates whether wireless client isolation is enabled or disabled",
"type" : "boolean"
},
"clientIsolationUnicastEnabled" : {
"description" : "Indicates whether isolate unicast of wireless client isolation is enabled or disabled",
"type" : "boolean"
},
"clientIsolationMulticastEnabled" : {
"description" : "Indicates whether isolate multicast of wireless client isolation is enabled or disabled",
"type" : "boolean"
},
"clientIsolationAutoVrrpEnabled" : {
"description" : "Indicates whether Automatic support for VRRP of wireless client isolation is enabled or disabled",
"type" : "boolean"
},
"clientIsolationWhitelist" : {
"description" : "Indicates wireless client isolation whitelist",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"priority" : {
"description" : "Priority of the WLAN",
"type" : "string",
"enum" : [ "High", "Low" ]
},
"hideSsidEnabled" : {
"description" : "Indicates whether the SSID is hidden or broadcast",
"type" : "boolean"
},
"hs20Onboarding" : {
"description" : "Allow WISPr WLAN for Hotspot 2.0 Onboarding",
"type" : "boolean"
},
"maxClientsPerRadio" : {
"description" : "Maximum number of clients per radio",
"type" : "integer",
"minimum" : 1,
"maximum" : 512
},
"clientIdleTimeoutSec" : {
"description" : "Client idle timeout in seconds",
"type" : "integer",
"minimum" : 60,
"maximum" : 1000
},
"dgafEnabled" : {
"description" : "Indicates whether dgaf is enabled or disabled",
"type" : "boolean"
},
"clientLoadBalancingEnabled" : {
"description" : "Indicates whether Client Load Balancing is enabled or disabled",
"type" : "boolean"
},
"proxyARPEnabled" : {
"description" : "Indicates whether proxy ARP is enabled or disabled",
"type" : "boolean"
},
"ndProxyEnabled" : {
"description" : "Indicates whether ND Proxy is enabled or disabled",
"type" : "boolean"
},
"suppressNsEnabled" : {
"description" : "Indicates whether supperssNS is enabled or disabled",
"type" : "boolean"
},
"raProxyEnabled" : {
"description" : "Indicates whether RA proxy is enabled or disabled",
"type" : "boolean"
},
"rsraGuardEnabled" : {
"description" : "Indicates whether RS/RA Guard is enabled or disabled",
"type" : "boolean"
},
"raThrottlingEnabled" : {
"description" : "Indicates whether RA Throttling is enabled or disabled",
"type" : "boolean"
},
"maxAllowedRA" : {
"description" : "Max Allowed RAs",
"type" : "integer",
"minimum" : 1,
"maximum" : 1440
},
"raInterval" : {
"description" : "A timer that RA proxy runs and once receives unsolicited RA checks against the configured time and allow/drop RA based on next timeout",
"type" : "integer",
"minimum" : 1,
"maximum" : 256
},
"support80211dEnabled" : {
"description" : "Indicates whether support for 802.11d is enabled or disabled",
"type" : "boolean"
},
"support80211kEnabled" : {
"description" : "Indicates whether support for 802.11k is enabled or disabled",
"type" : "boolean"
},
"antiSpoofingEnabled" : {
"description" : "Anti-Spoofing enabled",
"type" : "boolean"
},
"arpRequestRateLimit" : {
"description" : "ARP packets request rate limit, default value will be 15 if both rate limit not being set.",
"type" : "integer",
"minimum" : 0,
"maximum" : 100
},
"dhcpRequestRateLimit" : {
"description" : "DHCP packets request rate limit, default value will be 15 if both rate limit not being set.",
"type" : "integer",
"minimum" : 0,
"maximum" : 100
},
"forceClientDHCPTimeoutSec" : {
"description" : "Force DHCP disconnects the client if the client does not obtain a valid IP address within the timeout peroid. To disable force DHCP, set this value to zero (0).",
"type" : "integer",
"enum" : [ 0, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15 ]
},
"dhcpOption82Enabled" : {
"description" : "Indicates whether DCHP Option 82 is enabled or disabled",
"type" : "boolean"
},
"dhcp82Format" : {
"description" : "DHCP Option 82 format",
"type" : "string",
"enum" : [ "RUCKUS_DEFAULT", "SOFTGRE_CUSTOMIZED" ]
},
"unauthClientStatsEnabled" : {
"description" : "Indicates whether to send statistics of unauthorized clients or not",
"type" : "boolean"
},
"clientFingerprintingEnabled" : {
"description" : "Indicates whether client fingerprinting is enabled or disabled",
"type" : "boolean"
},
"ofdmOnlyEnabled" : {
"description" : "Indicates whether OFDM only is enabled or disabled",
"type" : "boolean"
},
"bandBalancing" : {
"description" : "Indicates whether band balancing is enabled or disabled",
"type" : "string",
"enum" : [ "Disabled", "UseZoneSetting" ]
},
"bssMinRateMbps" : {
"description" : "BSS minimum rate (mbps)",
"type" : "string",
"enum" : [ "Disable", "1 mbps", "2 mbps", "5.5 mbps", "12 mbps", "24 mbps" ]
},
"mgmtTxRateMbps" : {
"description" : "Management TX rate (mbps)",
"type" : "string",
"enum" : [ "1 mbps", "2 mbps", "5.5 mbps", "6 mbps", "9 mbps", "11 mbps", "12 mbps", "18 mbps", "24 mbps", "36 mbps", "48 mbps", "54 mbps" ]
},
"pmkCachingEnabled" : {
"description" : "Indicator of whether PKM caching support is enabled or disabled. The default value is true when the WLAN is WPA+AES non open WLAN.",
"type" : "boolean"
},
"okcEnabled" : {
"description" : "Indicator of whether OKC support is enabled or disabled. The default value is true when the WLAN is WPA+AES non open WLAN.",
"type" : "boolean"
},
"avcEnabled" : {
"description" : "Indicator of whether ARC support is enabled or disabled",
"type" : "boolean"
},
"urlFilteringPolicyEnabled" : {
"description" : "Indicator of whether URL Filtering is enabled or disabled",
"type" : "boolean"
},
"urlFilteringPolicyId" : {
"description" : "The URL Filtering policy ID.",
"type" : "string"
},
"wifiCallingPolicyEnabled" : {
"description" : "Indicator of whether Wi-Fi Calling is enabled or disabled",
"type" : "boolean"
},
"wifiCallingPolicyIds" : {
"description" : "The Wi-Fi Calling policy IDs. (Maximum allowed number is 5)",
"type" : "array",
"items" : {
"type" : "string"
}
},
"uplinkEnabled" : {
"description" : "SSID Rate Limiting uplink enabled.",
"type" : "boolean"
},
"uplinkRate" : {
"description" : "SSID Rate Limiting uplink.",
"type" : "number"
},
"downlinkEnabled" : {
"description" : "SSID Rate Limiting downlink enabled.",
"type" : "boolean"
},
"downlinkRate" : {
"description" : "SSID Rate Limiting downlink.",
"type" : "number"
},
"ratePerSTAUplink" : {
"description" : "UE Rate Limiting uplink.",
"type" : "string"
},
"ratePerSTADownlink" : {
"description" : "UE Rate Limiting downlink.",
"type" : "string"
},
"dtimInterval" : {
"description" : "DTIM Interval",
"type" : "integer",
"minimum" : 1,
"maximum" : 255
},
"directedThreshold" : {
"description" : "Directed Threshold Setting, Defines the client count at which an AP will stop converting group addressed data traffic to unicast.",
"type" : "integer",
"minimum" : 0,
"maximum" : 128
},
"flowLogEnabled" : {
"description" : "Flow log enabled.",
"type" : "boolean"
},
"hdOverheadOptimizeEnable" : {
"description" : "Airtime decongestion enabled.",
"type" : "boolean"
},
"probeRssiThr" : {
"type" : "integer",
"description" : "Join RSSI threshold.",
"minimum" : -90,
"maximum" : -60
},
"transientClientMgmtEnable" : {
"description" : "Transient Client Management enabled.",
"type" : "boolean"
},
"joinIgnoreTimeout" : {
"description" : "Join wait time.",
"type" : "integer",
"minimum" : 1,
"maximum" : 60
},
"joinAcceptTimeout" : {
"description" : "Join expire time.",
"type" : "integer",
"minimum" : 1,
"maximum" : 300
},
"joinIgnoreThr" : {
"description" : "Join wait threshold.",
"type" : "integer",
"minimum" : 1,
"maximum" : 50
},
"authRssiThr" : {
"description" : "Auth RSSI threshold.",
"type" : "integer",
"minimum" : -90,
"maximum" : -60
},
"assocRssiThr" : {
"description" : "Assoc RSSI threshold.",
"type" : "integer",
"minimum" : -90,
"maximum" : -60
},
"oceEnabled" : {
"description" : "Optimized Connectivity Experience(OCE) enabled.",
"type" : "boolean"
},
"oceBroadcastProbeResponseDelay" : {
"description" : "Broadcast probe response delay.",
"type" : "integer",
"minimum" : 8,
"maximum" : 120
},
"oceRssiBasedAssociationRejectionThreshold" : {
"description" : "RSSI-based association rejection threshold.",
"type" : "integer",
"minimum" : -90,
"maximum" : -60
}
}
},
"diffServProfile" : {
"description" : "DiffServ profile of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"qosMaps" : {
"description" : "Qos map set of the WLAN.",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"enable" : {
"description" : "Enabled or disabled",
"type" : "boolean"
},
"priority" : {
"description" : "Priority",
"type" : "integer"
},
"low" : {
"description" : "DSCP range - low",
"type" : [ "integer", "null" ],
"minimum" : 0,
"maximum" : 255
},
"high" : {
"description" : "DSCP range - high",
"type" : [ "integer", "null" ],
"minimum" : 0,
"maximum" : 255
},
"excepts" : {
"type" : [ "array", "null" ],
"items" : {
"type" : "integer",
"minimum" : 0,
"maximum" : 63
}
}
},
"required" : [ "enable", "priority" ]
}
},
"dpsk" : {
"description" : "DPSK Setting",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"dpskEnabled" : {
"description" : "DPSK enabled",
"type" : "boolean"
},
"length" : {
"description" : "Length of DPSK key",
"type" : "integer"
},
"dpskType" : {
"description" : "Type of DPSK key",
"type" : "string",
"enum" : [ "Secure", "KeyboardFriendly", "NumbersOnly" ]
},
"expiration" : {
"description" : "Expiration of DPSK key",
"type" : "string",
"enum" : [ "Unlimited", "OneDay", "TwoDays", "OneWeek", "TwoWeeks", "OneMonth", "SixMonths", "OneYear", "TwoYears" ]
},
"dpskFromType" : {
"description" : "Type of expiration start from",
"type" : "string",
"enum" : [ "CreateTime", "FirstUse" ]
}
}
},
"externalDpsk" : {
"description" : "External DPSK Enabled",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"enabled" : {
"description" : "Enable External DPSK",
"type" : "boolean"
},
"encryption" : {
"description" : "Encryption of the WLAN relate to external DPSK",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"method" : {
"description" : "Encryption method",
"type" : "string",
"enum" : [ "WPA2", "WPA_Mixed", "None" ]
},
"algorithm" : {
"description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
"type" : "string",
"enum" : [ "AES", "TKIP_AES" ]
}
}
},
"authService" : {
"description" : "Autentication of the WLAN relate to external DPSK",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Identifier of the authentication service. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the authentication service. At least one ID or name is required in the request.",
"type" : "string"
}
}
}
},
"required" : [ "enabled" ]
},
"dnsServerProfile" : {
"description" : "DNS server profile of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"accessTunnelProfile" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"accessIpsecProfile" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"splitTunnelProfileId" : {
"type" : "string"
},
"portalDetectionProfileId" : {
"type" : "string"
}
}
}204Modify Authentication ¶
PATCH/v8_0/rkszones/{zoneId}/wlans/{id}/authServiceOrProfile
Use this API command to modify the authentication method of a WLAN.
Body
{
"throughController": true,
"id": "authServiceUUID",
"locationDeliveryEnabled": true,
"authenticationOption": null
}Schema
{
"description": "Authentication of the WLAN",
"type": "object",
"additionalProperties": false,
"properties": {
"throughController": {
"description": "Indicates whether authentication messages were sent through the controller or not",
"type": "boolean"
},
"realmBasedAuth": {
"type": "boolean"
},
"id": {
"description": "Identifier of the authentication service or profile. At least one ID or name or authenticationOption is required in the request.",
"type": "string"
},
"name": {
"description": "Name of the authentication service or profile. At least one ID or name or authenticationOption is required in the request. Or could input the 'Always Accept' or 'Local DB'.",
"type": "string"
},
"authenticationOption": {
"description": "Option of the authentication service or profile, At least one ID or name or authenticationOption is required in the request. This only applies to hotspot and guest WLANs.",
"type": [
"string",
"null"
],
"enum": [
"Local DB",
"Guest",
"Always Accept",
null
]
},
"locationDeliveryEnabled": {
"description": "RFC5580 location delivery support",
"type": "boolean"
},
"backupAuthenticationId": {
"description": "Identifier of the backup authentication service or profile. At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service.",
"type": "string"
},
"backupAuthenticationName": {
"description": "Name of the backup authentication service or profile. At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service. Or could input the 'Always Accept'.",
"type": "string"
},
"backupAuthenticationOption": {
"description": "Option of the backup authentication service or profile, At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service. This only applies to hotspot WLANs.",
"type": [
"string",
"null"
],
"enum": [
"Always Accept",
null
]
}
}
}204Modify MAC Auth ¶
PATCH/v8_0/rkszones/{zoneId}/wlans/{id}/macAuth
Use this API command to modify the MAC authentication settings of a WLAN. macAuthMacFormat : Open (aabbccddeeff), 802.1X (AA-BB-CC-DD-EE-FF), UpperColon (AA:BB:CC:DD:EE:FF), Upper (AABBCCDDEEFF), LowerDash (aa-bb-cc-dd-ee-ff) and LowerColon (aa:bb:cc:dd:ee:ff).
Body
{
"macAuthMacFormat": "802.1X",
"customizedPassword": "password"
}Schema
{
"description" : "MAC address authentication settings of the WLAN. This only applies to standard MAC and Hotspot MAC bypass WLAN.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"macAuthMacFormat" : {
"description" : "MAC address format. The default format is 0010a42319c0 and the 802.1X format is 00-10-A4-23-19-C0.",
"type" : "string",
"enum" : [ "Default", "802.1X", "UpperColon", "Upper", "LowerDash", "LowerColon" ]
},
"customizedPassword" : {
"description" : "User defined password. When this field is set to an empty string, the MAC address is used as password.",
"type" : "string",
"maxLength" : 64,
"pattern" : "^([!-;=?-~]([ -;=?-~]){0,62}[!-;=?-~]|[!-;=?-~]{1,1}|\s{0,0})$"
}
}
}204Modify Accounting ¶
PATCH/v8_0/rkszones/{zoneId}/wlans/{id}/accountingServiceOrProfile
Use this API command to modify the accounting settings of a WLAN.
Body
{
"throughController": false,
"id": "accountingServiceUUID",
"name": "accountingServiceName",
"interimUpdateMin": 10,
"accountingDelayEnabled": false,
"accountingTTGSessionEnabled": false
}Schema
{
"description": "Accounting of the WLAN",
"type": "object",
"additionalProperties": false,
"properties": {
"throughController": {
"description": "Indicates whether accounting messages were sent through the controller",
"type": "boolean"
},
"realmBasedAcct": {
"type": "boolean"
},
"id": {
"description": "Accounting service or profile ID. At least one ID or name is required in the request.",
"type": "string"
},
"name": {
"description": "Accounting service or profile name. At least one ID or name is required in the request.",
"type": "string"
},
"interimUpdateMin": {
"description": "Interval (in minutes) for sending interim updates",
"type": "integer",
"minimum": 0,
"maximum": 1440
},
"accountingDelayEnabled": {
"description": "Indicates whether accounting delay time is enabled",
"type": "boolean"
},
"accountingTTGSessionEnabled": {
"description": "Indicates whether accounting for TTG sessions is to enabled",
"type": "boolean"
},
"backupAccountingId": {
"description": "Backup accounting service or profile ID. At least one backupAccountingId or backupAccountingName is required in the request when setting backup accounting service.",
"type": "string"
},
"backupAccountingName": {
"description": "Backup accounting service or profile name. At least one backupAccountingId or backupAccountingName is required in the request when setting backup accounting service.",
"type": "string"
}
}
}204Modify Encryption ¶
PATCH/v8_0/rkszones/{zoneId}/wlans/{id}/encryption
Use this API command to modify the encryption settings of a WLAN.
Body
{
"method": "WPA2",
"algorithm": "AES",
"passphrase": "password",
"mfp": "disabled",
"support80211rEnabled": true,
"mobilityDomainId": 3
}Schema
{
"description": "Encryption of the WLAN",
"type": "object",
"additionalProperties": false,
"properties": {
"method": {
"description": "Encryption method",
"type": "string",
"enum": [
"WPA2",
"WPA_Mixed",
"WEP_64",
"WEP_128",
"None"
]
},
"algorithm": {
"description": "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
"type": "string",
"enum": [
"AES",
"TKIP_AES"
]
},
"passphrase": {
"description": "Passphrase. This only applies to WPA2 and WPA mixed mode.",
"type": "string"
},
"mfp": {
"description": "Management frame protection. This only applies to WPA2 + AES",
"type": "string",
"enum": [
"disabled",
"capable",
"required"
]
},
"keyIndex": {
"description": "Key index. This only applies to WEP64 and WEP128.",
"type": "integer"
},
"keyInHex": {
"description": "Key in hex format. This only applies to WEP64 and WEP128.",
"type": "string"
},
"support80211rEnabled": {
"description": "Enable 802.11r Fast BSS Transition, fast Romaing.",
"type": "boolean"
},
"mobilityDomainId": {
"description": "mobility Domain Id.",
"type": "integer",
"minimum": 1,
"maximum": 65535
}
},
"required": [
"method"
]
}204Modify Core Tunnel ¶
PATCH/v8_0/rkszones/{zoneId}/wlans/{id}/coreTunnelProfile
Use this API command to modify the core tunnel configuration of a WLAN.
Body
{
"type": "Bridge",
"id": "forwardingUUID",
"name": "forwardingName"
}Schema
{
"description": "Core tunnel of the WLAN. This only applies when the access tunnel type is set to RuckusGRE.",
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Tunnel type",
"type": "string",
"enum": [
"Bridge",
"L2oGRE",
"TTG_PDG",
"Mixed"
]
},
"id": {
"description": "Identifier of the forwarding profile. At least one ID or name is required in the request.",
"type": "string"
},
"name": {
"description": "Name of the forwarding profile. At least one ID or name is required in the request.",
"type": "string"
},
"operatorRealm": {
"description": "Operator realm, deprecated coreTunnelProfile.operatorRealm from version3.1, prepare remove",
"type": "string",
"maxLength": 255,
"pattern": "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
}
},
"required": [
"type"
]
}204Modify Portal Profile ¶
PATCH/v8_0/rkszones/{zoneId}/wlans/{id}/portalServiceProfile
Use this API command to modify the portal configuration of a WLAN.
Body
{
"id": "portalServiceUUID",
"name": "portalServiceName"
}Schema
{
"description": "Portal service of the WLAN. This only applies to hotspot, hotspot MAC bypass, guest and web auth WLANs.",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}204Modify Hotspot20 Profile ¶
PATCH/v8_0/rkszones/{zoneId}/wlans/{id}/hotspot20Profile
Use this API command to modify the Hotspot 2.0 profile configuration of a WLAN.
Body
{
"id": "hotspot20ServiceUUID",
"name": "hotspot20ServiceName"
}Schema
{
"description": "Hotspot 2.0 operator profile of the WLAN. id or name of the hotspot 2.0 operator profiles within the zone is required.",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}204Modify User Traffic Profile ¶
PATCH/v8_0/rkszones/{zoneId}/wlans/{id}/defaultUserTrafficProfile
Use this API command to modify the user traffic profile configuration of a WLAN.
Body
{
"id": "userTrafficUUID",
"name": "userTrafficName"
}Schema
{
"description": "User traffic profile of the WLAN",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}204Modify Schedule ¶
PATCH/v8_0/rkszones/{zoneId}/wlans/{id}/schedule
Use this API command to modify the schedule configuration of a WLAN.
Body
{
"type": "Customized",
"id": "ServiceUUID",
"name": "ServiceName"
}Schema
{
"description": "Schedule of the WLAN",
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Type of WLAN schedule",
"type": "string",
"enum": [
"AlwaysOn",
"AlwaysOff",
"Customized"
]
},
"id": {
"description": "Identifier of the schedule profile. At least one ID or name is required in the request.",
"type": "string"
},
"name": {
"description": "Name of the schedule profile. At least one ID or name is required in the request.",
"type": "string"
}
},
"required": [
"type"
]
}204Modify VLAN ¶
PATCH/v8_0/rkszones/{zoneId}/wlans/{id}/vlan
Use this API command to modify the VLAN configuration of a WLAN.
Body
{
"accessVlan": 23,
"aaaVlanOverride": true,
"coreQinQEnabled": false,
"coreSVlan": 10
}Schema
{
"description": "VLAN (access and/or core) of the WLAN.",
"type": "object",
"additionalProperties": false,
"properties": {
"accessVlan": {
"description": "Access VLAN ID",
"type": "integer",
"minimum": 1,
"maximum": 4094
},
"aaaVlanOverride": {
"description": "Indicates whether the AAA VLAN settings can be overriden or not",
"type": "boolean"
},
"coreQinQEnabled": {
"description": "Indicates whether Q-in-Q is allowed at the core network or not",
"type": "boolean"
},
"coreSVlan": {
"description": "Core SVLAN ID. This only applies when core Q-in-Q is enabled",
"type": "integer",
"minimum": 1,
"maximum": 4094
},
"vlanPooling": {
"description": "Vlan pooling",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
}
}204Modify Layer 2 ACL ¶
PATCH/v8_0/rkszones/{zoneId}/wlans/{id}/l2ACL
Use this API command to modify the layer 2 access control list (ACL) configuration of a WLAN.
Body
{
"id": "l2ACLUUID",
"name": "l2ACLName"
}Schema
{
"description": "Layer 2 ACL of the WLAN",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}204Modify Device Policy ¶
PATCH/v8_0/rkszones/{zoneId}/wlans/{id}/devicePolicy
Use this API command to modify the device policy of a WLAN.
Body
{
"id": "devicePolicyUUID",
"name": "devicePolicyName"
}Schema
{
"description": "Device policy of the WLAN",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}204Modify RADIUS Options ¶
PATCH/v8_0/rkszones/{zoneId}/wlans/{id}/radiusOptions
Use this API command to modify the RADIUS settings of a WLAN.
Body
{
"nasIdType": "Customized",
"customizedNasId": "nasId",
"nasRequestTimeoutSec": 12,
"nasMaxRetry": 3,
"nasReconnectPrimaryMin": 30,
"calledStaIdType": "WLAN_BSSID",
"nasIpType": "disabled",
"nasIpUserDefined": "192.168.1.1",
"singleSessionIdAcctEnabled": false
}Schema
{
"description": "RADIUS options of the WLAN",
"type": "object",
"additionalProperties": false,
"properties": {
"nasIdType": {
"description": "NAS ID type",
"type": "string",
"enum": [
"WLAN_BSSID",
"AP_MAC",
"Customized"
]
},
"customizedNasId": {
"description": "User defined NAS ID",
"type": "string",
"maxLength": 64,
"pattern": "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$"
},
"nasRequestTimeoutSec": {
"description": "NAS request timeout in seconds",
"type": "integer",
"minimum": 2,
"maximum": 20
},
"nasMaxRetry": {
"description": "NAS request maximum retry",
"type": "integer",
"minimum": 2,
"maximum": 10
},
"nasReconnectPrimaryMin": {
"description": "NAS reconnect primary time in minutes",
"type": "integer",
"minimum": 1,
"maximum": 60
},
"calledStaIdType": {
"description": "Called station ID type",
"type": "string",
"enum": [
"WLAN_BSSID",
"AP_MAC",
"NONE"
]
},
"nasIpType": {
"description": "NAS IP type",
"type": "string",
"enum": [
"disabled",
"control",
"management",
"userDefined"
]
},
"nasIpUserDefined": {
"description": "User-defined NAS IP",
"type": "string",
"maxLength": 45
},
"singleSessionIdAcctEnabled": {
"description": "When Single Accounting Session ID is enabled, APs will maintain one accounting session for client roaming",
"type": "boolean"
}
}
}204Modify Advanced Options ¶
PATCH/v8_0/rkszones/{zoneId}/wlans/{id}/advancedOptions
Use this API command to modify the advanced settings of a WLAN.
Body
{
"clientIsolationEnabled": true,
"clientIsolationUnicastEnabled": true,
"clientIsolationMulticastEnabled": false,
"clientIsolationAutoVrrpEnabled": false,
"clientIsolationWhitelist": {
"id": "24f24c00-0b47-11e4-a9b5-000c29b1347d",
"name": "myWhitelist"
},
"priority": "High",
"hideSsidEnabled": true,
"maxClientsPerRadio": 12,
"clientIdleTimeoutSec": 60,
"clientLoadBalancingEnabled": true,
"proxyARPEnabled": true,
"ndProxyEnabled": false,
"suppressNsEnabled": false,
"raProxyEnabled": false,
"rsraGuardEnabled": false,
"raThrottlingEnabled": false,
"maxAllowedRA": 10,
"raInterval": 10,
"support80211dEnabled": false,
"support80211kEnabled": true,
"forceClientDHCPTimeoutSec": 5,
"dhcpOption82Enabled": true,
"dhcp82Format": "RUCKUS_DEFAULT",
"unauthClientStatsEnabled": false,
"clientFingerprintingEnabled": true,
"ofdmOnlyEnabled": false,
"bandBalancing": "UseZoneSetting",
"bssMinRateMbps": "Disable",
"mgmtTxRateMbps": "2 mbps",
"hs20Onboarding": false,
"avcEnabled": true,
"urlFilteringPolicyEnabled": false,
"urlFilteringPolicyId": "",
"wifiCallingPolicyEnabled": false,
"wifiCallingPolicyIds": [],
"uplinkEnabled": true,
"uplinkRate": 1800,
"downlinkEnabled": true,
"downlinkRate": 2000,
"ratePerSTAUplink": "650mbps",
"ratePerSTADownlink": "1mbps",
"dtimInterval": 1,
"directedThreshold": 5
}Schema
{
"description": "Advanced settings for the WLAN.",
"type": "object",
"additionalProperties": false,
"properties": {
"clientIsolationEnabled": {
"description": "Indicates whether wireless client isolation is enabled or disabled",
"type": "boolean"
},
"clientIsolationUnicastEnabled": {
"description": "Indicates whether isolate unicast of wireless client isolation is enabled or disabled",
"type": "boolean"
},
"clientIsolationMulticastEnabled": {
"description": "Indicates whether isolate multicast of wireless client isolation is enabled or disabled",
"type": "boolean"
},
"clientIsolationAutoVrrpEnabled": {
"description": "Indicates whether Automatic support for VRRP of wireless client isolation is enabled or disabled",
"type": "boolean"
},
"clientIsolationWhitelist": {
"description": "Indicates wireless client isolation whitelist",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"priority": {
"description": "Priority of the WLAN",
"type": "string",
"enum": [
"High",
"Low"
]
},
"hideSsidEnabled": {
"description": "Indicates whether the SSID is hidden or broadcast",
"type": "boolean"
},
"hs20Onboarding": {
"description": "Allow WISPr WLAN for Hotspot 2.0 Onboarding",
"type": "boolean"
},
"maxClientsPerRadio": {
"description": "Maximum number of clients per radio",
"type": "integer",
"minimum": 1,
"maximum": 512
},
"clientIdleTimeoutSec": {
"description": "Client idle timeout in seconds",
"type": "integer",
"minimum": 60,
"maximum": 1000
},
"dgafEnabled": {
"description": "Indicates whether dgaf is enabled or disabled",
"type": "boolean"
},
"clientLoadBalancingEnabled": {
"description": "Indicates whether Client Load Balancing is enabled or disabled",
"type": "boolean"
},
"proxyARPEnabled": {
"description": "Indicates whether proxy ARP is enabled or disabled",
"type": "boolean"
},
"ndProxyEnabled": {
"description": "Indicates whether ND Proxy is enabled or disabled",
"type": "boolean"
},
"suppressNsEnabled": {
"description": "Indicates whether supperssNS is enabled or disabled",
"type": "boolean"
},
"raProxyEnabled": {
"description": "Indicates whether RA proxy is enabled or disabled",
"type": "boolean"
},
"rsraGuardEnabled": {
"description": "Indicates whether RS/RA Guard is enabled or disabled",
"type": "boolean"
},
"raThrottlingEnabled": {
"description": "Indicates whether RA Throttling is enabled or disabled",
"type": "boolean"
},
"maxAllowedRA": {
"description": "Max Allowed RAs",
"type": "integer",
"minimum": 1,
"maximum": 1440
},
"raInterval": {
"description": "A timer that RA proxy runs and once receives unsolicited RA checks against the configured time and allow/drop RA based on next timeout",
"type": "integer",
"minimum": 1,
"maximum": 256
},
"support80211dEnabled": {
"description": "Indicates whether support for 802.11d is enabled or disabled",
"type": "boolean"
},
"support80211kEnabled": {
"description": "Indicates whether support for 802.11k is enabled or disabled",
"type": "boolean"
},
"antiSpoofingEnabled": {
"description": "Anti-Spoofing enabled",
"type": "boolean"
},
"arpRequestRateLimit": {
"description": "ARP packets request rate limit, default value will be 15 if both rate limit not being set.",
"type": "integer",
"minimum": 0,
"maximum": 100
},
"dhcpRequestRateLimit": {
"description": "DHCP packets request rate limit, default value will be 15 if both rate limit not being set.",
"type": "integer",
"minimum": 0,
"maximum": 100
},
"forceClientDHCPTimeoutSec": {
"description": "Force DHCP disconnects the client if the client does not obtain a valid IP address within the timeout peroid. To disable force DHCP, set this value to zero (0).",
"type": "integer",
"enum": [
0,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15
]
},
"dhcpOption82Enabled": {
"description": "Indicates whether DCHP Option 82 is enabled or disabled",
"type": "boolean"
},
"dhcp82Format": {
"description": "DHCP Option 82 format",
"type": "string",
"enum": [
"RUCKUS_DEFAULT",
"SOFTGRE_CUSTOMIZED"
]
},
"unauthClientStatsEnabled": {
"description": "Indicates whether to send statistics of unauthorized clients or not",
"type": "boolean"
},
"clientFingerprintingEnabled": {
"description": "Indicates whether client fingerprinting is enabled or disabled",
"type": "boolean"
},
"ofdmOnlyEnabled": {
"description": "Indicates whether OFDM only is enabled or disabled",
"type": "boolean"
},
"bandBalancing": {
"description": "Indicates whether band balancing is enabled or disabled",
"type": "string",
"enum": [
"Disabled",
"UseZoneSetting"
]
},
"bssMinRateMbps": {
"description": "BSS minimum rate (mbps)",
"type": "string",
"enum": [
"Disable",
"1 mbps",
"2 mbps",
"5.5 mbps",
"12 mbps",
"24 mbps"
]
},
"mgmtTxRateMbps": {
"description": "Management TX rate (mbps)",
"type": "string",
"enum": [
"1 mbps",
"2 mbps",
"5.5 mbps",
"6 mbps",
"9 mbps",
"11 mbps",
"12 mbps",
"18 mbps",
"24 mbps",
"36 mbps",
"48 mbps",
"54 mbps"
]
},
"pmkCachingEnabled": {
"description": "Indicator of whether PKM caching support is enabled or disabled. The default value is true when the WLAN is WPA+AES non open WLAN.",
"type": "boolean"
},
"okcEnabled": {
"description": "Indicator of whether OKC support is enabled or disabled. The default value is true when the WLAN is WPA+AES non open WLAN.",
"type": "boolean"
},
"avcEnabled": {
"description": "Indicator of whether ARC support is enabled or disabled",
"type": "boolean"
},
"urlFilteringPolicyEnabled": {
"description": "Indicator of whether URL Filtering is enabled or disabled",
"type": "boolean"
},
"urlFilteringPolicyId": {
"description": "The URL Filtering policy ID.",
"type": "string"
},
"wifiCallingPolicyEnabled": {
"description": "Indicator of whether Wi-Fi Calling is enabled or disabled",
"type": "boolean"
},
"wifiCallingPolicyIds": {
"description": "The Wi-Fi Calling policy IDs. (Maximum allowed number is 5)",
"type": "array",
"items": {
"type": "string"
}
},
"uplinkEnabled": {
"description": "SSID Rate Limiting uplink enabled.",
"type": "boolean"
},
"uplinkRate": {
"description": "SSID Rate Limiting uplink.",
"type": "number"
},
"downlinkEnabled": {
"description": "SSID Rate Limiting downlink enabled.",
"type": "boolean"
},
"downlinkRate": {
"description": "SSID Rate Limiting downlink.",
"type": "number"
},
"ratePerSTAUplink": {
"description": "UE Rate Limiting uplink.",
"type": "string"
},
"ratePerSTADownlink": {
"description": "UE Rate Limiting downlink.",
"type": "string"
},
"dtimInterval": {
"description": "DTIM Interval",
"type": "integer",
"minimum": 1,
"maximum": 255
},
"directedThreshold": {
"description": "Directed Threshold Setting, Defines the client count at which an AP will stop converting group addressed data traffic to unicast.",
"type": "integer",
"minimum": 0,
"maximum": 128
},
"flowLogEnabled": {
"description": "Flow log enabled.",
"type": "boolean"
},
"hdOverheadOptimizeEnable": {
"description": "Airtime decongestion enabled.",
"type": "boolean"
},
"probeRssiThr": {
"type": "integer",
"description": "Join RSSI threshold.",
"minimum": -90,
"maximum": -60
},
"transientClientMgmtEnable": {
"description": "Transient Client Management enabled.",
"type": "boolean"
},
"joinIgnoreTimeout": {
"description": "Join wait time.",
"type": "integer",
"minimum": 1,
"maximum": 60
},
"joinAcceptTimeout": {
"description": "Join expire time.",
"type": "integer",
"minimum": 1,
"maximum": 300
},
"joinIgnoreThr": {
"description": "Join wait threshold.",
"type": "integer",
"minimum": 1,
"maximum": 50
},
"authRssiThr": {
"description": "Auth RSSI threshold.",
"type": "integer",
"minimum": -90,
"maximum": -60
},
"assocRssiThr": {
"description": "Assoc RSSI threshold.",
"type": "integer",
"minimum": -90,
"maximum": -60
},
"oceEnabled": {
"description": "Optimized Connectivity Experience(OCE) enabled.",
"type": "boolean"
},
"oceBroadcastProbeResponseDelay": {
"description": "Broadcast probe response delay.",
"type": "integer",
"minimum": 8,
"maximum": 120
},
"oceRssiBasedAssociationRejectionThreshold": {
"description": "RSSI-based association rejection threshold.",
"type": "integer",
"minimum": -90,
"maximum": -60
}
}
}204Modify DiffServ Profile ¶
PATCH/v8_0/rkszones/{zoneId}/wlans/{id}/diffServProfile
Use this API command to modify the DiffServ profile of a WLAN.
Body
{
"id": "diffServId",
"name": "diffServName"
}Schema
{
"description": "DiffServ profile of the WLAN",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}204Modify Qos Map Set ¶
PATCH/v8_0/rkszones/{zoneId}/wlans/{id}/qosMaps
Use this API command to modify Qos Map Set of a WLAN.
Body
[
{
"enable": true,
"priority": 0,
"low": 0,
"high": 7,
"excepts": null
},
{
"enable": true,
"priority": 1,
"low": 8,
"high": 15,
"excepts": null
},
{
"enable": true,
"priority": 2,
"low": 16,
"high": 23,
"excepts": null
},
{
"enable": true,
"priority": 3,
"low": 0,
"high": 32,
"excepts": [
43,
45,
60
]
},
{
"enable": true,
"priority": 4,
"low": 32,
"high": 39,
"excepts": null
},
{
"enable": true,
"priority": 5,
"low": 40,
"high": 47,
"excepts": null
},
{
"enable": true,
"priority": 6,
"low": 48,
"high": 55,
"excepts": [
46
]
},
{
"enable": true,
"priority": 7,
"low": 56,
"high": 63,
"excepts": null
}
]Schema
{
"description": "Qos map set of the WLAN.",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"enable": {
"description": "Enabled or disabled",
"type": "boolean"
},
"priority": {
"description": "Priority",
"type": "integer"
},
"low": {
"description": "DSCP range - low",
"type": [
"integer",
"null"
],
"minimum": 0,
"maximum": 255
},
"high": {
"description": "DSCP range - high",
"type": [
"integer",
"null"
],
"minimum": 0,
"maximum": 255
},
"excepts": {
"type": [
"array",
"null"
],
"items": {
"type": "integer",
"minimum": 0,
"maximum": 63
}
}
},
"required": [
"enable",
"priority"
]
}
}204Modify DNS server profile ¶
PATCH/v8_0/rkszones/{zoneId}/wlans/{id}/dnsServerProfile
Use this API command to modify DNS server profile of a WLAN.
Body
{
"id": "DNS server profile UUID",
"name": "DNS server profile name"
}Schema
{
"description": "DNS server profile of the WLAN",
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}204Modify DPSK Setting ¶
PATCH/v8_0/rkszones/{zoneId}/wlans/{id}/dpsk
Use this API command to modify DPSK setting of a WLAN.
Body
{
"dpskEnabled": true,
"length": 8,
"dpskType": "Secure",
"expiration": "OneDay",
"dpskFromType": "FirstUse"
}Schema
{
"description": "DPSK Setting",
"type": "object",
"additionalProperties": false,
"properties": {
"dpskEnabled": {
"description": "DPSK enabled",
"type": "boolean"
},
"length": {
"description": "Length of DPSK key",
"type": "integer"
},
"dpskType": {
"description": "Type of DPSK key",
"type": "string",
"enum": [
"Secure",
"KeyboardFriendly",
"NumbersOnly"
]
},
"expiration": {
"description": "Expiration of DPSK key",
"type": "string",
"enum": [
"Unlimited",
"OneDay",
"TwoDays",
"OneWeek",
"TwoWeeks",
"OneMonth",
"SixMonths",
"OneYear",
"TwoYears"
]
},
"dpskFromType": {
"description": "Type of expiration start from",
"type": "string",
"enum": [
"CreateTime",
"FirstUse"
]
}
}
}204Modify External DPSK Setting ¶
PATCH/v8_0/rkszones/{zoneId}/wlans/{id}/externalDpsk
Use this API command to modify External DPSK setting of a WLAN.
Body
‧ Sample : Enable external DPSK with encryption WPA2 and radius authentication service of proxy mode
{
"enabled" : true,
"encryption" : {
"method" : "WPA2",
"algorithm" : "AES"
},
"authService" : {
"id" : "authServiceUUID"
}
}
‧ Sample : Disable external DPSK with encryption None
{
"enabled" : false,
"encryption" : {
"method" : "None"
}
}Schema
{
"description" : "External DPSK Enabled",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"enabled" : {
"description" : "Enable External DPSK",
"type" : "boolean"
},
"encryption" : {
"description" : "Encryption of the WLAN relate to external DPSK",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"method" : {
"description" : "Encryption method",
"type" : "string",
"enum" : [ "WPA2", "WPA_Mixed", "None" ]
},
"algorithm" : {
"description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
"type" : "string",
"enum" : [ "AES", "TKIP_AES" ]
}
}
},
"authService" : {
"description" : "Autentication of the WLAN relate to external DPSK",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Identifier of the authentication service. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the authentication service. At least one ID or name is required in the request.",
"type" : "string"
}
}
}
},
"required" : [ "enabled" ]
}204Modify Entire ¶
PUT/v8_0/rkszones/{zoneId}/wlans/{id}
Use this API command to modify entire information of a WLAN.
Body
{
"name": "wlanName",
"ssid": "wlanSSID",
"description": "wlanDescription",
"accessTunnelType": "RuckusGRE",
"accessTunnelProfile": {
"id": "f5b92938-aa4e-4d02-90ea-273799ff689b",
"name": "Default Tunnel Profile"
},
"splitTunnelProfileId": "38119bac-49e1-4410-ab8e-1c1bc88dd770",
"coreTunnelProfile": {
"type": "Bridge",
"id": "forwardingUUID",
"name": "forwardingName"
},
"macAuth": {
"macAuthMacFormat": "802.1X",
"customizedPassword": "password"
},
"encryption": {
"method": "WPA2",
"algorithm": "AES",
"passphrase": "password",
"mfp": "disabled",
"support80211rEnabled": true,
"mobilityDomainId": 3
},
"authServiceOrProfile": {
"throughController": true,
"id": "authServiceUUID",
"locationDeliveryEnabled": true,
"authenticationOption": null
},
"operatorRealm": "operator realm",
"accountingServiceOrProfile": {
"throughController": false,
"id": "accountingServiceUUID",
"name": "accountingServiceName",
"interimUpdateMin": 10,
"accountingDelayEnabled": false,
"accountingTTGSessionEnabled": false
},
"portalServiceProfile": {
"id": "portalServiceUUID",
"name": "portalServiceName"
},
"hotspot20Profile": {
"id": "hotspot20ServiceUUID",
"name": "hotspot20ServiceName"
},
"defaultUserTrafficProfile": {
"id": "userTrafficUUID",
"name": "userTrafficName"
},
"precedenceProfileId": "c514d450-c839-9527-afc9-525400d12345",
"portalDetectionProfileId": "de0fa30c-9565-11e8-9eb6-529269fb1459",
"schedule": {
"type": "Customized",
"id": "ServiceUUID",
"name": "ServiceName"
},
"vlan": {
"accessVlan": 23,
"aaaVlanOverride": true,
"coreQinQEnabled": false,
"coreSVlan": 10
},
"l2ACL": {
"id": "l2ACLUUID",
"name": "l2ACLName"
},
"devicePolicy": {
"id": "devicePolicyUUID",
"name": "devicePolicyName"
},
"radiusOptions": {
"nasIdType": "Customized",
"customizedNasId": "nasId",
"nasRequestTimeoutSec": 12,
"nasMaxRetry": 3,
"nasReconnectPrimaryMin": 30,
"calledStaIdType": "WLAN_BSSID",
"nasIpType": "disabled",
"nasIpUserDefined": "192.168.1.1",
"singleSessionIdAcctEnabled": false
},
"advancedOptions": {
"clientIsolationEnabled": true,
"clientIsolationUnicastEnabled": true,
"clientIsolationMulticastEnabled": false,
"clientIsolationAutoVrrpEnabled": false,
"clientIsolationWhitelist": {
"id": "24f24c00-0b47-11e4-a9b5-000c29b1347d",
"name": "myWhitelist"
},
"priority": "High",
"hideSsidEnabled": true,
"maxClientsPerRadio": 12,
"clientIdleTimeoutSec": 60,
"clientLoadBalancingEnabled": true,
"proxyARPEnabled": true,
"ndProxyEnabled": false,
"suppressNsEnabled": false,
"raProxyEnabled": false,
"rsraGuardEnabled": false,
"raThrottlingEnabled": false,
"maxAllowedRA": 10,
"raInterval": 10,
"support80211dEnabled": false,
"support80211kEnabled": true,
"forceClientDHCPTimeoutSec": 5,
"dhcpOption82Enabled": true,
"dhcp82Format": "RUCKUS_DEFAULT",
"unauthClientStatsEnabled": false,
"clientFingerprintingEnabled": true,
"ofdmOnlyEnabled": false,
"bandBalancing": "UseZoneSetting",
"bssMinRateMbps": "Disable",
"mgmtTxRateMbps": "2 mbps",
"hs20Onboarding": false,
"avcEnabled": true,
"urlFilteringPolicyEnabled": false,
"urlFilteringPolicyId": "",
"wifiCallingPolicyEnabled": false,
"wifiCallingPolicyIds": [],
"uplinkEnabled": true,
"uplinkRate": 1800,
"downlinkEnabled": true,
"downlinkRate": 2000,
"ratePerSTAUplink": "650mbps",
"ratePerSTADownlink": "1mbps",
"dtimInterval": 1,
"directedThreshold": 5
},
"diffServProfile": {
"id": "diffServId",
"name": "diffServName"
},
"qosMaps": [
{
"enable": true,
"priority": 0,
"low": 0,
"high": 7,
"excepts": null
},
{
"enable": true,
"priority": 1,
"low": 8,
"high": 15,
"excepts": null
},
{
"enable": true,
"priority": 2,
"low": 16,
"high": 23,
"excepts": null
},
{
"enable": true,
"priority": 3,
"low": 0,
"high": 32,
"excepts": [
43,
45,
60
]
},
{
"enable": true,
"priority": 4,
"low": 32,
"high": 39,
"excepts": null
},
{
"enable": true,
"priority": 5,
"low": 40,
"high": 47,
"excepts": null
},
{
"enable": true,
"priority": 6,
"low": 48,
"high": 55,
"excepts": [
46
]
},
{
"enable": true,
"priority": 7,
"low": 56,
"high": 63,
"excepts": null
}
],
"dnsServerProfile": {
"id": "DNS server profile UUID",
"name": "DNS server profile name"
},
"dpsk": {
"dpskEnabled": true,
"length": 8,
"dpskType": "Secure",
"expiration": "OneDay",
"dpskFromType": "FirstUse"
},
"externalDpsk": {
"enabled": true,
"encryption": {
"method": "WPA2",
"algorithm": "AES"
},
"authService": {
"id": "authServiceUUID"
}
}
}Schema
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"name" : {
"description" : "Name of the WLAN",
"type" : "string",
"minLength" : 1,
"maxLength" : 32
},
"ssid" : {
"description" : "SSID of the WLAN",
"type" : "string",
"minLength" : 1,
"maxLength" : 32
},
"hessid" : {
"description" : "HESSID of the WLAN",
"type" : "string",
"pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$"
},
"description" : {
"description" : "Description of the WLAN",
"type" : [ "string", "null" ],
"maxLength" : 64
},
"bypassCNA" : {
"description" : "Bypass Capitive Network Assitance",
"type" : "boolean"
},
"caleaEnabled" : {
"description" : "DP CALEA Server Enabled",
"type" : "boolean"
},
"dpTunnelNatEnabled" : {
"description" : "DP Tunnel NAT Enabled",
"type" : "boolean"
},
"dpTunnelDhcpEnabled" : {
"description" : "DP Tunnel DHCP Enabled",
"type" : "boolean"
},
"awsExtNasIPEnable" : {
"description" : "Aws ExtNasIP Enable",
"type" : "boolean"
},
"awsVenueEnable" : {
"description" : "Aws Venue Enable",
"type" : "boolean"
},
"accessTunnelType" : {
"description" : "Access tunnel type of the WLAN. APLBO means AP local breakout, RuckusGRE means RuckusGRE tunnel to the data plane, and SoftGRE means AP direct SoftGRE tunnel",
"type" : "string",
"enum" : [ "APLBO", "RuckusGRE", "SoftGRE" ]
},
"coreTunnelProfile" : {
"description" : "Core tunnel of the WLAN. This only applies when the access tunnel type is set to RuckusGRE.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"type" : {
"description" : "Tunnel type",
"type" : "string",
"enum" : [ "Bridge", "L2oGRE", "TTG_PDG", "Mixed" ]
},
"id" : {
"description" : "Identifier of the forwarding profile. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the forwarding profile. At least one ID or name is required in the request.",
"type" : "string"
},
"operatorRealm" : {
"description" : "Operator realm, deprecated coreTunnelProfile.operatorRealm from version3.1, prepare remove",
"type" : "string",
"maxLength" : 255,
"pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
}
},
"required" : [ "type" ]
},
"macAuth" : {
"description" : "MAC address authentication settings of the WLAN. This only applies to standard MAC and Hotspot MAC bypass WLAN.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"macAuthMacFormat" : {
"description" : "MAC address format. The default format is 0010a42319c0 and the 802.1X format is 00-10-A4-23-19-C0.",
"type" : "string",
"enum" : [ "Default", "802.1X", "UpperColon", "Upper", "LowerDash", "LowerColon" ]
},
"customizedPassword" : {
"description" : "User defined password. When this field is set to an empty string, the MAC address is used as password.",
"type" : "string",
"maxLength" : 64,
"pattern" : "^([!-;=?-~]([ -;=?-~]){0,62}[!-;=?-~]|[!-;=?-~]{1,1}|\s{0,0})$"
}
}
},
"encryption" : {
"description" : "Encryption of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"method" : {
"description" : "Encryption method",
"type" : "string",
"enum" : [ "WPA2", "WPA_Mixed", "WEP_64", "WEP_128", "None" ]
},
"algorithm" : {
"description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
"type" : "string",
"enum" : [ "AES", "TKIP_AES" ]
},
"passphrase" : {
"description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
"type" : "string"
},
"mfp" : {
"description" : "Management frame protection. This only applies to WPA2 + AES",
"type" : "string",
"enum" : [ "disabled", "capable", "required" ]
},
"keyIndex" : {
"description" : "Key index. This only applies to WEP64 and WEP128.",
"type" : "integer"
},
"keyInHex" : {
"description" : "Key in hex format. This only applies to WEP64 and WEP128.",
"type" : "string"
},
"support80211rEnabled" : {
"description" : "Enable 802.11r Fast BSS Transition, fast Romaing.",
"type" : "boolean"
},
"mobilityDomainId" : {
"description" : "mobility Domain Id.",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
}
},
"required" : [ "method" ]
},
"authServiceOrProfile" : {
"description" : "Authentication of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"throughController" : {
"description" : "Indicates whether authentication messages were sent through the controller or not",
"type" : "boolean"
},
"realmBasedAuth" : {
"type" : "boolean"
},
"id" : {
"description" : "Identifier of the authentication service or profile. At least one ID or name or authenticationOption is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the authentication service or profile. At least one ID or name or authenticationOption is required in the request. Or could input the 'Always Accept' or 'Local DB'.",
"type" : "string"
},
"authenticationOption" : {
"description" : "Option of the authentication service or profile, At least one ID or name or authenticationOption is required in the request. This only applies to hotspot and guest WLANs.",
"type" : [ "string", "null" ],
"enum" : [ "Local DB", "Guest", "Always Accept", null ]
},
"locationDeliveryEnabled" : {
"description" : "RFC5580 location delivery support",
"type" : "boolean"
},
"backupAuthenticationId" : {
"description" : "Identifier of the backup authentication service or profile. At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service.",
"type" : "string"
},
"backupAuthenticationName" : {
"description" : "Name of the backup authentication service or profile. At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service. Or could input the 'Always Accept'.",
"type" : "string"
},
"backupAuthenticationOption" : {
"description" : "Option of the backup authentication service or profile, At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service. This only applies to hotspot WLANs.",
"type" : [ "string", "null" ],
"enum" : [ "Always Accept", null ]
}
}
},
"operatorRealm" : {
"description" : "Operator realm, operatorRealm only supports coreTunnelProfile type is authServiceOrProfile.locationDeliveryEnabled is true",
"type" : "string",
"maxLength" : 255,
"pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
},
"accountingServiceOrProfile" : {
"description" : "Accounting of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"throughController" : {
"description" : "Indicates whether accounting messages were sent through the controller",
"type" : "boolean"
},
"realmBasedAcct" : {
"type" : "boolean"
},
"id" : {
"description" : "Accounting service or profile ID. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Accounting service or profile name. At least one ID or name is required in the request.",
"type" : "string"
},
"interimUpdateMin" : {
"description" : "Interval (in minutes) for sending interim updates",
"type" : "integer",
"minimum" : 0,
"maximum" : 1440
},
"accountingDelayEnabled" : {
"description" : "Indicates whether accounting delay time is enabled",
"type" : "boolean"
},
"accountingTTGSessionEnabled" : {
"description" : "Indicates whether accounting for TTG sessions is to enabled",
"type" : "boolean"
},
"backupAccountingId" : {
"description" : "Backup accounting service or profile ID. At least one backupAccountingId or backupAccountingName is required in the request when setting backup accounting service.",
"type" : "string"
},
"backupAccountingName" : {
"description" : "Backup accounting service or profile name. At least one backupAccountingId or backupAccountingName is required in the request when setting backup accounting service.",
"type" : "string"
}
}
},
"portalServiceProfile" : {
"description" : "Portal service of the WLAN. This only applies to hotspot, hotspot MAC bypass, guest and web auth WLANs.",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"hotspot20Profile" : {
"description" : "Hotspot 2.0 operator profile of the WLAN. id or name of the hotspot 2.0 operator profiles within the zone is required.",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"defaultUserTrafficProfile" : {
"description" : "User traffic profile of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"precedenceProfileId" : {
"description" : "Precedence profile of the WLAN",
"type" : "string"
},
"schedule" : {
"description" : "Schedule of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"type" : {
"description" : "Type of WLAN schedule",
"type" : "string",
"enum" : [ "AlwaysOn", "AlwaysOff", "Customized" ]
},
"id" : {
"description" : "Identifier of the schedule profile. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the schedule profile. At least one ID or name is required in the request.",
"type" : "string"
}
},
"required" : [ "type" ]
},
"vlan" : {
"description" : "VLAN (access and/or core) of the WLAN.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"accessVlan" : {
"description" : "Access VLAN ID",
"type" : "integer",
"minimum" : 1,
"maximum" : 4094
},
"aaaVlanOverride" : {
"description" : "Indicates whether the AAA VLAN settings can be overriden or not",
"type" : "boolean"
},
"coreQinQEnabled" : {
"description" : "Indicates whether Q-in-Q is allowed at the core network or not",
"type" : "boolean"
},
"coreSVlan" : {
"description" : "Core SVLAN ID. This only applies when core Q-in-Q is enabled",
"type" : "integer",
"minimum" : 1,
"maximum" : 4094
},
"vlanPooling" : {
"description" : "Vlan pooling",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
}
}
},
"l2ACL" : {
"description" : "Layer 2 ACL of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"devicePolicy" : {
"description" : "Device policy of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"radiusOptions" : {
"description" : "RADIUS options of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"nasIdType" : {
"description" : "NAS ID type",
"type" : "string",
"enum" : [ "WLAN_BSSID", "AP_MAC", "Customized" ]
},
"customizedNasId" : {
"description" : "User defined NAS ID",
"type" : "string",
"maxLength" : 64,
"pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$"
},
"nasRequestTimeoutSec" : {
"description" : "NAS request timeout in seconds",
"type" : "integer",
"minimum" : 2,
"maximum" : 20
},
"nasMaxRetry" : {
"description" : "NAS request maximum retry",
"type" : "integer",
"minimum" : 2,
"maximum" : 10
},
"nasReconnectPrimaryMin" : {
"description" : "NAS reconnect primary time in minutes",
"type" : "integer",
"minimum" : 1,
"maximum" : 60
},
"calledStaIdType" : {
"description" : "Called station ID type",
"type" : "string",
"enum" : [ "WLAN_BSSID", "AP_MAC", "NONE" ]
},
"nasIpType" : {
"description" : "NAS IP type",
"type" : "string",
"enum" : [ "disabled", "control", "management", "userDefined" ]
},
"nasIpUserDefined" : {
"description" : "User-defined NAS IP",
"type" : "string",
"maxLength" : 45
},
"singleSessionIdAcctEnabled" : {
"description" : "When Single Accounting Session ID is enabled, APs will maintain one accounting session for client roaming",
"type" : "boolean"
}
}
},
"advancedOptions" : {
"description" : "Advanced settings for the WLAN.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"clientIsolationEnabled" : {
"description" : "Indicates whether wireless client isolation is enabled or disabled",
"type" : "boolean"
},
"clientIsolationUnicastEnabled" : {
"description" : "Indicates whether isolate unicast of wireless client isolation is enabled or disabled",
"type" : "boolean"
},
"clientIsolationMulticastEnabled" : {
"description" : "Indicates whether isolate multicast of wireless client isolation is enabled or disabled",
"type" : "boolean"
},
"clientIsolationAutoVrrpEnabled" : {
"description" : "Indicates whether Automatic support for VRRP of wireless client isolation is enabled or disabled",
"type" : "boolean"
},
"clientIsolationWhitelist" : {
"description" : "Indicates wireless client isolation whitelist",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"priority" : {
"description" : "Priority of the WLAN",
"type" : "string",
"enum" : [ "High", "Low" ]
},
"hideSsidEnabled" : {
"description" : "Indicates whether the SSID is hidden or broadcast",
"type" : "boolean"
},
"hs20Onboarding" : {
"description" : "Allow WISPr WLAN for Hotspot 2.0 Onboarding",
"type" : "boolean"
},
"maxClientsPerRadio" : {
"description" : "Maximum number of clients per radio",
"type" : "integer",
"minimum" : 1,
"maximum" : 512
},
"clientIdleTimeoutSec" : {
"description" : "Client idle timeout in seconds",
"type" : "integer",
"minimum" : 60,
"maximum" : 1000
},
"dgafEnabled" : {
"description" : "Indicates whether dgaf is enabled or disabled",
"type" : "boolean"
},
"clientLoadBalancingEnabled" : {
"description" : "Indicates whether Client Load Balancing is enabled or disabled",
"type" : "boolean"
},
"proxyARPEnabled" : {
"description" : "Indicates whether proxy ARP is enabled or disabled",
"type" : "boolean"
},
"ndProxyEnabled" : {
"description" : "Indicates whether ND Proxy is enabled or disabled",
"type" : "boolean"
},
"suppressNsEnabled" : {
"description" : "Indicates whether supperssNS is enabled or disabled",
"type" : "boolean"
},
"raProxyEnabled" : {
"description" : "Indicates whether RA proxy is enabled or disabled",
"type" : "boolean"
},
"rsraGuardEnabled" : {
"description" : "Indicates whether RS/RA Guard is enabled or disabled",
"type" : "boolean"
},
"raThrottlingEnabled" : {
"description" : "Indicates whether RA Throttling is enabled or disabled",
"type" : "boolean"
},
"maxAllowedRA" : {
"description" : "Max Allowed RAs",
"type" : "integer",
"minimum" : 1,
"maximum" : 1440
},
"raInterval" : {
"description" : "A timer that RA proxy runs and once receives unsolicited RA checks against the configured time and allow/drop RA based on next timeout",
"type" : "integer",
"minimum" : 1,
"maximum" : 256
},
"support80211dEnabled" : {
"description" : "Indicates whether support for 802.11d is enabled or disabled",
"type" : "boolean"
},
"support80211kEnabled" : {
"description" : "Indicates whether support for 802.11k is enabled or disabled",
"type" : "boolean"
},
"antiSpoofingEnabled" : {
"description" : "Anti-Spoofing enabled",
"type" : "boolean"
},
"arpRequestRateLimit" : {
"description" : "ARP packets request rate limit, default value will be 15 if both rate limit not being set.",
"type" : "integer",
"minimum" : 0,
"maximum" : 100
},
"dhcpRequestRateLimit" : {
"description" : "DHCP packets request rate limit, default value will be 15 if both rate limit not being set.",
"type" : "integer",
"minimum" : 0,
"maximum" : 100
},
"forceClientDHCPTimeoutSec" : {
"description" : "Force DHCP disconnects the client if the client does not obtain a valid IP address within the timeout peroid. To disable force DHCP, set this value to zero (0).",
"type" : "integer",
"enum" : [ 0, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15 ]
},
"dhcpOption82Enabled" : {
"description" : "Indicates whether DCHP Option 82 is enabled or disabled",
"type" : "boolean"
},
"dhcp82Format" : {
"description" : "DHCP Option 82 format",
"type" : "string",
"enum" : [ "RUCKUS_DEFAULT", "SOFTGRE_CUSTOMIZED" ]
},
"unauthClientStatsEnabled" : {
"description" : "Indicates whether to send statistics of unauthorized clients or not",
"type" : "boolean"
},
"clientFingerprintingEnabled" : {
"description" : "Indicates whether client fingerprinting is enabled or disabled",
"type" : "boolean"
},
"ofdmOnlyEnabled" : {
"description" : "Indicates whether OFDM only is enabled or disabled",
"type" : "boolean"
},
"bandBalancing" : {
"description" : "Indicates whether band balancing is enabled or disabled",
"type" : "string",
"enum" : [ "Disabled", "UseZoneSetting" ]
},
"bssMinRateMbps" : {
"description" : "BSS minimum rate (mbps)",
"type" : "string",
"enum" : [ "Disable", "1 mbps", "2 mbps", "5.5 mbps", "12 mbps", "24 mbps" ]
},
"mgmtTxRateMbps" : {
"description" : "Management TX rate (mbps)",
"type" : "string",
"enum" : [ "1 mbps", "2 mbps", "5.5 mbps", "6 mbps", "9 mbps", "11 mbps", "12 mbps", "18 mbps", "24 mbps", "36 mbps", "48 mbps", "54 mbps" ]
},
"pmkCachingEnabled" : {
"description" : "Indicator of whether PKM caching support is enabled or disabled. The default value is true when the WLAN is WPA+AES non open WLAN.",
"type" : "boolean"
},
"okcEnabled" : {
"description" : "Indicator of whether OKC support is enabled or disabled. The default value is true when the WLAN is WPA+AES non open WLAN.",
"type" : "boolean"
},
"avcEnabled" : {
"description" : "Indicator of whether ARC support is enabled or disabled",
"type" : "boolean"
},
"urlFilteringPolicyEnabled" : {
"description" : "Indicator of whether URL Filtering is enabled or disabled",
"type" : "boolean"
},
"urlFilteringPolicyId" : {
"description" : "The URL Filtering policy ID.",
"type" : "string"
},
"wifiCallingPolicyEnabled" : {
"description" : "Indicator of whether Wi-Fi Calling is enabled or disabled",
"type" : "boolean"
},
"wifiCallingPolicyIds" : {
"description" : "The Wi-Fi Calling policy IDs. (Maximum allowed number is 5)",
"type" : "array",
"items" : {
"type" : "string"
}
},
"uplinkEnabled" : {
"description" : "SSID Rate Limiting uplink enabled.",
"type" : "boolean"
},
"uplinkRate" : {
"description" : "SSID Rate Limiting uplink.",
"type" : "number"
},
"downlinkEnabled" : {
"description" : "SSID Rate Limiting downlink enabled.",
"type" : "boolean"
},
"downlinkRate" : {
"description" : "SSID Rate Limiting downlink.",
"type" : "number"
},
"ratePerSTAUplink" : {
"description" : "UE Rate Limiting uplink.",
"type" : "string"
},
"ratePerSTADownlink" : {
"description" : "UE Rate Limiting downlink.",
"type" : "string"
},
"dtimInterval" : {
"description" : "DTIM Interval",
"type" : "integer",
"minimum" : 1,
"maximum" : 255
},
"directedThreshold" : {
"description" : "Directed Threshold Setting, Defines the client count at which an AP will stop converting group addressed data traffic to unicast.",
"type" : "integer",
"minimum" : 0,
"maximum" : 128
},
"flowLogEnabled" : {
"description" : "Flow log enabled.",
"type" : "boolean"
},
"hdOverheadOptimizeEnable" : {
"description" : "Airtime decongestion enabled.",
"type" : "boolean"
},
"probeRssiThr" : {
"type" : "integer",
"description" : "Join RSSI threshold.",
"minimum" : -90,
"maximum" : -60
},
"transientClientMgmtEnable" : {
"description" : "Transient Client Management enabled.",
"type" : "boolean"
},
"joinIgnoreTimeout" : {
"description" : "Join wait time.",
"type" : "integer",
"minimum" : 1,
"maximum" : 60
},
"joinAcceptTimeout" : {
"description" : "Join expire time.",
"type" : "integer",
"minimum" : 1,
"maximum" : 300
},
"joinIgnoreThr" : {
"description" : "Join wait threshold.",
"type" : "integer",
"minimum" : 1,
"maximum" : 50
},
"authRssiThr" : {
"description" : "Auth RSSI threshold.",
"type" : "integer",
"minimum" : -90,
"maximum" : -60
},
"assocRssiThr" : {
"description" : "Assoc RSSI threshold.",
"type" : "integer",
"minimum" : -90,
"maximum" : -60
},
"oceEnabled" : {
"description" : "Optimized Connectivity Experience(OCE) enabled.",
"type" : "boolean"
},
"oceBroadcastProbeResponseDelay" : {
"description" : "Broadcast probe response delay.",
"type" : "integer",
"minimum" : 8,
"maximum" : 120
},
"oceRssiBasedAssociationRejectionThreshold" : {
"description" : "RSSI-based association rejection threshold.",
"type" : "integer",
"minimum" : -90,
"maximum" : -60
}
}
},
"diffServProfile" : {
"description" : "DiffServ profile of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"qosMaps" : {
"description" : "Qos map set of the WLAN.",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"enable" : {
"description" : "Enabled or disabled",
"type" : "boolean"
},
"priority" : {
"description" : "Priority",
"type" : "integer"
},
"low" : {
"description" : "DSCP range - low",
"type" : [ "integer", "null" ],
"minimum" : 0,
"maximum" : 255
},
"high" : {
"description" : "DSCP range - high",
"type" : [ "integer", "null" ],
"minimum" : 0,
"maximum" : 255
},
"excepts" : {
"type" : [ "array", "null" ],
"items" : {
"type" : "integer",
"minimum" : 0,
"maximum" : 63
}
}
},
"required" : [ "enable", "priority" ]
}
},
"dpsk" : {
"description" : "DPSK Setting",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"dpskEnabled" : {
"description" : "DPSK enabled",
"type" : "boolean"
},
"length" : {
"description" : "Length of DPSK key",
"type" : "integer"
},
"dpskType" : {
"description" : "Type of DPSK key",
"type" : "string",
"enum" : [ "Secure", "KeyboardFriendly", "NumbersOnly" ]
},
"expiration" : {
"description" : "Expiration of DPSK key",
"type" : "string",
"enum" : [ "Unlimited", "OneDay", "TwoDays", "OneWeek", "TwoWeeks", "OneMonth", "SixMonths", "OneYear", "TwoYears" ]
},
"dpskFromType" : {
"description" : "Type of expiration start from",
"type" : "string",
"enum" : [ "CreateTime", "FirstUse" ]
}
}
},
"externalDpsk" : {
"description" : "External DPSK Enabled",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"enabled" : {
"description" : "Enable External DPSK",
"type" : "boolean"
},
"encryption" : {
"description" : "Encryption of the WLAN relate to external DPSK",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"method" : {
"description" : "Encryption method",
"type" : "string",
"enum" : [ "WPA2", "WPA_Mixed", "None" ]
},
"algorithm" : {
"description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
"type" : "string",
"enum" : [ "AES", "TKIP_AES" ]
}
}
},
"authService" : {
"description" : "Autentication of the WLAN relate to external DPSK",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Identifier of the authentication service. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the authentication service. At least one ID or name is required in the request.",
"type" : "string"
}
}
}
},
"required" : [ "enabled" ]
},
"dnsServerProfile" : {
"description" : "DNS server profile of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"accessTunnelProfile" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"accessIpsecProfile" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"splitTunnelProfileId" : {
"type" : "string"
},
"portalDetectionProfileId" : {
"type" : "string"
}
}
}204Enable Qos Map Set ¶
POST/v8_0/rkszones/{zoneId}/wlans/{id}/qosMaps
Use this API command to enable Qos Map Set of a WLAN.
201Retrieve ¶
GET/v8_0/rkszones/{zoneId}/wlans/{id}
Use this API command to retrieve a WLAN.
200Body
{
"id": "1027",
"zoneId": "21a18b1c-e260-48c8-866c-69e66c81368e",
"name": "wlan1",
"ssid": "wlan1",
"hessid": "BSSID",
"description": "",
"type": "Standard_Open",
"encryption": {
"method": "None"
},
"macAuth": null,
"authServiceOrProfile": null,
"operatorRealm": null,
"accountingServiceOrProfile": {
"accountingDelayEnabled": false,
"interimUpdateMin": 10,
"throughController": true,
"realmBasedAcct": true,
"name": "realmBasedProfileName"
},
"accessTunnelType": "APLBO",
"accessTunnelProfile": null,
"splitTunnelProfileId": "38119bac-49e1-4410-ab8e-1c1bc88dd770",
"coreTunnelProfile": null,
"portalServiceProfile": null,
"hotspot20Profile": null,
"defaultUserTrafficProfile": {
"id": "24f24c00-0b47-11e4-a9b5-000c29b1347d",
"name": "Factory Default"
},
"precedenceProfileId": "ca1edc50-c839-11e6-afc9-525400da2f0d",
"portalDetectionProfileId": "de0fa30c-9565-11e8-9eb6-529269fb1459",
"l2ACL": null,
"devicePolicy": null,
"dnsServerProfile": {
"id": "DNS server profile UUID",
"name": "DNS server profile name"
},
"vlan": {
"accessVlan": null,
"aaaVlanOverride": false,
"coreQinQEnabled": false,
"coreSVlan": null,
"vlanpooling": {
"id": "0b8d4e50-167a-11e6-97a5-56847afe9799",
"name": "X27s"
}
},
"schedule": {
"id": null,
"name": null,
"type": "AlwaysOn"
},
"radiusOptions": {
"nasIdType": "WLAN_BSSID",
"customizedNasId": null,
"nasRequestTimeoutSec": 3,
"nasMaxRetry": 2,
"nasReconnectPrimaryMin": 5,
"calledStaIdType": "WLAN_BSSID",
"nasIpType": "disabled",
"nasIpUserDefined": "192.168.1.1",
"singleSessionIdAcctEnabled": false
},
"advancedOptions": {
"uplinkEnabled": false,
"downlinkEnabled": false,
"clientIsolationEnabled": true,
"clientIsolationUnicastEnabled": true,
"clientIsolationMulticastEnabled": false,
"clientIsolationAutoVrrpEnabled": false,
"clientIsolationWhitelist": {
"id": "24f24c00-0b47-11e4-a9b5-000c29b1347d",
"name": "myWhitelist"
},
"priority": "High",
"hideSsidEnabled": true,
"clientLoadBalancingEnabled": true,
"proxyARPEnabled": false,
"ndProxyEnabled": false,
"suppressNsEnabled": false,
"raProxyEnabled": false,
"rsraGuardEnabled": false,
"raThrottlingEnabled": false,
"maxAllowedRA": 10,
"raInterval": 10,
"dgafEnabled": null,
"maxClientsPerRadio": 100,
"support80211dEnabled": false,
"support80211kEnabled": true,
"forceClientDHCPTimeoutSec": 5,
"dhcpOption82Enabled": false,
"dhcp82Format": "RUCKUS_DEFAULT",
"unauthClientStatsEnabled": false,
"clientIdleTimeoutSec": 120,
"clientFingerprintingEnabled": false,
"ofdmOnlyEnabled": false,
"hs20Onboarding": false,
"avcEnabled": false,
"urlFilteringPolicyEnabled": false,
"urlFilteringPolicyId": "",
"wifiCallingPolicyEnabled": false,
"wifiCallingPolicyIds": [],
"bssMinRateMbps": "Disable",
"mgmtTxRateMbps": "2 mbps",
"bandBalancing": "UseZoneSetting",
"dtimInterval": 1,
"directedThreshold": 5
},
"qosMaps": [
{
"enable": true,
"priority": 0,
"low": 0,
"high": 7,
"excepts": null
},
{
"enable": true,
"priority": 1,
"low": 8,
"high": 15,
"excepts": null
},
{
"enable": true,
"priority": 2,
"low": 16,
"high": 23,
"excepts": null
},
{
"enable": true,
"priority": 3,
"low": 0,
"high": 32,
"excepts": [
43,
45,
60
]
},
{
"enable": true,
"priority": 4,
"low": 32,
"high": 39,
"excepts": null
},
{
"enable": true,
"priority": 5,
"low": 40,
"high": 47,
"excepts": null
},
{
"enable": true,
"priority": 6,
"low": 48,
"high": 55,
"excepts": [
46
]
},
{
"enable": true,
"priority": 7,
"low": 56,
"high": 63,
"excepts": null
}
],
"dpsk": {
"dpskEnabled": true,
"length": 8,
"dpskType": "Secure",
"expiration": "OneDay",
"dpskFromType": "FirstUse"
},
"bssid": [
"E0:10:7F:28:C9:D8",
"E0:10:7F:28:C9:DC"
]
}Schema
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Identifier of the WLAN",
"type" : "string"
},
"zoneId" : {
"description" : "Identifier of the zone to which the WLAN belongs",
"type" : "string"
},
"name" : {
"description" : "Name of the WLAN",
"type" : "string"
},
"ssid" : {
"description" : "SSID of the WLAN",
"type" : "string"
},
"hessid" : {
"description" : "HESSID of the WLAN",
"type" : "string",
"pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$"
},
"description" : {
"description" : "Description of the WLAN",
"type" : "string"
},
"type" : {
"description" : "Type of the WLAN",
"type" : "string",
"enum" : [ "Standard_Open", "Standard_8021X", "Standard_Mac", "Hotspot", "Hotspot_MacByPass", "Guest", "WebAuth", "Hotspot20", "Hotspot20_Open", "Hotspot20_OSEN" ]
},
"bypassCNA" : {
"description" : "Bypass Capitive Network Assitance",
"type" : "boolean"
},
"caleaEnabled" : {
"description" : "DP CALEA Server Enabled",
"type" : "boolean"
},
"dpTunnelNatEnabled" : {
"description" : "DP Tunnel NAT Enabled",
"type" : "boolean"
},
"dpTunnelDhcpEnabled" : {
"description" : "DP Tunnel DHCP Enabled",
"type" : "boolean"
},
"awsExtNasIPEnable" : {
"description" : "Aws ExtNasIP Enable",
"type" : "boolean"
},
"awsVenueEnable" : {
"description" : "Aws Venue Enable",
"type" : "boolean"
},
"encryption" : {
"description" : "Encryption of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"method" : {
"description" : "Encryption method",
"type" : "string",
"enum" : [ "WPA2", "WPA_Mixed", "WEP_64", "WEP_128", "None" ],
"default" : "None"
},
"algorithm" : {
"description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
"type" : "string",
"enum" : [ "AES", "TKIP_AES" ]
},
"passphrase" : {
"description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
"type" : "string"
},
"mfp" : {
"description" : "Management frame protection. This only applies to WPA2 + AES",
"type" : "string",
"enum" : [ "disabled", "capable", "required" ]
},
"keyIndex" : {
"description" : "Key index. This only applies to WEP64 and WEP128.",
"type" : "integer"
},
"keyInHex" : {
"description" : "Key in hex format. This only applies to WEP64 and WEP128.",
"type" : "string"
},
"support80211rEnabled" : {
"description" : "Enable 802.11r Fast BSS Transition, fast Romaing.",
"type" : "boolean"
},
"mobilityDomainId" : {
"description" : "mobility Domain Id.",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
}
},
"required" : [ "method" ]
},
"authServiceOrProfile" : {
"description" : "Autentication of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"throughController" : {
"description" : "Indicates whether authentication messages were sent through the controller or not",
"type" : "boolean"
},
"realmBasedAuth" : {
"type" : "boolean"
},
"id" : {
"description" : "Identifier of the authentication service or profile. At least one ID or name or authenticationOption is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the authentication service or profile. At least one ID or name or authenticationOption is required in the request. Or could input the 'Always Accept' or 'Local DB'.",
"type" : "string"
},
"authenticationOption" : {
"description" : "Option of the authentication service or profile, At least one ID or name or authenticationOption is required in the request. This only applies to hotspot and guest WLANs.",
"type" : [ "string", "null" ],
"enum" : [ "Local DB", "Guest", "Always Accept", null ]
},
"locationDeliveryEnabled" : {
"description" : "RFC5580 location delivery support",
"type" : "boolean"
},
"backupAuthenticationId" : {
"description" : "Identifier of the backup authentication service or profile. At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service.",
"type" : "string"
},
"backupAuthenticationName" : {
"description" : "Name of the backup authentication service or profile. At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service. Or could input the 'Always Accept'.",
"type" : "string"
},
"backupAuthenticationOption" : {
"description" : "Option of the backup authentication service or profile, At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service. This only applies to hotspot WLANs.",
"type" : [ "string", "null" ],
"enum" : [ "Always Accept", null ]
}
}
},
"operatorRealm" : {
"description" : "Operator realm, operatorRealm only supports coreTunnelProfile type is authServiceOrProfile.locationDeliveryEnabled is true",
"type" : "string",
"maxLength" : 255,
"pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
},
"macAuth" : {
"description" : "MAC authentication of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"macAuthMacFormat" : {
"description" : "MAC address format. The default format is 0010a42319c0 and the 802.1X format is 00-10-A4-23-19-C0.",
"type" : "string",
"enum" : [ "Default", "802.1X", "UpperColon", "Upper", "LowerDash", "LowerColon" ]
},
"customizedPassword" : {
"description" : "User defined password. When this field is set to an empty string, the MAC address is used as password.",
"type" : "string",
"maxLength" : 64,
"pattern" : "^([!-;=?-~]([ -;=?-~]){0,62}[!-;=?-~]|[!-;=?-~]{1,1}|\s{0,0})$"
}
}
},
"accountingServiceOrProfile" : {
"description" : "Accounting of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"throughController" : {
"description" : "Indicates whether accounting messages were sent through the controller",
"type" : "boolean"
},
"realmBasedAcct" : {
"type" : "boolean"
},
"id" : {
"description" : "Accounting service or profile ID. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Accounting service or profile name. At least one ID or name is required in the request.",
"type" : "string"
},
"interimUpdateMin" : {
"description" : "Interval (in minutes) for sending interim updates",
"type" : "integer",
"minimum" : 0,
"maximum" : 1440
},
"accountingDelayEnabled" : {
"description" : "Indicates whether accounting delay time is enabled",
"type" : "boolean"
},
"accountingTTGSessionEnabled" : {
"description" : "Indicates whether accounting for TTG sessions is to enabled",
"type" : "boolean"
},
"backupAccountingId" : {
"description" : "Backup accounting service or profile ID. At least one backupAccountingId or backupAccountingName is required in the request when setting backup accounting service.",
"type" : "string"
},
"backupAccountingName" : {
"description" : "Backup accounting service or profile name. At least one backupAccountingId or backupAccountingName is required in the request when setting backup accounting service.",
"type" : "string"
}
}
},
"accessTunnelType" : {
"description" : "Access tunnel type of the WLAN. APLBO means AP local breakout, RuckusGRE means RuckusGRE tunnel to data plane, SoftGRE means AP direct SoftGRE tunnel",
"type" : "string",
"enum" : [ "APLBO", "RuckusGRE", "SoftGRE" ]
},
"portalServiceProfile" : {
"description" : "Portal service of the WLAN. This only applies to hotspot, hotspot MAC bypass, guest and web auth WLANs.",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"hotspot20Profile" : {
"description" : "Hotspot 2.0 operator profile of the WLAN. id or name of the hotspot 2.0 operator profiles within the zone is required.",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"defaultUserTrafficProfile" : {
"description" : "User traffic profile of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"precedenceProfileId" : {
"description" : "Precedence profile of the WLAN",
"type" : "string"
},
"flexiVpnProfile" : {
"description" : "Flexi-VPN profile of the WLAN",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"wlanId" : {
"type" : "string",
"description" : "Wlan ID"
},
"zoneAffinityId" : {
"type" : "string",
"description" : "Zone Affinity ID"
}
},
"required" : [ "zoneAffinityId" ]
},
"coreTunnelProfile" : {
"description" : "Core tunnel of the WLAN. This only applies when the access tunnel type is set to RuckusGRE.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"type" : {
"description" : "Tunnel type",
"type" : "string",
"enum" : [ "Bridge", "L2oGRE", "TTG_PDG", "Mixed" ]
},
"id" : {
"description" : "Identifier of the forwarding profile. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the forwarding profile. At least one ID or name is required in the request.",
"type" : "string"
},
"operatorRealm" : {
"description" : "Operator realm, deprecated coreTunnelProfile.operatorRealm from version3.1, prepare remove",
"type" : "string",
"maxLength" : 255,
"pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
}
},
"required" : [ "type" ]
},
"vlan" : {
"description" : "VLAN (access and/or core) of the WLAN.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"accessVlan" : {
"description" : "Access VLAN ID",
"type" : "integer",
"minimum" : 1,
"maximum" : 4094,
"default" : 1
},
"aaaVlanOverride" : {
"description" : "Indicates whether the AAA VLAN settings can be overriden or not",
"type" : "boolean"
},
"coreQinQEnabled" : {
"description" : "Indicates whether Q-in-Q is allowed at the core network or not",
"type" : "boolean"
},
"coreSVlan" : {
"description" : "Core SVLAN ID. This only applies when core Q-in-Q is enabled",
"type" : "integer",
"minimum" : 1,
"maximum" : 4094
},
"vlanPooling" : {
"description" : "Vlan pooling",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
}
}
},
"l2ACL" : {
"description" : "Layer 2 ACL of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"devicePolicy" : {
"description" : "Device policy of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"radiusOptions" : {
"description" : "RADIUS options of the WLAN.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"nasIdType" : {
"description" : "NAS ID type",
"type" : "string",
"enum" : [ "WLAN_BSSID", "AP_MAC", "Customized" ],
"default" : "WLAN_BSSID"
},
"customizedNasId" : {
"description" : "User defined NAS ID",
"type" : "string",
"maxLength" : 64,
"pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$"
},
"nasRequestTimeoutSec" : {
"description" : "NAS request timeout in seconds",
"type" : "integer",
"default" : 3,
"minimum" : 2,
"maximum" : 20
},
"nasMaxRetry" : {
"description" : "NAS request maximum retry",
"type" : "integer",
"default" : 2,
"minimum" : 2,
"maximum" : 10
},
"nasReconnectPrimaryMin" : {
"description" : "NAS reconnect primary time in minutes",
"type" : "integer",
"default" : 5,
"minimum" : 1,
"maximum" : 60
},
"calledStaIdType" : {
"description" : "Called station ID type",
"type" : "string",
"enum" : [ "WLAN_BSSID", "AP_MAC", "NONE" ],
"default" : "WLAN_BSSID"
},
"nasIpType" : {
"description" : "NAS IP type",
"type" : "string",
"enum" : [ "disabled", "control", "management", "userDefined" ],
"default" : "disabled"
},
"nasIpUserDefined" : {
"description" : "User-defined NAS IP",
"type" : "string",
"maxLength" : 45
},
"singleSessionIdAcctEnabled" : {
"description" : "When Single Accounting Session ID is enabled, APs will maintain one accounting session for client roaming",
"type" : "boolean",
"default" : false
}
}
},
"schedule" : {
"description" : "Schedule of the WLAN.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"type" : {
"description" : "Type of WLAN schedule",
"type" : "string",
"enum" : [ "AlwaysOn", "AlwaysOff", "Customized" ],
"default" : "AlwaysOn"
},
"id" : {
"description" : "Identifier of the schedule profile. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the schedule profile. At least one ID or name is required in the request.",
"type" : "string"
}
},
"required" : [ "type" ]
},
"advancedOptions" : {
"description" : "Advanced settings for the WLAN.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"clientIsolationEnabled" : {
"description" : "Indicates whether wireless client isolation is enabled or disabled",
"type" : "boolean",
"default" : false
},
"clientIsolationUnicastEnabled" : {
"description" : "Indicates whether isolate unicast of wireless client isolation is enabled or disabled",
"type" : "boolean",
"default" : true
},
"clientIsolationMulticastEnabled" : {
"description" : "Indicates whether isolate multicast of wireless client isolation is enabled or disabled",
"type" : "boolean"
},
"clientIsolationAutoVrrpEnabled" : {
"description" : "Indicates whether Automatic support for VRRP of wireless client isolation is enabled or disabled",
"type" : "boolean",
"default" : false
},
"clientIsolationWhitelist" : {
"description" : "Indicates wireless client isolation whitelist",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"priority" : {
"description" : "Priority of the WLAN",
"type" : "string",
"enum" : [ "High", "Low" ],
"default" : "High"
},
"hideSsidEnabled" : {
"description" : "Indicates whether the SSID is hidden or broadcast",
"type" : "boolean",
"default" : false
},
"hs20Onboarding" : {
"description" : "Allow WISPr WLAN for Hotspot 2.0 Onboarding",
"type" : "boolean",
"default" : false
},
"maxClientsPerRadio" : {
"description" : "Maximum number of clients per radio",
"type" : "integer",
"default" : 100,
"minimum" : 1,
"maximum" : 512
},
"clientIdleTimeoutSec" : {
"description" : "Client idle timeout in seconds",
"type" : "integer",
"minimum" : 60,
"maximum" : 1000,
"default" : 120
},
"dgafEnabled" : {
"description" : "Indicates whether dgaf is enabled or disabled",
"type" : "boolean"
},
"clientLoadBalancingEnabled" : {
"description" : "Indicates whether Client Load Balancing is enabled or disabled",
"type" : "boolean",
"default" : true
},
"proxyARPEnabled" : {
"description" : "Indicates whether proxy ARP is enabled or disabled",
"type" : "boolean",
"default" : false
},
"ndProxyEnabled" : {
"description" : "Indicates whether ND Proxy is enabled or disabled",
"type" : "boolean",
"default" : false
},
"suppressNsEnabled" : {
"description" : "Indicates whether supperssNS is enabled or disabled",
"type" : "boolean",
"default" : false
},
"raProxyEnabled" : {
"description" : "Indicates whether RA proxy is enabled or disabled",
"type" : "boolean",
"default" : false
},
"rsraGuardEnabled" : {
"description" : "Indicates whether RS/RA Guard is enabled or disabled",
"type" : "boolean",
"default" : false
},
"raThrottlingEnabled" : {
"description" : "Indicates whether RA Throttling is enabled or disabled",
"type" : "boolean",
"default" : false
},
"maxAllowedRA" : {
"description" : "Max Allowed RAs",
"type" : "integer",
"minimum" : 1,
"maximum" : 1440,
"default" : 10
},
"raInterval" : {
"description" : "A timer that RA proxy runs and once receives unsolicited RA checks against the configured time and allow/drop RA based on next timeout",
"type" : "integer",
"minimum" : 1,
"maximum" : 256,
"default" : 10
},
"support80211dEnabled" : {
"description" : "Indicates whether support for 802.11d is enabled or disabled",
"type" : "boolean",
"default" : true
},
"support80211kEnabled" : {
"description" : "Indicates whether support for 802.11k is enabled or disabled",
"type" : "boolean",
"default" : true
},
"antiSpoofingEnabled" : {
"description" : "Anti-Spoofing enabled",
"type" : "boolean",
"default" : false
},
"arpRequestRateLimit" : {
"description" : "ARP packets request rate limit, default value will be 15 if both rate limit not being set.",
"type" : "integer",
"minimum" : 0,
"maximum" : 100
},
"dhcpRequestRateLimit" : {
"description" : "DHCP packets request rate limit, default value will be 15 if both rate limit not being set.",
"type" : "integer",
"minimum" : 0,
"maximum" : 100
},
"forceClientDHCPTimeoutSec" : {
"description" : "Force DHCP disconnects the client if the client does not obtain a valid IP address within the timeout peroid. To disable force DHCP, set this value to zero (0).",
"type" : "integer",
"enum" : [ 0, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15 ],
"default" : 0
},
"dhcpOption82Enabled" : {
"description" : "Indicates whether DCHP Option 82 is enabled or disabled",
"type" : "boolean",
"default" : false
},
"dhcp82Format" : {
"description" : "DHCP Option 82 format",
"type" : "string",
"enum" : [ "RUCKUS_DEFAULT", "SOFTGRE_CUSTOMIZED" ]
},
"unauthClientStatsEnabled" : {
"description" : "Indicates whether to send statistics of unauthorized clients or not",
"type" : "boolean",
"default" : false
},
"clientFingerprintingEnabled" : {
"description" : "Indicates whether client fingerprinting is enabled or disabled",
"type" : "boolean",
"default" : false
},
"ofdmOnlyEnabled" : {
"description" : "Indicates whether OFDM only is enabled or disabled",
"type" : "boolean",
"default" : false
},
"bandBalancing" : {
"description" : "Indicates whether band balancing is enabled or disabled",
"type" : "string",
"enum" : [ "Disabled", "UseZoneSetting" ],
"default" : "UseZoneSetting"
},
"bssMinRateMbps" : {
"description" : "BSS minimum rate (mbps)",
"type" : "string",
"enum" : [ "Disable", "1 mbps", "2 mbps", "5.5 mbps", "12 mbps", "24 mbps" ],
"default" : "Disable"
},
"mgmtTxRateMbps" : {
"description" : "Management TX rate (mbps)",
"type" : "string",
"enum" : [ "1 mbps", "2 mbps", "5.5 mbps", "6 mbps", "9 mbps", "11 mbps", "12 mbps", "18 mbps", "24 mbps", "36 mbps", "48 mbps", "54 mbps" ],
"default" : "2 mbps"
},
"pmkCachingEnabled" : {
"description" : "Indicator of whether PKM caching support is enabled or disabled. The default value is true when the WLAN is WPA+AES non open WLAN.",
"type" : "boolean"
},
"okcEnabled" : {
"description" : "Indicator of whether OKC support is enabled or disabled. The default value is true when the WLAN is WPA+AES non open WLAN.",
"type" : "boolean"
},
"avcEnabled" : {
"description" : "Indicator of whether ARC support is enabled or disabled",
"type" : "boolean",
"default" : false
},
"urlFilteringPolicyEnabled" : {
"description" : "Indicator of whether URL Filtering is enabled or disabled",
"type" : "boolean",
"default" : false
},
"urlFilteringPolicyId" : {
"description" : "The URL Filtering policy ID.",
"type" : "string"
},
"wifiCallingPolicyEnabled" : {
"description" : "Indicator of whether Wi-Fi Calling is enabled or disabled",
"type" : "boolean",
"default" : false
},
"wifiCallingPolicyIds" : {
"description" : "The Wi-Fi Calling policy IDs. (Maximum allowed number is 5)",
"type" : "array",
"items" : {
"type" : "string"
}
},
"uplinkEnabled" : {
"description" : "SSID Rate Limiting uplink enabled.",
"type" : "boolean",
"default" : false
},
"uplinkRate" : {
"description" : "SSID Rate Limiting uplink.",
"type" : "number",
"default" : 0.0
},
"downlinkEnabled" : {
"description" : "SSID Rate Limiting downlink enabled.",
"type" : "boolean",
"default" : false
},
"downlinkRate" : {
"description" : "SSID Rate Limiting downlink.",
"type" : "number",
"default" : 0.0
},
"ratePerSTAUplink" : {
"description" : "UE Rate Limiting uplink.",
"type" : "string"
},
"ratePerSTADownlink" : {
"description" : "UE Rate Limiting downlink.",
"type" : "string"
},
"dtimInterval" : {
"description" : "DTIM Interval",
"type" : "integer",
"minimum" : 1,
"maximum" : 255,
"default" : 1
},
"directedThreshold" : {
"description" : "Directed Threshold Setting, Defines the client count at which an AP will stop converting group addressed data traffic to unicast.",
"type" : "integer",
"minimum" : 0,
"maximum" : 128,
"default" : 5
},
"flowLogEnabled" : {
"description" : "Flow log enabled.",
"type" : "boolean",
"default" : false
},
"hdOverheadOptimizeEnable" : {
"description" : "Airtime decongestion enabled.",
"type" : "boolean",
"default" : false
},
"probeRssiThr" : {
"type" : "integer",
"description" : "Join RSSI threshold.",
"minimum" : -90,
"maximum" : -60,
"default" : -85
},
"transientClientMgmtEnable" : {
"description" : "Transient Client Management enabled.",
"type" : "boolean",
"default" : false
},
"joinIgnoreTimeout" : {
"description" : "Join wait time.",
"type" : "integer",
"minimum" : 1,
"maximum" : 60,
"default" : 30
},
"joinAcceptTimeout" : {
"description" : "Join expire time.",
"type" : "integer",
"minimum" : 1,
"maximum" : 300,
"default" : 300
},
"joinIgnoreThr" : {
"description" : "Join wait threshold.",
"type" : "integer",
"minimum" : 1,
"maximum" : 50,
"default" : 10
},
"authRssiThr" : {
"description" : "Auth RSSI threshold.",
"type" : "integer",
"minimum" : -90,
"maximum" : -60
},
"assocRssiThr" : {
"description" : "Assoc RSSI threshold.",
"type" : "integer",
"minimum" : -90,
"maximum" : -60
},
"oceEnabled" : {
"description" : "Optimized Connectivity Experience(OCE) enabled.",
"type" : "boolean",
"default" : false
},
"oceBroadcastProbeResponseDelay" : {
"description" : "Broadcast probe response delay.",
"type" : "integer",
"minimum" : 8,
"maximum" : 120,
"default" : 15
},
"oceRssiBasedAssociationRejectionThreshold" : {
"description" : "RSSI-based association rejection threshold.",
"type" : "integer",
"minimum" : -90,
"maximum" : -60,
"default" : -75
}
}
},
"diffServProfile" : {
"description" : "DiffServ profile of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"qosMaps" : {
"description" : "Qos map set of the WLAN.",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"enable" : {
"description" : "Enabled or disabled",
"type" : "boolean"
},
"priority" : {
"description" : "Priority",
"type" : "integer"
},
"low" : {
"description" : "DSCP range - low",
"type" : [ "integer", "null" ],
"minimum" : 0,
"maximum" : 255
},
"high" : {
"description" : "DSCP range - high",
"type" : [ "integer", "null" ],
"minimum" : 0,
"maximum" : 255
},
"excepts" : {
"type" : [ "array", "null" ],
"items" : {
"type" : "integer",
"minimum" : 0,
"maximum" : 63
}
}
},
"required" : [ "enable", "priority" ]
}
},
"dpsk" : {
"description" : "DPSK Setting",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"dpskEnabled" : {
"description" : "DPSK enabled",
"type" : "boolean",
"default" : false
},
"length" : {
"description" : "Length of DPSK key",
"type" : "integer",
"default" : 62
},
"dpskType" : {
"description" : "Type of DPSK key",
"type" : "string",
"enum" : [ "Secure", "KeyboardFriendly", "NumbersOnly" ],
"default" : "Secure"
},
"expiration" : {
"description" : "Expiration of DPSK key",
"type" : "string",
"enum" : [ "Unlimited", "OneDay", "TwoDays", "OneWeek", "TwoWeeks", "OneMonth", "SixMonths", "OneYear", "TwoYears" ],
"default" : "Unlimited"
},
"dpskFromType" : {
"description" : "Type of expiration start from",
"type" : "string",
"enum" : [ "CreateTime", "FirstUse" ],
"default" : "CreateTime"
}
}
},
"dnsServerProfile" : {
"description" : "DNS server profile of the WLAN",
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"bssid" : {
"description" : "BSSID of the WLAN",
"type" : "array",
"items" : {
"type" : "string"
}
},
"accessTunnelProfile" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"accessIpsecProfile" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"splitTunnelProfileId" : {
"type" : "string"
},
"portalDetectionProfileId" : {
"type" : "string"
}
}
}Disable Accounting ¶
DELETE/v8_0/rkszones/{zoneId}/wlans/{id}/accountingServiceOrProfile
Use this API command to disable the accounting of a WLAN.
204Disable Layer 2 ACL ¶
DELETE/v8_0/rkszones/{zoneId}/wlans/{id}/l2ACL
Use this API command to disable the layer 2 access control list (ACL) configuration of a WLAN.
204Disable Device Policy ¶
DELETE/v8_0/rkszones/{zoneId}/wlans/{id}/devicePolicy
Use this API command to disable the device policy of a WLAN.
204Disable DiffServ Profile ¶
DELETE/v8_0/rkszones/{zoneId}/wlans/{id}/diffServProfile
Use this API command to disable the DiffServ profile of a WLAN.
204WLAN Scheduler ¶
Create ¶
POST/v8_0/rkszones/{zoneId}/wlanSchedulers
Use this API command to create a new WLAN schedule.
Body
{
"name": "wlanSchedulerName",
"description": "wlanSchedulerDescription",
"sun": [
"00:15-01:15",
"07:00-08:30",
"10:45-12:00"
],
"mon": [
"00:00-01:15",
"13:00-14:00"
],
"tue": [
"00:15-01:15"
],
"wed": [
"00:15-01:15"
],
"thu": [
"00:15-01:15"
],
"fri": [
"00:15-01:15"
],
"sat": [
"23:45-24:00"
]
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"description": "Name of the WLAN schedule",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the WLAN schedule",
"type": [
"string",
"null"
],
"maxLength": 64
},
"sun": {
"description": "Schedules on Sunday",
"type": "array",
"items": {
"type": "string",
"pattern": "^([0-1][0-9]|2[0-3]):(00|15|30|45)-(([0-1][0-9]|2[0-3]):(00|15|30|45)|24:00)$"
}
},
"mon": {
"description": "Schedules on Monday",
"type": "array",
"items": {
"type": "string",
"pattern": "^([0-1][0-9]|2[0-3]):(00|15|30|45)-(([0-1][0-9]|2[0-3]):(00|15|30|45)|24:00)$"
}
},
"tue": {
"description": "Schedules on Tuesday",
"type": "array",
"items": {
"type": "string",
"pattern": "^([0-1][0-9]|2[0-3]):(00|15|30|45)-(([0-1][0-9]|2[0-3]):(00|15|30|45)|24:00)$"
}
},
"wed": {
"description": "Schedules on Wednesday",
"type": "array",
"items": {
"type": "string",
"pattern": "^([0-1][0-9]|2[0-3]):(00|15|30|45)-(([0-1][0-9]|2[0-3]):(00|15|30|45)|24:00)$"
}
},
"thu": {
"description": "Schedules on Thursday",
"type": "array",
"items": {
"type": "string",
"pattern": "^([0-1][0-9]|2[0-3]):(00|15|30|45)-(([0-1][0-9]|2[0-3]):(00|15|30|45)|24:00)$"
}
},
"fri": {
"description": "Schedules on Friday",
"type": "array",
"items": {
"type": "string",
"pattern": "^([0-1][0-9]|2[0-3]):(00|15|30|45)-(([0-1][0-9]|2[0-3]):(00|15|30|45)|24:00)$"
}
},
"sat": {
"description": "Schedules on Saturday",
"type": "array",
"items": {
"type": "string",
"pattern": "^([0-1][0-9]|2[0-3]):(00|15|30|45)-(([0-1][0-9]|2[0-3]):(00|15|30|45)|24:00)$"
}
}
},
"required": [
"name"
]
}201Body
{
"id": "wlanSchedulerUUID"
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
}
}
}Retrieve ¶
GET/v8_0/rkszones/{zoneId}/wlanSchedulers/{id}
Use this API command to retrieve a WLAN schedule.
200Body
{
"id": "wlanSchedulerUUID",
"zoneId": "zoneUUID",
"name": "wlanSchedulerName",
"description": "wlanSchedulerDescription",
"sun": [
"00:15-01:15",
"07:00-08:30",
"10:45-12:00"
],
"mon": [
"00:00-01:15",
"13:00-14:00"
],
"tue": [
"00:15-01:15"
],
"wed": [
"00:15-01:15",
"07:00-08:30",
"10:45-12:00"
],
"thu": [
"00:15-01:15"
],
"fri": [
"00:15-01:15"
],
"sat": [
"23:45-24:00"
]
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the WLAN schedule",
"type": "string"
},
"zoneId": {
"description": "Identifier of the zone to which the WLAN schedule belongs",
"type": "string"
},
"name": {
"description": "Name of the WLAN schedule",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the WLAN schedule",
"type": [
"string",
"null"
],
"maxLength": 64
},
"sun": {
"description": "Schedules on Sunday",
"type": "array",
"items": {
"type": "string"
}
},
"mon": {
"description": "Schedules on Monday",
"type": "array",
"items": {
"type": "string"
}
},
"tue": {
"description": "Schedules on Tuesday",
"type": "array",
"items": {
"type": "string"
}
},
"wed": {
"description": "Schedules on Wednesday",
"type": "array",
"items": {
"type": "string"
}
},
"thu": {
"description": "Schedules on Thursday",
"type": "array",
"items": {
"type": "string"
}
},
"fri": {
"description": "Schedules on Friday",
"type": "array",
"items": {
"type": "string"
}
},
"sat": {
"description": "Schedules on Saturday",
"type": "array",
"items": {
"type": "string"
}
}
}
}Retrieve List ¶
GET/v8_0/rkszones/{zoneId}/wlanSchedulers
Use this API command to retrieve the list of WLAN schedule from a zone.
- index
string(optional)The index of the first entry to be retrieved. Default: 0
- listSize
string(optional)The maximum number of entries to be retrieved. Default: 100
200Body
{
"totalCount": 2,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"id": "wlanSchedulerUUID",
"name": "wlanSchedulerName",
"description": "wlanSchedulerDescription",
"sun": [
"00:15-01:15",
"07:00-08:30",
"10:45-12:00"
],
"mon": [
"00:00-01:15",
"13:00-14:00"
],
"tue": [
"00:15-01:15"
],
"wed": [
"00:15-01:15",
"07:00-08:30",
"10:45-12:00"
],
"thu": [
"00:15-01:15"
],
"fri": [
"00:15-01:15"
],
"sat": [
"23:45-24:00"
]
},
{
"id": "wlanSchedulerUUID2",
"name": "wlanSchedulerName2",
"description": "wlanSchedulerDescription2",
"sun": [
"00:15-01:15",
"07:00-08:30",
"10:45-12:00"
],
"mon": [
"00:00-01:15",
"13:00-14:00"
],
"tue": [
"00:15-01:15"
],
"wed": [
"00:15-01:15",
"07:00-08:30",
"10:45-12:00"
],
"thu": [
"16:15-17:15"
],
"fri": [
"00:30-03:15"
],
"sat": [
"23:45-24:00"
]
}
]
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"totalCount": {
"type": "integer"
},
"hasMore": {
"type": "boolean"
},
"firstIndex": {
"type": "integer"
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the WLAN schedule",
"type": "string"
},
"zoneId": {
"description": "Identifier of the zone to which the WLAN schedule belongs",
"type": "string"
},
"name": {
"description": "Name of the WLAN schedule",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the WLAN schedule",
"type": [
"string",
"null"
],
"maxLength": 64
},
"sun": {
"description": "Schedules on Sunday",
"type": "array",
"items": {
"type": "string"
}
},
"mon": {
"description": "Schedules on Monday",
"type": "array",
"items": {
"type": "string"
}
},
"tue": {
"description": "Schedules on Tuesday",
"type": "array",
"items": {
"type": "string"
}
},
"wed": {
"description": "Schedules on Wednesday",
"type": "array",
"items": {
"type": "string"
}
},
"thu": {
"description": "Schedules on Thursday",
"type": "array",
"items": {
"type": "string"
}
},
"fri": {
"description": "Schedules on Friday",
"type": "array",
"items": {
"type": "string"
}
},
"sat": {
"description": "Schedules on Saturday",
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}
}Modify ¶
PATCH/v8_0/rkszones/{zoneId}/wlanSchedulers/{id}
Use this API command to modify the basic information of a WLAN schedule.
Body
{
"name": "wlanSchedulerName",
"description": "wlanSchedulerDescription",
"sun": [
"00:15-01:15",
"07:00-08:30",
"10:45-12:00"
],
"mon": [
"00:00-01:15",
"13:00-14:00"
],
"tue": [
"00:15-01:15"
],
"wed": [
"00:15-01:15",
"07:00-08:30",
"10:45-12:00"
],
"thu": [
"00:15-01:15"
],
"fri": [
"00:15-01:15"
],
"sat": [
"23:45-24:00"
]
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"description": "Name of the WLAN schedule",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the WLAN schedule",
"type": [
"string",
"null"
],
"maxLength": 64
},
"sun": {
"description": "Schedules on Sunday",
"type": "array",
"items": {
"type": "string",
"pattern": "^([0-1][0-9]|2[0-3]):(00|15|30|45)-(([0-1][0-9]|2[0-3]):(00|15|30|45)|24:00)$"
}
},
"mon": {
"description": "Schedules on Monday",
"type": "array",
"items": {
"type": "string",
"pattern": "^([0-1][0-9]|2[0-3]):(00|15|30|45)-(([0-1][0-9]|2[0-3]):(00|15|30|45)|24:00)$"
}
},
"tue": {
"description": "Schedules on Tuesday",
"type": "array",
"items": {
"type": "string",
"pattern": "^([0-1][0-9]|2[0-3]):(00|15|30|45)-(([0-1][0-9]|2[0-3]):(00|15|30|45)|24:00)$"
}
},
"wed": {
"description": "schedules on Wednesday",
"type": "array",
"items": {
"type": "string",
"pattern": "^([0-1][0-9]|2[0-3]):(00|15|30|45)-(([0-1][0-9]|2[0-3]):(00|15|30|45)|24:00)$"
}
},
"thu": {
"description": "Schedules on Thursday",
"type": "array",
"items": {
"type": "string",
"pattern": "^([0-1][0-9]|2[0-3]):(00|15|30|45)-(([0-1][0-9]|2[0-3]):(00|15|30|45)|24:00)$"
}
},
"fri": {
"description": "Schedules on Friday",
"type": "array",
"items": {
"type": "string",
"pattern": "^([0-1][0-9]|2[0-3]):(00|15|30|45)-(([0-1][0-9]|2[0-3]):(00|15|30|45)|24:00)$"
}
},
"sat": {
"description": "Schedules on Saturday",
"type": "array",
"items": {
"type": "string",
"pattern": "^([0-1][0-9]|2[0-3]):(00|15|30|45)-(([0-1][0-9]|2[0-3]):(00|15|30|45)|24:00)$"
}
}
}
}204Modify Schedules On Sunday ¶
PATCH/v8_0/rkszones/{zoneId}/wlanSchedulers/{id}/sun
Use this API command to modify schedules on Sunday.
Body
[
"00:15-01:15",
"07:00-08:30",
"10:45-12:00"
]Schema
{
"description": "Schedules on Sunday",
"type": "array",
"items": {
"type": "string",
"pattern": "^([0-1][0-9]|2[0-3]):(00|15|30|45)-(([0-1][0-9]|2[0-3]):(00|15|30|45)|24:00)$"
}
}204Modify Schedules On Monday ¶
PATCH/v8_0/rkszones/{zoneId}/wlanSchedulers/{id}/mon
Use this API command to modify schedules on Monday.
Body
[
"00:00-01:15",
"13:00-14:00"
]Schema
{
"description": "Schedules on Monday",
"type": "array",
"items": {
"type": "string",
"pattern": "^([0-1][0-9]|2[0-3]):(00|15|30|45)-(([0-1][0-9]|2[0-3]):(00|15|30|45)|24:00)$"
}
}204Modify Schedule On Tuesday ¶
PATCH/v8_0/rkszones/{zoneId}/wlanSchedulers/{id}/tue
Use this API command to modify schedules on Tuesday.
Body
[
"00:15-01:15"
]Schema
{
"description": "Schedules on Tuesday",
"type": "array",
"items": {
"type": "string",
"pattern": "^([0-1][0-9]|2[0-3]):(00|15|30|45)-(([0-1][0-9]|2[0-3]):(00|15|30|45)|24:00)$"
}
}204Modify Schedule On Wednesday ¶
PATCH/v8_0/rkszones/{zoneId}/wlanSchedulers/{id}/wed
Use this API command to modify schedules on Wednesday.
Body
[
"00:15-01:15",
"07:00-08:30",
"10:45-12:00"
]Schema
{
"description": "schedules on Wednesday",
"type": "array",
"items": {
"type": "string",
"pattern": "^([0-1][0-9]|2[0-3]):(00|15|30|45)-(([0-1][0-9]|2[0-3]):(00|15|30|45)|24:00)$"
}
}204Modify Schedules On Thursday ¶
PATCH/v8_0/rkszones/{zoneId}/wlanSchedulers/{id}/thu
Use this API command to modify schedules on Thursday.
Body
[
"00:15-01:15"
]Schema
{
"description": "Schedules on Thursday",
"type": "array",
"items": {
"type": "string",
"pattern": "^([0-1][0-9]|2[0-3]):(00|15|30|45)-(([0-1][0-9]|2[0-3]):(00|15|30|45)|24:00)$"
}
}204Modify Schedules On Friday ¶
PATCH/v8_0/rkszones/{zoneId}/wlanSchedulers/{id}/fri
Use this API command to modify schedules on Friday.
Body
[
"00:15-01:15"
]Schema
{
"description": "Schedules on Friday",
"type": "array",
"items": {
"type": "string",
"pattern": "^([0-1][0-9]|2[0-3]):(00|15|30|45)-(([0-1][0-9]|2[0-3]):(00|15|30|45)|24:00)$"
}
}204Modify Schedules On Saturday ¶
PATCH/v8_0/rkszones/{zoneId}/wlanSchedulers/{id}/sat
Use this API command to modify schedules on Saturday.
Body
[
"23:45-24:00"
]Schema
{
"description": "Schedules on Saturday",
"type": "array",
"items": {
"type": "string",
"pattern": "^([0-1][0-9]|2[0-3]):(00|15|30|45)-(([0-1][0-9]|2[0-3]):(00|15|30|45)|24:00)$"
}
}204Zone AAA ¶
Retrieve List - RADIUS ¶
GET/v8_0/rkszones/{zoneId}/aaa/radius
Use this API command to retrieve a list of radius servers of a zone.
200Body
{
"totalCount": 1,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"id": "RADIUSServerUUID",
"mvnoId": "userMVNOId",
"zoneId": "zoneUUID",
"name": "RADIUSServerName",
"description": "RADIUSServerDescription",
"primary": {
"ip": "192.168.1.1",
"port": 1812,
"sharedSecret": "sharedSecret"
},
"secondary": {
"ip": "192.168.1.2",
"port": 1812,
"sharedSecret": "sharedSecret"
},
"mappings": [
{
"id": "73587760-6589-11e4-800c-0026b9f85aaf",
"groupAttr": "abc",
"userRole": {
"id": "a4c288b0-63cf-11e4-a18a-080027b147d4",
"name": "identity user role name",
"userTrafficProfile": {
"id": "9474cc20-63cf-11e4-a18a-080027b147d4",
"name": "rapheal-usertraffic-profile"
}
}
},
{
"id": "735e6ad0-6589-11e4-800c-0026b9f85aaf",
"groupAttr": "*",
"userRole": {
"id": "9ac45fd6-a87b-4eef-87d7-b759fed376c5",
"name": "identity user role name",
"userTrafficProfile": {
"id": "03ec5340-60a4-11e4-87fc-080027b147d4",
"name": "System Default"
}
}
}
]
}
]
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"totalCount": {
"type": "integer"
},
"hasMore": {
"type": "boolean"
},
"firstIndex": {
"type": "integer"
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the RADIUS server",
"type": "string"
},
"zoneId": {
"description": "Identifier of the zone which the RADIUS server belongs to",
"type": "string"
},
"mvnoId": {
"description": "Tenant UUID",
"type": "string"
},
"name": {
"description": "Name of the RADIUS server",
"type": "string"
},
"description": {
"description": "Description of the RADIUS server",
"type": "string"
},
"primary": {
"description": "Primary RADIUS server",
"type": "object",
"additionalProperties": false,
"properties": {
"ip": {
"description": "Server IP",
"type": "string"
},
"port": {
"description": "Server port",
"type": "integer",
"minimum": 1,
"maximum": 65535
},
"sharedSecret": {
"description": "Server shared secrect",
"type": "string"
}
},
"required": [
"ip",
"port",
"sharedSecret"
]
},
"secondary": {
"description": "Secondary RADIUS server",
"type": "object",
"additionalProperties": false,
"properties": {
"ip": {
"description": "Server IP",
"type": "string"
},
"port": {
"description": "Server port",
"type": "integer",
"minimum": 1,
"maximum": 65535
},
"sharedSecret": {
"description": "Server shared secrect",
"type": "string"
}
},
"required": [
"ip",
"port",
"sharedSecret"
]
},
"standbyPrimary": {
"description": "Primary RADIUS server for standby cluster",
"type": "object",
"additionalProperties": false,
"properties": {
"ip": {
"description": "Server IP",
"type": "string"
},
"port": {
"description": "Server port",
"type": "integer",
"minimum": 1,
"maximum": 65535
},
"sharedSecret": {
"description": "Server shared secrect",
"type": "string"
}
},
"required": [
"ip",
"port",
"sharedSecret"
]
},
"mappings": {
"type": "array",
"description": "Group attribute and user traffic profile mapping",
"items": {
"type": "object",
"additionalProperties": false,
"description": "User traffic profile mapping",
"properties": {
"id": {
"type": "string",
"description": "Group attribute mapping UUID"
},
"groupAttr": {
"type": "string",
"description": "Group attribute"
},
"userRole": {
"type": "object",
"additionalProperties": false,
"description": "Identity user role",
"properties": {
"id": {
"type": "string",
"description": "Identity user role UUID"
},
"name": {
"description": "Identity user role name",
"type": "string",
"minLength": 2,
"maxLength": 64,
"pattern": "^[!-~]([ -~]){0,62}[!-~]$"
},
"userTrafficProfile": {
"type": "object",
"description": "Identity user role",
"properties": {
"id": {
"type": "string",
"description": "User traffic profile UUID"
},
"name": {
"type": "string",
"description": "User traffic profile name"
}
}
}
}
}
},
"required": [
"groupAttr",
"userRole"
]
}
},
"standbyServerEnabled": {
"description": "StandbyCluster different AAA Settings Enabled",
"type": "boolean"
}
}
}
}
}
}Create - RADIUS ¶
POST/v8_0/rkszones/{zoneId}/aaa/radius
Use this API command to create a new radius server of a zone.
- forAccounting
string(optional)radius server for accounting type. default: false.
Body
{
"name": "RADIUSServerName",
"primary": {
"ip": "192.168.1.1",
"port": 1812,
"sharedSecret": "sharedSecret"
},
"standbyServerEnabled": false
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"description": "Name of the RADIUS server",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the RADIUS server",
"type": [
"string",
"null"
],
"maxLength": 64
},
"primary": {
"description": "Primary RADIUS server",
"type": "object",
"additionalProperties": false,
"properties": {
"ip": {
"description": "Server IP",
"type": "string"
},
"port": {
"description": "Server port",
"type": "integer",
"minimum": 1,
"maximum": 65535
},
"sharedSecret": {
"description": "Server shared secrect",
"type": "string"
}
},
"required": [
"ip",
"port",
"sharedSecret"
]
},
"secondary": {
"description": "Secondary RADIUS server",
"type": "object",
"additionalProperties": false,
"properties": {
"ip": {
"description": "Server IP",
"type": "string"
},
"port": {
"description": "Server port",
"type": "integer",
"minimum": 1,
"maximum": 65535
},
"sharedSecret": {
"description": "Server shared secrect",
"type": "string"
}
},
"required": [
"ip",
"port",
"sharedSecret"
]
},
"standbyPrimary": {
"description": "Primary RADIUS server for standby cluster",
"type": "object",
"additionalProperties": false,
"properties": {
"ip": {
"description": "Server IP",
"type": "string"
},
"port": {
"description": "Server port",
"type": "integer",
"minimum": 1,
"maximum": 65535
},
"sharedSecret": {
"description": "Server shared secrect",
"type": "string"
}
},
"required": [
"ip",
"port",
"sharedSecret"
]
},
"mappings": {
"type": "array",
"description": "Group attribute and user traffic profile mapping",
"items": {
"type": "object",
"additionalProperties": false,
"description": "User traffic profile mapping",
"properties": {
"groupAttr": {
"type": "string",
"description": "Group attribute"
},
"userRole": {
"type": "object",
"additionalProperties": false,
"description": "Identity user role",
"properties": {
"id": {
"type": "string",
"description": "Identity user role UUID"
},
"name": {
"description": "Identity user role name",
"type": "string",
"minLength": 2,
"maxLength": 64,
"pattern": "^[!-~]([ -~]){0,62}[!-~]$"
}
}
}
},
"required": [
"groupAttr",
"userRole"
]
}
},
"standbyServerEnabled": {
"description": "StandbyCluster different AAA Settings Enabled",
"type": "boolean",
"default": false
}
},
"required": [
"name",
"primary"
]
}201Body
{
"id": "RADIUSServerUUID"
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
}
}
}Retrieve - RADIUS ¶
GET/v8_0/rkszones/{zoneId}/aaa/radius/{id}
Use this API command to retrieve a radius server of a zone.
200Body
{
"id": "RADIUSServerUUID",
"mvnoId": "userMVNOId",
"zoneId": "zoneUUID",
"name": "RADIUSServerName",
"description": "RADIUSServerDescription",
"primary": {
"ip": "192.168.1.1",
"port": 1812,
"sharedSecret": "sharedSecret"
},
"secondary": {
"ip": "192.168.1.2",
"port": 1812,
"sharedSecret": "sharedSecret"
},
"standbyPrimary": {
"ip": "192.168.2.1",
"port": 1812,
"sharedSecret": "abc"
},
"mappings": [
{
"id": "73587760-6589-11e4-800c-0026b9f85aaf",
"groupAttr": "abc",
"userRole": {
"id": "a4c288b0-63cf-11e4-a18a-080027b147d4",
"name": "identity user role name",
"userTrafficProfile": {
"id": "9474cc20-63cf-11e4-a18a-080027b147d4",
"name": "rapheal-usertraffic-profile"
}
}
},
{
"id": "735e6ad0-6589-11e4-800c-0026b9f85aaf",
"groupAttr": "*",
"userRole": {
"id": "9ac45fd6-a87b-4eef-87d7-b759fed376c5",
"name": "identity user role name",
"userTrafficProfile": {
"id": "03ec5340-60a4-11e4-87fc-080027b147d4",
"name": "System Default"
}
}
}
],
"standbyServerEnabled": true
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the RADIUS server",
"type": "string"
},
"zoneId": {
"description": "Identifier of the zone which the RADIUS server belongs to",
"type": "string"
},
"mvnoId": {
"description": "Tenant UUID",
"type": "string"
},
"name": {
"description": "Name of the RADIUS server",
"type": "string"
},
"description": {
"description": "Description of the RADIUS server",
"type": "string"
},
"primary": {
"description": "Primary RADIUS server",
"type": "object",
"additionalProperties": false,
"properties": {
"ip": {
"description": "Server IP",
"type": "string"
},
"port": {
"description": "Server port",
"type": "integer",
"minimum": 1,
"maximum": 65535
},
"sharedSecret": {
"description": "Server shared secrect",
"type": "string"
}
},
"required": [
"ip",
"port",
"sharedSecret"
]
},
"secondary": {
"description": "Secondary RADIUS server",
"type": "object",
"additionalProperties": false,
"properties": {
"ip": {
"description": "Server IP",
"type": "string"
},
"port": {
"description": "Server port",
"type": "integer",
"minimum": 1,
"maximum": 65535
},
"sharedSecret": {
"description": "Server shared secrect",
"type": "string"
}
},
"required": [
"ip",
"port",
"sharedSecret"
]
},
"standbyPrimary": {
"description": "Primary RADIUS server for standby cluster",
"type": "object",
"additionalProperties": false,
"properties": {
"ip": {
"description": "Server IP",
"type": "string"
},
"port": {
"description": "Server port",
"type": "integer",
"minimum": 1,
"maximum": 65535
},
"sharedSecret": {
"description": "Server shared secrect",
"type": "string"
}
},
"required": [
"ip",
"port",
"sharedSecret"
]
},
"mappings": {
"type": "array",
"description": "Group attribute and user traffic profile mapping",
"items": {
"type": "object",
"additionalProperties": false,
"description": "User traffic profile mapping",
"properties": {
"id": {
"type": "string",
"description": "Group attribute mapping UUID"
},
"groupAttr": {
"type": "string",
"description": "Group attribute"
},
"userRole": {
"type": "object",
"additionalProperties": false,
"description": "Identity user role",
"properties": {
"id": {
"type": "string",
"description": "Identity user role UUID"
},
"name": {
"description": "Identity user role name",
"type": "string",
"minLength": 2,
"maxLength": 64,
"pattern": "^[!-~]([ -~]){0,62}[!-~]$"
},
"userTrafficProfile": {
"type": "object",
"description": "Identity user role",
"properties": {
"id": {
"type": "string",
"description": "User traffic profile UUID"
},
"name": {
"type": "string",
"description": "User traffic profile name"
}
}
}
}
}
},
"required": [
"groupAttr",
"userRole"
]
}
},
"standbyServerEnabled": {
"description": "StandbyCluster different AAA Settings Enabled",
"type": "boolean"
}
}
}Modify Entire - RADIUS ¶
PUT/v8_0/rkszones/{zoneId}/aaa/radius/{id}
Use this API command to modify the basic information on radius server of a zone by complete attributes.
Body
{
"name": "RADIUSServerName",
"description": "RADIUSServerDescription",
"primary": {
"ip": "192.168.1.1",
"port": 1812,
"sharedSecret": "abc"
},
"secondary": {
"ip": "192.168.1.2",
"port": 1812,
"sharedSecret": "sharedSecret"
},
"standbyPrimary": {
"ip": "192.168.2.1",
"port": 1812,
"sharedSecret": "abc"
},
"mappings": [
{
"groupAttr": "newGroupAttr",
"userRole": {
"id": "identity user role UUID"
}
},
{
"groupAttr": "*",
"userRole": {
"name": "identity user role name"
}
}
],
"standbyServerEnabled": true
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"description": "Name of the RADIUS server",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the RADIUS server",
"type": [
"string",
"null"
],
"maxLength": 64
},
"primary": {
"description": "Primary RADIUS server",
"type": "object",
"additionalProperties": false,
"properties": {
"ip": {
"description": "Server IP",
"type": "string"
},
"port": {
"description": "Server port",
"type": "integer",
"minimum": 1,
"maximum": 65535
},
"sharedSecret": {
"description": "Server shared secrect",
"type": "string"
}
},
"required": [
"ip",
"port",
"sharedSecret"
]
},
"secondary": {
"description": "Secondary RADIUS server",
"type": "object",
"additionalProperties": false,
"properties": {
"ip": {
"description": "Server IP",
"type": "string"
},
"port": {
"description": "Server port",
"type": "integer",
"minimum": 1,
"maximum": 65535
},
"sharedSecret": {
"description": "Server shared secrect",
"type": "string"
}
},
"required": [
"ip",
"port",
"sharedSecret"
]
},
"standbyPrimary": {
"description": "Primary RADIUS server for standby cluster",
"type": "object",
"additionalProperties": false,
"properties": {
"ip": {
"description": "Server IP",
"type": "string"
},
"port": {
"description": "Server port",
"type": "integer",
"minimum": 1,
"maximum": 65535
},
"sharedSecret": {
"description": "Server shared secrect",
"type": "string"
}
},
"required": [
"ip",
"port",
"sharedSecret"
]
},
"mappings": {
"type": "array",
"description": "Group attribute and user traffic profile mapping",
"items": {
"type": "object",
"additionalProperties": false,
"description": "User traffic profile mapping",
"properties": {
"groupAttr": {
"type": "string",
"description": "Group attribute"
},
"userRole": {
"type": "object",
"additionalProperties": false,
"description": "Identity user role",
"properties": {
"id": {
"type": "string",
"description": "Identity user role UUID"
},
"name": {
"description": "Identity user role name",
"type": "string",
"minLength": 2,
"maxLength": 64,
"pattern": "^[!-~]([ -~]){0,62}[!-~]$"
}
}
}
},
"required": [
"groupAttr",
"userRole"
]
}
},
"standbyServerEnabled": {
"description": "StandbyCluster different AAA Settings Enabled",
"type": "boolean"
}
}
}204Modify - RADIUS ¶
PATCH/v8_0/rkszones/{zoneId}/aaa/radius/{id}
Use this API command to modify the basic information on radius server of a zone.
Body
{
"name": "RADIUSServerName",
"description": "RADIUSServerDescription",
"primary": {
"ip": "192.168.1.1",
"port": 1812,
"sharedSecret": "abc"
},
"secondary": {
"ip": "192.168.1.2",
"port": 1812,
"sharedSecret": "sharedSecret"
},
"standbyPrimary": {
"ip": "192.168.2.1",
"port": 1812,
"sharedSecret": "abc"
},
"mappings": [
{
"groupAttr": "newGroupAttr",
"userRole": {
"id": "identity user role UUID"
}
},
{
"groupAttr": "*",
"userRole": {
"name": "identity user role name"
}
}
],
"standbyServerEnabled": true
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"description": "Name of the RADIUS server",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the RADIUS server",
"type": [
"string",
"null"
],
"maxLength": 64
},
"primary": {
"description": "Primary RADIUS server",
"type": "object",
"additionalProperties": false,
"properties": {
"ip": {
"description": "Server IP",
"type": "string"
},
"port": {
"description": "Server port",
"type": "integer",
"minimum": 1,
"maximum": 65535
},
"sharedSecret": {
"description": "Server shared secrect",
"type": "string"
}
},
"required": [
"ip",
"port",
"sharedSecret"
]
},
"secondary": {
"description": "Secondary RADIUS server",
"type": "object",
"additionalProperties": false,
"properties": {
"ip": {
"description": "Server IP",
"type": "string"
},
"port": {
"description": "Server port",
"type": "integer",
"minimum": 1,
"maximum": 65535
},
"sharedSecret": {
"description": "Server shared secrect",
"type": "string"
}
},
"required": [
"ip",
"port",
"sharedSecret"
]
},
"standbyPrimary": {
"description": "Primary RADIUS server for standby cluster",
"type": "object",
"additionalProperties": false,
"properties": {
"ip": {
"description": "Server IP",
"type": "string"
},
"port": {
"description": "Server port",
"type": "integer",
"minimum": 1,
"maximum": 65535
},
"sharedSecret": {
"description": "Server shared secrect",
"type": "string"
}
},
"required": [
"ip",
"port",
"sharedSecret"
]
},
"mappings": {
"type": "array",
"description": "Group attribute and user traffic profile mapping",
"items": {
"type": "object",
"additionalProperties": false,
"description": "User traffic profile mapping",
"properties": {
"groupAttr": {
"type": "string",
"description": "Group attribute"
},
"userRole": {
"type": "object",
"additionalProperties": false,
"description": "Identity user role",
"properties": {
"id": {
"type": "string",
"description": "Identity user role UUID"
},
"name": {
"description": "Identity user role name",
"type": "string",
"minLength": 2,
"maxLength": 64,
"pattern": "^[!-~]([ -~]){0,62}[!-~]$"
}
}
}
},
"required": [
"groupAttr",
"userRole"
]
}
},
"standbyServerEnabled": {
"description": "StandbyCluster different AAA Settings Enabled",
"type": "boolean"
}
}
}204Modify - Primary Server of RADIUS ¶
PATCH/v8_0/rkszones/{zoneId}/aaa/radius/{id}/primary
Use this API command to modify primary server on radius server of a zone.
Body
{
"ip": "192.168.1.1",
"port": 1812,
"sharedSecret": "abc"
}Schema
{
"description": "Primary RADIUS server",
"type": "object",
"additionalProperties": false,
"properties": {
"ip": {
"description": "Server IP",
"type": "string"
},
"port": {
"description": "Server port",
"type": "integer",
"minimum": 1,
"maximum": 65535
},
"sharedSecret": {
"description": "Server shared secrect",
"type": "string"
}
},
"required": [
"ip",
"port",
"sharedSecret"
]
}204Modify - Secondary Server of RADIUS ¶
PATCH/v8_0/rkszones/{zoneId}/aaa/radius/{id}/secondary
Use this API command to modify secondary server on radius server of a zone.
Body
{
"ip": "192.168.1.2",
"port": 1812,
"sharedSecret": "sharedSecret"
}Schema
{
"description": "Secondary RADIUS server",
"type": "object",
"additionalProperties": false,
"properties": {
"ip": {
"description": "Server IP",
"type": "string"
},
"port": {
"description": "Server port",
"type": "integer",
"minimum": 1,
"maximum": 65535
},
"sharedSecret": {
"description": "Server shared secrect",
"type": "string"
}
},
"required": [
"ip",
"port",
"sharedSecret"
]
}204Modify - Primary Server of RADIUS for Standby Cluster ¶
PATCH/v8_0/rkszones/{zoneId}/aaa/radius/{id}/standbyPrimary
Use this API command to modify primary server on radius server of a zone for Standby Cluster.
Body
{
"ip": "192.168.2.1",
"port": 1812,
"sharedSecret": "abc"
}Schema
{
"description": "Primary RADIUS server for standby cluster",
"type": "object",
"additionalProperties": false,
"properties": {
"ip": {
"description": "Server IP",
"type": "string"
},
"port": {
"description": "Server port",
"type": "integer",
"minimum": 1,
"maximum": 65535
},
"sharedSecret": {
"description": "Server shared secrect",
"type": "string"
}
},
"required": [
"ip",
"port",
"sharedSecret"
]
}204Delete - RADIUS ¶
DELETE/v8_0/rkszones/{zoneId}/aaa/radius/{id}
Use this API command to delete a radius server of a zone.
204Disable Secondary Server - RADIUS ¶
DELETE/v8_0/rkszones/{zoneId}/aaa/radius/{id}/secondary
Use this API command to disable secondary server on radius server of a zone.
204Disable Primary Server - RADIUS for Standby Cluster ¶
DELETE/v8_0/rkszones/{zoneId}/aaa/radius/{id}/standbyPrimary
Use this API command to disable primary server on radius server of a zone for Standby Cluster.
204Retrieve List - ActiveDirectory ¶
GET/v8_0/rkszones/{zoneId}/aaa/ad
Use this API command to retrieve a list of active directory servers of a zone.
200Body
{
"totalCount": 1,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"id": "a49bf7dd-be4a-45fb-abd6-bc15dcd697c2",
"mvnoId": "839f87c6-d116-497e-afce-aa8157abd30c",
"zoneId": "3c7fd7f4-68bd-4957-a698-a1a810888959",
"name": "activeDirectoryServerName",
"description": null,
"ip": "192.168.1.1",
"port": 389,
"windowsDomainName": null,
"adminDomainName": null,
"password": "",
"globalCatalogEnabled": false,
"mappings": [
{
"id": "c7608860-6afd-11e4-b9bb-08002716c79f",
"groupAttr": "*",
"userRole": {
"id": "636431d6-c06e-4692-a28f-3914afc2a817",
"name": "identity user role name",
"userTrafficProfile": {
"id": "fbde8510-6972-11e4-926e-08002716c79f",
"name": "System Default"
}
}
}
]
}
]
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"totalCount": {
"type": "integer"
},
"hasMore": {
"type": "boolean"
},
"firstIndex": {
"type": "integer"
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the active directory server",
"type": "string"
},
"zoneId": {
"description": "Identifier of the zone which the active directory server belongs to",
"type": "string"
},
"mvnoId": {
"description": "Tenant UUID",
"type": "string"
},
"name": {
"description": "Name of the active directory server",
"type": "string"
},
"description": {
"description": "Description of the active directory server",
"type": "string"
},
"ip": {
"description": "IP address",
"type": "string"
},
"port": {
"description": "Port",
"type": "integer"
},
"windowsDomainName": {
"description": "Windows domain name",
"type": "string"
},
"adminDomainName": {
"description": "Admin domain name",
"type": "string"
},
"password": {
"description": "Admin password",
"type": "string"
},
"globalCatalogEnabled": {
"description": "Enable global catalog support",
"type": "boolean"
},
"mappings": {
"type": "array",
"description": "Group attribute and user traffic profile mapping",
"items": {
"type": "object",
"additionalProperties": false,
"description": "User traffic profile mapping",
"properties": {
"id": {
"type": "string",
"description": "Group attribute mapping UUID"
},
"groupAttr": {
"type": "string",
"description": "Group attribute"
},
"userRole": {
"type": "object",
"additionalProperties": false,
"description": "Identity user role",
"properties": {
"id": {
"type": "string",
"description": "Identity user role UUID"
},
"name": {
"description": "Identity user role name",
"type": "string",
"minLength": 2,
"maxLength": 64,
"pattern": "^[!-~]([ -~]){0,62}[!-~]$"
},
"userTrafficProfile": {
"type": "object",
"description": "Identity user role",
"properties": {
"id": {
"type": "string",
"description": "User traffic profile UUID"
},
"name": {
"type": "string",
"description": "User traffic profile name"
}
}
}
}
}
},
"required": [
"groupAttr",
"userRole"
]
}
},
"standbyServerEnabled": {
"description": "StandbyCluster different AAA Settings Enabled",
"type": "boolean"
},
"standbyIp": {
"description": "IP address - Standby Cluster settings",
"type": "string"
},
"standbyPort": {
"description": "Port - Standby Cluster settings",
"type": "integer"
},
"standbyWindowsDomainName": {
"description": "Windows domain name - Standby Cluster settings",
"type": "string"
},
"standbyAdminDomainName": {
"description": "Admin domain name - Standby Cluster settings",
"type": "string"
},
"standbyPassword": {
"description": "Admin password - Standby Cluster settings",
"type": "string"
},
"standbyGlobalCatalogEnabled": {
"description": "Enable global catalog support - Standby Cluster settings",
"type": "boolean"
}
}
}
}
}
}Retrieve - ActiveDirectory ¶
GET/v8_0/rkszones/{zoneId}/aaa/ad/{id}
Use this API command to retrieve an active directory server of a zone.
200Body
{
"id": "a49bf7dd-be4a-45fb-abd6-bc15dcd697c2",
"mvnoId": "839f87c6-d116-497e-afce-aa8157abd30c",
"zoneId": "3c7fd7f4-68bd-4957-a698-a1a810888959",
"name": "activeDirectoryServerName",
"description": null,
"ip": "192.168.1.1",
"port": 389,
"windowsDomainName": null,
"adminDomainName": null,
"password": "",
"globalCatalogEnabled": false,
"mappings": [
{
"id": "c7608860-6afd-11e4-b9bb-08002716c79f",
"groupAttr": "*",
"userRole": {
"id": "636431d6-c06e-4692-a28f-3914afc2a817",
"name": "identity user role name",
"userTrafficProfile": {
"id": "fbde8510-6972-11e4-926e-08002716c79f",
"name": "System Default"
}
}
}
],
"standbyServerEnabled": true,
"standbyIp": "2.2.2.2",
"standbyPort": 389,
"standbyWindowsDomainName": "dc=domain,dc=ruckuswireless,dc=com",
"standbyGlobalCatalogEnabled": true,
"standbyPassword": "admin",
"standbyAdminDomainName": "uid=admin, dc=ldap, dc=com"
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the active directory server",
"type": "string"
},
"zoneId": {
"description": "Identifier of the zone which the active directory server belongs to",
"type": "string"
},
"mvnoId": {
"description": "Tenant UUID",
"type": "string"
},
"name": {
"description": "Name of the active directory server",
"type": "string"
},
"description": {
"description": "Description of the active directory server",
"type": "string"
},
"ip": {
"description": "IP address",
"type": "string"
},
"port": {
"description": "Port",
"type": "integer"
},
"windowsDomainName": {
"description": "Windows domain name",
"type": "string"
},
"adminDomainName": {
"description": "Admin domain name",
"type": "string"
},
"password": {
"description": "Admin password",
"type": "string"
},
"globalCatalogEnabled": {
"description": "Enable global catalog support",
"type": "boolean"
},
"mappings": {
"type": "array",
"description": "Group attribute and user traffic profile mapping",
"items": {
"type": "object",
"additionalProperties": false,
"description": "User traffic profile mapping",
"properties": {
"id": {
"type": "string",
"description": "Group attribute mapping UUID"
},
"groupAttr": {
"type": "string",
"description": "Group attribute"
},
"userRole": {
"type": "object",
"additionalProperties": false,
"description": "Identity user role",
"properties": {
"id": {
"type": "string",
"description": "Identity user role UUID"
},
"name": {
"description": "Identity user role name",
"type": "string",
"minLength": 2,
"maxLength": 64,
"pattern": "^[!-~]([ -~]){0,62}[!-~]$"
},
"userTrafficProfile": {
"type": "object",
"description": "Identity user role",
"properties": {
"id": {
"type": "string",
"description": "User traffic profile UUID"
},
"name": {
"type": "string",
"description": "User traffic profile name"
}
}
}
}
}
},
"required": [
"groupAttr",
"userRole"
]
}
},
"standbyServerEnabled": {
"description": "StandbyCluster different AAA Settings Enabled",
"type": "boolean"
},
"standbyIp": {
"description": "IP address - Standby Cluster settings",
"type": "string"
},
"standbyPort": {
"description": "Port - Standby Cluster settings",
"type": "integer"
},
"standbyWindowsDomainName": {
"description": "Windows domain name - Standby Cluster settings",
"type": "string"
},
"standbyAdminDomainName": {
"description": "Admin domain name - Standby Cluster settings",
"type": "string"
},
"standbyPassword": {
"description": "Admin password - Standby Cluster settings",
"type": "string"
},
"standbyGlobalCatalogEnabled": {
"description": "Enable global catalog support - Standby Cluster settings",
"type": "boolean"
}
}
}Create - ActiveDirectory ¶
POST/v8_0/rkszones/{zoneId}/aaa/ad
Use this API command to create a new active directory server of a zone.
Body
{
"name": "activeDirectoryServerName",
"ip": "192.168.1.1",
"port": 389,
"globalCatalogEnabled": false,
"windowsDomainName": "dc=domain,dc=ruckuswireless,dc=com",
"standbyServerEnabled": true,
"standbyIp": "2.2.2.2",
"standbyPort": 389,
"standbyWindowsDomainName": "dc=domain,dc=ruckuswireless,dc=com",
"standbyGlobalCatalogEnabled": true,
"standbyPassword": "admin",
"standbyAdminDomainName": "uid=admin, dc=ldap, dc=com"
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"description": "Name of the active directory server",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the active directory server",
"type": [
"string",
"null"
],
"maxLength": 64
},
"ip": {
"description": "IP address",
"type": "string"
},
"port": {
"description": "Port",
"type": "integer",
"minimum": 1,
"maximum": 65535,
"default": 389
},
"windowsDomainName": {
"description": "Windows domain name",
"type": [
"string",
"null"
],
"maxLength": 64,
"pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$"
},
"adminDomainName": {
"description": "Admin domain name",
"type": "string",
"minLength": 2,
"maxLength": 64,
"pattern": "^[!-~]([ -~]){0,62}[!-~]$"
},
"password": {
"description": "Admin password",
"type": "string"
},
"globalCatalogEnabled": {
"description": "Enable global catalog support",
"type": "boolean"
},
"mappings": {
"type": "array",
"description": "Group attribute and user traffic profile mapping",
"items": {
"type": "object",
"additionalProperties": false,
"description": "User traffic profile mapping",
"properties": {
"groupAttr": {
"type": "string",
"description": "Group attribute"
},
"userRole": {
"type": "object",
"additionalProperties": false,
"description": "Identity user role",
"properties": {
"id": {
"type": "string",
"description": "Identity user role UUID"
},
"name": {
"description": "Identity user role name",
"type": "string",
"minLength": 2,
"maxLength": 64,
"pattern": "^[!-~]([ -~]){0,62}[!-~]$"
}
}
}
},
"required": [
"groupAttr",
"userRole"
]
}
},
"standbyServerEnabled": {
"description": "StandbyCluster different AAA Settings Enabled",
"type": "boolean",
"default": false
},
"standbyIp": {
"description": "IP address - Standby Cluster settings",
"type": "string"
},
"standbyPort": {
"description": "Port - Standby Cluster settings",
"type": "integer"
},
"standbyWindowsDomainName": {
"description": "Windows domain name - Standby Cluster settings",
"type": "string"
},
"standbyAdminDomainName": {
"description": "Admin domain name - Standby Cluster settings",
"type": "string"
},
"standbyPassword": {
"description": "Admin password - Standby Cluster settings",
"type": "string"
},
"standbyGlobalCatalogEnabled": {
"description": "Enable global catalog support - Standby Cluster settings",
"type": "boolean"
}
},
"required": [
"name",
"ip",
"port",
"globalCatalogEnabled"
]
}201Body
{
"id": "RADIUSServerUUID"
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
}
}
}Modify Entire - ActiveDirectory ¶
PUT/v8_0/rkszones/{zoneId}/aaa/ad/{id}
Use this API command to modify the basic information on active directory server of a zone by complete attributes.
Body
{
"name": "new name",
"ip": "192.168.1.2",
"port": 3268,
"globalCatalogEnabled": true,
"adminDomainName": "[email protected]",
"password": "admin",
"mappings": [
{
"groupAttr": "newGroupAttr",
"userRole": {
"id": "identity user role UUID"
}
},
{
"groupAttr": "*",
"userRole": {
"name": "identity user role name"
}
}
],
"standbyServerEnabled": false
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"description": "Name of the active directory server",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the active directory server",
"type": [
"string",
"null"
],
"maxLength": 64
},
"ip": {
"description": "IP address",
"type": "string"
},
"port": {
"description": "Port",
"type": "integer",
"minimum": 1,
"maximum": 65535
},
"windowsDomainName": {
"description": "Windows domain name",
"type": [
"string",
"null"
],
"maxLength": 64,
"pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$"
},
"adminDomainName": {
"description": "Admin domain name",
"type": "string",
"minLength": 2,
"maxLength": 64,
"pattern": "^[!-~]([ -~]){0,62}[!-~]$"
},
"password": {
"description": "Admin password",
"type": "string"
},
"globalCatalogEnabled": {
"description": "Enable global catalog support",
"type": "boolean"
},
"mappings": {
"type": "array",
"description": "Group attribute and user traffic profile mapping",
"items": {
"type": "object",
"additionalProperties": false,
"description": "User traffic profile mapping",
"properties": {
"groupAttr": {
"type": "string",
"description": "Group attribute"
},
"userRole": {
"type": "object",
"additionalProperties": false,
"description": "Identity user role",
"properties": {
"id": {
"type": "string",
"description": "Identity user role UUID"
},
"name": {
"description": "Identity user role name",
"type": "string",
"minLength": 2,
"maxLength": 64,
"pattern": "^[!-~]([ -~]){0,62}[!-~]$"
}
}
}
},
"required": [
"groupAttr",
"userRole"
]
}
},
"standbyServerEnabled": {
"description": "StandbyCluster different AAA Settings Enabled",
"type": "boolean"
},
"standbyIp": {
"description": "IP address - Standby Cluster settings",
"type": "string"
},
"standbyPort": {
"description": "Port - Standby Cluster settings",
"type": "integer"
},
"standbyWindowsDomainName": {
"description": "Windows domain name - Standby Cluster settings",
"type": "string"
},
"standbyAdminDomainName": {
"description": "Admin domain name - Standby Cluster settings",
"type": "string"
},
"standbyPassword": {
"description": "Admin password - Standby Cluster settings",
"type": "string"
},
"standbyGlobalCatalogEnabled": {
"description": "Enable global catalog support - Standby Cluster settings",
"type": "boolean"
}
}
}204Modify - ActiveDirectory ¶
PATCH/v8_0/rkszones/{zoneId}/aaa/ad/{id}
Use this API command to modify the basic information on active directory server of a zone.
Body
{
"name": "new name",
"ip": "192.168.1.2",
"port": 3268,
"globalCatalogEnabled": true,
"adminDomainName": "[email protected]",
"password": "admin",
"mappings": [
{
"groupAttr": "newGroupAttr",
"userRole": {
"id": "identity user role UUID"
}
},
{
"groupAttr": "*",
"userRole": {
"name": "identity user role name"
}
}
],
"standbyServerEnabled": false
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"description": "Name of the active directory server",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the active directory server",
"type": [
"string",
"null"
],
"maxLength": 64
},
"ip": {
"description": "IP address",
"type": "string"
},
"port": {
"description": "Port",
"type": "integer",
"minimum": 1,
"maximum": 65535
},
"windowsDomainName": {
"description": "Windows domain name",
"type": [
"string",
"null"
],
"maxLength": 64,
"pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$"
},
"adminDomainName": {
"description": "Admin domain name",
"type": "string",
"minLength": 2,
"maxLength": 64,
"pattern": "^[!-~]([ -~]){0,62}[!-~]$"
},
"password": {
"description": "Admin password",
"type": "string"
},
"globalCatalogEnabled": {
"description": "Enable global catalog support",
"type": "boolean"
},
"mappings": {
"type": "array",
"description": "Group attribute and user traffic profile mapping",
"items": {
"type": "object",
"additionalProperties": false,
"description": "User traffic profile mapping",
"properties": {
"groupAttr": {
"type": "string",
"description": "Group attribute"
},
"userRole": {
"type": "object",
"additionalProperties": false,
"description": "Identity user role",
"properties": {
"id": {
"type": "string",
"description": "Identity user role UUID"
},
"name": {
"description": "Identity user role name",
"type": "string",
"minLength": 2,
"maxLength": 64,
"pattern": "^[!-~]([ -~]){0,62}[!-~]$"
}
}
}
},
"required": [
"groupAttr",
"userRole"
]
}
},
"standbyServerEnabled": {
"description": "StandbyCluster different AAA Settings Enabled",
"type": "boolean"
},
"standbyIp": {
"description": "IP address - Standby Cluster settings",
"type": "string"
},
"standbyPort": {
"description": "Port - Standby Cluster settings",
"type": "integer"
},
"standbyWindowsDomainName": {
"description": "Windows domain name - Standby Cluster settings",
"type": "string"
},
"standbyAdminDomainName": {
"description": "Admin domain name - Standby Cluster settings",
"type": "string"
},
"standbyPassword": {
"description": "Admin password - Standby Cluster settings",
"type": "string"
},
"standbyGlobalCatalogEnabled": {
"description": "Enable global catalog support - Standby Cluster settings",
"type": "boolean"
}
}
}204Delete - ActiveDirectory ¶
DELETE/v8_0/rkszones/{zoneId}/aaa/ad/{id}
Use this API command to delete an active directory server of a zone.
204Retrieve List - LDAP ¶
GET/v8_0/rkszones/{zoneId}/aaa/ldap
Use this API command to retrieve a list of LDAP servers of a zone.
200Body
{
"totalCount": 1,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"id": "32fb8816-60e7-46df-876b-038c655278d4",
"mvnoId": "839f87c6-d116-497e-afce-aa8157abd30c",
"zoneId": "3c7fd7f4-68bd-4957-a698-a1a810888959",
"name": "rapheal-ldap",
"description": "",
"ip": "1.1.1.1",
"port": 389,
"baseDomainName": "dc=ldap",
"adminDomainName": "ibm",
"password": "admin",
"keyAttribute": "uid",
"searchFilter": "objectClass=*",
"mappings": [
{
"id": "afa788e0-6afd-11e4-b9bb-08002716c79f",
"groupAttr": "*",
"userRole": {
"id": "636431d6-c06e-4692-a28f-3914afc2a817",
"name": "identity user role name",
"userTrafficProfile": {
"id": "fbde8510-6972-11e4-926e-08002716c79f",
"name": "System Default"
}
}
},
{
"id": "afaa4800-6afd-11e4-b9bb-08002716c79f",
"groupAttr": "abcd",
"userRole": {
"id": "636431d6-c06e-4692-a28f-3914afc2a817",
"name": "identity user role name",
"userTrafficProfile": {
"id": "fbde8510-6972-11e4-926e-08002716c79f",
"name": "System Default"
}
}
}
]
}
]
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"totalCount": {
"type": "integer"
},
"hasMore": {
"type": "boolean"
},
"firstIndex": {
"type": "integer"
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the LDAP server",
"type": "string"
},
"zoneId": {
"description": "Identifier of the zone which the LDAP server belongs to",
"type": "string"
},
"mvnoId": {
"description": "Tenant UUID",
"type": "string"
},
"name": {
"description": "Name of the LDAP server",
"type": "string"
},
"description": {
"description": "Description of the LDAP server",
"type": "string"
},
"ip": {
"description": "IP address",
"type": "string"
},
"port": {
"description": "Port",
"type": "integer"
},
"baseDomainName": {
"description": "Base domain name",
"type": "string"
},
"adminDomainName": {
"description": "Admin domain name",
"type": "string"
},
"password": {
"description": "Admin password",
"type": "string"
},
"keyAttribute": {
"description": "Key attribute",
"type": "string"
},
"searchFilter": {
"description": "Search filter",
"type": "string"
},
"mappings": {
"type": "array",
"description": "Group attribute and user traffic profile mapping",
"items": {
"type": "object",
"additionalProperties": false,
"description": "User traffic profile mapping",
"properties": {
"id": {
"type": "string",
"description": "Group attribute mapping UUID"
},
"groupAttr": {
"type": "string",
"description": "Group attribute"
},
"userRole": {
"type": "object",
"additionalProperties": false,
"description": "Identity user role",
"properties": {
"id": {
"type": "string",
"description": "Identity user role UUID"
},
"name": {
"description": "Identity user role name",
"type": "string",
"minLength": 2,
"maxLength": 64,
"pattern": "^[!-~]([ -~]){0,62}[!-~]$"
},
"userTrafficProfile": {
"type": "object",
"description": "Identity user role",
"properties": {
"id": {
"type": "string",
"description": "User traffic profile UUID"
},
"name": {
"type": "string",
"description": "User traffic profile name"
}
}
}
}
}
},
"required": [
"groupAttr",
"userRole"
]
}
},
"standbyServerEnabled": {
"description": "StandbyCluster different AAA Settings Enabled",
"type": "boolean"
},
"standbyIp": {
"description": "IP address - Standby Cluster settings ",
"type": "string"
},
"standbyPort": {
"description": "Port - Standby Cluster settings ",
"type": "integer"
},
"standbyBaseDomainName": {
"description": "Base domain name - Standby Cluster settings ",
"type": "string"
},
"standbyAdminDomainName": {
"description": "Admin domain name - Standby Cluster settings ",
"type": "string"
},
"standbyPassword": {
"description": "Admin password - Standby Cluster settings ",
"type": "string"
},
"standbyKeyAttribute": {
"description": "Key attribute - Standby Cluster settings ",
"type": "string"
},
"standbySearchFilter": {
"description": "Search filter - Standby Cluster settings ",
"type": "string"
}
}
}
}
}
}Retrieve - LDAP ¶
GET/v8_0/rkszones/{zoneId}/aaa/ldap/{id}
Use this API command to retrieve a LDAP server of a zone.
200Body
{
"id": "32fb8816-60e7-46df-876b-038c655278d4",
"mvnoId": "839f87c6-d116-497e-afce-aa8157abd30c",
"zoneId": "3c7fd7f4-68bd-4957-a698-a1a810888959",
"name": "rapheal-ldap",
"description": "",
"ip": "1.1.1.1",
"port": 389,
"baseDomainName": "dc=ldap",
"adminDomainName": "ibm",
"password": "admin",
"keyAttribute": "uid",
"searchFilter": "objectClass=*",
"mappings": [
{
"id": "afa788e0-6afd-11e4-b9bb-08002716c79f",
"groupAttr": "*",
"userRole": {
"id": "636431d6-c06e-4692-a28f-3914afc2a817",
"name": "identity user role name",
"userTrafficProfile": {
"id": "fbde8510-6972-11e4-926e-08002716c79f",
"name": "System Default"
}
}
},
{
"id": "afaa4800-6afd-11e4-b9bb-08002716c79f",
"groupAttr": "abcd",
"userRole": {
"id": "636431d6-c06e-4692-a28f-3914afc2a817",
"name": "identity user role name",
"userTrafficProfile": {
"id": "fbde8510-6972-11e4-926e-08002716c79f",
"name": "System Default"
}
}
}
],
"standbyServerEnabled": true,
"standbyIp": "2.2.2.2",
"standbyPort": 389,
"standbyBaseDomainName": "dc=ldap",
"standbyAdminDomainName": "uid=admin, dc=ldap, dc=com",
"standbyPassword": "admin",
"standbyKeyAttribute": "uid",
"standbySearchFilter": "objectClass=*"
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Identifier of the LDAP server",
"type": "string"
},
"zoneId": {
"description": "Identifier of the zone which the LDAP server belongs to",
"type": "string"
},
"mvnoId": {
"description": "Tenant UUID",
"type": "string"
},
"name": {
"description": "Name of the LDAP server",
"type": "string"
},
"description": {
"description": "Description of the LDAP server",
"type": "string"
},
"ip": {
"description": "IP address",
"type": "string"
},
"port": {
"description": "Port",
"type": "integer"
},
"baseDomainName": {
"description": "Base domain name",
"type": "string"
},
"adminDomainName": {
"description": "Admin domain name",
"type": "string"
},
"password": {
"description": "Admin password",
"type": "string"
},
"keyAttribute": {
"description": "Key attribute",
"type": "string"
},
"searchFilter": {
"description": "Search filter",
"type": "string"
},
"mappings": {
"type": "array",
"description": "Group attribute and user traffic profile mapping",
"items": {
"type": "object",
"additionalProperties": false,
"description": "User traffic profile mapping",
"properties": {
"id": {
"type": "string",
"description": "Group attribute mapping UUID"
},
"groupAttr": {
"type": "string",
"description": "Group attribute"
},
"userRole": {
"type": "object",
"additionalProperties": false,
"description": "Identity user role",
"properties": {
"id": {
"type": "string",
"description": "Identity user role UUID"
},
"name": {
"description": "Identity user role name",
"type": "string",
"minLength": 2,
"maxLength": 64,
"pattern": "^[!-~]([ -~]){0,62}[!-~]$"
},
"userTrafficProfile": {
"type": "object",
"description": "Identity user role",
"properties": {
"id": {
"type": "string",
"description": "User traffic profile UUID"
},
"name": {
"type": "string",
"description": "User traffic profile name"
}
}
}
}
}
},
"required": [
"groupAttr",
"userRole"
]
}
},
"standbyServerEnabled": {
"description": "StandbyCluster different AAA Settings Enabled",
"type": "boolean"
},
"standbyIp": {
"description": "IP address - Standby Cluster settings ",
"type": "string"
},
"standbyPort": {
"description": "Port - Standby Cluster settings ",
"type": "integer"
},
"standbyBaseDomainName": {
"description": "Base domain name - Standby Cluster settings ",
"type": "string"
},
"standbyAdminDomainName": {
"description": "Admin domain name - Standby Cluster settings ",
"type": "string"
},
"standbyPassword": {
"description": "Admin password - Standby Cluster settings ",
"type": "string"
},
"standbyKeyAttribute": {
"description": "Key attribute - Standby Cluster settings ",
"type": "string"
},
"standbySearchFilter": {
"description": "Search filter - Standby Cluster settings ",
"type": "string"
}
}
}Create - LDAP ¶
POST/v8_0/rkszones/{zoneId}/aaa/ldap
Use this API command to create a new LDAP server of a zone.
Body
{
"name": "rapheal-ldap",
"ip": "1.1.1.2",
"port": 389,
"baseDomainName": "dc=ldap",
"adminDomainName": "ibm",
"password": "admin",
"keyAttribute": "uid",
"searchFilter": "objectClass=*",
"standbyServerEnabled": true,
"standbyIp": "2.2.2.2",
"standbyPort": 389,
"standbyBaseDomainName": "dc=ldap",
"standbyAdminDomainName": "uid=admin, dc=ldap, dc=com",
"standbyPassword": "admin",
"standbyKeyAttribute": "uid",
"standbySearchFilter": "objectClass=*"
}Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"description": "Name of the LDAP server",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the LDAP server",
"type": [
"string",
"null"
],
"maxLength": 64
},
"ip": {
"description": "IP address",
"type": "string"
},
"port": {
"description": "Port",
"type": "integer",
"minimum": 1,
"maximum": 65535,
"default": 389
},
"baseDomainName": {
"description": "Base domain name",
"type": "string",
"minLength": 2,
"maxLength": 64,
"pattern": "^[!-~]([ -~]){0,62}[!-~]$"
},
"adminDomainName": {
"description": "Admin domain name",
"type": "string",
"minLength": 2,
"maxLength": 128,
"pattern": "^[!-~]([ -~]){0,126}[!-~]$"
},
"password": {
"description": "Admin password",
"type": "string"
},
"keyAttribute": {
"description": "Key attribute",
"type": "string",
"minLength": 2,
"maxLength": 64,
"pattern": "^[!-~]([ -~]){0,62}[!-~]$"
},
"searchFilter": {
"description": "Search filter",
"type": "string",
"minLength": 2,
"maxLength": 64,
"pattern": "^[!-~]([ -~]){0,62}[!-~]$"
},
"mappings": {
"type": "array",
"description": "Group attribute and user traffic profile mapping",
"items": {
"type": "object",
"additionalProperties": false,
"description": "User traffic profile mapping",
"properties": {
"groupAttr": {
"type": "string",
"description": "Group attribute"
},
"userRole": {
"type": "object",
"additionalProperties": false,
"description": "Identity user role",
"properties": {
"id": {
"type": "string",
"description": "Identity user role UUID"
},
"name": {
"description": "Identity user role name",
"type": "string",
"minLength": 2,
"maxLength": 64,
"pattern": "^[!-~]([ -~]){0,62}[!-~]$"
}
}
}
},
"required":