Virtual SmartZone - High Scale Public API Reference Guide
Overview
This reference guide describes the public APIs supported by the Virtual SmartZone (High Scale). 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 |
OpenAPI documents
OpenAPI documents is based on OAS 2.0, Please try it for free.
Installed Smart Zone Software Release and link to https://{host}:8443/wsg/apiDoc/openapi 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 according to the following matrix.
SZ Version | API Version |
---|---|
6.1.2 |
v9_0 v9_1 v10_0 v11_0 v11_1 |
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/Nuuk | 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/Punta_Arenas | 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/Qostanay |
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/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/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 Properties
Due to security reasons, the feature has been changed in the design. The below properties are no longer supported in all API version.
-
Session Management
-
GET
/sessionManagement
Remove Substitution sessionId
sessionUuid
-
-
Northbound Data Streaming
-
GET
/northboundDataStreamingProfile/{id}
-
GET
/northboundDataStreamingProfileList
Remove password
-
-
System
-
GET
/system/nbi
Remove password
-
-
FtpServerSettings
-
GET
/ftps/{ftpId}
-
POST
/ftps/query
Remove ftpPassword
-
-
LBS profile
-
GET
/profiles/lbs/{id}
-
POST
/profiles/lbs/query
Remove password
-
-
Administration
-
GET
/adminaaa/{id}
-
GET
/adminaaa
Remove sharedSecret
proxyUserPassword
adminPassword
-
-
Authentication Service
-
GET
/services/auth/radius
-
GET
/services/auth/radius/{id}
-
GET
/services/auth/ad
-
GET
/services/auth/ad/{id}
-
GET
/services/auth/ldap
-
GET
/services/auth/ldap/{id}
-
POST
/services/auth/query
-
POST
/services/auth/radius/query
-
POST
/services/auth/ad/query
-
POST
/services/auth/ldap/query
Remove sharedSecret
password
-
-
Accounting Service
-
GET
/services/acct/radius
-
GET
/services/acct/radius/{id}
-
POST
/services/acct/query
-
POST
/services/acct/radius/query
Remove sharedSecret
-
What’s New
-
API
- Network Segmentation Profile
- Create a new network segmentation profile
- Modify network segmentation profile by id
- Delete network segmentation profile by id
- Retrieve network segmentation profile by id
- Query network segmentation profile
- Update network segmentation ethernet port profile
- Retrieve network segmentation ethernet port profile
- Delete network segmentation ethernet port profile list
- Bulk delete network segmentation ethernet port profile list
- Create network segmentation ethernet port profile
- Retrieve network segmentation ethernet port profile list
- Network Segmentation Profile
-
Properties
- Access Point Operational
- Retrieve Operational Information
- wifi6gChannel
- Retrieve Operational Information
- Cluster Management
- Modify Auto Export Backup
- ftpNamePrefix
- Modify Auto Export Backup
- ftpNamePrefix
- Get Auto Export Backup
- ftpNamePrefix
- Modify Auto Export Backup
- LBS profile
- Create LBS profile
- tlsVersion
- Create LBS profile
- tlsVersion
- Create LBS profile
- tlsVersion
- Update LBS profile
- tlsVersion
- Update LBS profile
- tlsVersion
- Create LBS profile
- WLAN
- Modify
- networkSegmentationEnabled
- Modify
- networkSegmentationEnabled
- Modify Entire
- networkSegmentationEnabled
- Modify Entire
- networkSegmentationEnabled
- Retrieve
- networkSegmentationEnabled, oweTransWlanId
- Create - Standard Open
- networkSegmentationEnabled
- Create - Standard Open
- networkSegmentationEnabled
- Modify
- Ethernet Port Profile
- Retrieve - Ethernet Port Porfile
- clientIsolationEnabled, clientIsolationUnicastEnabled, clientIsolationMulticastEnabled, clientIsolationAutoVrrpEnabled, clientIsolationWhitelist, dhcpOption82
- Create - Ethernet Port Porfile
- clientIsolationEnabled, clientIsolationUnicastEnabled, clientIsolationMulticastEnabled, clientIsolationAutoVrrpEnabled, clientIsolationWhitelist, dhcpOption82
- Create - Ethernet Port Porfile
- clientIsolationEnabled, clientIsolationUnicastEnabled, clientIsolationMulticastEnabled, clientIsolationAutoVrrpEnabled, clientIsolationWhitelist, dhcpOption82
- Modify - Ethernet Port Porfile
- clientIsolationEnabled, clientIsolationUnicastEnabled, clientIsolationMulticastEnabled, clientIsolationAutoVrrpEnabled, clientIsolationWhitelist, dhcpOption82
- Modify - Ethernet Port Porfile
- clientIsolationEnabled, clientIsolationUnicastEnabled, clientIsolationMulticastEnabled, clientIsolationAutoVrrpEnabled, clientIsolationWhitelist, dhcpOption82
- Modify Entire - Ethernet Port Porfile
- clientIsolationEnabled, clientIsolationUnicastEnabled, clientIsolationMulticastEnabled, clientIsolationAutoVrrpEnabled, clientIsolationWhitelist, dhcpOption82
- Modify Entire - Ethernet Port Porfile
- clientIsolationEnabled, clientIsolationUnicastEnabled, clientIsolationMulticastEnabled, clientIsolationAutoVrrpEnabled, clientIsolationWhitelist, dhcpOption82
- Retrieve - Ethernet Port Porfile
- Access Point Operational
What’s Deprecated
- API
API Information ¶
Retrieve API information ¶
GET/apiInfo
Use this API command to retrieve API information.
200
Body
{
"apiSupportVersions": [
"v6_0",
"v6_1",
"v7_0",
"v8_0",
"v8_1",
"v8_2",
"v9_0"
]
}
Schema
{
"type": "object",
"properties": {
"apiSupportVersions": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
Logon ¶
Service Ticket ¶
Logon ¶
POST/v11_1/serviceTicket
Use this API command to log on to the controller and acquire a valid service ticket. The service ticket will expire in 24 hours. It is recommended to use the same valid service ticket for multiple API calls during its validity period.
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"
]
}
200
Body
{
"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/v11_1/serviceTicket
Use this API command to log off of the controller.
- serviceTicket
string
(required)
200
Session ID ¶
Retrieve ¶
GET/v11_1/session
Use this API command to retrieve information about the current logon session.
200
Body
{
"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"
}
}
}
Logon ¶
POST/v11_1/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"
]
}
200
Body
{
"controllerVersion": "1"
}
Schema
{
"type": "object",
"properties": {
"controllerVersion": {
"type": "string"
}
}
}
Session Management ¶
Retrieve ¶
GET/v11_1/sessionManagement
Use this API command to retrieve information about the current logon sessions.
200
Body
{
"totalCount": 2,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"authType": "PUBLIC_API",
"lastAccessTime": 1536290141430,
"lastAccessURI": "/v8_0/sessionManagement",
"sessionUuid": "apcc1b65-53cd-4f26-8c9b-3e7b055c7cdd",
"sourceIp": "127.0.0.1",
"userName": "admin",
"userUUID": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25"
},
{
"authType": "PUBLIC_API",
"lastAccessTime": 1536290095781,
"lastAccessURI": null,
"sessionUuid": "apcc1b65-53cd-4f26-8c9b-3e7b055c7cdd",
"sourceIp": "127.0.0.1",
"userName": "admin",
"userUUID": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25"
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"totalCount": {
"type": "integer"
},
"hasMore": {
"type": "boolean"
},
"firstIndex": {
"type": "integer"
},
"list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"lastAccessTime": {
"type": "string",
"description": "The last access time"
},
"lastAccessURI": {
"type": "string",
"description": "The last access URI"
},
"userUUID": {
"type": "string",
"description": "The user UUID"
},
"userName": {
"type": "string",
"description": "Logon user name"
},
"sessionUuid": {
"type": "string"
},
"sourceIp": {
"type": "string",
"description": "The source IP address"
},
"authType": {
"type": "string",
"description": "The authentication type of logon"
}
}
}
}
}
}
Ruckus Wireless AP Zone ¶
Retrieve List ¶
GET/v11_1/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, Maximum: 1000
- domainId
string
(optional)The domain ID. Default: current logon domain ID
200
Body
{
"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"
}
}
}
}
}
}
Retrieve Mesh Configuration ¶
GET/v11_1/rkszones/{id}/mesh
Use this API command to retrieve the mesh configuration of a zone.
200
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"ssid": {
"description": "SSID of the mesh network",
"type": "string"
},
"passphrase": {
"description": "Passphrase for the mesh network. Would be mandatory when the mesh is enabled.",
"type": "string"
},
"meshRadioIdx": {
"description": "Mesh radio index",
"type": "string",
"enum": [
"Radio24G",
"Radio5G"
],
"default": "Radio5G"
},
"zeroTouchStatus": {
"type": "boolean"
}
}
}
Retrieve AP Model ¶
GET/v11_1/rkszones/{zoneId}/apmodel/{model}
Use this API command to retrieve AP model specific configuration that belong to a zone.
200
Body
{
"ledStatusEnabled": true,
"lacp": {
"keepApSetting": false,
"enabled": true,
"bondPortProfileId": "ed395d1c-45a7-4d85-994f-244c38c83f2c"
},
"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"
]
},
"lacp": {
"type": "object",
"additionalProperties": false,
"properties": {
"keepApSetting": {
"type": "boolean"
},
"enabled": {
"type": "boolean"
},
"bondPortProfileId": {
"type": [
"string",
"null"
]
}
}
},
"cellularSettings": {
"type": "object",
"additionalProperties": false,
"properties": {
"mobileAPName": {
"type": [
"string",
"null"
],
"maxLength": 100,
"pattern": "^([!-?A-~]([!-?A-~]){0,62}[!-?A-~]|[!-?A-~]?)$"
},
"mobileAPName2": {
"type": [
"string",
"null"
],
"maxLength": 100,
"pattern": "^([!-?A-~]([!-?A-~]){0,62}[!-?A-~]|[!-?A-~]?)$"
},
"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",
"_802_3bt_Class_5",
"_802_3bt_Class_6",
"_802_3bt_Class_7",
"_802_3bt_Class_8",
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"
},
"ethPortProfile": {
"type": [
"object",
"null"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"required": [
"portName",
"enabled"
]
}
}
}
}
Retrieve AP Model Common Attribute ¶
GET/v11_1/rkszones/{zoneId}/apmodel/{model}/commonAttribute
Use this API command to retrieve AP model common attribute that belong to a zone.
200
Body
{
"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,
"meshRadioCaps": "1,2",
"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"
]
},
"meshRadioCaps": {
"type": "string"
},
"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": "integer",
"format": "int64"
},
"poeModeCaps": {
"type": "string"
}
}
}
Retrieve AP Firmware List ¶
GET/v11_1/rkszones/{zoneId}/apFirmware
Use this API command to retrieve AP Firmware the list that belong to a zone.
200
Body
{
"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"
}
}
}
}
}
}
Get Available GRE Tunnel Profiles. ¶
GET/v11_1/rkszones/{zoneId}/availableTunnelProfiles
Get available GRE tunnel profiles of this Zone.
200
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": "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/v11_1/rkszones/{zoneId}/availableIpsecProfiles
Get available IPSec tunnel profiles of this Zone.
200
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": "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/v11_1/rkszones/{id}
Use this API command to retrieve Ruckus Wireless AP zones configuration.
200
Body
{
"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"
},
"radioConfig": {
"radio24g": {
"autoCellSizing": false,
"txPower": "Full",
"channelWidth": 0,
"channel": 0,
"channelRange": [
1,
6,
11
],
"availableChannelRange": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11
],
"autoChannelSelection": {
"channelSelectMode": "ChannelFly",
"channelFlyMtbc": 300,
"channelFlyChangeFrequency": 80,
"channelFlyOptimizationTimePeriod": [
"02:00-03:00",
"04:00-05:00"
]
},
"protectionMode": "CTS_ONLY",
"backgroundScanning": {
"frequencyInSec": 20
}
},
"radio5g": {
"autoCellSizing": false,
"txPower": "Full",
"channelWidth": 0,
"channel": 0,
"channelRange": [
36,
40,
44,
48,
149,
153,
157,
161
],
"availableChannelRange": [
36,
40,
44,
48,
149,
153,
157,
161
],
"secondaryChannel": null,
"channelIndoor": 0,
"secondaryChannelIndoor": 0,
"channelRangeIndoor": [
36,
40,
44,
48,
149,
153,
157,
161
],
"availableChannelRangeIndoor": [
36,
40,
44,
48,
149,
153,
157,
161
],
"dfsChannelEnabled": false,
"cbandChannelEnabled": false,
"cbandChannelLicenseEnabled": false,
"channel144Enabled": false,
"channelModeEnabled": false,
"autoChannelSelection": {
"channelSelectMode": "ChannelFly",
"channelFlyMtbc": 300,
"channelFlyChangeFrequency": 80,
"channelFlyOptimizationTimePeriod": [
"02:00-03:00",
"04:00-05:00"
]
},
"backgroundScanning": {
"frequencyInSec": 20
}
},
"radio5gUpper": {
"autoCellSizing": false,
"txPower": "Full",
"channelWidth": 0,
"channel": 0,
"channelRange": [
36,
40,
44,
48,
149,
153,
157,
161
],
"availableChannelRange": [
149,
153,
157,
161
],
"secondaryChannel": null,
"channelIndoor": 0,
"secondaryChannelIndoor": 0,
"channelRangeIndoor": [
36,
40,
44,
48,
149,
153,
157,
161
],
"availableChannelRangeIndoor": [
149,
153,
157,
161
],
"dfsChannelEnabled": false,
"cbandChannelEnabled": false,
"cbandChannelLicenseEnabled": false,
"channel144Enabled": false,
"channelModeEnabled": false,
"autoChannelSelection": {
"channelSelectMode": "ChannelFly",
"channelFlyMtbc": 300,
"channelFlyChangeFrequency": 80,
"channelFlyOptimizationTimePeriod": [
"02:00-03:00",
"04:00-05:00"
]
},
"backgroundScanning": {
"frequencyInSec": 20
}
},
"radio5gLower": {
"autoCellSizing": false,
"txPower": "Full",
"channelWidth": 0,
"channel": 0,
"channelRange": [
36,
40,
44,
48,
149,
153,
157,
161
],
"availableChannelRange": [
36,
40,
44,
48
],
"secondaryChannel": null,
"channelIndoor": 0,
"secondaryChannelIndoor": 0,
"channelRangeIndoor": [
36,
40,
44,
48,
149,
153,
157,
161
],
"availableChannelRangeIndoor": [
36,
40,
44,
48
],
"dfsChannelEnabled": false,
"cbandChannelEnabled": false,
"cbandChannelLicenseEnabled": false,
"channel144Enabled": false,
"channelModeEnabled": false,
"autoChannelSelection": {
"channelSelectMode": "ChannelFly",
"channelFlyMtbc": 300,
"channelFlyChangeFrequency": 80,
"channelFlyOptimizationTimePeriod": [
"02:00-03:00",
"04:00-05:00"
]
},
"backgroundScanning": {
"frequencyInSec": 20
}
},
"radio6g": {
"autoCellSizing": false,
"txPower": "Full",
"channelWidth": 0,
"channel": 0,
"channelRange": [
1,
5,
9,
13,
17,
21,
25,
29,
33,
37,
41,
45,
49,
53,
57,
61,
65,
69,
73,
77,
81,
85,
89,
93,
97,
101,
105,
109,
113,
117,
121,
125,
129,
133,
137,
141,
145,
149,
153,
157,
161,
165,
169,
173,
177,
181,
185,
189,
193,
197,
201,
205,
209,
213,
217,
221
],
"availableChannelRange": [
1,
5,
9,
13,
17,
21,
25,
29,
33,
37,
41,
45,
49,
53,
57,
61,
65,
69,
73,
77,
81,
85,
89,
93,
97,
101,
105,
109,
113,
117,
121,
125,
129,
133,
137,
141,
145,
149,
153,
157,
161,
165,
169,
173,
177,
181,
185,
189,
193,
197,
201,
205,
209,
213,
217,
221
],
"lowPowerIndoorModeEnabled": true,
"autoChannelSelection": {
"channelSelectMode": "ChannelFly",
"channelFlyMtbc": 300,
"channelFlyChangeFrequency": 80,
"channelFlyOptimizationTimePeriod": [
"02:00-03:00",
"04:00-05:00"
]
},
"backgroundScanning": {
"frequencyInSec": 20
},
"bssMinRate": "HE-MCS0",
"mgmtTxRate": "6 mbps",
"multicastUplinkRateLimit": 3,
"multicastDownlinkRateLimit": 3
},
"dual5gEnabled": false
},
"syslog": null,
"smartMonitor": null,
"clientAdmissionControl24": null,
"clientAdmissionControl50": null,
"tunnelType": "No_Tunneled",
"tunnelProfile": null,
"loadBalancing": {
"loadBalancingMethod": "BASED_ON_CLIENT_COUNT",
"bandBalancing": {
"wifi24Percentage": 10
},
"steeringMode": "BASIC"
},
"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,
"channelEvaluationInterval": 777,
"apMgmtVlan": {
"id": 1,
"mode": "KEEP"
},
"ipsecProfile": {
"id": "ipsecProfileId",
"name": "ipsecProfileName"
},
"restrictedApAccessEnabled": true,
"restrictedApAccessProfileId": "f5b92938-aa4e-4d02-90ea-273799ff689b",
"bonjourFencingPolicyEnabled": true,
"bonjourFencingPolicy": {
"id": "bonjourFencingPolicyId",
"name": "bonjourFencingPolicyName"
},
"recoverySsid": {
"recoverySsidEnabled": true
},
"dhcpSiteConfig": {
"zoneName": "zoneK",
"siteEnabled": true,
"portSelectionEnabled": false,
"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,
"snmpConfigType": "CUSTOM",
"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",
"paloAltoFirewallProfileId": "2f59b0f4-c86f-11e8-a8d5-f2801f1b9fd1",
"apHccdEnabled": true,
"apHccdPersist": true,
"myRuckusConfig": {
"aclForTunnelWlanAndVlanEnable": false
},
"bssColoringEnable": true
}
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" : "Time zone",
"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. Would be mandatory when the mesh is enabled.",
"type" : "string"
},
"meshRadioIdx" : {
"description" : "Mesh radio index",
"type" : "string",
"enum" : [ "Radio24G", "Radio5G" ],
"default" : "Radio5G"
},
"zeroTouchStatus" : {
"type" : "boolean"
}
}
},
"syslog" : {
"description" : "Syslog configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"syslogConfigType" : {
"description" : "Syslog configuration type.",
"type" : "string",
"enum" : [ "CUSTOM", "AP_SYSLOG_SERVER_PROFILE" ],
"default" : "CUSTOM"
},
"syslogServerProfileId" : {
"description" : "Syslog server profile ID.",
"type" : "string"
},
"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
}
}
},
"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"
}
}
},
"loadBalancing" : {
"description" : "Load Balancing configuration of the zone",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"loadBalancingMethod" : {
"type" : "string",
"enum" : [ "BASED_ON_CLIENT_COUNT", "BASED_ON_CAPACITY", "OFF" ],
"default" : "BASED_ON_CLIENT_COUNT"
},
"bandBalancing" : {
"description" : "Band Balancing configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"wifi24Percentage" : {
"description" : "Percentage of client load on 2.4GHz radio band",
"type" : "integer",
"minimum" : 0,
"maximum" : 100,
"default" : 25
}
}
},
"steeringMode" : {
"description" : "Steering 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"
}
}
},
"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"
},
"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"
}
}
},
"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"
},
"restrictedApAccessEnabled" : {
"description" : "Enable Restricted AP Access of the zone.",
"type" : "boolean"
},
"restrictedApAccessProfileId" : {
"description" : "Restricted AP Access Profile Id of the zone.",
"type" : "string"
},
"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 Config in Zone",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"siteEnabled" : {
"description" : "DHCP Service Enabling Status",
"type" : "boolean"
},
"portSelectionEnabled" : {
"description" : "DHCP Port Selection Enabled",
"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"
},
"apServerType" : {
"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"
},
"snmpConfigType" : {
"description" : "The config type of SNMP",
"type" : "string",
"enum" : [ "CUSTOM", "AP_SNMP_AGENT_PROFILE" ],
"default" : "CUSTOM"
},
"apSnmpAgentProfileId" : {
"type" : "string"
},
"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", "readEnabled", "writeEnabled", "notificationEnabled" ]
}
},
"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", "readEnabled", "writeEnabled", "notificationEnabled" ]
}
}
}
},
"recoverySsid" : {
"description" : "Recovery SSID",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"recoverySsidPskKey" : {
"description" : "Custom recovery ssid passphrase. If passphrase has been customized, this property cannot be empty in the future. ",
"type" : "string"
},
"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"
}
}
}
},
"ipsecTunnelMode" : {
"type" : "string",
"enum" : [ "DISABLE", "SOFT_GRE", "RUCKUS_GRE" ]
},
"rksGreForwardBroadcast" : {
"description" : "Ruckus GRE tunnel broadcast packet forwarding",
"type" : "boolean",
"default" : false
},
"sshTunnelEncryption" : {
"type" : "string",
"enum" : [ "AES128", "AES256" ]
},
"lteBandLockChannels" : {
"description" : "LTE band lock channels options",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"simCardId" : {
"description" : "SIM card ID(Primary:0, Secondary:1)",
"type" : "integer"
},
"type" : {
"description" : "LTE chipset SKU type",
"type" : "string"
},
"channel4g" : {
"description" : "LTE 4G channels",
"type" : "string"
},
"channel3g" : {
"description" : "LTE 3G channels",
"type" : "string"
}
}
}
},
"paloAltoFirewallProfileId" : {
"type" : "string"
},
"apHccdEnabled" : {
"description" : "Historical Connection Failures allows the AP to report historical client connection failures for this zone.",
"type" : "boolean",
"default" : false
},
"apHccdPersist" : {
"description" : "Allow Historical Connection Failures to be persisted.",
"type" : "boolean",
"default" : true
},
"aaaAffinityEnabled" : {
"type" : "boolean"
},
"awsVenue" : {
"description" : "Venue Code",
"type" : "string",
"minLength" : 0,
"maxLength" : 64,
"pattern" : "^[!-~]{0,63}[!-~]$|^$"
},
"dpGroupId" : {
"description" : "DP Group ID",
"type" : "string"
},
"enforcePriorityDpGroupEnable" : {
"type" : "boolean"
},
"myRuckusConfig" : {
"description" : "My.Ruckus configuration",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"aclForTunnelWlanAndVlanEnable" : {
"description" : "My.Ruckus support for tunnel-wlan/vlan",
"type" : "boolean"
}
},
"required" : [ "aclForTunnelWlanAndVlanEnable" ]
},
"apHttp2CertChkEnable" : {
"type" : "boolean"
},
"bssColoringEnable" : {
"description" : "BSS coloring mechanism enabled.",
"type" : "boolean"
},
"radioConfig" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"radio24g" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"autoCellSizing" : {
"type" : "boolean"
},
"txPower" : {
"type" : "string",
"enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
"default" : "Full"
},
"channelWidth" : {
"type" : "integer",
"enum" : [ 0, 20, 40 ],
"default" : 0
},
"channel" : {
"type" : "integer"
},
"channelRange" : {
"type" : "array",
"items" : {
"type" : "integer"
}
},
"availableChannelRange" : {
"type" : "array",
"items" : {
"type" : "integer"
}
},
"wlanGroupId" : {
"type" : "string"
},
"wlanServiceEnabled" : {
"type" : "boolean"
},
"protectionMode" : {
"type" : "string",
"enum" : [ "NONE", "CTS_ONLY", "RTS_CTS" ],
"default" : "RTS_CTS"
},
"backgroundScanning" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"frequencyInSec" : {
"type" : "integer",
"minimum" : 1,
"maximum" : 65535,
"default" : 20
}
},
"required" : [ "frequencyInSec" ]
},
"autoChannelSelection" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"channelSelectMode" : {
"type" : "string",
"enum" : [ "None", "BackgroundScanning", "ChannelFly" ],
"default" : "BackgroundScanning"
},
"channelFlyMtbc" : {
"type" : "integer",
"default" : 480,
"minimum" : 100,
"maximum" : 1440
},
"channelFlyChangeFrequency" : {
"type" : "integer",
"default" : 33,
"minimum" : 1,
"maximum" : 100
},
"channelFlyOptimizationTimePeriod" : {
"type" : "array",
"items" : {
"type" : "string",
"pattern" : "^([0-1][0-9]|2[0-3]):00-(([0-1][0-9]|2[0-4]):00)$"
}
}
}
}
}
},
"radio5g" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"autoCellSizing" : {
"type" : "boolean"
},
"txPower" : {
"type" : "string",
"enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
"default" : "Full"
},
"channelWidth" : {
"type" : "integer",
"enum" : [ 0, 20, 40, 80, 8080, 160 ],
"default" : 0
},
"channel" : {
"type" : "integer"
},
"channelIndoor" : {
"type" : "integer"
},
"secondaryChannel" : {
"type" : "integer"
},
"secondaryChannelIndoor" : {
"type" : "integer"
},
"channelRange" : {
"type" : "array",
"items" : {
"type" : "integer"
}
},
"channelRangeIndoor" : {
"type" : "array",
"items" : {
"type" : "integer"
}
},
"dfsChannelEnabled" : {
"type" : "boolean"
},
"cbandChannelEnabled" : {
"type" : "boolean"
},
"cbandChannelLicenseEnabled" : {
"type" : "boolean"
},
"channel144Enabled" : {
"type" : "boolean"
},
"channelModeEnabled" : {
"type" : "boolean"
},
"availableChannelRange" : {
"type" : "array",
"items" : {
"type" : "integer"
}
},
"availableChannelRangeIndoor" : {
"type" : "array",
"items" : {
"type" : "integer"
}
},
"wlanGroupId" : {
"type" : "string"
},
"protectionMode" : {
"type" : "string",
"enum" : [ "NONE", "CTS_ONLY", "RTS_CTS" ],
"default" : "RTS_CTS"
},
"backgroundScanning" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"frequencyInSec" : {
"type" : "integer",
"minimum" : 1,
"maximum" : 65535,
"default" : 20
}
},
"required" : [ "frequencyInSec" ]
},
"autoChannelSelection" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"channelSelectMode" : {
"type" : "string",
"enum" : [ "None", "BackgroundScanning", "ChannelFly" ],
"default" : "BackgroundScanning"
},
"channelFlyMtbc" : {
"type" : "integer",
"default" : 480,
"minimum" : 100,
"maximum" : 1440
},
"channelFlyChangeFrequency" : {
"type" : "integer",
"default" : 33,
"minimum" : 1,
"maximum" : 100
},
"channelFlyOptimizationTimePeriod" : {
"type" : "array",
"items" : {
"type" : "string",
"pattern" : "^([0-1][0-9]|2[0-3]):00-(([0-1][0-9]|2[0-4]):00)$"
}
}
}
}
}
},
"radio5gUpper" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"autoCellSizing" : {
"type" : "boolean"
},
"txPower" : {
"type" : "string",
"enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
"default" : "Full"
},
"channelWidth" : {
"type" : "integer",
"enum" : [ 0, 20, 40, 80, 8080, 160 ],
"default" : 0
},
"channel" : {
"type" : "integer"
},
"channelIndoor" : {
"type" : "integer"
},
"secondaryChannel" : {
"type" : "integer"
},
"secondaryChannelIndoor" : {
"type" : "integer"
},
"channelRange" : {
"type" : "array",
"items" : {
"type" : "integer"
}
},
"channelRangeIndoor" : {
"type" : "array",
"items" : {
"type" : "integer"
}
},
"dfsChannelEnabled" : {
"type" : "boolean"
},
"cbandChannelEnabled" : {
"type" : "boolean"
},
"cbandChannelLicenseEnabled" : {
"type" : "boolean"
},
"channel144Enabled" : {
"type" : "boolean"
},
"channelModeEnabled" : {
"type" : "boolean"
},
"availableChannelRange" : {
"type" : "array",
"items" : {
"type" : "integer"
}
},
"availableChannelRangeIndoor" : {
"type" : "array",
"items" : {
"type" : "integer"
}
},
"wlanGroupId" : {
"type" : "string"
},
"protectionMode" : {
"type" : "string",
"enum" : [ "NONE", "CTS_ONLY", "RTS_CTS" ],
"default" : "RTS_CTS"
},
"backgroundScanning" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"frequencyInSec" : {
"type" : "integer",
"minimum" : 1,
"maximum" : 65535,
"default" : 20
}
},
"required" : [ "frequencyInSec" ]
},
"autoChannelSelection" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"channelSelectMode" : {
"type" : "string",
"enum" : [ "None", "BackgroundScanning", "ChannelFly" ],
"default" : "BackgroundScanning"
},
"channelFlyMtbc" : {
"type" : "integer",
"default" : 480,
"minimum" : 100,
"maximum" : 1440
},
"channelFlyChangeFrequency" : {
"type" : "integer",
"default" : 33,
"minimum" : 1,
"maximum" : 100
},
"channelFlyOptimizationTimePeriod" : {
"type" : "array",
"items" : {
"type" : "string",
"pattern" : "^([0-1][0-9]|2[0-3]):00-(([0-1][0-9]|2[0-4]):00)$"
}
}
}
}
}
},
"radio5gLower" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"autoCellSizing" : {
"type" : "boolean"
},
"txPower" : {
"type" : "string",
"enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
"default" : "Full"
},
"channelWidth" : {
"type" : "integer",
"enum" : [ 0, 20, 40, 80, 8080, 160 ],
"default" : 0
},
"channel" : {
"type" : "integer"
},
"channelIndoor" : {
"type" : "integer"
},
"secondaryChannel" : {
"type" : "integer"
},
"secondaryChannelIndoor" : {
"type" : "integer"
},
"channelRange" : {
"type" : "array",
"items" : {
"type" : "integer"
}
},
"channelRangeIndoor" : {
"type" : "array",
"items" : {
"type" : "integer"
}
},
"dfsChannelEnabled" : {
"type" : "boolean"
},
"cbandChannelEnabled" : {
"type" : "boolean"
},
"cbandChannelLicenseEnabled" : {
"type" : "boolean"
},
"channel144Enabled" : {
"type" : "boolean"
},
"channelModeEnabled" : {
"type" : "boolean"
},
"availableChannelRange" : {
"type" : "array",
"items" : {
"type" : "integer"
}
},
"availableChannelRangeIndoor" : {
"type" : "array",
"items" : {
"type" : "integer"
}
},
"wlanGroupId" : {
"type" : "string"
},
"protectionMode" : {
"type" : "string",
"enum" : [ "NONE", "CTS_ONLY", "RTS_CTS" ],
"default" : "RTS_CTS"
},
"backgroundScanning" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"frequencyInSec" : {
"type" : "integer",
"minimum" : 1,
"maximum" : 65535,
"default" : 20
}
},
"required" : [ "frequencyInSec" ]
},
"autoChannelSelection" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"channelSelectMode" : {
"type" : "string",
"enum" : [ "None", "BackgroundScanning", "ChannelFly" ],
"default" : "BackgroundScanning"
},
"channelFlyMtbc" : {
"type" : "integer",
"default" : 480,
"minimum" : 100,
"maximum" : 1440
},
"channelFlyChangeFrequency" : {
"type" : "integer",
"default" : 33,
"minimum" : 1,
"maximum" : 100
},
"channelFlyOptimizationTimePeriod" : {
"type" : "array",
"items" : {
"type" : "string",
"pattern" : "^([0-1][0-9]|2[0-3]):00-(([0-1][0-9]|2[0-4]):00)$"
}
}
}
}
}
},
"radio6g" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"autoCellSizing" : {
"type" : "boolean"
},
"txPower" : {
"type" : "string",
"enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
"default" : "Full"
},
"channelWidth" : {
"type" : "integer",
"enum" : [ 0, 20, 40, 80, 8080, 160 ],
"default" : 0
},
"channel" : {
"type" : "integer"
},
"channelRange" : {
"type" : "array",
"items" : {
"type" : "integer"
}
},
"lowPowerIndoorModeEnabled" : {
"type" : "boolean"
},
"availableChannelRange" : {
"type" : "array",
"items" : {
"type" : "integer"
}
},
"wlanGroupId" : {
"type" : "string"
},
"wlanServiceEnabled" : {
"type" : "boolean"
},
"protectionMode" : {
"type" : "string",
"enum" : [ "NONE", "CTS_ONLY", "RTS_CTS" ],
"default" : "RTS_CTS"
},
"backgroundScanning" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"frequencyInSec" : {
"type" : "integer",
"minimum" : 1,
"maximum" : 65535,
"default" : 20
}
},
"required" : [ "frequencyInSec" ]
},
"autoChannelSelection" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"channelSelectMode" : {
"type" : "string",
"enum" : [ "None", "BackgroundScanning", "ChannelFly" ],
"default" : "BackgroundScanning"
},
"channelFlyMtbc" : {
"type" : "integer",
"default" : 480,
"minimum" : 100,
"maximum" : 1440
},
"channelFlyChangeFrequency" : {
"type" : "integer",
"default" : 33,
"minimum" : 1,
"maximum" : 100
},
"channelFlyOptimizationTimePeriod" : {
"type" : "array",
"items" : {
"type" : "string",
"pattern" : "^([0-1][0-9]|2[0-3]):00-(([0-1][0-9]|2[0-4]):00)$"
}
}
}
},
"bssMinRate" : {
"description" : "6G BSS minimum rate (mbps)",
"type" : "string",
"enum" : [ "HE-MCS0", "HE-MCS1", "HE-MCS2", "HE-MCS3" ]
},
"mgmtTxRate" : {
"description" : "6G management TX rate (mbps)",
"type" : "string",
"enum" : [ "6 mbps", "9 mbps", "12 mbps", "18 mbps", "24 mbps", "36 mbps", "48 mbps", "54 mbps" ]
},
"multicastUplinkRateLimit" : {
"description" : "Multicast data rate limit for uplink (mbps), set to 0 to disable.",
"type" : "integer",
"minimum" : 0,
"maximum" : 100
},
"multicastDownlinkRateLimit" : {
"description" : "Multicast data rate limit for downlink (mbps), set to 0 to disable.",
"type" : "integer",
"minimum" : 0,
"maximum" : 100
}
}
},
"dual5gEnabled" : {
"type" : "boolean"
}
}
}
}
}
Create Zone of IPv6 ¶
POST/v11_1/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"
},
"radioConfig": {
"radio24g": {
"txPower": "Full",
"channelWidth": 20,
"channel": 0,
"channelRange": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11
],
"autoChannelSelection": {
"channelSelectMode": "ChannelFly",
"channelFlyMtbc": 300,
"channelFlyChangeFrequency": 80,
"channelFlyOptimizationTimePeriod": [
"02:00-03:00",
"04:00-05:00"
]
},
"protectionMode": "CTS_ONLY",
"backgroundScanning": {
"frequencyInSec": 20
}
},
"radio5g": {
"txPower": "Full",
"channelWidth": 40,
"channel": 0,
"channelIndoor": 0,
"channelRange": [
149,
153,
157,
161
],
"channelRangeIndoor": [
36,
40,
44,
48,
149,
153,
157,
161
],
"dfsChannelEnabled": false,
"cbandChannelEnabled": false,
"cbandChannelLicenseEnabled": false,
"channel144Enabled": false,
"channelModeEnabled": false,
"autoChannelSelection": {
"channelSelectMode": "ChannelFly",
"channelFlyMtbc": 300,
"channelFlyChangeFrequency": 80,
"channelFlyOptimizationTimePeriod": [
"02:00-03:00",
"04:00-05:00"
]
},
"backgroundScanning": {
"frequencyInSec": 20
}
}
},
"syslog": {
"syslogConfigType": "CUSTOM",
"syslogServerProfileId": "",
"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
},
"tunnelType": "RuckusGRE",
"loadBalancing": {
"loadBalancingMethod": "BASED_ON_CLIENT_COUNT",
"bandBalancing": {
"wifi24Percentage": 10
},
"steeringMode": "BASIC"
},
"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,
"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,
"snmpConfigType": "CUSTOM",
"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",
"paloAltoFirewallProfileId": "2f59b0f4-c86f-11e8-a8d5-f2801f1b9fd1",
"apHccdEnabled": true,
"apHccdPersist": true,
"myRuckusConfig": {
"aclForTunnelWlanAndVlanEnable": false
},
"bssColoringEnable": true
}
Schema
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"domainId" : {
"description" : "Identifier of the management domain to which the zone belongs",
"type" : "string"
},
"dpGroupId" : {
"description" : "DP Group ID",
"type" : "string"
},
"enforcePriorityDpGroupEnable" : {
"description" : "Enable to enforce priority of DP Group",
"type" : "boolean"
},
"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. Would be mandatory when the mesh is enabled.",
"type" : "string"
},
"meshRadioIdx" : {
"description" : "Mesh radio index",
"type" : "string",
"enum" : [ "Radio24G", "Radio5G" ],
"default" : "Radio5G"
},
"zeroTouchStatus" : {
"type" : "boolean"
}
}
},
"syslog" : {
"description" : "Syslog configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"syslogConfigType" : {
"description" : "Syslog configuration type.",
"type" : "string",
"enum" : [ "CUSTOM", "AP_SYSLOG_SERVER_PROFILE" ],
"default" : "CUSTOM"
},
"syslogServerProfileId" : {
"description" : "Syslog server profile ID.",
"type" : "string"
},
"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
}
}
},
"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"
}
}
},
"loadBalancing" : {
"description" : "Load Balancing configuration of the zone",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"loadBalancingMethod" : {
"type" : "string",
"enum" : [ "BASED_ON_CLIENT_COUNT", "BASED_ON_CAPACITY", "OFF" ],
"default" : "BASED_ON_CLIENT_COUNT"
},
"bandBalancing" : {
"description" : "Band Balancing configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"wifi24Percentage" : {
"description" : "Percentage of client load on 2.4GHz radio band",
"type" : "integer",
"minimum" : 0,
"maximum" : 100,
"default" : 25
}
}
},
"steeringMode" : {
"description" : "Steering 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"
}
}
},
"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"
},
"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"
}
}
},
"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"
},
"portSelectionEnabled" : {
"description" : "DHCP Port Selection Enabled",
"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"
},
"apServerType" : {
"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"
},
"snmpConfigType" : {
"description" : "The config type of SNMP",
"type" : "string",
"enum" : [ "CUSTOM", "AP_SNMP_AGENT_PROFILE" ],
"default" : "CUSTOM"
},
"apSnmpAgentProfileId" : {
"type" : "string"
},
"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", "readEnabled", "writeEnabled", "notificationEnabled" ]
}
},
"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", "readEnabled", "writeEnabled", "notificationEnabled" ]
}
}
}
},
"recoverySsid" : {
"description" : "Recovery SSID",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"recoverySsidPskKey" : {
"description" : "Custom recovery ssid passphrase. If passphrase has been customized, this property cannot be empty in the future. ",
"type" : "string"
},
"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"
}
}
}
},
"ipsecTunnelMode" : {
"type" : "string",
"enum" : [ "DISABLE", "SOFT_GRE", "RUCKUS_GRE" ]
},
"rksGreForwardBroadcast" : {
"description" : "Ruckus GRE tunnel broadcast packet forwarding",
"type" : "boolean",
"default" : false
},
"sshTunnelEncryption" : {
"type" : "string",
"enum" : [ "AES128", "AES256" ],
"default" : "AES128"
},
"lteBandLockChannels" : {
"description" : "LTE band lock channels options",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"simCardId" : {
"description" : "SIM card ID(Primary:0, Secondary:1)",
"type" : "integer"
},
"type" : {
"description" : "LTE chipset SKU type",
"type" : "string"
},
"channel4g" : {
"description" : "LTE 4G channels",
"type" : "string"
},
"channel3g" : {
"description" : "LTE 3G channels",
"type" : "string"
}
}
}
},
"paloAltoFirewallProfileId" : {
"type" : "string"
},
"apHccdEnabled" : {
"description" : "Historical Connection Failures allows the AP to report historical client connection failures for this zone.",
"type" : "boolean",
"default" : false
},
"apHccdPersist" : {
"description" : "Allow Historical Connection Failures to be persisted.",
"type" : "boolean",
"default" : true
},
"myRuckusConfig" : {
"description" : "My.Ruckus configuration",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"aclForTunnelWlanAndVlanEnable" : {
"description" : "My.Ruckus support for tunnel-wlan/vlan",
"type" : "boolean"
}
},
"required" : [ "aclForTunnelWlanAndVlanEnable" ]
},
"apHttp2CertChkEnable" : {
"type" : "boolean"
},
"bssColoringEnable" : {
"description" : "Turn on/off BSS coloring mechanism.",
"type" : "boolean",
"default" : true
},
"radioConfig" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"radio24g" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"autoCellSizing" : {
"type" : "boolean"
},
"txPower" : {
"type" : "string",
"enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
"default" : "Full"
},
"channelWidth" : {
"type" : "integer",
"enum" : [ 0, 20, 40 ],
"default" : 0
},
"channel" : {
"type" : "integer"
},
"channelRange" : {
"type" : "array",
"items" : {
"type" : "integer"
},
"minItems" : 1
},
"backgroundScanning" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"frequencyInSec" : {
"type" : "integer",
"minimum" : 1,
"maximum" : 65535,
"default" : 20
}
},
"required" : [ "frequencyInSec" ]
},
"protectionMode" : {
"type" : "string",
"enum" : [ "NONE", "CTS_ONLY", "RTS_CTS" ],
"default" : "RTS_CTS"
},
"autoChannelSelection" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"channelSelectMode" : {
"type" : "string",
"enum" : [ "None", "BackgroundScanning", "ChannelFly" ],
"default" : "BackgroundScanning"
},
"channelFlyMtbc" : {
"type" : "integer",
"default" : 480,
"minimum" : 100,
"maximum" : 1440
},
"channelFlyChangeFrequency" : {
"type" : "integer",
"default" : 33,
"minimum" : 1,
"maximum" : 100
},
"channelFlyOptimizationTimePeriod" : {
"type" : "array",
"items" : {
"type" : "string",
"pattern" : "^([0-1][0-9]|2[0-3]):00-(([0-1][0-9]|2[0-4]):00)$"
}
}
}
}
}
},
"radio5g" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"autoCellSizing" : {
"type" : "boolean"
},
"txPower" : {
"type" : "string",
"enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
"default" : "Full"
},
"channelWidth" : {
"type" : "integer",
"enum" : [ 0, 20, 40, 80, 8080, 160 ],
"default" : 0
},
"channel" : {
"type" : "integer"
},
"channelIndoor" : {
"type" : "integer"
},
"channelRange" : {
"type" : "array",
"items" : {
"type" : "integer"
},
"minItems" : 1
},
"channelRangeIndoor" : {
"type" : "array",
"items" : {
"type" : "integer"
}
},
"secondaryChannel" : {
"type" : "integer"
},
"secondaryChannelIndoor" : {
"type" : "integer"
},
"dfsChannelEnabled" : {
"type" : "boolean"
},
"cbandChannelEnabled" : {
"type" : "boolean"
},
"cbandChannelLicenseEnabled" : {
"type" : "boolean"
},
"channel144Enabled" : {
"type" : "boolean"
},
"channelModeEnabled" : {
"type" : "boolean"
},
"backgroundScanning" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"frequencyInSec" : {
"type" : "integer",
"minimum" : 1,
"maximum" : 65535,
"default" : 20
}
},
"required" : [ "frequencyInSec" ]
},
"autoChannelSelection" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"channelSelectMode" : {
"type" : "string",
"enum" : [ "None", "BackgroundScanning", "ChannelFly" ],
"default" : "BackgroundScanning"
},
"channelFlyMtbc" : {
"type" : "integer",
"default" : 480,
"minimum" : 100,
"maximum" : 1440
},
"channelFlyChangeFrequency" : {
"type" : "integer",
"default" : 33,
"minimum" : 1,
"maximum" : 100
},
"channelFlyOptimizationTimePeriod" : {
"type" : "array",
"items" : {
"type" : "string",
"pattern" : "^([0-1][0-9]|2[0-3]):00-(([0-1][0-9]|2[0-4]):00)$"
}
}
}
}
}
},
"radio5gLower" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"autoCellSizing" : {
"type" : "boolean"
},
"txPower" : {
"type" : "string",
"enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
"default" : "Full"
},
"channelWidth" : {
"type" : "integer",
"enum" : [ 0, 20, 40, 80, 8080, 160 ],
"default" : 0
},
"channel" : {
"type" : "integer"
},
"channelIndoor" : {
"type" : "integer"
},
"channelRange" : {
"type" : "array",
"items" : {
"type" : "integer"
},
"minItems" : 1
},
"channelRangeIndoor" : {
"type" : "array",
"items" : {
"type" : "integer"
}
},
"secondaryChannel" : {
"type" : "integer"
},
"secondaryChannelIndoor" : {
"type" : "integer"
},
"dfsChannelEnabled" : {
"type" : "boolean"
},
"cbandChannelEnabled" : {
"type" : "boolean"
},
"cbandChannelLicenseEnabled" : {
"type" : "boolean"
},
"channel144Enabled" : {
"type" : "boolean"
},
"channelModeEnabled" : {
"type" : "boolean"
},
"backgroundScanning" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"frequencyInSec" : {
"type" : "integer",
"minimum" : 1,
"maximum" : 65535,
"default" : 20
}
},
"required" : [ "frequencyInSec" ]
},
"autoChannelSelection" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"channelSelectMode" : {
"type" : "string",
"enum" : [ "None", "BackgroundScanning", "ChannelFly" ],
"default" : "BackgroundScanning"
},
"channelFlyMtbc" : {
"type" : "integer",
"default" : 480,
"minimum" : 100,
"maximum" : 1440
},
"channelFlyChangeFrequency" : {
"type" : "integer",
"default" : 33,
"minimum" : 1,
"maximum" : 100
},
"channelFlyOptimizationTimePeriod" : {
"type" : "array",
"items" : {
"type" : "string",
"pattern" : "^([0-1][0-9]|2[0-3]):00-(([0-1][0-9]|2[0-4]):00)$"
}
}
}
}
}
},
"radio5gUpper" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"autoCellSizing" : {
"type" : "boolean"
},
"txPower" : {
"type" : "string",
"enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
"default" : "Full"
},
"channelWidth" : {
"type" : "integer",
"enum" : [ 0, 20, 40, 80, 8080, 160 ],
"default" : 0
},
"channel" : {
"type" : "integer"
},
"channelIndoor" : {
"type" : "integer"
},
"channelRange" : {
"type" : "array",
"items" : {
"type" : "integer"
},
"minItems" : 1
},
"channelRangeIndoor" : {
"type" : "array",
"items" : {
"type" : "integer"
}
},
"secondaryChannel" : {
"type" : "integer"
},
"secondaryChannelIndoor" : {
"type" : "integer"
},
"dfsChannelEnabled" : {
"type" : "boolean"
},
"cbandChannelEnabled" : {
"type" : "boolean"
},
"cbandChannelLicenseEnabled" : {
"type" : "boolean"
},
"channel144Enabled" : {
"type" : "boolean"
},
"channelModeEnabled" : {
"type" : "boolean"
},
"backgroundScanning" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"frequencyInSec" : {
"type" : "integer",
"minimum" : 1,
"maximum" : 65535,
"default" : 20
}
},
"required" : [ "frequencyInSec" ]
},
"autoChannelSelection" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"channelSelectMode" : {
"type" : "string",
"enum" : [ "None", "BackgroundScanning", "ChannelFly" ],
"default" : "BackgroundScanning"
},
"channelFlyMtbc" : {
"type" : "integer",
"default" : 480,
"minimum" : 100,
"maximum" : 1440
},
"channelFlyChangeFrequency" : {
"type" : "integer",
"default" : 33,
"minimum" : 1,
"maximum" : 100
},
"channelFlyOptimizationTimePeriod" : {
"type" : "array",
"items" : {
"type" : "string",
"pattern" : "^([0-1][0-9]|2[0-3]):00-(([0-1][0-9]|2[0-4]):00)$"
}
}
}
}
}
},
"radio6g" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"autoCellSizing" : {
"type" : "boolean"
},
"txPower" : {
"type" : "string",
"enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
"default" : "Full"
},
"channelWidth" : {
"type" : "integer",
"enum" : [ 0, 20, 40, 80, 8080, 160 ],
"default" : 0
},
"channel" : {
"type" : "integer"
},
"channelRange" : {
"type" : "array",
"items" : {
"type" : "integer"
},
"minItems" : 1
},
"lowPowerIndoorModeEnabled" : {
"type" : "boolean"
},
"backgroundScanning" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"frequencyInSec" : {
"type" : "integer",
"minimum" : 1,
"maximum" : 65535,
"default" : 20
}
},
"required" : [ "frequencyInSec" ]
},
"autoChannelSelection" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"channelSelectMode" : {
"type" : "string",
"enum" : [ "None", "BackgroundScanning", "ChannelFly" ],
"default" : "BackgroundScanning"
},
"channelFlyMtbc" : {
"type" : "integer",
"default" : 480,
"minimum" : 100,
"maximum" : 1440
},
"channelFlyChangeFrequency" : {
"type" : "integer",
"default" : 33,
"minimum" : 1,
"maximum" : 100
},
"channelFlyOptimizationTimePeriod" : {
"type" : "array",
"items" : {
"type" : "string",
"pattern" : "^([0-1][0-9]|2[0-3]):00-(([0-1][0-9]|2[0-4]):00)$"
}
}
}
},
"bssMinRate" : {
"description" : "6G BSS minimum rate (mbps)",
"type" : "string",
"enum" : [ "HE-MCS0", "HE-MCS1", "HE-MCS2", "HE-MCS3" ]
},
"mgmtTxRate" : {
"description" : "6G management TX rate (mbps)",
"type" : "string",
"enum" : [ "6 mbps", "9 mbps", "12 mbps", "18 mbps", "24 mbps", "36 mbps", "48 mbps", "54 mbps" ]
},
"multicastUplinkRateLimit" : {
"description" : "Multicast data rate limit for uplink (mbps), set to 0 to disable.",
"type" : "integer",
"minimum" : 0,
"maximum" : 100
},
"multicastDownlinkRateLimit" : {
"description" : "Multicast data rate limit for downlink (mbps), set to 0 to disable.",
"type" : "integer",
"minimum" : 0,
"maximum" : 100
}
}
},
"dual5gEnabled" : {
"type" : "boolean"
}
}
}
},
"required" : [ "name", "login" ]
}
201
Body
{
"id": "zoneUUID"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
}
}
}
Create Zone of Dual ¶
POST/v11_1/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"
},
"radioConfig": {
"radio24g": {
"txPower": "Full",
"channelWidth": 20,
"channel": 0,
"channelRange": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11
],
"autoChannelSelection": {
"channelSelectMode": "ChannelFly",
"channelFlyMtbc": 300,
"channelFlyChangeFrequency": 80,
"channelFlyOptimizationTimePeriod": [
"02:00-03:00",
"04:00-05:00"
]
},
"protectionMode": "CTS_ONLY",
"backgroundScanning": {
"frequencyInSec": 20
}
},
"radio5g": {
"txPower": "Full",
"channelWidth": 40,
"channel": 0,
"channelIndoor": 0,
"channelRange": [
149,
153,
157,
161
],
"channelRangeIndoor": [
36,
40,
44,
48,
149,
153,
157,
161
],
"dfsChannelEnabled": false,
"cbandChannelEnabled": false,
"cbandChannelLicenseEnabled": false,
"channel144Enabled": false,
"channelModeEnabled": false,
"autoChannelSelection": {
"channelSelectMode": "ChannelFly",
"channelFlyMtbc": 300,
"channelFlyChangeFrequency": 80,
"channelFlyOptimizationTimePeriod": [
"02:00-03:00",
"04:00-05:00"
]
},
"backgroundScanning": {
"frequencyInSec": 20
}
}
},
"syslog": {
"syslogConfigType": "CUSTOM",
"syslogServerProfileId": "",
"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
},
"tunnelType": "RuckusGRE",
"loadBalancing": {
"loadBalancingMethod": "BASED_ON_CLIENT_COUNT",
"bandBalancing": {
"wifi24Percentage": 10
},
"steeringMode": "BASIC"
},
"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,
"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,
"snmpConfigType": "CUSTOM",
"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",
"paloAltoFirewallProfileId": "2f59b0f4-c86f-11e8-a8d5-f2801f1b9fd1",
"apHccdEnabled": true,
"apHccdPersist": true,
"myRuckusConfig": {
"aclForTunnelWlanAndVlanEnable": false
},
"bssColoringEnable": true
}
Schema
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"domainId" : {
"description" : "Identifier of the management domain to which the zone belongs",
"type" : "string"
},
"dpGroupId" : {
"description" : "DP Group ID",
"type" : "string"
},
"enforcePriorityDpGroupEnable" : {
"description" : "Enable to enforce priority of DP Group",
"type" : "boolean"
},
"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. Would be mandatory when the mesh is enabled.",
"type" : "string"
},
"meshRadioIdx" : {
"description" : "Mesh radio index",
"type" : "string",
"enum" : [ "Radio24G", "Radio5G" ],
"default" : "Radio5G"
},
"zeroTouchStatus" : {
"type" : "boolean"
}
}
},
"syslog" : {
"description" : "Syslog configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"syslogConfigType" : {
"description" : "Syslog configuration type.",
"type" : "string",
"enum" : [ "CUSTOM", "AP_SYSLOG_SERVER_PROFILE" ],
"default" : "CUSTOM"
},
"syslogServerProfileId" : {
"description" : "Syslog server profile ID.",
"type" : "string"
},
"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
}
}
},
"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"
}
}
},
"loadBalancing" : {
"description" : "Load Balancing configuration of the zone",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"loadBalancingMethod" : {
"type" : "string",
"enum" : [ "BASED_ON_CLIENT_COUNT", "BASED_ON_CAPACITY", "OFF" ],
"default" : "BASED_ON_CLIENT_COUNT"
},
"bandBalancing" : {
"description" : "Band Balancing configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"wifi24Percentage" : {
"description" : "Percentage of client load on 2.4GHz radio band",
"type" : "integer",
"minimum" : 0,
"maximum" : 100,
"default" : 25
}
}
},
"steeringMode" : {
"description" : "Steering 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"
}
}
},
"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"
},
"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"
}
}
},
"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"
},
"portSelectionEnabled" : {
"description" : "DHCP Port Selection Enabled",
"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"
},
"apServerType" : {
"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"
},
"snmpConfigType" : {
"description" : "The config type of SNMP",
"type" : "string",
"enum" : [ "CUSTOM", "AP_SNMP_AGENT_PROFILE" ],
"default" : "CUSTOM"
},
"apSnmpAgentProfileId" : {
"type" : "string"
},
"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", "readEnabled", "writeEnabled", "notificationEnabled" ]
}
},
"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", "readEnabled", "writeEnabled", "notificationEnabled" ]
}
}
}
},
"recoverySsid" : {
"description" : "Recovery SSID",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"recoverySsidPskKey" : {
"description" : "Custom recovery ssid passphrase. If passphrase has been customized, this property cannot be empty in the future. ",
"type" : "string"
},
"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"
}
}
}
},
"ipsecTunnelMode" : {
"type" : "string",
"enum" : [ "DISABLE", "SOFT_GRE", "RUCKUS_GRE" ]
},
"rksGreForwardBroadcast" : {
"description" : "Ruckus GRE tunnel broadcast packet forwarding",
"type" : "boolean",
"default" : false
},
"sshTunnelEncryption" : {
"type" : "string",
"enum" : [ "AES128", "AES256" ],
"default" : "AES128"
},
"lteBandLockChannels" : {
"description" : "LTE band lock channels options",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"simCardId" : {
"description" : "SIM card ID(Primary:0, Secondary:1)",
"type" : "integer"
},
"type" : {
"description" : "LTE chipset SKU type",
"type" : "string"
},
"channel4g" : {
"description" : "LTE 4G channels",
"type" : "string"
},
"channel3g" : {
"description" : "LTE 3G channels",
"type" : "string"
}
}
}
},
"paloAltoFirewallProfileId" : {
"type" : "string"
},
"apHccdEnabled" : {
"description" : "Historical Connection Failures allows the AP to report historical client connection failures for this zone.",
"type" : "boolean",
"default" : false
},
"apHccdPersist" : {
"description" : "Allow Historical Connection Failures to be persisted.",
"type" : "boolean",
"default" : true
},
"myRuckusConfig" : {
"description" : "My.Ruckus configuration",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"aclForTunnelWlanAndVlanEnable" : {
"description" : "My.Ruckus support for tunnel-wlan/vlan",
"type" : "boolean"
}
},
"required" : [ "aclForTunnelWlanAndVlanEnable" ]
},
"apHttp2CertChkEnable" : {
"type" : "boolean"
},
"bssColoringEnable" : {
"description" : "Turn on/off BSS coloring mechanism.",
"type" : "boolean",
"default" : true
},
"radioConfig" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"radio24g" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"autoCellSizing" : {
"type" : "boolean"
},
"txPower" : {
"type" : "string",
"enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
"default" : "Full"
},
"channelWidth" : {
"type" : "integer",
"enum" : [ 0, 20, 40 ],
"default" : 0
},
"channel" : {
"type" : "integer"
},
"channelRange" : {
"type" : "array",
"items" : {
"type" : "integer"
},
"minItems" : 1
},
"backgroundScanning" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"frequencyInSec" : {
"type" : "integer",
"minimum" : 1,
"maximum" : 65535,
"default" : 20
}
},
"required" : [ "frequencyInSec" ]
},
"protectionMode" : {
"type" : "string",
"enum" : [ "NONE", "CTS_ONLY", "RTS_CTS" ],
"default" : "RTS_CTS"
},
"autoChannelSelection" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"channelSelectMode" : {
"type" : "string",
"enum" : [ "None", "BackgroundScanning", "ChannelFly" ],
"default" : "BackgroundScanning"
},
"channelFlyMtbc" : {
"type" : "integer",
"default" : 480,
"minimum" : 100,
"maximum" : 1440
},
"channelFlyChangeFrequency" : {
"type" : "integer",
"default" : 33,
"minimum" : 1,
"maximum" : 100
},
"channelFlyOptimizationTimePeriod" : {
"type" : "array",
"items" : {
"type" : "string",
"pattern" : "^([0-1][0-9]|2[0-3]):00-(([0-1][0-9]|2[0-4]):00)$"
}
}
}
}
}
},
"radio5g" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"autoCellSizing" : {
"type" : "boolean"
},
"txPower" : {
"type" : "string",
"enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
"default" : "Full"
},
"channelWidth" : {
"type" : "integer",
"enum" : [ 0, 20, 40, 80, 8080, 160 ],
"default" : 0
},
"channel" : {
"type" : "integer"
},
"channelIndoor" : {
"type" : "integer"
},
"channelRange" : {
"type" : "array",
"items" : {
"type" : "integer"
},
"minItems" : 1
},
"channelRangeIndoor" : {
"type" : "array",
"items" : {
"type" : "integer"
}
},
"secondaryChannel" : {
"type" : "integer"
},
"secondaryChannelIndoor" : {
"type" : "integer"
},
"dfsChannelEnabled" : {
"type" : "boolean"
},
"cbandChannelEnabled" : {
"type" : "boolean"
},
"cbandChannelLicenseEnabled" : {
"type" : "boolean"
},
"channel144Enabled" : {
"type" : "boolean"
},
"channelModeEnabled" : {
"type" : "boolean"
},
"backgroundScanning" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"frequencyInSec" : {
"type" : "integer",
"minimum" : 1,
"maximum" : 65535,
"default" : 20
}
},
"required" : [ "frequencyInSec" ]
},
"autoChannelSelection" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"channelSelectMode" : {
"type" : "string",
"enum" : [ "None", "BackgroundScanning", "ChannelFly" ],
"default" : "BackgroundScanning"
},
"channelFlyMtbc" : {
"type" : "integer",
"default" : 480,
"minimum" : 100,
"maximum" : 1440
},
"channelFlyChangeFrequency" : {
"type" : "integer",
"default" : 33,
"minimum" : 1,
"maximum" : 100
},
"channelFlyOptimizationTimePeriod" : {
"type" : "array",
"items" : {
"type" : "string",
"pattern" : "^([0-1][0-9]|2[0-3]):00-(([0-1][0-9]|2[0-4]):00)$"
}
}
}
}
}
},
"radio5gLower" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"autoCellSizing" : {
"type" : "boolean"
},
"txPower" : {
"type" : "string",
"enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
"default" : "Full"
},
"channelWidth" : {
"type" : "integer",
"enum" : [ 0, 20, 40, 80, 8080, 160 ],
"default" : 0
},
"channel" : {
"type" : "integer"
},
"channelIndoor" : {
"type" : "integer"
},
"channelRange" : {
"type" : "array",
"items" : {
"type" : "integer"
},
"minItems" : 1
},
"channelRangeIndoor" : {
"type" : "array",
"items" : {
"type" : "integer"
}
},
"secondaryChannel" : {
"type" : "integer"
},
"secondaryChannelIndoor" : {
"type" : "integer"
},
"dfsChannelEnabled" : {
"type" : "boolean"
},
"cbandChannelEnabled" : {
"type" : "boolean"
},
"cbandChannelLicenseEnabled" : {
"type" : "boolean"
},
"channel144Enabled" : {
"type" : "boolean"
},
"channelModeEnabled" : {
"type" : "boolean"
},
"backgroundScanning" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"frequencyInSec" : {
"type" : "integer",
"minimum" : 1,
"maximum" : 65535,
"default" : 20
}
},
"required" : [ "frequencyInSec" ]
},
"autoChannelSelection" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"channelSelectMode" : {
"type" : "string",
"enum" : [ "None", "BackgroundScanning", "ChannelFly" ],
"default" : "BackgroundScanning"
},
"channelFlyMtbc" : {
"type" : "integer",
"default" : 480,
"minimum" : 100,
"maximum" : 1440
},
"channelFlyChangeFrequency" : {
"type" : "integer",
"default" : 33,
"minimum" : 1,
"maximum" : 100
},
"channelFlyOptimizationTimePeriod" : {
"type" : "array",
"items" : {
"type" : "string",
"pattern" : "^([0-1][0-9]|2[0-3]):00-(([0-1][0-9]|2[0-4]):00)$"
}
}
}
}
}
},
"radio5gUpper" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"autoCellSizing" : {
"type" : "boolean"
},
"txPower" : {
"type" : "string",
"enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
"default" : "Full"
},
"channelWidth" : {
"type" : "integer",
"enum" : [ 0, 20, 40, 80, 8080, 160 ],
"default" : 0
},
"channel" : {
"type" : "integer"
},
"channelIndoor" : {
"type" : "integer"
},
"channelRange" : {
"type" : "array",
"items" : {
"type" : "integer"
},
"minItems" : 1
},
"channelRangeIndoor" : {
"type" : "array",
"items" : {
"type" : "integer"
}
},
"secondaryChannel" : {
"type" : "integer"
},
"secondaryChannelIndoor" : {
"type" : "integer"
},
"dfsChannelEnabled" : {
"type" : "boolean"
},
"cbandChannelEnabled" : {
"type" : "boolean"
},
"cbandChannelLicenseEnabled" : {
"type" : "boolean"
},
"channel144Enabled" : {
"type" : "boolean"
},
"channelModeEnabled" : {
"type" : "boolean"
},
"backgroundScanning" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"frequencyInSec" : {
"type" : "integer",
"minimum" : 1,
"maximum" : 65535,
"default" : 20
}
},
"required" : [ "frequencyInSec" ]
},
"autoChannelSelection" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"channelSelectMode" : {
"type" : "string",
"enum" : [ "None", "BackgroundScanning", "ChannelFly" ],
"default" : "BackgroundScanning"
},
"channelFlyMtbc" : {
"type" : "integer",
"default" : 480,
"minimum" : 100,
"maximum" : 1440
},
"channelFlyChangeFrequency" : {
"type" : "integer",
"default" : 33,
"minimum" : 1,
"maximum" : 100
},
"channelFlyOptimizationTimePeriod" : {
"type" : "array",
"items" : {
"type" : "string",
"pattern" : "^([0-1][0-9]|2[0-3]):00-(([0-1][0-9]|2[0-4]):00)$"
}
}
}
}
}
},
"radio6g" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"autoCellSizing" : {
"type" : "boolean"
},
"txPower" : {
"type" : "string",
"enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
"default" : "Full"
},
"channelWidth" : {
"type" : "integer",
"enum" : [ 0, 20, 40, 80, 8080, 160 ],
"default" : 0
},
"channel" : {
"type" : "integer"
},
"channelRange" : {
"type" : "array",
"items" : {
"type" : "integer"
},
"minItems" : 1
},
"lowPowerIndoorModeEnabled" : {
"type" : "boolean"
},
"backgroundScanning" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"frequencyInSec" : {
"type" : "integer",
"minimum" : 1,
"maximum" : 65535,
"default" : 20
}
},
"required" : [ "frequencyInSec" ]
},
"autoChannelSelection" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"channelSelectMode" : {
"type" : "string",
"enum" : [ "None", "BackgroundScanning", "ChannelFly" ],
"default" : "BackgroundScanning"
},
"channelFlyMtbc" : {
"type" : "integer",
"default" : 480,
"minimum" : 100,
"maximum" : 1440
},
"channelFlyChangeFrequency" : {
"type" : "integer",
"default" : 33,
"minimum" : 1,
"maximum" : 100
},
"channelFlyOptimizationTimePeriod" : {
"type" : "array",
"items" : {
"type" : "string",
"pattern" : "^([0-1][0-9]|2[0-3]):00-(([0-1][0-9]|2[0-4]):00)$"
}
}
}
},
"bssMinRate" : {
"description" : "6G BSS minimum rate (mbps)",
"type" : "string",
"enum" : [ "HE-MCS0", "HE-MCS1", "HE-MCS2", "HE-MCS3" ]
},
"mgmtTxRate" : {
"description" : "6G management TX rate (mbps)",
"type" : "string",
"enum" : [ "6 mbps", "9 mbps", "12 mbps", "18 mbps", "24 mbps", "36 mbps", "48 mbps", "54 mbps" ]
},
"multicastUplinkRateLimit" : {
"description" : "Multicast data rate limit for uplink (mbps), set to 0 to disable.",
"type" : "integer",
"minimum" : 0,
"maximum" : 100
},
"multicastDownlinkRateLimit" : {
"description" : "Multicast data rate limit for downlink (mbps), set to 0 to disable.",
"type" : "integer",
"minimum" : 0,
"maximum" : 100
}
}
},
"dual5gEnabled" : {
"type" : "boolean"
}
}
}
},
"required" : [ "name", "login" ]
}
201
Body
{
"id": "zoneUUID"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
}
}
}
Create Zone ¶
POST/v11_1/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"
},
"radioConfig": {
"radio24g": {
"txPower": "Full",
"channelWidth": 20,
"channel": 0,
"channelRange": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11
],
"autoChannelSelection": {
"channelSelectMode": "ChannelFly",
"channelFlyMtbc": 300,
"channelFlyChangeFrequency": 80,
"channelFlyOptimizationTimePeriod": [
"02:00-03:00",
"04:00-05:00"
]
},
"protectionMode": "CTS_ONLY",
"backgroundScanning": {
"frequencyInSec": 20
}
},
"radio5g": {
"txPower": "Full",
"channelWidth": 40,
"channel": 0,
"channelIndoor": 0,
"channelRange": [
149,
153,
157,
161
],
"channelRangeIndoor": [
36,
40,
44,
48,
149,
153,
157,
161
],
"dfsChannelEnabled": false,
"cbandChannelEnabled": false,
"cbandChannelLicenseEnabled": false,
"channel144Enabled": false,
"channelModeEnabled": false,
"autoChannelSelection": {
"channelSelectMode": "ChannelFly",
"channelFlyMtbc": 300,
"channelFlyChangeFrequency": 80,
"channelFlyOptimizationTimePeriod": [
"02:00-03:00",
"04:00-05:00"
]
},
"backgroundScanning": {
"frequencyInSec": 20
}
}
},
"syslog": {
"syslogConfigType": "CUSTOM",
"syslogServerProfileId": "",
"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
},
"tunnelType": "RuckusGRE",
"loadBalancing": {
"loadBalancingMethod": "BASED_ON_CLIENT_COUNT",
"bandBalancing": {
"wifi24Percentage": 10
},
"steeringMode": "BASIC"
},
"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,
"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,
"snmpConfigType": "CUSTOM",
"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",
"paloAltoFirewallProfileId": "2f59b0f4-c86f-11e8-a8d5-f2801f1b9fd1",
"apHccdEnabled": true,
"apHccdPersist": true,
"myRuckusConfig": {
"aclForTunnelWlanAndVlanEnable": false
},
"bssColoringEnable": true
}
Schema
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"domainId" : {
"description" : "Identifier of the management domain to which the zone belongs",
"type" : "string"
},
"dpGroupId" : {
"description" : "DP Group ID",
"type" : "string"
},
"enforcePriorityDpGroupEnable" : {
"description" : "Enable to enforce priority of DP Group",
"type" : "boolean"
},
"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. Would be mandatory when the mesh is enabled.",
"type" : "string"
},
"meshRadioIdx" : {
"description" : "Mesh radio index",
"type" : "string",
"enum" : [ "Radio24G", "Radio5G" ],
"default" : "Radio5G"
},
"zeroTouchStatus" : {
"type" : "boolean"
}
}
},
"syslog" : {
"description" : "Syslog configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"syslogConfigType" : {
"description" : "Syslog configuration type.",
"type" : "string",
"enum" : [ "CUSTOM", "AP_SYSLOG_SERVER_PROFILE" ],
"default" : "CUSTOM"
},
"syslogServerProfileId" : {
"description" : "Syslog server profile ID.",
"type" : "string"
},
"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
}
}
},
"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"
}
}
},
"loadBalancing" : {
"description" : "Load Balancing configuration of the zone",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"loadBalancingMethod" : {
"type" : "string",
"enum" : [ "BASED_ON_CLIENT_COUNT", "BASED_ON_CAPACITY", "OFF" ],
"default" : "BASED_ON_CLIENT_COUNT"
},
"bandBalancing" : {
"description" : "Band Balancing configuration of the zone.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"wifi24Percentage" : {
"description" : "Percentage of client load on 2.4GHz radio band",
"type" : "integer",
"minimum" : 0,
"maximum" : 100,
"default" : 25
}
}
},
"steeringMode" : {
"description" : "Steering 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"
}
}
},
"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"