vSCG Carrier Kumo Public API Reference Guide
Overview
This reference guide describes the public APIs supported by the Virtual SmartZone (KUMO). Use the RESTful API commands described in this guide as an alternative way to manage the controller and its managed APs (in addition to the web and command line interfaces).
All API URIs in this guide could use the below all common prefix, where {host} is the IP address of the management interface of the controller.
Prefix Pattern | Note |
---|---|
https://{host}:8443/wsg/api/public | Recommend |
https://{host}:7443/api/public | Deprecated Will be removed in the future version |
Open API document
Open API document is based on OAS 2.0 and is now a POC program, Please try it for free.
Intall 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 for up to 3 major API versions, according to the following matrix.
VSCGCKUMO Version | API Version |
---|---|
5.1.1 |
v6_0 v6_1 v7_0 v8_0 v8_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/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/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/Pacific-New |
US/Samoa | UTC | Universal |
W-SU | WET | Zulu |
EST | HST | MST |
ACT | AET | AGT |
ART | AST | BET |
BST | CAT | CNT |
CST | CTT | EAT |
ECT | IET | IST |
JST | MIT | NET |
NST | PLT | PNT |
PRT | PST | SST |
VST |
Usage for Query Criteria
For further information on how to use the query criteria. Please click the link for the detail.
Not Support URIs
Due to the feature has been changed the design. There below URIs are no longer support in all API version as below.
- Flexi-VPN
Remove |
---|
PATCH /system/flexiVpnGlobalSetting |
GET /system/flexiVpnGlobalSetting |
Not Support Properties
Due to the feature has been changed the design. There below properties are no longer support in all API version as below.
-
Hotspot Service
- CREATE INTERNAL
Remove trafficClassProfileId
signatureSigningKey
internalNode
- CREATE INTERNAL
-
FLEXI-VPN
- MODIFY FLEXI-VPN PROFILE
Remove wlanId
- MODIFY FLEXI-VPN PROFILE
-
L3 ROAMING
- RETRIVE L3 ROAMING CONFIGURATION
- RETRIEVE L3 ROAMING BASIC CONFIGURATION
- MODIFY L3 ROAMING BASIC CONFIGURATION
Remove featureEnabled
-
SCG USER
Remove companyName
What’s New
-
API
- AP Group
- Disable LTE band lock channel override
- Access Point Configuration
- Disable LTE band lock channel override
- Administration
- Create - Admin AAA Server
- Retrieve - Admin AAA Server
- Retrieve List - Admin AAA Server
- Modify - Admin AAA Server
- Delete - Admin AAA Server
- Session Management
- Retrieve
- SystemIPsec
- Retrieve System IPSec
- Modify System IPSec
- Vendor Specific Attribute Profile
- Get Vendor Specific Attribute Profiles
- Get Vendor Specific Attribute Profile
- Create Vendor Specific Attribute Profile
- Modify Entire Vendor Specific Attribute Profile
- Delete Vendor Specific Attribute Profile
- Bulk Delete Vendor Specific Attribute Profile
- Query Vendor Specific Attribute Profiles
- Wired Client
- Deauth Wired Client
- Bulk Deauth Wired Client
- AP Group
-
Properties
- AP Group
- Retrieve Default AP Group
- lteBandLockChannels
- Modify
- lteBandLockChannels
- Modify Recovery SSID Override
- lteBandLockChannels
- Create
- lteBandLockChannels
- Retrieve
- lteBandLockChannels
- Retrieve AP Model
- lacp
- Override AP Model
- lacp
- Retrieve Default AP Group
- Access Point Configuration
- Modify Specific
- lacp
- Modify Recovery SSID Override
- lteBandLockChannels
- Modify
- lteBandLockChannels
- Modify AP Config
- lteBandLockChannels
- Retrieve
- lteBandLockChannels
- Modify Specific
- Account Security
- Get the account security profile by id
- minimumPasswordLength
- Modify
- minimumPasswordLength
- Modify the account security profile
- minimumPasswordLength
- Create the account security profile.
- minimumPasswordLength
- Get the account security profile by id
- IPSEC Profile
- Retrieve
- tunnelMode
- Create ipsec
- tunnelMode
- Retrieve
- Zone Affinity Profile
- Get one zone affinity profile
- zoneAffinityListWithPriority
- Get one zone affinity profile
- System
- Retrieve NBI
- radiusAuthType
- Modify NBI Basic
- radiusAuthType
- Retrieve System Time
- authenticationKey
- Modify System Time
- authenticationKey
- Retrieve NBI
- WLAN
- Create - Hotspot 2.0 Open
- flexiVpnProfile, timeboundWhitelist
- Create - Hotspot 2.0 OSEN
- flexiVpnProfile, timeboundWhitelist
- Modify RADIUS Options
- vendorSpecificAttributeProfileId
- Modify Advanced Options
- dhcp82SubOpt1Format, dhcp82SubOpt2Format, dhcp82SubOpt150Format, dhcp82SubOpt151Format, dhcp82SubOpt151AreaName, dropRandomProbesEnabled
- Create - Hotspot 2.0 Open
- WLAN Group
- Add Member
- name
- Add Member
- Ruckus Wireless AP Zone
- Change the Zone’s IPsec Profiles
- channel144Enabled, lteBandLockChannels, apHccdEnabled, apHccdPersist
- Create Zone of IPv6
- zoneAffinityProfileId, enforcePriorityZoneAffinityEnable, channel144Enabled, lteBandLockChannels, apHccdEnabled, apHccdPersist
- Create Zone of Dual
- zoneAffinityProfileId, enforcePriorityZoneAffinityEnable, channel144Enabled, lteBandLockChannels, apHccdEnabled, apHccdPersist
- Modify entire zone
- channel144Enabled, lteBandLockChannels, apHccdEnabled, apHccdPersist
- Retrieve AP Model
- lacp
- Modify AP Model
- lacp
- Retrieve AP Model Common Attribute
- meshRadioCaps
- Retrieve
- channel144Enabled, lteBandLockChannels, apHccdEnabled, apHccdPersist
- Modify
- channel144Enabled, lteBandLockChannels, apHccdEnabled, apHccdPersist
- Create Zone
- zoneAffinityProfileId, enforcePriorityZoneAffinityEnable, channel144Enabled, lteBandLockChannels, apHccdEnabled, apHccdPersist
- Change the Zone’s IPsec Profiles
- Web Authentication
- Retrieve
- webAuthenticationPortalCustomization
- Create
- webAuthenticationPortalCustomization
- Modify
- webAuthenticationPortalCustomization
- Retrieve
- AP Group
What’s Deprecated
- API
API Information ¶
Logon ¶
Service Ticket ¶
Logon ¶
POST/v8_1/serviceTicket
Use this API command to log on to the controller and acquire a valid service ticket.
Body
{
"username": "admin",
"password": "admin!234"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"username": {
"description": "Logon user name",
"type": "string"
},
"password": {
"description": "Logon password",
"type": "string"
}
},
"required": [
"username",
"password"
]
}
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/v8_1/serviceTicket
Use this API command to log off of the controller.
- serviceTicket
string
(required)
200
Session ID ¶
Logon ¶
POST/v8_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"
}
}
}
Retrieve ¶
GET/v8_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"
}
}
}
Session Management ¶
Retrieve ¶
GET/v8_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",
"sessionId": "5C2450F464951DD70FDA73D68824A547",
"sourceIp": "127.0.0.1",
"userName": "admin",
"userUUID": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25"
},
{
"authType": "PUBLIC_API",
"lastAccessTime": 1536290095781,
"lastAccessURI": null,
"sessionId": "6991866A7F5689C859D09B33C31A262A",
"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"
},
"sessionId": {
"type": "string",
"description": "The user session ID"
},
"sourceIp": {
"type": "string",
"description": "The source IP address"
},
"authType": {
"type": "string",
"description": "The authentication type of logon"
}
}
}
}
}
}
Ruckus Wireless AP Zone ¶
Retrieve DHCP/NAT service configuration within Domain ¶
POST/v8_1/rkszones/services/dhcpSiteConfig/query
Use this API command to modify DHCP/NAT service configuration of Domain. Please click the link for the usage of Query Criteria.
Body
{
"filters": [
{
"type": "DOMAIN",
"value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
}
],
"fullTextSearch": {
"type": "AND",
"value": ""
},
"attributes": [
"*"
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"filters": {
"description": "Filters used to select specific resource scope",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Group type",
"type": "string",
"enum": [
"SYSTEM",
"CONTROLBLADE",
"DATABLADE",
"DOMAIN",
"ZONE",
"THIRD_PARTY_ZONE",
"APGROUP",
"WLANGROUP",
"INDOORMAP",
"AP",
"WLAN",
"SWITCH_GROUP"
]
},
"value": {
"description": "Group ID",
"type": "string"
},
"operator": {
"description": "Operator for filtering",
"type": "string",
"enum": [
"eq"
]
}
},
"required": [
"type",
"value"
]
}
},
"extraFilters": {
"description": "\"AND\" condition for multiple filters",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Filters for specific attribute",
"type": "string",
"enum": [
"VERSION"
]
},
"value": {
"description": "Value for filtering",
"type": "string"
},
"operator": {
"description": "Operator for filtering",
"type": "string",
"enum": [
"eq",
"gt",
"lt",
"gte",
"lte"
]
}
},
"required": [
"type",
"value"
]
}
},
"options": {
"description": "Specified feature required information.",
"type": "object",
"additionalProperties": false,
"properties": {
"zone_ipmode": {
"description": "List the zones only with the specified IP Mode.",
"type": "string",
"enum": [
"IPV4",
"IPV6",
"IPV4_IPV6"
]
},
"includeSharedResources": {
"description": "Include the resources of parent domain as well while querying.",
"type": "boolean"
}
}
},
"extraTimeRange": {
"description": "Specified data time range of selection",
"type": "object",
"additionalProperties": false,
"properties": {
"start": {
"description": "start time for collecting data",
"type": "number"
},
"end": {
"description": "end time for collecting data",
"type": "number"
},
"interval": {
"description": "time interval in second",
"type": "number"
},
"field": {
"description": "time field for collecting data",
"type": "string",
"enum": [
"insertionTime"
]
}
}
},
"fullTextSearch": {
"description": "Specified search string",
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Search logic operator",
"type": "string",
"enum": [
"AND",
"OR"
]
},
"value": {
"description": "Text or number to search",
"type": "string"
},
"fields": {
"description": "Specific fields to search",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"attributes": {
"description": "Get specific columns only",
"type": "array",
"items": {
"type": "string"
}
},
"sortInfo": {
"description": "About sorting",
"type": "object",
"additionalProperties": false,
"properties": {
"sortColumn": {
"type": "string"
},
"dir": {
"type": "string",
"enum": [
"ASC",
"DESC"
]
}
}
},
"page": {
"description": "Page number to get",
"type": "integer",
"minimum": 1
},
"limit": {
"description": "Size of one page",
"type": "integer",
"minimum": 1
},
"expandDomains": {
"description": "Whether to expand domains into sub domains/ zones or not",
"type": "boolean"
},
"criteria": {
"description": "Add backward compatibility for UI framework",
"type": "string"
},
"query": {
"description": "Add backward compatibility for UI framework",
"type": "string"
}
}
}
200
Body
{
"totalCount": 2,
"hasMore": false,
"firstIndex": 0,
"list": [
{
"zoneName": "Default Zone",
"siteEnabled": false,
"dwpdEnabled": false,
"manualSelect": false,
"siteMode": "EnableOnEachAPs",
"siteProfiles": [],
"siteAps": []
},
{
"zoneName": "zoneK",
"siteEnabled": true,
"dwpdEnabled": false,
"manualSelect": false,
"siteMode": "EnableOnEachAPs",
"siteProfiles": [
{
"id": "c1b60951-eeb6-11e6-850a-525400f698b4",
"zoneId": "fce48fb7-8b89-49f6-8ce5-f52aecfc81ff",
"name": "P01",
"description": "",
"vlanId": 10,
"subnetNetworkIp": "192.168.10.0",
"subnetMask": "255.255.255.0",
"poolStartIp": "192.168.10.1",
"poolEndIp": "192.168.10.100",
"primaryDnsIp": "",
"secondaryDnsIp": "",
"leaseTimeHours": 0,
"leaseTimeMinutes": 5
}
],
"siteAps": [
{
"apMac": "EC:8C:A2:01:C5:B0",
"apServerEnabled": true,
"apServerPrimary": true,
"apServerIp": "192.168.10.1",
"apGatewayIp": "192.168.10.1",
"apName": "RuckusAP",
"apStatus": "Offline"
}
]
}
]
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"totalCount": {
"type": "integer"
},
"hasMore": {
"type": "boolean"
},
"firstIndex": {
"type": "integer"
},
"list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"zoneName": {
"description": "DHCP Service Zone Name",
"type": "string"
},
"siteEnabled": {
"description": "DHCP Service Enabling Status",
"type": "boolean"
},
"dwpdEnabled": {
"description": "DHCP Service Dynamic WAN Port Detection",
"type": "boolean"
},
"manualSelect": {
"description": "DHCP Service AP Selection Mode",
"type": "boolean"
},
"siteMode": {
"description": "DHCP Service mode",
"type": "string",
"enum": [
"EnableOnEachAPs",
"EnableOnMultipleAPs",
"EnableOnHierarchicalAPs"
]
},
"eth0ProfileId": {
"type": "integer"
},
"eth1ProfileId": {
"type": "integer"
},
"siteAps": {
"type": "array",
"items": {
"type": "object",
"description": "DHCP Site selected APs",
"additionalProperties": false,
"properties": {
"apMac": {
"type": "string"
},
"apName": {
"type": "string"
},
"apStatus": {
"type": "string",
"enum": [
"Online",
"Offline",
"Flagged"
]
},
"apServerEnabled": {
"type": "boolean"
},
"apServerPrimary": {
"type": "boolean"
},
"apServerIp": {
"type": "string"
},
"apGatewayIp": {
"type": "string"
},
"apServerType": {
"type": "string"
}
}
}
},
"siteProfiles": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"zoneId": {
"description": "Zone Id of DHCP Profile",
"type": "string"
},
"id": {
"description": "Identifier of the DHCP Profile",
"type": "string"
},
"name": {
"description": "Name of the DHCP Profile",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the DHCP Profile",
"type": [
"string",
"null"
],
"maxLength": 64
},
"vlanId": {
"description": "VLAN ID of the DHCP Profile",
"type": "integer",
"minimum": 1,
"maximum": 4094
},
"subnetNetworkIp": {
"description": "Subnet Network IP of the DHCP Profile",
"type": "string"
},
"subnetMask": {
"description": "Subnet Mask of the DHCP Profile",
"type": "string"
},
"poolStartIp": {
"description": "Pool Starting IP of the DHCP Profile",
"type": "string"
},
"poolEndIp": {
"description": "Pool Ending IP of the DHCP Profile",
"type": "string"
},
"primaryDnsIp": {
"description": "Primany DNS IP of the DHCP Profile",
"type": "string"
},
"secondaryDnsIp": {
"description": "Secondary DNS IP of the DHCP Profile",
"type": "string"
},
"leaseTimeHours": {
"description": "Lease time in hours of the DHCP Profile",
"type": "integer",
"minimum": 0,
"maximum": 24
},
"leaseTimeMinutes": {
"description": "Lease time in minutes of the DHCP Profile",
"type": "integer",
"minimum": 0,
"maximum": 59
}
}
}
}
}
}
}
}
}
Retrieve DHCP/NAT service IP assignment ¶
POST/v8_1/rkszones/{zoneId}/dhcpSite/dhcpSiteConfig/doAssignIp
Use this API command to get the DHCP/NAT service IP assignment when selecting with “Enable on Multiple APs”. In the Manually Select AP mode (the manualSelect is true), the body should contain the selected APs (include the siteAps array). Otherwise, there is no need to include the selected APs in the Auto Select AP mode (see samples).
Body
‧ Sample : Assign IP for DHCP Service of EnableOnMultipleAPs with Manually Select AP
{
"siteEnabled" : true,
"dwpdEnabled" : false,
"manualSelect" : true,
"siteMode" : "EnableOnMultipleAPs",
"siteAps" : [ {
"apMac" : "38:FF:36:00:0E:10",
"apServerEnabled" : true,
"apServerPrimary" : true
}, {
"apMac" : "58:FF:36:00:0E:20",
"apServerEnabled" : true,
"apServerPrimary" : true
} ],
"siteProfileIds" : [ "75e26590-547f-11e6-9ca7-5a095364c13c", "869bb532-547f-11e6-9ca7-5a095364c13c" ]
}
‧ Sample : Assign IP for DHCP Service of EnableOnMultipleAPs with Auto Select AP
{
"siteEnabled" : true,
"dwpdEnabled" : false,
"manualSelect" : false,
"siteMode" : "EnableOnMultipleAPs",
"siteProfileIds" : [ "75e26590-547f-11e6-9ca7-5a095364c13c", "869bb532-547f-11e6-9ca7-5a095364c13c" ]
}
Schema
{
"description" : "DHCP Service Assign IP For Server and Gateway",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"siteEnabled" : {
"description" : "DHCP Service Enabling Status",
"type" : "boolean"
},
"dwpdEnabled" : {
"description" : "DHCP Service Dynamic WAN Port Detection",
"type" : "boolean"
},
"manualSelect" : {
"description" : "DHCP Service AP Selection Mode. This value is effective when the siteMode is EnableOnMultipleAPs.",
"type" : "boolean"
},
"siteMode" : {
"description" : "DHCP Service mode",
"type" : "string",
"enum" : [ "EnableOnEachAPs", "EnableOnMultipleAPs", "EnableOnHierarchicalAPs" ]
},
"siteAps" : {
"type" : "array",
"items" : {
"type" : "object",
"description" : "DHCP Site selected APs. The content is effective when the siteMode is EnableOnMultipleAPs.",
"additionalProperties" : false,
"properties" : {
"apMac" : {
"type" : "string"
},
"apServerEnabled" : {
"type" : "boolean"
},
"apServerPrimary" : {
"type" : "boolean"
}
}
}
},
"siteProfileIds" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
}
}
200
Body
{
"zoneName": "zoneK",
"siteEnabled": true,
"dwpdEnabled": false,
"manualSelect": true,
"siteMode": "EnableOnMultipleAPs",
"siteAps": [
{
"apMac": "38:FF:36:00:0E:20",
"apServerEnabled": true,
"apGatewayEnabled": true
},
{
"apMac": "58:FF:36:00:0E:20",
"apServerEnabled": true,
"apGatewayEnabled": true
}
],
"siteProfiles": [
"75e26590-547f-11e6-9ca7-5a095364c13c",
"869bb532-547f-11e6-9ca7-5a095364c13c"
]
}
Schema
{
"description": "DHCP Site Configuration in Zone",
"type": "object",
"additionalProperties": false,
"properties": {
"zoneName": {
"description": "DHCP Service Zone Name",
"type": "string"
},
"siteEnabled": {
"description": "DHCP Service Enabling Status",
"type": "boolean"
},
"dwpdEnabled": {
"description": "DHCP Service Dynamic WAN Port Detection",
"type": "boolean"
},
"manualSelect": {
"description": "DHCP Service AP Selection Mode",
"type": "boolean"
},
"siteMode": {
"description": "DHCP Service mode",
"type": "string",
"enum": [
"EnableOnEachAPs",
"EnableOnMultipleAPs",
"EnableOnHierarchicalAPs"
]
},
"eth0ProfileId": {
"type": "integer"
},
"eth1ProfileId": {
"type": "integer"
},
"siteAps": {
"type": "array",
"items": {
"type": "object",
"description": "DHCP Site selected APs",
"additionalProperties": false,
"properties": {
"apMac": {
"type": "string"
},
"apName": {
"type": "string"
},
"apStatus": {
"type": "string",
"enum": [
"Online",
"Offline",
"Flagged"
]
},
"apServerEnabled": {
"type": "boolean"
},
"apServerPrimary": {
"type": "boolean"
},
"apServerIp": {
"type": "string"
},
"apGatewayIp": {
"type": "string"
},
"apServerType": {
"type": "string"
}
}
}
},
"siteProfiles": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"zoneId": {
"description": "Zone Id of DHCP Profile",
"type": "string"
},
"id": {
"description": "Identifier of the DHCP Profile",
"type": "string"
},
"name": {
"description": "Name of the DHCP Profile",
"type": "string",
"minLength": 2,
"maxLength": 32,
"pattern": "^[!-~]([ -~]){0,30}[!-~]$"
},
"description": {
"description": "Description of the DHCP Profile",
"type": [
"string",
"null"
],
"maxLength": 64
},
"vlanId": {
"description": "VLAN ID of the DHCP Profile",
"type": "integer",
"minimum": 1,
"maximum": 4094
},
"subnetNetworkIp": {
"description": "Subnet Network IP of the DHCP Profile",
"type": "string"
},
"subnetMask": {
"description": "Subnet Mask of the DHCP Profile",
"type": "string"
},
"poolStartIp": {
"description": "Pool Starting IP of the DHCP Profile",
"type": "string"
},
"poolEndIp": {
"description": "Pool Ending IP of the DHCP Profile",
"type": "string"
},
"primaryDnsIp": {
"description": "Primany DNS IP of the DHCP Profile",
"type": "string"
},
"secondaryDnsIp": {
"description": "Secondary DNS IP of the DHCP Profile",
"type": "string"
},
"leaseTimeHours": {
"description": "Lease time in hours of the DHCP Profile",
"type": "integer",
"minimum": 0,
"maximum": 24
},
"leaseTimeMinutes": {
"description": "Lease time in minutes of the DHCP Profile",
"type": "integer",
"minimum": 0,
"maximum": 59
}
}
}
}
}
}
Modify AP Latency Interval ¶
PATCH/v8_1/rkszones/{id}/apLatencyInterval
Modify AP Latency Interval of a zone.
Body
{
"pingEnabled": true
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"pingEnabled": {
"description": "AP ping latency enabled",
"type": "boolean"
}
}
}
204
Change the Zone's Ruckus GRE Tunnel Profile ¶
PATCH/v8_1/rkszones/{id}/ruckusGreTunnelProfile
Use this API command to change the Zone’s Ruckus GRE Tunnel Profile.
Body
{
"domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
"zoneAffinityProfileId": "3fd9aa91-df65-11e7-98e1-08002748d78e",
"enforcePriorityZoneAffinityEnable": false,
"name": "modifyZoneName",
"description": "description Zone",
"countryCode": "US",
"timezone": {
"systemTimezone": "America/Whitehorse"
},
"login": {
"apLoginName": "admin",
"apLoginPassword": "admin!234"
},
"mesh": {
"ssid": "meshSSID",
"passphrase": "passphrase"
},
"dfsChannelEnabled": false,
"wifi24": {
"txPower": "Full",
"channelWidth": 20,
"channel": 0,
"channelRange": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11
]
},
"wifi50": {
"txPower": "-1dB",
"channelWidth": 40,
"indoorChannel": 0,
"outdoorChannel": 0,
"indoorChannelRange": [
36,
40,
44,
48,
149,
153,
157,
161
],
"outdoorChannelRange": [
149,
153,
157,
161
]
},
"protectionMode24": "CTS_ONLY",
"syslog": {
"address": "1.1.1.1",
"port": 514,
"facility": "Local0",
"priority": "Error"
},
"smartMonitor": {
"intervalInSec": 10,
"retryThreshold": 3
},
"nodeAffinityProfile": null,
"venueProfile": null,
"locationBasedService": null,
"channelModeEnabled": false,
"bonjourFencingPolicy": null,
"tunnelType": "RuckusGRE",
"tunnelProfile": {
"id": "f5b92938-aa4e-4d02-90ea-273799ff689b",
"name": "Default Tunnel Profile"
},
"clientAdmissionControl24": {
"maxRadioLoadPercent": 70,
"minClientCount": 10,
"minClientThroughputMbps": 10
},
"clientAdmissionControl50": {
"maxRadioLoadPercent": 70,
"minClientCount": 10,
"minClientThroughputMbps": 10
},
"backgroundScanning24": {
"frequencyInSec": 20
},
"backgroundScanning50": {
"frequencyInSec": 20
},
"clientLoadBalancing24": {
"adjacentRadioThreshold": 12
},
"clientLoadBalancing50": {
"adjacentRadioThreshold": 12
},
"bandBalancing": {
"wifi24Percentage": 10
},
"loadBalancingMethod": "BASED_ON_CLIENT_COUNT",
"rogue": {
"reportType": "All",
"maliciousTypes": null,
"protectionEnabled": true
},
"dosBarringEnable": 0,
"dosBarringPeriod": 60,
"dosBarringThreshold": 5,
"dosBarringCheckPeriod": 30,
"apRebootTimeout": {
"gatewayLossTimeoutInSec": 1800,
"serverLossTimeoutInSec": 7200
},
"location": "location",
"locationAdditionalInfo": "locationAdditionalInfo",
"latitude": 23,
"longitude": 23,
"vlanOverlappingEnabled": false,
"autoChannelSelection24": {
"channelSelectMode": "ChannelFly",
"channelFlyMtbc": 480
},
"autoChannelSelection50": {
"channelSelectMode": "BackgroundScanning",
"channelFlyMtbc": 480
},
"channelEvaluationInterval": 777,
"apMgmtVlan": {
"id": 1,
"mode": "KEEP"
},
"apLatencyInterval": {
"pingEnabled": true
},
"ipsecProfile": {
"id": "ipsecProfileId",
"name": "ipsecProfileName"
},
"altitude": {
"altitudeUnit": "meters",
"altitudeValue": 1
},
"bonjourFencingPolicyEnabled": false,
"snmpAgent": {
"apSnmpEnabled": true,
"snmpV2Agent": [
{
"communityName": "v2Agent",
"notificationEnabled": true,
"readEnabled": true,
"writeEnabled": true,
"notificationType": "TRAP",
"notificationTarget": [
{
"address": "172.19.16.20",
"port": 161
}
]
}
],
"snmpV3Agent": [
{
"userName": "v3Agent",
"authProtocol": "MD5",
"authPassword": "admin!234",
"privProtocol": "DES",
"privPassword": "admin!234",
"notificationEnabled": true,
"readEnabled": true,
"writeEnabled": true,
"notificationType": "TRAP",
"notificationTarget": [
{
"address": "172.19.16.20",
"port": 161
}
]
}
]
},
"recoverySsid": {
"recoverySsidEnabled": true
},
"dhcpSiteConfig": {
"siteEnabled": true,
"siteMode": "EnableOnEachAPs",
"siteProfileIds": [
"75e26590-547f-11e6-9ca7-5a095364c13c",
"869bb532-547f-11e6-9ca7-5a095364c13c"
]
},
"rogueApReportThreshold": 40,
"rogueApAggressivenessMode": 2,
"rogueApJammingDetection": true,
"rogueApJammingThreshold": 40,
"directedMulticastFromWiredClientEnabled": true,
"directedMulticastFromWirelessClientEnabled": true,
"directedMulticastFromNetworkEnabled": false,
"healthCheckSitesEnabled": true,
"healthCheckSites": [
"www.google.com",
"www.live.com:443",
"www.github.com:443",
"source.codeaurora.org:443",
"www.wikipedia.com"
],
"ruckusGreTunnelProfile": {
"id": "f5b92938-aa4e-4d02-90ea-273799ff689b",
"name": "Default Tunnel Profile"
},
"softGreTunnelProflies": [
{
"id": "5a2e41b0-df53-11e7-98e1-08002748d78e",
"name": "softGre1",
"aaaAffinityEnabled": true
},
{
"id": "7803e411-df53-11e7-98e1-08002748d78e",
"name": "softGre2",
"aaaAffinityEnabled": true
}
],
"ipsecProfiles": [
{
"id": "3fd9aa91-df65-11e7-98e1-08002748d78e",
"name": "ipsec1"
}
],
"ipsecTunnelMode": "SOFT_GRE",
"sshTunnelEncryption": "AES128",
"lteBandLockChannels": [
{
"simCardId": 0,
"type": "EC25E",
"channel4g": "B1,B3,B5",
"channel3g": "B5"
},
{
"simCardId": 1,
"type": "EC25E",
"channel4g": "",
"channel3g": ""
}
],
"apHccdEnabled": true,
"apHccdPersist": true
}
Schema
{
"additionalProperties" : false,
"properties" : {
"altitude" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"altitudeUnit" : {
"description" : "altitude unit",
"type" : "string",
"enum" : [ "meters", "floor" ]
},
"altitudeValue" : {
"description" : "altitude value",
"type" : "integer"
}
}
},
"apMgmtVlan" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"mode" : {
"description" : "Vlan Mode of the zone",
"type" : "string",
"enum" : [ "KEEP", "USER_DEFINED" ]
},
"id" : {
"description" : "Vlan id of the zone",
"type" : "integer"
}
}
},
"apLatencyInterval" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"pingEnabled" : {
"description" : "AP ping latency enabled",
"type" : "boolean"
}
}
},
"apRebootTimeout" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"gatewayLossTimeoutInSec" : {
"description" : "Gateway loss timeout in second",
"type" : "integer",
"enum" : [ 0, 1800, 3600, 5400, 7200, 9000, 10800, 12600, 14400, 16200, 18000, 19800, 23400, 25200, 27000, 28800, 30600, 32400, 34200, 36000, 37800, 39600, 41400, 43200, 45000, 46800, 48600, 50400, 52200, 54000, 55800, 57600, 59400, 61200, 63000, 64800, 66600, 68400, 70200, 72000, 73800, 75600, 77400, 79200, 81000, 82800, 84600, 86400 ]
},
"serverLossTimeoutInSec" : {
"description" : "Server loss timeout in second",
"type" : "integer",
"enum" : [ 0, 7200, 14400, 21600, 28800, 36000, 43200, 50400, 57600, 64800, 72000, 79200, 86400 ]
}
}
},
"autoChannelSelection24" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"channelSelectMode" : {
"description" : "Channel Select Mode",
"type" : "string",
"enum" : [ "None", "BackgroundScanning", "ChannelFly" ]
},
"channelFlyMtbc" : {
"description" : "ChannelFly MTBC",
"type" : "integer",
"minimum" : 100,
"maximum" : 1440
}
}
},
"autoChannelSelection50" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"channelSelectMode" : {
"description" : "Channel Select Mode",
"type" : "string",
"enum" : [ "None", "BackgroundScanning", "ChannelFly" ]
},
"channelFlyMtbc" : {
"description" : "ChannelFly MTBC",
"type" : "integer",
"minimum" : 100,
"maximum" : 1440
}
}
},
"awsVenue" : {
"type" : "string"
},
"backgroundScanning24" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"frequencyInSec" : {
"description" : "Frequency in second",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
}
}
},
"backgroundScanning50" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"frequencyInSec" : {
"description" : "Frequency in second",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
}
}
},
"bandBalancing" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"mode" : {
"description" : "Band Balancing Mode: BASIC-Withholds probe and authentication responses at connetcion time in heavily loaded band to balance clients to the other band, PROACTIVE-Uses BASIC functionality and actively rebalances clients via 802.11v BTM, STRICT-Uses PROACTIVE functionality and forcefully rebalances clients via 802.11v BTM",
"type" : "string",
"enum" : [ "BASIC", "PROACTIVE", "STRICT" ]
},
"wifi24Percentage" : {
"description" : "Percentage of client load on 2.4GHz radio band",
"type" : "integer",
"minimum" : 0,
"maximum" : 100
}
}
},
"loadBalancingMethod" : {
"type" : "string",
"enum" : [ "BASED_ON_CLIENT_COUNT", "BASED_ON_CAPACITY", "OFF" ]
},
"bonjourFencingPolicy" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"bonjourFencingPolicyEnabled" : {
"type" : "boolean"
},
"channelEvaluationInterval" : {
"maximum" : 3600,
"minimum" : 60,
"type" : "integer"
},
"channelModeEnabled" : {
"type" : "boolean"
},
"clientAdmissionControl24" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"maxRadioLoadPercent" : {
"description" : "Maximum radio load percentage.",
"type" : "integer",
"minimum" : 50,
"maximum" : 100
},
"minClientCount" : {
"description" : "Minimum client count number.",
"type" : "integer",
"minimum" : 0,
"maximum" : 100
},
"minClientThroughputMbps" : {
"description" : "Minimum client throughput in Mbps.",
"type" : "number",
"minimum" : 0,
"maximum" : 100
}
}
},
"clientAdmissionControl50" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"maxRadioLoadPercent" : {
"description" : "Maximum radio load percentage.",
"type" : "integer",
"minimum" : 50,
"maximum" : 100
},
"minClientCount" : {
"description" : "Minimum client count number.",
"type" : "integer",
"minimum" : 0,
"maximum" : 100
},
"minClientThroughputMbps" : {
"description" : "Minimum client throughput in Mbps.",
"type" : "number",
"minimum" : 0,
"maximum" : 100
}
}
},
"clientLoadBalancing24" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"adjacentRadioThreshold" : {
"description" : "Adjacent radio threshold",
"type" : "integer",
"minimum" : 1,
"maximum" : 100
}
}
},
"clientLoadBalancing50" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"adjacentRadioThreshold" : {
"description" : "Adjacent radio threshold",
"type" : "integer",
"minimum" : 1,
"maximum" : 100
}
}
},
"countryCode" : {
"type" : "string"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64
},
"dfsChannelEnabled" : {
"type" : "boolean"
},
"cbandChannelEnabled" : {
"type" : "boolean"
},
"cbandChannelLicenseEnabled" : {
"type" : "boolean"
},
"channel144Enabled" : {
"type" : "boolean"
},
"dhcpSiteConfig" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"siteEnabled" : {
"description" : "DHCP Service Enabling Status",
"type" : "boolean"
},
"dwpdEnabled" : {
"description" : "DHCP Service Dynamic WAN Port Detection",
"type" : "boolean"
},
"manualSelect" : {
"description" : "DHCP Service AP Selection Mode. This value is effective when the siteMode is EnableOnMultipleAPs.",
"type" : "boolean"
},
"siteMode" : {
"description" : "DHCP Service mode",
"type" : "string",
"enum" : [ "EnableOnEachAPs", "EnableOnMultipleAPs", "EnableOnHierarchicalAPs" ]
},
"eth0ProfileId" : {
"type" : "integer"
},
"eth1ProfileId" : {
"type" : "integer"
},
"siteAps" : {
"type" : "array",
"items" : {
"type" : "object",
"description" : "DHCP Site selected APs. The content is effective when the siteMode is EnableOnMultipleAPs.",
"additionalProperties" : false,
"properties" : {
"apMac" : {
"type" : "string"
},
"apName" : {
"type" : "string"
},
"apStatus" : {
"type" : "string",
"enum" : [ "Online", "Offline", "Flagged" ]
},
"apServerEnabled" : {
"type" : "boolean"
},
"apServerPrimary" : {
"type" : "boolean"
},
"apServerIp" : {
"type" : [ "string", "null" ]
},
"apGatewayIp" : {
"type" : "string"
},
"apServerType" : {
"type" : "string"
}
}
}
},
"siteProfileIds" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
}
},
"domainId" : {
"type" : "string"
},
"dosBarringCheckPeriod" : {
"type" : "integer"
},
"dosBarringEnable" : {
"type" : "integer"
},
"dosBarringPeriod" : {
"type" : "integer"
},
"dosBarringThreshold" : {
"type" : "integer"
},
"ipsecProfile" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"ipv6TrafficFilterEnabled" : {
"type" : "integer"
},
"latitude" : {
"type" : "number"
},
"location" : {
"type" : "string"
},
"locationAdditionalInfo" : {
"type" : "string",
"pattern" : "^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
},
"locationBasedService" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"login" : {
"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" ]
},
"longitude" : {
"type" : "number"
},
"mesh" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"ssid" : {
"description" : "SSID of the mesh network",
"type" : "string"
},
"passphrase" : {
"description" : "Passphrase for the mesh network",
"type" : "string"
},
"meshRadioIdx" : {
"description" : "Mesh radio index",
"type" : "string",
"enum" : [ "Radio24G", "Radio5G" ]
},
"zeroTouchStatus" : {
"type" : "boolean"
}
}
},
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$"
},
"nodeAffinityProfile" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"rogue" : {
"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"
}
}
},
"smartMonitor" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"intervalInSec" : {
"description" : "Interval in seconds. This is required if smartMonitor is enabled",
"type" : "integer",
"minimum" : 5,
"maximum" : 60
},
"retryThreshold" : {
"description" : "Retry threshold. This is required if smartMonitor is enabled",
"type" : "integer",
"minimum" : 1,
"maximum" : 10
}
}
},
"syslog" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"flowLevel" : {
"description" : "Flow Level of the syslog",
"type" : "string",
"enum" : [ "GENERAL_LOGS", "CLIENT_FLOW", "ALL" ]
},
"address" : {
"description" : "Address of the syslog server.",
"type" : "string"
},
"port" : {
"description" : "Port number of the syslog server",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
},
"protocol" : {
"description" : "Protocol of the syslog server",
"type" : "string",
"enum" : [ "IPPROTO_TCP", "IPPROTO_UDP" ]
},
"secondaryAddress" : {
"description" : "Secondary Server Address of the syslog server",
"type" : "string"
},
"secondaryPort" : {
"description" : "Secondary Server Port of the syslog server",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
},
"secondaryProtocol" : {
"description" : "Secondary Server Protocol of the syslog server",
"type" : "string",
"enum" : [ "IPPROTO_TCP", "IPPROTO_UDP" ]
},
"facility" : {
"description" : "Facility of the syslog server",
"type" : "string",
"enum" : [ "Keep_Original", "Local0", "Local1", "Local2", "Local3", "Local4", "Local5", "Local6", "Local7" ]
},
"priority" : {
"description" : "Priority of the log messages",
"type" : "string",
"enum" : [ "Emergency", "Alert", "Critical", "Error", "Warning", "Notice", "Info", "All" ]
}
}
},
"timezone" : {
"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" ]
}
}
},
"tunnelProfile" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"aaaAffinityEnabled" : {
"type" : "boolean"
},
"tunnelType" : {
"description" : "Tunnel type configuration of the zone. No_Tunneled is for IPv6 mode",
"type" : "string",
"enum" : [ "No_Tunneled", "RuckusGRE", "SoftGRE", "SoftGREIpsec" ]
},
"venueProfile" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"vlanOverlappingEnabled" : {
"type" : "boolean"
},
"wifi24" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"autoCellSizing" : {
"description" : "Auto Cell Sizing",
"type" : "boolean"
},
"txPower" : {
"description" : "Transmission power",
"type" : "string",
"enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ]
},
"channelWidth" : {
"description" : "Channel width. Zero (0) means Auto.",
"type" : "integer",
"enum" : [ 0, 20, 40 ]
},
"channel" : {
"description" : "Channel number",
"type" : "integer"
},
"channelRange" : {
"description" : "Channel range options",
"type" : "array",
"items" : {
"type" : "integer"
}
}
}
},
"wifi50" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"autoCellSizing" : {
"description" : "Auto Cell Sizing",
"type" : "boolean"
},
"txPower" : {
"description" : "Transmission power",
"type" : "string",
"enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ]
},
"channelWidth" : {
"description" : "Channel width. Zero (0) means Auto. 8080 means 80+80MHz",
"type" : "integer",
"enum" : [ 0, 20, 40, 80, 8080, 160 ]
},
"indoorChannel" : {
"description" : "Channel number for Indoor AP",
"type" : "integer"
},
"outdoorChannel" : {
"description" : "Channel number for Outdoor AP",
"type" : "integer"
},
"indoorSecondaryChannel" : {
"description" : "Secondary channel number for Indoor AP (channelWidth is 80+80MHz only)",
"type" : "integer"
},
"outdoorSecondaryChannel" : {
"description" : "Secondary channel number for outdoor AP (channelWidth is 80+80MHz only)",
"type" : "integer"
},
"indoorChannelRange" : {
"description" : "Channel range options for Indoor AP",
"type" : "array",
"items" : {
"type" : "integer"
}
},
"outdoorChannelRange" : {
"description" : "Channel range options for outdoor AP",
"type" : "array",
"items" : {
"type" : "integer"
}
}
}
},
"protectionMode24" : {
"type" : "string",
"enum" : [ "NONE", "CTS_ONLY", "RTS_CTS" ]
},
"zoneAffinityProfileId" : {
"type" : "string"
},
"snmpAgent" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"apSnmpEnabled" : {
"description" : "Enable AP SNMP",
"type" : "boolean"
},
"snmpV2Agent" : {
"description" : "Community List of the SNMP V2 Agent.",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"communityName" : {
"description" : "name of the SNMP Community.",
"type" : "string"
},
"readEnabled" : {
"description" : "read privilege of the SNMP Coummunity",
"type" : "boolean"
},
"writeEnabled" : {
"description" : "write privilege of the SNMP Coummunity",
"type" : "boolean"
},
"notificationEnabled" : {
"description" : "notification privilege of the SNMP Coummunity",
"type" : "boolean"
},
"notificationType" : {
"description" : "type of the notification privilege",
"type" : "string",
"enum" : [ "TRAP", "INFORM" ]
},
"notificationTarget" : {
"description" : "Trap List of the SNMP Coummunity",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"address" : {
"description" : "address of the SNMP Trap",
"type" : "string"
},
"port" : {
"description" : "port number of the SNMP Trap",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
}
},
"required" : [ "address", "port" ]
}
}
},
"required" : [ "communityName" ]
}
},
"snmpV3Agent" : {
"description" : "User List of the SNMP V3 Agent.",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"userName" : {
"description" : "name of the SNMP User.",
"type" : "string"
},
"authProtocol" : {
"description" : "authProtocol of the SNMP User.",
"type" : "string",
"enum" : [ "NONE", "MD5", "SHA" ]
},
"authPassword" : {
"description" : "authPassword of the SNMP User.",
"type" : "string",
"minLength" : 8
},
"privProtocol" : {
"description" : "privProtocol of the SNMP User.",
"type" : "string",
"enum" : [ "NONE", "DES", "AES" ]
},
"privPassword" : {
"description" : "privPassword of the SNMP User.",
"type" : "string",
"minLength" : 8
},
"readEnabled" : {
"description" : "read privilege of the SNMP User",
"type" : "boolean"
},
"writeEnabled" : {
"description" : "write privilege of the SNMP User",
"type" : "boolean"
},
"notificationEnabled" : {
"description" : "notification privilege of the SNMP User",
"type" : "boolean"
},
"notificationType" : {
"description" : "type of the notification privilege",
"type" : "string",
"enum" : [ "TRAP", "INFORM" ]
},
"notificationTarget" : {
"description" : "Trap List of the SNMP User",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"address" : {
"description" : "address of the SNMP Trap",
"type" : "string"
},
"port" : {
"description" : "port number of the SNMP Trap",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
}
},
"required" : [ "address", "port" ]
}
}
},
"required" : [ "userName" ]
}
}
}
},
"recoverySsid" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"recoverySsidPskKey" : {
"description" : "recovery ssid password",
"type" : "string"
},
"recoverySsidEnabled" : {
"description" : "recovery ssid enable/disable",
"type" : "boolean"
}
}
},
"clusterRedundancyEnabled" : {
"type" : "boolean"
},
"rogueApReportThreshold" : {
"type" : "integer"
},
"rogueApAggressivenessMode" : {
"type" : "integer"
},
"rogueApJammingDetection" : {
"type" : "boolean"
},
"rogueApJammingThreshold" : {
"type" : "integer"
},
"directedMulticastFromWiredClientEnabled" : {
"type" : "boolean"
},
"directedMulticastFromWirelessClientEnabled" : {
"type" : "boolean"
},
"directedMulticastFromNetworkEnabled" : {
"type" : "boolean"
},
"healthCheckSitesEnabled" : {
"description" : "Enabled Health Check Sites. ",
"type" : "boolean"
},
"healthCheckSites" : {
"description" : "Health Check Sites.",
"type" : "array",
"items" : {
"type" : "string"
}
},
"ruckusGreTunnelProfile" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"softGreTunnelProflies" : {
"type" : "array",
"items" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"aaaAffinityEnabled" : {
"type" : "boolean"
}
}
}
},
"ipsecProfiles" : {
"type" : "array",
"items" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
}
},
"sshTunnelEncryption" : {
"type" : "string",
"enum" : [ "AES128", "AES256" ]
},
"lteBandLockChannels" : {
"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"
}
}
}
},
"apHccdEnabled" : {
"type" : "boolean"
},
"apHccdPersist" : {
"type" : "boolean"
}
},
"type" : "object"
}
204
Change the Zone's SoftGRE Tunnel Profiles ¶
PATCH/v8_1/rkszones/{id}/softGreTunnelProflies
Use this API command to change the Zone’s SoftGRE tunnel profiles.
Body
{
"domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
"zoneAffinityProfileId": "3fd9aa91-df65-11e7-98e1-08002748d78e",
"enforcePriorityZoneAffinityEnable": false,
"name": "modifyZoneName",
"description": "description Zone",
"countryCode": "US",
"timezone": {
"systemTimezone": "America/Whitehorse"
},
"login": {
"apLoginName": "admin",
"apLoginPassword": "admin!234"
},
"mesh": {
"ssid": "meshSSID",
"passphrase": "passphrase"
},
"dfsChannelEnabled": false,
"wifi24": {
"txPower": "Full",
"channelWidth": 20,
"channel": 0,
"channelRange": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11
]
},
"wifi50": {
"txPower": "-1dB",
"channelWidth": 40,
"indoorChannel": 0,
"outdoorChannel": 0,
"indoorChannelRange": [
36,
40,
44,
48,
149,
153,
157,
161
],
"outdoorChannelRange": [
149,
153,
157,
161
]
},
"protectionMode24": "CTS_ONLY",
"syslog": {
"address": "1.1.1.1",
"port": 514,
"facility": "Local0",
"priority": "Error"
},
"smartMonitor": {
"intervalInSec": 10,
"retryThreshold": 3
},
"nodeAffinityProfile": null,
"venueProfile": null,
"locationBasedService": null,
"channelModeEnabled": false,
"bonjourFencingPolicy": null,
"tunnelType": "RuckusGRE",
"tunnelProfile": {
"id": "f5b92938-aa4e-4d02-90ea-273799ff689b",
"name": "Default Tunnel Profile"
},
"clientAdmissionControl24": {
"maxRadioLoadPercent": 70,
"minClientCount": 10,
"minClientThroughputMbps": 10
},
"clientAdmissionControl50": {
"maxRadioLoadPercent": 70,
"minClientCount": 10,
"minClientThroughputMbps": 10
},
"backgroundScanning24": {
"frequencyInSec": 20
},
"backgroundScanning50": {
"frequencyInSec": 20
},
"clientLoadBalancing24": {
"adjacentRadioThreshold": 12
},
"clientLoadBalancing50": {
"adjacentRadioThreshold": 12
},
"bandBalancing": {
"wifi24Percentage": 10
},
"loadBalancingMethod": "BASED_ON_CLIENT_COUNT",
"rogue": {
"reportType": "All",
"maliciousTypes": null,
"protectionEnabled": true
},
"dosBarringEnable": 0,
"dosBarringPeriod": 60,
"dosBarringThreshold": 5,
"dosBarringCheckPeriod": 30,
"apRebootTimeout": {
"gatewayLossTimeoutInSec": 1800,
"serverLossTimeoutInSec": 7200
},
"location": "location",
"locationAdditionalInfo": "locationAdditionalInfo",
"latitude": 23,
"longitude": 23,
"vlanOverlappingEnabled": false,
"autoChannelSelection24": {
"channelSelectMode": "ChannelFly",
"channelFlyMtbc": 480
},
"autoChannelSelection50": {
"channelSelectMode": "BackgroundScanning",
"channelFlyMtbc": 480
},
"channelEvaluationInterval": 777,
"apMgmtVlan": {
"id": 1,
"mode": "KEEP"
},
"apLatencyInterval": {
"pingEnabled": true
},
"ipsecProfile": {
"id": "ipsecProfileId",
"name": "ipsecProfileName"
},
"altitude": {
"altitudeUnit": "meters",
"altitudeValue": 1
},
"bonjourFencingPolicyEnabled": false,
"snmpAgent": {
"apSnmpEnabled": true,
"snmpV2Agent": [
{
"communityName": "v2Agent",
"notificationEnabled": true,
"readEnabled": true,
"writeEnabled": true,
"notificationType": "TRAP",
"notificationTarget": [
{
"address": "172.19.16.20",
"port": 161
}
]
}
],
"snmpV3Agent": [
{
"userName": "v3Agent",
"authProtocol": "MD5",
"authPassword": "admin!234",
"privProtocol": "DES",
"privPassword": "admin!234",
"notificationEnabled": true,
"readEnabled": true,
"writeEnabled": true,
"notificationType": "TRAP",
"notificationTarget": [
{
"address": "172.19.16.20",
"port": 161
}
]
}
]
},
"recoverySsid": {
"recoverySsidEnabled": true
},
"dhcpSiteConfig": {
"siteEnabled": true,
"siteMode": "EnableOnEachAPs",
"siteProfileIds": [
"75e26590-547f-11e6-9ca7-5a095364c13c",
"869bb532-547f-11e6-9ca7-5a095364c13c"
]
},
"rogueApReportThreshold": 40,
"rogueApAggressivenessMode": 2,
"rogueApJammingDetection": true,
"rogueApJammingThreshold": 40,
"directedMulticastFromWiredClientEnabled": true,
"directedMulticastFromWirelessClientEnabled": true,
"directedMulticastFromNetworkEnabled": false,
"healthCheckSitesEnabled": true,
"healthCheckSites": [
"www.google.com",
"www.live.com:443",
"www.github.com:443",
"source.codeaurora.org:443",
"www.wikipedia.com"
],
"ruckusGreTunnelProfile": {
"id": "f5b92938-aa4e-4d02-90ea-273799ff689b",
"name": "Default Tunnel Profile"
},
"softGreTunnelProflies": [
{
"id": "5a2e41b0-df53-11e7-98e1-08002748d78e",
"name": "softGre1",
"aaaAffinityEnabled": true
},
{
"id": "7803e411-df53-11e7-98e1-08002748d78e",
"name": "softGre2",
"aaaAffinityEnabled": true
}
],
"ipsecProfiles": [
{
"id": "3fd9aa91-df65-11e7-98e1-08002748d78e",
"name": "ipsec1"
}
],
"ipsecTunnelMode": "SOFT_GRE",
"sshTunnelEncryption": "AES128",
"lteBandLockChannels": [
{
"simCardId": 0,
"type": "EC25E",
"channel4g": "B1,B3,B5",
"channel3g": "B5"
},
{
"simCardId": 1,
"type": "EC25E",
"channel4g": "",
"channel3g": ""
}
],
"apHccdEnabled": true,
"apHccdPersist": true
}
Schema
{
"additionalProperties" : false,
"properties" : {
"altitude" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"altitudeUnit" : {
"description" : "altitude unit",
"type" : "string",
"enum" : [ "meters", "floor" ]
},
"altitudeValue" : {
"description" : "altitude value",
"type" : "integer"
}
}
},
"apMgmtVlan" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"mode" : {
"description" : "Vlan Mode of the zone",
"type" : "string",
"enum" : [ "KEEP", "USER_DEFINED" ]
},
"id" : {
"description" : "Vlan id of the zone",
"type" : "integer"
}
}
},
"apLatencyInterval" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"pingEnabled" : {
"description" : "AP ping latency enabled",
"type" : "boolean"
}
}
},
"apRebootTimeout" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"gatewayLossTimeoutInSec" : {
"description" : "Gateway loss timeout in second",
"type" : "integer",
"enum" : [ 0, 1800, 3600, 5400, 7200, 9000, 10800, 12600, 14400, 16200, 18000, 19800, 23400, 25200, 27000, 28800, 30600, 32400, 34200, 36000, 37800, 39600, 41400, 43200, 45000, 46800, 48600, 50400, 52200, 54000, 55800, 57600, 59400, 61200, 63000, 64800, 66600, 68400, 70200, 72000, 73800, 75600, 77400, 79200, 81000, 82800, 84600, 86400 ]
},
"serverLossTimeoutInSec" : {
"description" : "Server loss timeout in second",
"type" : "integer",
"enum" : [ 0, 7200, 14400, 21600, 28800, 36000, 43200, 50400, 57600, 64800, 72000, 79200, 86400 ]
}
}
},
"autoChannelSelection24" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"channelSelectMode" : {
"description" : "Channel Select Mode",
"type" : "string",
"enum" : [ "None", "BackgroundScanning", "ChannelFly" ]
},
"channelFlyMtbc" : {
"description" : "ChannelFly MTBC",
"type" : "integer",
"minimum" : 100,
"maximum" : 1440
}
}
},
"autoChannelSelection50" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"channelSelectMode" : {
"description" : "Channel Select Mode",
"type" : "string",
"enum" : [ "None", "BackgroundScanning", "ChannelFly" ]
},
"channelFlyMtbc" : {
"description" : "ChannelFly MTBC",
"type" : "integer",
"minimum" : 100,
"maximum" : 1440
}
}
},
"awsVenue" : {
"type" : "string"
},
"backgroundScanning24" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"frequencyInSec" : {
"description" : "Frequency in second",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
}
}
},
"backgroundScanning50" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"frequencyInSec" : {
"description" : "Frequency in second",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
}
}
},
"bandBalancing" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"mode" : {
"description" : "Band Balancing Mode: BASIC-Withholds probe and authentication responses at connetcion time in heavily loaded band to balance clients to the other band, PROACTIVE-Uses BASIC functionality and actively rebalances clients via 802.11v BTM, STRICT-Uses PROACTIVE functionality and forcefully rebalances clients via 802.11v BTM",
"type" : "string",
"enum" : [ "BASIC", "PROACTIVE", "STRICT" ]
},
"wifi24Percentage" : {
"description" : "Percentage of client load on 2.4GHz radio band",
"type" : "integer",
"minimum" : 0,
"maximum" : 100
}
}
},
"loadBalancingMethod" : {
"type" : "string",
"enum" : [ "BASED_ON_CLIENT_COUNT", "BASED_ON_CAPACITY", "OFF" ]
},
"bonjourFencingPolicy" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"bonjourFencingPolicyEnabled" : {
"type" : "boolean"
},
"channelEvaluationInterval" : {
"maximum" : 3600,
"minimum" : 60,
"type" : "integer"
},
"channelModeEnabled" : {
"type" : "boolean"
},
"clientAdmissionControl24" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"maxRadioLoadPercent" : {
"description" : "Maximum radio load percentage.",
"type" : "integer",
"minimum" : 50,
"maximum" : 100
},
"minClientCount" : {
"description" : "Minimum client count number.",
"type" : "integer",
"minimum" : 0,
"maximum" : 100
},
"minClientThroughputMbps" : {
"description" : "Minimum client throughput in Mbps.",
"type" : "number",
"minimum" : 0,
"maximum" : 100
}
}
},
"clientAdmissionControl50" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"maxRadioLoadPercent" : {
"description" : "Maximum radio load percentage.",
"type" : "integer",
"minimum" : 50,
"maximum" : 100
},
"minClientCount" : {
"description" : "Minimum client count number.",
"type" : "integer",
"minimum" : 0,
"maximum" : 100
},
"minClientThroughputMbps" : {
"description" : "Minimum client throughput in Mbps.",
"type" : "number",
"minimum" : 0,
"maximum" : 100
}
}
},
"clientLoadBalancing24" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"adjacentRadioThreshold" : {
"description" : "Adjacent radio threshold",
"type" : "integer",
"minimum" : 1,
"maximum" : 100
}
}
},
"clientLoadBalancing50" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"adjacentRadioThreshold" : {
"description" : "Adjacent radio threshold",
"type" : "integer",
"minimum" : 1,
"maximum" : 100
}
}
},
"countryCode" : {
"type" : "string"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64
},
"dfsChannelEnabled" : {
"type" : "boolean"
},
"cbandChannelEnabled" : {
"type" : "boolean"
},
"cbandChannelLicenseEnabled" : {
"type" : "boolean"
},
"channel144Enabled" : {
"type" : "boolean"
},
"dhcpSiteConfig" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"siteEnabled" : {
"description" : "DHCP Service Enabling Status",
"type" : "boolean"
},
"dwpdEnabled" : {
"description" : "DHCP Service Dynamic WAN Port Detection",
"type" : "boolean"
},
"manualSelect" : {
"description" : "DHCP Service AP Selection Mode. This value is effective when the siteMode is EnableOnMultipleAPs.",
"type" : "boolean"
},
"siteMode" : {
"description" : "DHCP Service mode",
"type" : "string",
"enum" : [ "EnableOnEachAPs", "EnableOnMultipleAPs", "EnableOnHierarchicalAPs" ]
},
"eth0ProfileId" : {
"type" : "integer"
},
"eth1ProfileId" : {
"type" : "integer"
},
"siteAps" : {
"type" : "array",
"items" : {
"type" : "object",
"description" : "DHCP Site selected APs. The content is effective when the siteMode is EnableOnMultipleAPs.",
"additionalProperties" : false,
"properties" : {
"apMac" : {
"type" : "string"
},
"apName" : {
"type" : "string"
},
"apStatus" : {
"type" : "string",
"enum" : [ "Online", "Offline", "Flagged" ]
},
"apServerEnabled" : {
"type" : "boolean"
},
"apServerPrimary" : {
"type" : "boolean"
},
"apServerIp" : {
"type" : [ "string", "null" ]
},
"apGatewayIp" : {
"type" : "string"
},
"apServerType" : {
"type" : "string"
}
}
}
},
"siteProfileIds" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
}
},
"domainId" : {
"type" : "string"
},
"dosBarringCheckPeriod" : {
"type" : "integer"
},
"dosBarringEnable" : {
"type" : "integer"
},
"dosBarringPeriod" : {
"type" : "integer"
},
"dosBarringThreshold" : {
"type" : "integer"
},
"ipsecProfile" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"ipv6TrafficFilterEnabled" : {
"type" : "integer"
},
"latitude" : {
"type" : "number"
},
"location" : {
"type" : "string"
},
"locationAdditionalInfo" : {
"type" : "string",
"pattern" : "^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
},
"locationBasedService" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"login" : {
"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" ]
},
"longitude" : {
"type" : "number"
},
"mesh" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"ssid" : {
"description" : "SSID of the mesh network",
"type" : "string"
},
"passphrase" : {
"description" : "Passphrase for the mesh network",
"type" : "string"
},
"meshRadioIdx" : {
"description" : "Mesh radio index",
"type" : "string",
"enum" : [ "Radio24G", "Radio5G" ]
},
"zeroTouchStatus" : {
"type" : "boolean"
}
}
},
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$"
},
"nodeAffinityProfile" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"rogue" : {
"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"
}
}
},
"smartMonitor" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"intervalInSec" : {
"description" : "Interval in seconds. This is required if smartMonitor is enabled",
"type" : "integer",
"minimum" : 5,
"maximum" : 60
},
"retryThreshold" : {
"description" : "Retry threshold. This is required if smartMonitor is enabled",
"type" : "integer",
"minimum" : 1,
"maximum" : 10
}
}
},
"syslog" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"flowLevel" : {
"description" : "Flow Level of the syslog",
"type" : "string",
"enum" : [ "GENERAL_LOGS", "CLIENT_FLOW", "ALL" ]
},
"address" : {
"description" : "Address of the syslog server.",
"type" : "string"
},
"port" : {
"description" : "Port number of the syslog server",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
},
"protocol" : {
"description" : "Protocol of the syslog server",
"type" : "string",
"enum" : [ "IPPROTO_TCP", "IPPROTO_UDP" ]
},
"secondaryAddress" : {
"description" : "Secondary Server Address of the syslog server",
"type" : "string"
},
"secondaryPort" : {
"description" : "Secondary Server Port of the syslog server",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
},
"secondaryProtocol" : {
"description" : "Secondary Server Protocol of the syslog server",
"type" : "string",
"enum" : [ "IPPROTO_TCP", "IPPROTO_UDP" ]
},
"facility" : {
"description" : "Facility of the syslog server",
"type" : "string",
"enum" : [ "Keep_Original", "Local0", "Local1", "Local2", "Local3", "Local4", "Local5", "Local6", "Local7" ]
},
"priority" : {
"description" : "Priority of the log messages",
"type" : "string",
"enum" : [ "Emergency", "Alert", "Critical", "Error", "Warning", "Notice", "Info", "All" ]
}
}
},
"timezone" : {
"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" ]
}
}
},
"tunnelProfile" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"aaaAffinityEnabled" : {
"type" : "boolean"
},
"tunnelType" : {
"description" : "Tunnel type configuration of the zone. No_Tunneled is for IPv6 mode",
"type" : "string",
"enum" : [ "No_Tunneled", "RuckusGRE", "SoftGRE", "SoftGREIpsec" ]
},
"venueProfile" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"vlanOverlappingEnabled" : {
"type" : "boolean"
},
"wifi24" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"autoCellSizing" : {
"description" : "Auto Cell Sizing",
"type" : "boolean"
},
"txPower" : {
"description" : "Transmission power",
"type" : "string",
"enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ]
},
"channelWidth" : {
"description" : "Channel width. Zero (0) means Auto.",
"type" : "integer",
"enum" : [ 0, 20, 40 ]
},
"channel" : {
"description" : "Channel number",
"type" : "integer"
},
"channelRange" : {
"description" : "Channel range options",
"type" : "array",
"items" : {
"type" : "integer"
}
}
}
},
"wifi50" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"autoCellSizing" : {
"description" : "Auto Cell Sizing",
"type" : "boolean"
},
"txPower" : {
"description" : "Transmission power",
"type" : "string",
"enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ]
},
"channelWidth" : {
"description" : "Channel width. Zero (0) means Auto. 8080 means 80+80MHz",
"type" : "integer",
"enum" : [ 0, 20, 40, 80, 8080, 160 ]
},
"indoorChannel" : {
"description" : "Channel number for Indoor AP",
"type" : "integer"
},
"outdoorChannel" : {
"description" : "Channel number for Outdoor AP",
"type" : "integer"
},
"indoorSecondaryChannel" : {
"description" : "Secondary channel number for Indoor AP (channelWidth is 80+80MHz only)",
"type" : "integer"
},
"outdoorSecondaryChannel" : {
"description" : "Secondary channel number for outdoor AP (channelWidth is 80+80MHz only)",
"type" : "integer"
},
"indoorChannelRange" : {
"description" : "Channel range options for Indoor AP",
"type" : "array",
"items" : {
"type" : "integer"
}
},
"outdoorChannelRange" : {
"description" : "Channel range options for outdoor AP",
"type" : "array",
"items" : {
"type" : "integer"
}
}
}
},
"protectionMode24" : {
"type" : "string",
"enum" : [ "NONE", "CTS_ONLY", "RTS_CTS" ]
},
"zoneAffinityProfileId" : {
"type" : "string"
},
"snmpAgent" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"apSnmpEnabled" : {
"description" : "Enable AP SNMP",
"type" : "boolean"
},
"snmpV2Agent" : {
"description" : "Community List of the SNMP V2 Agent.",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"communityName" : {
"description" : "name of the SNMP Community.",
"type" : "string"
},
"readEnabled" : {
"description" : "read privilege of the SNMP Coummunity",
"type" : "boolean"
},
"writeEnabled" : {
"description" : "write privilege of the SNMP Coummunity",
"type" : "boolean"
},
"notificationEnabled" : {
"description" : "notification privilege of the SNMP Coummunity",
"type" : "boolean"
},
"notificationType" : {
"description" : "type of the notification privilege",
"type" : "string",
"enum" : [ "TRAP", "INFORM" ]
},
"notificationTarget" : {
"description" : "Trap List of the SNMP Coummunity",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"address" : {
"description" : "address of the SNMP Trap",
"type" : "string"
},
"port" : {
"description" : "port number of the SNMP Trap",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
}
},
"required" : [ "address", "port" ]
}
}
},
"required" : [ "communityName" ]
}
},
"snmpV3Agent" : {
"description" : "User List of the SNMP V3 Agent.",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"userName" : {
"description" : "name of the SNMP User.",
"type" : "string"
},
"authProtocol" : {
"description" : "authProtocol of the SNMP User.",
"type" : "string",
"enum" : [ "NONE", "MD5", "SHA" ]
},
"authPassword" : {
"description" : "authPassword of the SNMP User.",
"type" : "string",
"minLength" : 8
},
"privProtocol" : {
"description" : "privProtocol of the SNMP User.",
"type" : "string",
"enum" : [ "NONE", "DES", "AES" ]
},
"privPassword" : {
"description" : "privPassword of the SNMP User.",
"type" : "string",
"minLength" : 8
},
"readEnabled" : {
"description" : "read privilege of the SNMP User",
"type" : "boolean"
},
"writeEnabled" : {
"description" : "write privilege of the SNMP User",
"type" : "boolean"
},
"notificationEnabled" : {
"description" : "notification privilege of the SNMP User",
"type" : "boolean"
},
"notificationType" : {
"description" : "type of the notification privilege",
"type" : "string",
"enum" : [ "TRAP", "INFORM" ]
},
"notificationTarget" : {
"description" : "Trap List of the SNMP User",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"address" : {
"description" : "address of the SNMP Trap",
"type" : "string"
},
"port" : {
"description" : "port number of the SNMP Trap",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
}
},
"required" : [ "address", "port" ]
}
}
},
"required" : [ "userName" ]
}
}
}
},
"recoverySsid" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"recoverySsidPskKey" : {
"description" : "recovery ssid password",
"type" : "string"
},
"recoverySsidEnabled" : {
"description" : "recovery ssid enable/disable",
"type" : "boolean"
}
}
},
"clusterRedundancyEnabled" : {
"type" : "boolean"
},
"rogueApReportThreshold" : {
"type" : "integer"
},
"rogueApAggressivenessMode" : {
"type" : "integer"
},
"rogueApJammingDetection" : {
"type" : "boolean"
},
"rogueApJammingThreshold" : {
"type" : "integer"
},
"directedMulticastFromWiredClientEnabled" : {
"type" : "boolean"
},
"directedMulticastFromWirelessClientEnabled" : {
"type" : "boolean"
},
"directedMulticastFromNetworkEnabled" : {
"type" : "boolean"
},
"healthCheckSitesEnabled" : {
"description" : "Enabled Health Check Sites. ",
"type" : "boolean"
},
"healthCheckSites" : {
"description" : "Health Check Sites.",
"type" : "array",
"items" : {
"type" : "string"
}
},
"ruckusGreTunnelProfile" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"softGreTunnelProflies" : {
"type" : "array",
"items" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"aaaAffinityEnabled" : {
"type" : "boolean"
}
}
}
},
"ipsecProfiles" : {
"type" : "array",
"items" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
}
},
"sshTunnelEncryption" : {
"type" : "string",
"enum" : [ "AES128", "AES256" ]
},
"lteBandLockChannels" : {
"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"
}
}
}
},
"apHccdEnabled" : {
"type" : "boolean"
},
"apHccdPersist" : {
"type" : "boolean"
}
},
"type" : "object"
}
204
Change the Zone's IPsec Profiles ¶
PATCH/v8_1/rkszones/{id}/ipsecProfiles
Use this API command to change the Zone’s IPsec profiles.
Body
{
"domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
"zoneAffinityProfileId": "3fd9aa91-df65-11e7-98e1-08002748d78e",
"enforcePriorityZoneAffinityEnable": false,
"name": "modifyZoneName",
"description": "description Zone",
"countryCode": "US",
"timezone": {
"systemTimezone": "America/Whitehorse"
},
"login": {
"apLoginName": "admin",
"apLoginPassword": "admin!234"
},
"mesh": {
"ssid": "meshSSID",
"passphrase": "passphrase"
},
"dfsChannelEnabled": false,
"wifi24": {
"txPower": "Full",
"channelWidth": 20,
"channel": 0,
"channelRange": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11
]
},
"wifi50": {
"txPower": "-1dB",
"channelWidth": 40,
"indoorChannel": 0,
"outdoorChannel": 0,
"indoorChannelRange": [
36,
40,
44,
48,
149,
153,
157,
161
],
"outdoorChannelRange": [
149,
153,
157,
161
]
},
"protectionMode24": "CTS_ONLY",
"syslog": {
"address": "1.1.1.1",
"port": 514,
"facility": "Local0",
"priority": "Error"
},
"smartMonitor": {
"intervalInSec": 10,
"retryThreshold": 3
},
"nodeAffinityProfile": null,
"venueProfile": null,
"locationBasedService": null,
"channelModeEnabled": false,
"bonjourFencingPolicy": null,
"tunnelType": "RuckusGRE",
"tunnelProfile": {
"id": "f5b92938-aa4e-4d02-90ea-273799ff689b",
"name": "Default Tunnel Profile"
},
"clientAdmissionControl24": {
"maxRadioLoadPercent": 70,
"minClientCount": 10,
"minClientThroughputMbps": 10
},
"clientAdmissionControl50": {
"maxRadioLoadPercent": 70,
"minClientCount": 10,
"minClientThroughputMbps": 10
},
"backgroundScanning24": {
"frequencyInSec": 20
},
"backgroundScanning50": {
"frequencyInSec": 20
},
"clientLoadBalancing24": {
"adjacentRadioThreshold": 12
},
"clientLoadBalancing50": {
"adjacentRadioThreshold": 12
},
"bandBalancing": {
"wifi24Percentage": 10
},
"loadBalancingMethod": "BASED_ON_CLIENT_COUNT",
"rogue": {
"reportType": "All",
"maliciousTypes": null,
"protectionEnabled": true
},
"dosBarringEnable": 0,
"dosBarringPeriod": 60,
"dosBarringThreshold": 5,
"dosBarringCheckPeriod": 30,
"apRebootTimeout": {
"gatewayLossTimeoutInSec": 1800,
"serverLossTimeoutInSec": 7200
},
"location": "location",
"locationAdditionalInfo": "locationAdditionalInfo",
"latitude": 23,
"longitude": 23,
"vlanOverlappingEnabled": false,
"autoChannelSelection24": {
"channelSelectMode": "ChannelFly",
"channelFlyMtbc": 480
},
"autoChannelSelection50": {
"channelSelectMode": "BackgroundScanning",
"channelFlyMtbc": 480
},
"channelEvaluationInterval": 777,
"apMgmtVlan": {
"id": 1,
"mode": "KEEP"
},
"apLatencyInterval": {
"pingEnabled": true
},
"ipsecProfile": {
"id": "ipsecProfileId",
"name": "ipsecProfileName"
},
"altitude": {
"altitudeUnit": "meters",
"altitudeValue": 1
},
"bonjourFencingPolicyEnabled": false,
"snmpAgent": {
"apSnmpEnabled": true,
"snmpV2Agent": [
{
"communityName": "v2Agent",
"notificationEnabled": true,
"readEnabled": true,
"writeEnabled": true,
"notificationType": "TRAP",
"notificationTarget": [
{
"address": "172.19.16.20",
"port": 161
}
]
}
],
"snmpV3Agent": [
{
"userName": "v3Agent",
"authProtocol": "MD5",
"authPassword": "admin!234",
"privProtocol": "DES",
"privPassword": "admin!234",
"notificationEnabled": true,
"readEnabled": true,
"writeEnabled": true,
"notificationType": "TRAP",
"notificationTarget": [
{
"address": "172.19.16.20",
"port": 161
}
]
}
]
},
"recoverySsid": {
"recoverySsidEnabled": true
},
"dhcpSiteConfig": {
"siteEnabled": true,
"siteMode": "EnableOnEachAPs",
"siteProfileIds": [
"75e26590-547f-11e6-9ca7-5a095364c13c",
"869bb532-547f-11e6-9ca7-5a095364c13c"
]
},
"rogueApReportThreshold": 40,
"rogueApAggressivenessMode": 2,
"rogueApJammingDetection": true,
"rogueApJammingThreshold": 40,
"directedMulticastFromWiredClientEnabled": true,
"directedMulticastFromWirelessClientEnabled": true,
"directedMulticastFromNetworkEnabled": false,
"healthCheckSitesEnabled": true,
"healthCheckSites": [
"www.google.com",
"www.live.com:443",
"www.github.com:443",
"source.codeaurora.org:443",
"www.wikipedia.com"
],
"ruckusGreTunnelProfile": {
"id": "f5b92938-aa4e-4d02-90ea-273799ff689b",
"name": "Default Tunnel Profile"
},
"softGreTunnelProflies": [
{
"id": "5a2e41b0-df53-11e7-98e1-08002748d78e",
"name": "softGre1",
"aaaAffinityEnabled": true
},
{
"id": "7803e411-df53-11e7-98e1-08002748d78e",
"name": "softGre2",
"aaaAffinityEnabled": true
}
],
"ipsecProfiles": [
{
"id": "3fd9aa91-df65-11e7-98e1-08002748d78e",
"name": "ipsec1"
}
],
"ipsecTunnelMode": "SOFT_GRE",
"sshTunnelEncryption": "AES128",
"lteBandLockChannels": [
{
"simCardId": 0,
"type": "EC25E",
"channel4g": "B1,B3,B5",
"channel3g": "B5"
},
{
"simCardId": 1,
"type": "EC25E",
"channel4g": "",
"channel3g": ""
}
],
"apHccdEnabled": true,
"apHccdPersist": true
}
Schema
{
"additionalProperties" : false,
"properties" : {
"altitude" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"altitudeUnit" : {
"description" : "altitude unit",
"type" : "string",
"enum" : [ "meters", "floor" ]
},
"altitudeValue" : {
"description" : "altitude value",
"type" : "integer"
}
}
},
"apMgmtVlan" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"mode" : {
"description" : "Vlan Mode of the zone",
"type" : "string",
"enum" : [ "KEEP", "USER_DEFINED" ]
},
"id" : {
"description" : "Vlan id of the zone",
"type" : "integer"
}
}
},
"apLatencyInterval" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"pingEnabled" : {
"description" : "AP ping latency enabled",
"type" : "boolean"
}
}
},
"apRebootTimeout" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"gatewayLossTimeoutInSec" : {
"description" : "Gateway loss timeout in second",
"type" : "integer",
"enum" : [ 0, 1800, 3600, 5400, 7200, 9000, 10800, 12600, 14400, 16200, 18000, 19800, 23400, 25200, 27000, 28800, 30600, 32400, 34200, 36000, 37800, 39600, 41400, 43200, 45000, 46800, 48600, 50400, 52200, 54000, 55800, 57600, 59400, 61200, 63000, 64800, 66600, 68400, 70200, 72000, 73800, 75600, 77400, 79200, 81000, 82800, 84600, 86400 ]
},
"serverLossTimeoutInSec" : {
"description" : "Server loss timeout in second",
"type" : "integer",
"enum" : [ 0, 7200, 14400, 21600, 28800, 36000, 43200, 50400, 57600, 64800, 72000, 79200, 86400 ]
}
}
},
"autoChannelSelection24" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"channelSelectMode" : {
"description" : "Channel Select Mode",
"type" : "string",
"enum" : [ "None", "BackgroundScanning", "ChannelFly" ]
},
"channelFlyMtbc" : {
"description" : "ChannelFly MTBC",
"type" : "integer",
"minimum" : 100,
"maximum" : 1440
}
}
},
"autoChannelSelection50" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"channelSelectMode" : {
"description" : "Channel Select Mode",
"type" : "string",
"enum" : [ "None", "BackgroundScanning", "ChannelFly" ]
},
"channelFlyMtbc" : {
"description" : "ChannelFly MTBC",
"type" : "integer",
"minimum" : 100,
"maximum" : 1440
}
}
},
"awsVenue" : {
"type" : "string"
},
"backgroundScanning24" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"frequencyInSec" : {
"description" : "Frequency in second",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
}
}
},
"backgroundScanning50" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"frequencyInSec" : {
"description" : "Frequency in second",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
}
}
},
"bandBalancing" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"mode" : {
"description" : "Band Balancing Mode: BASIC-Withholds probe and authentication responses at connetcion time in heavily loaded band to balance clients to the other band, PROACTIVE-Uses BASIC functionality and actively rebalances clients via 802.11v BTM, STRICT-Uses PROACTIVE functionality and forcefully rebalances clients via 802.11v BTM",
"type" : "string",
"enum" : [ "BASIC", "PROACTIVE", "STRICT" ]
},
"wifi24Percentage" : {
"description" : "Percentage of client load on 2.4GHz radio band",
"type" : "integer",
"minimum" : 0,
"maximum" : 100
}
}
},
"loadBalancingMethod" : {
"type" : "string",
"enum" : [ "BASED_ON_CLIENT_COUNT", "BASED_ON_CAPACITY", "OFF" ]
},
"bonjourFencingPolicy" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"bonjourFencingPolicyEnabled" : {
"type" : "boolean"
},
"channelEvaluationInterval" : {
"maximum" : 3600,
"minimum" : 60,
"type" : "integer"
},
"channelModeEnabled" : {
"type" : "boolean"
},
"clientAdmissionControl24" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"maxRadioLoadPercent" : {
"description" : "Maximum radio load percentage.",
"type" : "integer",
"minimum" : 50,
"maximum" : 100
},
"minClientCount" : {
"description" : "Minimum client count number.",
"type" : "integer",
"minimum" : 0,
"maximum" : 100
},
"minClientThroughputMbps" : {
"description" : "Minimum client throughput in Mbps.",
"type" : "number",
"minimum" : 0,
"maximum" : 100
}
}
},
"clientAdmissionControl50" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"maxRadioLoadPercent" : {
"description" : "Maximum radio load percentage.",
"type" : "integer",
"minimum" : 50,
"maximum" : 100
},
"minClientCount" : {
"description" : "Minimum client count number.",
"type" : "integer",
"minimum" : 0,
"maximum" : 100
},
"minClientThroughputMbps" : {
"description" : "Minimum client throughput in Mbps.",
"type" : "number",
"minimum" : 0,
"maximum" : 100
}
}
},
"clientLoadBalancing24" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"adjacentRadioThreshold" : {
"description" : "Adjacent radio threshold",
"type" : "integer",
"minimum" : 1,
"maximum" : 100
}
}
},
"clientLoadBalancing50" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"adjacentRadioThreshold" : {
"description" : "Adjacent radio threshold",
"type" : "integer",
"minimum" : 1,
"maximum" : 100
}
}
},
"countryCode" : {
"type" : "string"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64
},
"dfsChannelEnabled" : {
"type" : "boolean"
},
"cbandChannelEnabled" : {
"type" : "boolean"
},
"cbandChannelLicenseEnabled" : {
"type" : "boolean"
},
"channel144Enabled" : {
"type" : "boolean"
},
"dhcpSiteConfig" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"siteEnabled" : {
"description" : "DHCP Service Enabling Status",
"type" : "boolean"
},
"dwpdEnabled" : {
"description" : "DHCP Service Dynamic WAN Port Detection",
"type" : "boolean"
},
"manualSelect" : {
"description" : "DHCP Service AP Selection Mode. This value is effective when the siteMode is EnableOnMultipleAPs.",
"type" : "boolean"
},
"siteMode" : {
"description" : "DHCP Service mode",
"type" : "string",
"enum" : [ "EnableOnEachAPs", "EnableOnMultipleAPs", "EnableOnHierarchicalAPs" ]
},
"eth0ProfileId" : {
"type" : "integer"
},
"eth1ProfileId" : {
"type" : "integer"
},
"siteAps" : {
"type" : "array",
"items" : {
"type" : "object",
"description" : "DHCP Site selected APs. The content is effective when the siteMode is EnableOnMultipleAPs.",
"additionalProperties" : false,
"properties" : {
"apMac" : {
"type" : "string"
},
"apName" : {
"type" : "string"
},
"apStatus" : {
"type" : "string",
"enum" : [ "Online", "Offline", "Flagged" ]
},
"apServerEnabled" : {
"type" : "boolean"
},
"apServerPrimary" : {
"type" : "boolean"
},
"apServerIp" : {
"type" : [ "string", "null" ]
},
"apGatewayIp" : {
"type" : "string"
},
"apServerType" : {
"type" : "string"
}
}
}
},
"siteProfileIds" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
}
},
"domainId" : {
"type" : "string"
},
"dosBarringCheckPeriod" : {
"type" : "integer"
},
"dosBarringEnable" : {
"type" : "integer"
},
"dosBarringPeriod" : {
"type" : "integer"
},
"dosBarringThreshold" : {
"type" : "integer"
},
"ipsecProfile" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"ipv6TrafficFilterEnabled" : {
"type" : "integer"
},
"latitude" : {
"type" : "number"
},
"location" : {
"type" : "string"
},
"locationAdditionalInfo" : {
"type" : "string",
"pattern" : "^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
},
"locationBasedService" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"login" : {
"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" ]
},
"longitude" : {
"type" : "number"
},
"mesh" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"ssid" : {
"description" : "SSID of the mesh network",
"type" : "string"
},
"passphrase" : {
"description" : "Passphrase for the mesh network",
"type" : "string"
},
"meshRadioIdx" : {
"description" : "Mesh radio index",
"type" : "string",
"enum" : [ "Radio24G", "Radio5G" ]
},
"zeroTouchStatus" : {
"type" : "boolean"
}
}
},
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$"
},
"nodeAffinityProfile" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"rogue" : {
"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"
}
}
},
"smartMonitor" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"intervalInSec" : {
"description" : "Interval in seconds. This is required if smartMonitor is enabled",
"type" : "integer",
"minimum" : 5,
"maximum" : 60
},
"retryThreshold" : {
"description" : "Retry threshold. This is required if smartMonitor is enabled",
"type" : "integer",
"minimum" : 1,
"maximum" : 10
}
}
},
"syslog" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"flowLevel" : {
"description" : "Flow Level of the syslog",
"type" : "string",
"enum" : [ "GENERAL_LOGS", "CLIENT_FLOW", "ALL" ]
},
"address" : {
"description" : "Address of the syslog server.",
"type" : "string"
},
"port" : {
"description" : "Port number of the syslog server",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
},
"protocol" : {
"description" : "Protocol of the syslog server",
"type" : "string",
"enum" : [ "IPPROTO_TCP", "IPPROTO_UDP" ]
},
"secondaryAddress" : {
"description" : "Secondary Server Address of the syslog server",
"type" : "string"
},
"secondaryPort" : {
"description" : "Secondary Server Port of the syslog server",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
},
"secondaryProtocol" : {
"description" : "Secondary Server Protocol of the syslog server",
"type" : "string",
"enum" : [ "IPPROTO_TCP", "IPPROTO_UDP" ]
},
"facility" : {
"description" : "Facility of the syslog server",
"type" : "string",
"enum" : [ "Keep_Original", "Local0", "Local1", "Local2", "Local3", "Local4", "Local5", "Local6", "Local7" ]
},
"priority" : {
"description" : "Priority of the log messages",
"type" : "string",
"enum" : [ "Emergency", "Alert", "Critical", "Error", "Warning", "Notice", "Info", "All" ]
}
}
},
"timezone" : {
"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" ]
}
}
},
"tunnelProfile" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"aaaAffinityEnabled" : {
"type" : "boolean"
},
"tunnelType" : {
"description" : "Tunnel type configuration of the zone. No_Tunneled is for IPv6 mode",
"type" : "string",
"enum" : [ "No_Tunneled", "RuckusGRE", "SoftGRE", "SoftGREIpsec" ]
},
"venueProfile" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"vlanOverlappingEnabled" : {
"type" : "boolean"
},
"wifi24" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"autoCellSizing" : {
"description" : "Auto Cell Sizing",
"type" : "boolean"
},
"txPower" : {
"description" : "Transmission power",
"type" : "string",
"enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ]
},
"channelWidth" : {
"description" : "Channel width. Zero (0) means Auto.",
"type" : "integer",
"enum" : [ 0, 20, 40 ]
},
"channel" : {
"description" : "Channel number",
"type" : "integer"
},
"channelRange" : {
"description" : "Channel range options",
"type" : "array",
"items" : {
"type" : "integer"
}
}
}
},
"wifi50" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"autoCellSizing" : {
"description" : "Auto Cell Sizing",
"type" : "boolean"
},
"txPower" : {
"description" : "Transmission power",
"type" : "string",
"enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ]
},
"channelWidth" : {
"description" : "Channel width. Zero (0) means Auto. 8080 means 80+80MHz",
"type" : "integer",
"enum" : [ 0, 20, 40, 80, 8080, 160 ]
},
"indoorChannel" : {
"description" : "Channel number for Indoor AP",
"type" : "integer"
},
"outdoorChannel" : {
"description" : "Channel number for Outdoor AP",
"type" : "integer"
},
"indoorSecondaryChannel" : {
"description" : "Secondary channel number for Indoor AP (channelWidth is 80+80MHz only)",
"type" : "integer"
},
"outdoorSecondaryChannel" : {
"description" : "Secondary channel number for outdoor AP (channelWidth is 80+80MHz only)",
"type" : "integer"
},
"indoorChannelRange" : {
"description" : "Channel range options for Indoor AP",
"type" : "array",
"items" : {
"type" : "integer"
}
},
"outdoorChannelRange" : {
"description" : "Channel range options for outdoor AP",
"type" : "array",
"items" : {
"type" : "integer"
}
}
}
},
"protectionMode24" : {
"type" : "string",
"enum" : [ "NONE", "CTS_ONLY", "RTS_CTS" ]
},
"zoneAffinityProfileId" : {
"type" : "string"
},
"snmpAgent" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"apSnmpEnabled" : {
"description" : "Enable AP SNMP",
"type" : "boolean"
},
"snmpV2Agent" : {
"description" : "Community List of the SNMP V2 Agent.",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"communityName" : {
"description" : "name of the SNMP Community.",
"type" : "string"
},
"readEnabled" : {
"description" : "read privilege of the SNMP Coummunity",
"type" : "boolean"
},
"writeEnabled" : {
"description" : "write privilege of the SNMP Coummunity",
"type" : "boolean"
},
"notificationEnabled" : {
"description" : "notification privilege of the SNMP Coummunity",
"type" : "boolean"
},
"notificationType" : {
"description" : "type of the notification privilege",
"type" : "string",
"enum" : [ "TRAP", "INFORM" ]
},
"notificationTarget" : {
"description" : "Trap List of the SNMP Coummunity",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"address" : {
"description" : "address of the SNMP Trap",
"type" : "string"
},
"port" : {
"description" : "port number of the SNMP Trap",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
}
},
"required" : [ "address", "port" ]
}
}
},
"required" : [ "communityName" ]
}
},
"snmpV3Agent" : {
"description" : "User List of the SNMP V3 Agent.",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"userName" : {
"description" : "name of the SNMP User.",
"type" : "string"
},
"authProtocol" : {
"description" : "authProtocol of the SNMP User.",
"type" : "string",
"enum" : [ "NONE", "MD5", "SHA" ]
},
"authPassword" : {
"description" : "authPassword of the SNMP User.",
"type" : "string",
"minLength" : 8
},
"privProtocol" : {
"description" : "privProtocol of the SNMP User.",
"type" : "string",
"enum" : [ "NONE", "DES", "AES" ]
},
"privPassword" : {
"description" : "privPassword of the SNMP User.",
"type" : "string",
"minLength" : 8
},
"readEnabled" : {
"description" : "read privilege of the SNMP User",
"type" : "boolean"
},
"writeEnabled" : {
"description" : "write privilege of the SNMP User",
"type" : "boolean"
},
"notificationEnabled" : {
"description" : "notification privilege of the SNMP User",
"type" : "boolean"
},
"notificationType" : {
"description" : "type of the notification privilege",
"type" : "string",
"enum" : [ "TRAP", "INFORM" ]
},
"notificationTarget" : {
"description" : "Trap List of the SNMP User",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"address" : {
"description" : "address of the SNMP Trap",
"type" : "string"
},
"port" : {
"description" : "port number of the SNMP Trap",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
}
},
"required" : [ "address", "port" ]
}
}
},
"required" : [ "userName" ]
}
}
}
},
"recoverySsid" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"recoverySsidPskKey" : {
"description" : "recovery ssid password",
"type" : "string"
},
"recoverySsidEnabled" : {
"description" : "recovery ssid enable/disable",
"type" : "boolean"
}
}
},
"clusterRedundancyEnabled" : {
"type" : "boolean"
},
"rogueApReportThreshold" : {
"type" : "integer"
},
"rogueApAggressivenessMode" : {
"type" : "integer"
},
"rogueApJammingDetection" : {
"type" : "boolean"
},
"rogueApJammingThreshold" : {
"type" : "integer"
},
"directedMulticastFromWiredClientEnabled" : {
"type" : "boolean"
},
"directedMulticastFromWirelessClientEnabled" : {
"type" : "boolean"
},
"directedMulticastFromNetworkEnabled" : {
"type" : "boolean"
},
"healthCheckSitesEnabled" : {
"description" : "Enabled Health Check Sites. ",
"type" : "boolean"
},
"healthCheckSites" : {
"description" : "Health Check Sites.",
"type" : "array",
"items" : {
"type" : "string"
}
},
"ruckusGreTunnelProfile" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"softGreTunnelProflies" : {
"type" : "array",
"items" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"aaaAffinityEnabled" : {
"type" : "boolean"
}
}
}
},
"ipsecProfiles" : {
"type" : "array",
"items" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
}
},
"sshTunnelEncryption" : {
"type" : "string",
"enum" : [ "AES128", "AES256" ]
},
"lteBandLockChannels" : {
"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"
}
}
}
},
"apHccdEnabled" : {
"type" : "boolean"
},
"apHccdPersist" : {
"type" : "boolean"
}
},
"type" : "object"
}
204
Retrieve List ¶
GET/v8_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
- 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"
}
}
}
}
}
}
Clear Mesh Configuration ¶
Disable Syslog ¶
DELETE/v8_1/rkszones/{id}/syslog
Use this API command to disable syslog configuration for APs that belong to a zone.
204
Disable Smart Monitor ¶
DELETE/v8_1/rkszones/{id}/smartMonitor
Use this API command to disable smart monitor for APs that belong to a zone.
204
Disable Client Admission Control 2.4G ¶
DELETE/v8_1/rkszones/{id}/clientAdmissionControl24
Use this API command to disable client admission control 2.4GHz radio configuration for APs that belong to a zone.
204
Disable Client Admission Control 5G ¶
DELETE/v8_1/rkszones/{id}/clientAdmissionControl50
Use this API command to disable client admission control 5GHz radio configuration for APs that belong to a zone.
204
Disable Background Scanning 2.4G ¶
DELETE/v8_1/rkszones/{id}/backgroundScanning24
Use this API command to disable background scanning 2.4GHz radio configuration for APs that belong to a zone.
204
Disable Background Scanning 5G ¶
DELETE/v8_1/rkszones/{id}/backgroundScanning50
Use this API command to disable background scanning 5GHz radio configuration for APs that belong to a zone.
204
Disable Client Load Balancing 2.4G ¶
DELETE/v8_1/rkszones/{id}/clientLoadBalancing24
Use this API command to disable client load balancing 2.4GHz radio configuration for APs that belong to a zone.
204
Disable Client Load Balancing 5G ¶
DELETE/v8_1/rkszones/{id}/clientLoadBalancing50
Use this API command to disable client load balancing 5GHz radio configuration for APs that belong to a zone.
204
Disable Band Balancing ¶
DELETE/v8_1/rkszones/{id}/bandBalancing
Use this API command to disable band balancing for APs that belong to a zone.
204
Clear Hotspot2.0 Venue Profile ¶
DELETE/v8_1/rkszones/{id}/venueProfile
Use this API command to clear Hotspot 2.0 venue profile for APs that belong to a zone.
204
Disable Rogue ¶
DELETE/v8_1/rkszones/{id}/rogue
Use this API command to disable rogue AP detection for APs that belong to a zone.
204
Disable Location Based Service ¶
DELETE/v8_1/rkszones/{id}/locationBasedService
Use this API command to disable location based service for APs that belong to a zone.
204
Disable Altitude ¶
DELETE/v8_1/rkszones/{id}/altitude
Use this API command to disable altitude configuration of zone.
204
Clear AP SNMP Options ¶
DELETE/v8_1/rkszones/{id}/snmpAgent
Use this API command to clear SNMPv2 and SNMPv3 agent that belong to a zone.
204
Clear zone recovery SSID ¶
DELETE/v8_1/rkszones/{id}/recoverySsid
Use this API command to clear recovery ssid setting of a zone.
204
Create Zone of IPv6 ¶
POST/v8_1/rkszones/ipv6
Use this API command to create a new Ruckus Wireless AP zone of IPv6.
Body
{
"domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
"zoneAffinityProfileId": "3fd9aa91-df65-11e7-98e1-08002748d78e",
"enforcePriorityZoneAffinityEnable": false,
"name": "createZoneName",
"description": "description Zone",
"countryCode": "US",
"timezone": {
"customizedTimezone": {
"abbreviation": "TPE",
"gmtOffset": 0,
"gmtOffsetMinute": 0
}
},
"login": {
"apLoginName": "admin",
"apLoginPassword": "admin!234"
},
"dfsChannelEnabled": false,
"wifi24": {
"txPower": "Full",
"channelWidth": 20,
"channel": 0,
"channelRange": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11
]
},
"wifi50": {
"txPower": "-1dB",
"channelWidth": 40,
"indoorChannel": 0,
"outdoorChannel": 0,
"indoorChannelRange": [
36,
40,
44,
48,
149,
153,
157,
161
],
"outdoorChannelRange": [
149,
153,
157,
161
]
},
"protectionMode24": "CTS_ONLY",
"syslog": {
"flowLevel": "GENERAL_LOGS",
"address": "1.1.1.1",
"port": 514,
"protocol": "IPPROTO_TCP",
"secondaryAddress": "2.2.2.2",
"secondaryPort": 514,
"secondaryProtocol": "IPPROTO_TCP",
"facility": "Local0",
"priority": "Error"
},
"smartMonitor": {
"intervalInSec": 10,
"retryThreshold": 3
},
"channelModeEnabled": false,
"tunnelType": "RuckusGRE",
"backgroundScanning24": {
"frequencyInSec": 20
},
"backgroundScanning50": {
"frequencyInSec": 20
},
"clientLoadBalancing24": {
"adjacentRadioThreshold": 12
},
"clientLoadBalancing50": {
"adjacentRadioThreshold": 12
},
"bandBalancing": {
"wifi24Percentage": 10
},
"loadBalancingMethod": "BASED_ON_CLIENT_COUNT",
"rogue": {
"reportType": "All",
"maliciousTypes": null,
"protectionEnabled": true
},
"dosBarringEnable": 0,
"dosBarringPeriod": 60,
"dosBarringThreshold": 5,
"dosBarringCheckPeriod": 30,
"apRebootTimeout": {
"gatewayLossTimeoutInSec": 1800,
"serverLossTimeoutInSec": 7200
},
"location": "location",
"locationAdditionalInfo": "locationAdditionalInfo",
"latitude": 23,
"longitude": 23,
"vlanOverlappingEnabled": false,
"autoChannelSelection24": {
"channelSelectMode": "ChannelFly",
"channelFlyMtbc": 480
},
"autoChannelSelection50": {
"channelSelectMode": "BackgroundScanning",
"channelFlyMtbc": 480
},
"channelEvaluationInterval": 777,
"apMgmtVlan": {
"id": 1,
"mode": "KEEP"
},
"apLatencyInterval": {
"pingEnabled": true
},
"ipsecProfile": {
"id": "ipsecProfileId",
"name": "ipsecProfileName"
},
"altitude": {
"altitudeUnit": "meters",
"altitudeValue": 1
},
"bonjourFencingPolicyEnabled": false,
"snmpAgent": {
"apSnmpEnabled": true,
"snmpV2Agent": [
{
"communityName": "v2Agent",
"notificationEnabled": true,
"readEnabled": true,
"writeEnabled": true,
"notificationType": "TRAP",
"notificationTarget": [
{
"address": "172.19.16.20",
"port": 161
}
]
}
],
"snmpV3Agent": [
{
"userName": "v3Agent",
"authProtocol": "MD5",
"authPassword": "admin!234",
"privProtocol": "DES",
"privPassword": "admin!234",
"notificationEnabled": true,
"readEnabled": true,
"writeEnabled": true,
"notificationType": "TRAP",
"notificationTarget": [
{
"address": "172.19.16.20",
"port": 161
}
]
}
]
},
"recoverySsid": {
"recoverySsidEnabled": true
},
"dhcpSiteConfig": {
"siteEnabled": true,
"siteMode": "EnableOnEachAPs",
"siteProfileIds": [
"75e26590-547f-11e6-9ca7-5a095364c13c",
"869bb532-547f-11e6-9ca7-5a095364c13c"
]
},
"rogueApReportThreshold": 40,
"rogueApAggressivenessMode": 2,
"rogueApJammingDetection": true,
"rogueApJammingThreshold": 40,
"directedMulticastFromWiredClientEnabled": true,
"directedMulticastFromWirelessClientEnabled": true,
"directedMulticastFromNetworkEnabled": false,
"healthCheckSitesEnabled": true,
"healthCheckSites": [
"www.google.com",
"www.live.com:443",
"www.github.com:443",
"source.codeaurora.org:443",
"www.wikipedia.com"
],
"ruckusGreTunnelProfile": {
"id": "f5b92938-aa4e-4d02-90ea-273799ff689b",
"name": "Default Tunnel Profile"
},
"softGreTunnelProflies": [
{
"id": "5a2e41b0-df53-11e7-98e1-08002748d78e",
"name": "softGre1",
"aaaAffinityEnabled": false
},
{
"id": "7803e411-df53-11e7-98e1-08002748d78e",
"name": "softGre2",
"aaaAffinityEnabled": true
},
{
"id": "664de4f1-df53-11e7-98e1-08002748d78e",
"name": "softGre3",
"aaaAffinityEnabled": false
}
],
"ipsecProfiles": [
{
"id": "3fd9aa91-df65-11e7-98e1-08002748d78e",
"name": "ipsec1"
},
{
"id": "832aa331-df65-11e7-98e1-08002748d78e",
"name": "ipsec2"
}
],
"ipsecTunnelMode": "SOFT_GRE",
"sshTunnelEncryption": "AES128",
"apHccdEnabled": true,
"apHccdPersist": true
}
Schema
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"domainId" : {
"type" : "string"
},
"zoneAffinityProfileId" : {
"description" : "Zone affinity profile of the zone",
"type" : "string"
},
"enforcePriorityZoneAffinityEnable" : {
"description" : "Enforce the priority of zone affinity",
"type" : "boolean"
},
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64
},
"version" : {
"type" : "string",
"pattern" : "^\d+\.\d+\.\d+\.\d+\.\d+$"
},
"countryCode" : {
"type" : "string"
},
"login" : {
"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" : {
"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" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"ssid" : {
"description" : "SSID of the mesh network",
"type" : "string"
},
"passphrase" : {
"description" : "Passphrase for the mesh network",
"type" : "string"
},
"meshRadioIdx" : {
"description" : "Mesh radio index",
"type" : "string",
"enum" : [ "Radio24G", "Radio5G" ],
"default" : "Radio5G"
},
"zeroTouchStatus" : {
"type" : "boolean"
}
}
},
"dfsChannelEnabled" : {
"type" : "boolean",
"default" : false
},
"cbandChannelEnabled" : {
"type" : "boolean",
"default" : false
},
"cbandChannelLicenseEnabled" : {
"type" : "boolean",
"default" : false
},
"channel144Enabled" : {
"type" : "boolean",
"default" : false
},
"wifi24" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"autoCellSizing" : {
"description" : "Auto Cell Sizing",
"type" : "boolean"
},
"txPower" : {
"description" : "Transmission power",
"type" : "string",
"enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
"default" : "Full"
},
"channelWidth" : {
"description" : "Channel width. Zero (0) means Auto.",
"type" : "integer",
"enum" : [ 0, 20, 40 ],
"default" : 0
},
"channel" : {
"description" : "Channel number",
"type" : "integer"
},
"channelRange" : {
"description" : "Channel range options",
"type" : "array",
"items" : {
"type" : "integer"
}
}
}
},
"wifi50" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"autoCellSizing" : {
"description" : "Auto Cell Sizing",
"type" : "boolean"
},
"txPower" : {
"description" : "Transmission power",
"type" : "string",
"enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
"default" : "Full"
},
"channelWidth" : {
"description" : "Channel width. Zero (0) means Auto. 8080 means 80+80MHz",
"type" : "integer",
"enum" : [ 0, 20, 40, 80, 8080, 160 ],
"default" : 0
},
"indoorChannel" : {
"description" : "Channel number for Indoor AP",
"type" : "integer"
},
"outdoorChannel" : {
"description" : "Channel number for Outdoor AP",
"type" : "integer"
},
"indoorSecondaryChannel" : {
"description" : "Secondary channel number for Indoor AP (channelWidth is 80+80MHz only)",
"type" : "integer"
},
"outdoorSecondaryChannel" : {
"description" : "Secondary channel number for outdoor AP (channelWidth is 80+80MHz only)",
"type" : "integer"
},
"indoorChannelRange" : {
"description" : "Channel range options for Indoor AP",
"type" : "array",
"items" : {
"type" : "integer"
}
},
"outdoorChannelRange" : {
"description" : "Channel range options for outdoor AP",
"type" : "array",
"items" : {
"type" : "integer"
}
}
}
},
"protectionMode24" : {
"type" : "string",
"enum" : [ "NONE", "CTS_ONLY", "RTS_CTS" ],
"default" : "RTS_CTS"
},
"syslog" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"flowLevel" : {
"description" : "Flow Level of the syslog",
"type" : "string",
"enum" : [ "GENERAL_LOGS", "CLIENT_FLOW", "ALL" ],
"default" : "GENERAL_LOGS"
},
"address" : {
"description" : "Address of the syslog server.",
"type" : "string"
},
"port" : {
"description" : "Port number of the syslog server",
"type" : "integer",
"default" : 514,
"minimum" : 1,
"maximum" : 65535
},
"protocol" : {
"description" : "Protocol of the syslog server",
"type" : "string",
"enum" : [ "IPPROTO_TCP", "IPPROTO_UDP" ],
"default" : "IPPROTO_TCP"
},
"secondaryAddress" : {
"description" : "Secondary Server Address of the syslog server",
"type" : "string"
},
"secondaryPort" : {
"description" : "Secondary Server Port of the syslog server",
"type" : "integer",
"default" : 514,
"minimum" : 1,
"maximum" : 65535
},
"secondaryProtocol" : {
"description" : "Secondary Server Protocol of the syslog server",
"type" : "string",
"enum" : [ "IPPROTO_TCP", "IPPROTO_UDP" ],
"default" : "IPPROTO_TCP"
},
"facility" : {
"description" : "Facility of the syslog server",
"type" : "string",
"enum" : [ "Keep_Original", "Local0", "Local1", "Local2", "Local3", "Local4", "Local5", "Local6", "Local7" ],
"default" : "Keep_Original"
},
"priority" : {
"description" : "Priority of the log messages",
"type" : "string",
"enum" : [ "Emergency", "Alert", "Critical", "Error", "Warning", "Notice", "Info", "All" ],
"default" : "Error"
}
}
},
"smartMonitor" : {
"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" : {
"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" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"maxRadioLoadPercent" : {
"description" : "Maximum radio load percentage.",
"type" : "integer",
"default" : 75,
"minimum" : 50,
"maximum" : 100
},
"minClientCount" : {
"description" : "Minimum client count number.",
"type" : "integer",
"default" : 10,
"minimum" : 0,
"maximum" : 100
},
"minClientThroughputMbps" : {
"description" : "Minimum client throughput in Mbps.",
"type" : "number",
"default" : 0,
"minimum" : 0,
"maximum" : 100
}
}
},
"channelModeEnabled" : {
"type" : "boolean",
"default" : false
},
"tunnelType" : {
"description" : "Tunnel type configuration of the zone. No_Tunneled is for IPv6 mode",
"type" : "string",
"enum" : [ "No_Tunneled", "RuckusGRE", "SoftGRE", "SoftGREIpsec" ],
"default" : "RuckusGRE"
},
"tunnelProfile" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"backgroundScanning24" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"frequencyInSec" : {
"description" : "Frequency in second",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535,
"default" : 20
}
}
},
"backgroundScanning50" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"frequencyInSec" : {
"description" : "Frequency in second",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535,
"default" : 20
}
}
},
"clientLoadBalancing24" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"adjacentRadioThreshold" : {
"description" : "Adjacent radio threshold",
"type" : "integer",
"minimum" : 1,
"maximum" : 100
}
}
},
"clientLoadBalancing50" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"adjacentRadioThreshold" : {
"description" : "Adjacent radio threshold",
"type" : "integer",
"minimum" : 1,
"maximum" : 100
}
}
},
"bandBalancing" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"mode" : {
"description" : "Band Balancing Mode: BASIC-Withholds probe and authentication responses at connetcion time in heavily loaded band to balance clients to the other band, PROACTIVE-Uses BASIC functionality and actively rebalances clients via 802.11v BTM, STRICT-Uses PROACTIVE functionality and forcefully rebalances clients via 802.11v BTM",
"type" : "string",
"enum" : [ "BASIC", "PROACTIVE", "STRICT" ],
"default" : "BASIC"
},
"wifi24Percentage" : {
"description" : "Percentage of client load on 2.4GHz radio band",
"type" : "integer",
"minimum" : 0,
"maximum" : 100,
"default" : 25
}
}
},
"loadBalancingMethod" : {
"type" : "string",
"enum" : [ "BASED_ON_CLIENT_COUNT", "BASED_ON_CAPACITY", "OFF" ],
"default" : "BASED_ON_CLIENT_COUNT"
},
"rogue" : {
"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" : {
"type" : "integer"
},
"dosBarringPeriod" : {
"type" : "integer",
"default" : 60
},
"dosBarringThreshold" : {
"type" : "integer",
"default" : 5
},
"dosBarringCheckPeriod" : {
"type" : "integer",
"default" : 30
},
"locationBasedService" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"apRebootTimeout" : {
"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" : {
"type" : "string"
},
"locationAdditionalInfo" : {
"type" : "string",
"pattern" : "^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
},
"altitude" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"altitudeUnit" : {
"description" : "altitude unit",
"type" : "string",
"enum" : [ "meters", "floor" ],
"default" : "meters"
},
"altitudeValue" : {
"description" : "altitude value",
"type" : "integer"
}
}
},
"latitude" : {
"type" : "number"
},
"longitude" : {
"type" : "number"
},
"vlanOverlappingEnabled" : {
"type" : "boolean"
},
"nodeAffinityProfile" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"venueProfile" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"autoChannelSelection24" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"channelSelectMode" : {
"description" : "Channel Select Mode",
"type" : "string",
"enum" : [ "None", "BackgroundScanning", "ChannelFly" ],
"default" : "BackgroundScanning"
},
"channelFlyMtbc" : {
"description" : "ChannelFly MTBC",
"type" : "integer",
"default" : 480,
"minimum" : 100,
"maximum" : 1440
}
}
},
"autoChannelSelection50" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"channelSelectMode" : {
"description" : "Channel Select Mode",
"type" : "string",
"enum" : [ "None", "BackgroundScanning", "ChannelFly" ],
"default" : "BackgroundScanning"
},
"channelFlyMtbc" : {
"description" : "ChannelFly MTBC",
"type" : "integer",
"default" : 480,
"minimum" : 100,
"maximum" : 1440
}
}
},
"channelEvaluationInterval" : {
"type" : "integer",
"default" : 600,
"minimum" : 60,
"maximum" : 3600
},
"apMgmtVlan" : {
"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" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"pingEnabled" : {
"description" : "AP ping latency enabled",
"type" : "boolean",
"default" : true
}
}
},
"ipsecProfile" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"ipv6TrafficFilterEnabled" : {
"type" : "integer"
},
"bonjourFencingPolicyEnabled" : {
"type" : "boolean"
},
"bonjourFencingPolicy" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"dhcpSiteConfig" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"siteEnabled" : {
"description" : "DHCP Service Enabling Status",
"type" : "boolean"
},
"dwpdEnabled" : {
"description" : "DHCP Service Dynamic WAN Port Detection",
"type" : "boolean"
},
"manualSelect" : {
"description" : "DHCP Service AP Selection Mode. This value is effective when the siteMode is EnableOnMultipleAPs.",
"type" : "boolean"
},
"siteMode" : {
"description" : "DHCP Service mode",
"type" : "string",
"enum" : [ "EnableOnEachAPs", "EnableOnMultipleAPs", "EnableOnHierarchicalAPs" ]
},
"eth0ProfileId" : {
"type" : "integer"
},
"eth1ProfileId" : {
"type" : "integer"
},
"siteAps" : {
"type" : "array",
"items" : {
"type" : "object",
"description" : "DHCP Site selected APs. The content is effective when the siteMode is EnableOnMultipleAPs.",
"additionalProperties" : false,
"properties" : {
"apMac" : {
"type" : "string"
},
"apName" : {
"type" : "string"
},
"apStatus" : {
"type" : "string",
"enum" : [ "Online", "Offline", "Flagged" ]
},
"apServerEnabled" : {
"type" : "boolean"
},
"apServerPrimary" : {
"type" : "boolean"
},
"apServerIp" : {
"type" : [ "string", "null" ]
},
"apGatewayIp" : {
"type" : "string"
},
"apServerType" : {
"type" : "string"
}
}
}
},
"siteProfileIds" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
}
},
"snmpAgent" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"apSnmpEnabled" : {
"description" : "Enable AP SNMP",
"type" : "boolean"
},
"snmpV2Agent" : {
"description" : "Community List of the SNMP V2 Agent.",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"communityName" : {
"description" : "name of the SNMP Community.",
"type" : "string"
},
"readEnabled" : {
"description" : "read privilege of the SNMP Coummunity",
"type" : "boolean"
},
"writeEnabled" : {
"description" : "write privilege of the SNMP Coummunity",
"type" : "boolean"
},
"notificationEnabled" : {
"description" : "notification privilege of the SNMP Coummunity",
"type" : "boolean"
},
"notificationType" : {
"description" : "type of the notification privilege",
"type" : "string",
"enum" : [ "TRAP", "INFORM" ]
},
"notificationTarget" : {
"description" : "Trap List of the SNMP Coummunity",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"address" : {
"description" : "address of the SNMP Trap",
"type" : "string"
},
"port" : {
"description" : "port number of the SNMP Trap",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
}
},
"required" : [ "address", "port" ]
}
}
},
"required" : [ "communityName" ]
}
},
"snmpV3Agent" : {
"description" : "User List of the SNMP V3 Agent.",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"userName" : {
"description" : "name of the SNMP User.",
"type" : "string"
},
"authProtocol" : {
"description" : "authProtocol of the SNMP User.",
"type" : "string",
"enum" : [ "NONE", "MD5", "SHA" ]
},
"authPassword" : {
"description" : "authPassword of the SNMP User.",
"type" : "string",
"minLength" : 8
},
"privProtocol" : {
"description" : "privProtocol of the SNMP User.",
"type" : "string",
"enum" : [ "NONE", "DES", "AES" ]
},
"privPassword" : {
"description" : "privPassword of the SNMP User.",
"type" : "string",
"minLength" : 8
},
"readEnabled" : {
"description" : "read privilege of the SNMP User",
"type" : "boolean"
},
"writeEnabled" : {
"description" : "write privilege of the SNMP User",
"type" : "boolean"
},
"notificationEnabled" : {
"description" : "notification privilege of the SNMP User",
"type" : "boolean"
},
"notificationType" : {
"description" : "type of the notification privilege",
"type" : "string",
"enum" : [ "TRAP", "INFORM" ]
},
"notificationTarget" : {
"description" : "Trap List of the SNMP User",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"address" : {
"description" : "address of the SNMP Trap",
"type" : "string"
},
"port" : {
"description" : "port number of the SNMP Trap",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
}
},
"required" : [ "address", "port" ]
}
}
},
"required" : [ "userName" ]
}
}
}
},
"recoverySsid" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"recoverySsidPskKey" : {
"description" : "recovery ssid password",
"type" : "string"
},
"recoverySsidEnabled" : {
"description" : "recovery ssid enable/disable",
"type" : "boolean"
}
}
},
"clusterRedundancyEnabled" : {
"type" : "boolean",
"default" : false
},
"rogueApReportThreshold" : {
"type" : "integer"
},
"rogueApAggressivenessMode" : {
"type" : "integer"
},
"rogueApJammingDetection" : {
"type" : "boolean",
"default" : false
},
"rogueApJammingThreshold" : {
"type" : "integer"
},
"directedMulticastFromWiredClientEnabled" : {
"type" : "boolean",
"default" : true
},
"directedMulticastFromWirelessClientEnabled" : {
"type" : "boolean",
"default" : true
},
"directedMulticastFromNetworkEnabled" : {
"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" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"softGreTunnelProflies" : {
"type" : "array",
"items" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"aaaAffinityEnabled" : {
"type" : "boolean"
}
}
}
},
"ipsecProfiles" : {
"type" : "array",
"items" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
}
},
"sshTunnelEncryption" : {
"type" : "string",
"enum" : [ "AES128", "AES256" ],
"default" : "AES128"
},
"lteBandLockChannels" : {
"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"
}
}
}
},
"apHccdEnabled" : {
"type" : "boolean",
"default" : false
},
"apHccdPersist" : {
"type" : "boolean",
"default" : true
}
},
"required" : [ "name", "login" ]
}
201
Body
{
"id": "zoneUUID"
}
Schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
}
}
}
Create Zone of Dual ¶
POST/v8_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",
"zoneAffinityProfileId": "3fd9aa91-df65-11e7-98e1-08002748d78e",
"enforcePriorityZoneAffinityEnable": false,
"name": "createZoneName",
"description": "description Zone",
"countryCode": "US",
"timezone": {
"customizedTimezone": {
"abbreviation": "TPE",
"gmtOffset": 0,
"gmtOffsetMinute": 0
}
},
"login": {
"apLoginName": "admin",
"apLoginPassword": "admin!234"
},
"dfsChannelEnabled": false,
"wifi24": {
"txPower": "Full",
"channelWidth": 20,
"channel": 0,
"channelRange": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11
]
},
"wifi50": {
"txPower": "-1dB",
"channelWidth": 40,
"indoorChannel": 0,
"outdoorChannel": 0,
"indoorChannelRange": [
36,
40,
44,
48,
149,
153,
157,
161
],
"outdoorChannelRange": [
149,
153,
157,
161
]
},
"protectionMode24": "CTS_ONLY",
"syslog": {
"flowLevel": "GENERAL_LOGS",
"address": "1.1.1.1",
"port": 514,
"protocol": "IPPROTO_TCP",
"secondaryAddress": "2.2.2.2",
"secondaryPort": 514,
"secondaryProtocol": "IPPROTO_TCP",
"facility": "Local0",
"priority": "Error"
},
"smartMonitor": {
"intervalInSec": 10,
"retryThreshold": 3
},
"channelModeEnabled": false,
"tunnelType": "RuckusGRE",
"backgroundScanning24": {
"frequencyInSec": 20
},
"backgroundScanning50": {
"frequencyInSec": 20
},
"clientLoadBalancing24": {
"adjacentRadioThreshold": 12
},
"clientLoadBalancing50": {
"adjacentRadioThreshold": 12
},
"bandBalancing": {
"wifi24Percentage": 10
},
"loadBalancingMethod": "BASED_ON_CLIENT_COUNT",
"rogue": {
"reportType": "All",
"maliciousTypes": null,
"protectionEnabled": true
},
"dosBarringEnable": 0,
"dosBarringPeriod": 60,
"dosBarringThreshold": 5,
"dosBarringCheckPeriod": 30,
"apRebootTimeout": {
"gatewayLossTimeoutInSec": 1800,
"serverLossTimeoutInSec": 7200
},
"location": "location",
"locationAdditionalInfo": "locationAdditionalInfo",
"latitude": 23,
"longitude": 23,
"vlanOverlappingEnabled": false,
"autoChannelSelection24": {
"channelSelectMode": "ChannelFly",
"channelFlyMtbc": 480
},
"autoChannelSelection50": {
"channelSelectMode": "BackgroundScanning",
"channelFlyMtbc": 480
},
"channelEvaluationInterval": 777,
"apMgmtVlan": {
"id": 1,
"mode": "KEEP"
},
"apLatencyInterval": {
"pingEnabled": true
},
"ipsecProfile": {
"id": "ipsecProfileId",
"name": "ipsecProfileName"
},
"altitude": {
"altitudeUnit": "meters",
"altitudeValue": 1
},
"bonjourFencingPolicyEnabled": false,
"snmpAgent": {
"apSnmpEnabled": true,
"snmpV2Agent": [
{
"communityName": "v2Agent",
"notificationEnabled": true,
"readEnabled": true,
"writeEnabled": true,
"notificationType": "TRAP",
"notificationTarget": [
{
"address": "172.19.16.20",
"port": 161
}
]
}
],
"snmpV3Agent": [
{
"userName": "v3Agent",
"authProtocol": "MD5",
"authPassword": "admin!234",
"privProtocol": "DES",
"privPassword": "admin!234",
"notificationEnabled": true,
"readEnabled": true,
"writeEnabled": true,
"notificationType": "TRAP",
"notificationTarget": [
{
"address": "172.19.16.20",
"port": 161
}
]
}
]
},
"recoverySsid": {
"recoverySsidEnabled": true
},
"dhcpSiteConfig": {
"siteEnabled": true,
"siteMode": "EnableOnEachAPs",
"siteProfileIds": [
"75e26590-547f-11e6-9ca7-5a095364c13c",
"869bb532-547f-11e6-9ca7-5a095364c13c"
]
},
"rogueApReportThreshold": 40,
"rogueApAggressivenessMode": 2,
"rogueApJammingDetection": true,
"rogueApJammingThreshold": 40,
"directedMulticastFromWiredClientEnabled": true,
"directedMulticastFromWirelessClientEnabled": true,
"directedMulticastFromNetworkEnabled": false,
"healthCheckSitesEnabled": true,
"healthCheckSites": [
"www.google.com",
"www.live.com:443",
"www.github.com:443",
"source.codeaurora.org:443",
"www.wikipedia.com"
],
"ruckusGreTunnelProfile": {
"id": "f5b92938-aa4e-4d02-90ea-273799ff689b",
"name": "Default Tunnel Profile"
},
"softGreTunnelProflies": [
{
"id": "5a2e41b0-df53-11e7-98e1-08002748d78e",
"name": "softGre1",
"aaaAffinityEnabled": false
},
{
"id": "7803e411-df53-11e7-98e1-08002748d78e",
"name": "softGre2",
"aaaAffinityEnabled": true
},
{
"id": "664de4f1-df53-11e7-98e1-08002748d78e",
"name": "softGre3",
"aaaAffinityEnabled": false
}
],
"ipsecProfiles": [
{
"id": "3fd9aa91-df65-11e7-98e1-08002748d78e",
"name": "ipsec1"
},
{
"id": "832aa331-df65-11e7-98e1-08002748d78e",
"name": "ipsec2"
}
],
"ipsecTunnelMode": "SOFT_GRE",
"sshTunnelEncryption": "AES128",
"apHccdEnabled": true,
"apHccdPersist": true
}
Schema
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"domainId" : {
"type" : "string"
},
"zoneAffinityProfileId" : {
"description" : "Zone affinity profile of the zone",
"type" : "string"
},
"enforcePriorityZoneAffinityEnable" : {
"description" : "Enforce the priority of zone affinity",
"type" : "boolean"
},
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64
},
"version" : {
"type" : "string",
"pattern" : "^\d+\.\d+\.\d+\.\d+\.\d+$"
},
"countryCode" : {
"type" : "string"
},
"login" : {
"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" : {
"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" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"ssid" : {
"description" : "SSID of the mesh network",
"type" : "string"
},
"passphrase" : {
"description" : "Passphrase for the mesh network",
"type" : "string"
},
"meshRadioIdx" : {
"description" : "Mesh radio index",
"type" : "string",
"enum" : [ "Radio24G", "Radio5G" ],
"default" : "Radio5G"
},
"zeroTouchStatus" : {
"type" : "boolean"
}
}
},
"dfsChannelEnabled" : {
"type" : "boolean",
"default" : false
},
"cbandChannelEnabled" : {
"type" : "boolean",
"default" : false
},
"cbandChannelLicenseEnabled" : {
"type" : "boolean",
"default" : false
},
"channel144Enabled" : {
"type" : "boolean",
"default" : false
},
"wifi24" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"autoCellSizing" : {
"description" : "Auto Cell Sizing",
"type" : "boolean"
},
"txPower" : {
"description" : "Transmission power",
"type" : "string",
"enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
"default" : "Full"
},
"channelWidth" : {
"description" : "Channel width. Zero (0) means Auto.",
"type" : "integer",
"enum" : [ 0, 20, 40 ],
"default" : 0
},
"channel" : {
"description" : "Channel number",
"type" : "integer"
},
"channelRange" : {
"description" : "Channel range options",
"type" : "array",
"items" : {
"type" : "integer"
}
}
}
},
"wifi50" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"autoCellSizing" : {
"description" : "Auto Cell Sizing",
"type" : "boolean"
},
"txPower" : {
"description" : "Transmission power",
"type" : "string",
"enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
"default" : "Full"
},
"channelWidth" : {
"description" : "Channel width. Zero (0) means Auto. 8080 means 80+80MHz",
"type" : "integer",
"enum" : [ 0, 20, 40, 80, 8080, 160 ],
"default" : 0
},
"indoorChannel" : {
"description" : "Channel number for Indoor AP",
"type" : "integer"
},
"outdoorChannel" : {
"description" : "Channel number for Outdoor AP",
"type" : "integer"
},
"indoorSecondaryChannel" : {
"description" : "Secondary channel number for Indoor AP (channelWidth is 80+80MHz only)",
"type" : "integer"
},
"outdoorSecondaryChannel" : {
"description" : "Secondary channel number for outdoor AP (channelWidth is 80+80MHz only)",
"type" : "integer"
},
"indoorChannelRange" : {
"description" : "Channel range options for Indoor AP",
"type" : "array",
"items" : {
"type" : "integer"
}
},
"outdoorChannelRange" : {
"description" : "Channel range options for outdoor AP",
"type" : "array",
"items" : {
"type" : "integer"
}
}
}
},
"protectionMode24" : {
"type" : "string",
"enum" : [ "NONE", "CTS_ONLY", "RTS_CTS" ],
"default" : "RTS_CTS"
},
"syslog" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"flowLevel" : {
"description" : "Flow Level of the syslog",
"type" : "string",
"enum" : [ "GENERAL_LOGS", "CLIENT_FLOW", "ALL" ],
"default" : "GENERAL_LOGS"
},
"address" : {
"description" : "Address of the syslog server.",
"type" : "string"
},
"port" : {
"description" : "Port number of the syslog server",
"type" : "integer",
"default" : 514,
"minimum" : 1,
"maximum" : 65535
},
"protocol" : {
"description" : "Protocol of the syslog server",
"type" : "string",
"enum" : [ "IPPROTO_TCP", "IPPROTO_UDP" ],
"default" : "IPPROTO_TCP"
},
"secondaryAddress" : {
"description" : "Secondary Server Address of the syslog server",
"type" : "string"
},
"secondaryPort" : {
"description" : "Secondary Server Port of the syslog server",
"type" : "integer",
"default" : 514,
"minimum" : 1,
"maximum" : 65535
},
"secondaryProtocol" : {
"description" : "Secondary Server Protocol of the syslog server",
"type" : "string",
"enum" : [ "IPPROTO_TCP", "IPPROTO_UDP" ],
"default" : "IPPROTO_TCP"
},
"facility" : {
"description" : "Facility of the syslog server",
"type" : "string",
"enum" : [ "Keep_Original", "Local0", "Local1", "Local2", "Local3", "Local4", "Local5", "Local6", "Local7" ],
"default" : "Keep_Original"
},
"priority" : {
"description" : "Priority of the log messages",
"type" : "string",
"enum" : [ "Emergency", "Alert", "Critical", "Error", "Warning", "Notice", "Info", "All" ],
"default" : "Error"
}
}
},
"smartMonitor" : {
"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" : {
"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" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"maxRadioLoadPercent" : {
"description" : "Maximum radio load percentage.",
"type" : "integer",
"default" : 75,
"minimum" : 50,
"maximum" : 100
},
"minClientCount" : {
"description" : "Minimum client count number.",
"type" : "integer",
"default" : 10,
"minimum" : 0,
"maximum" : 100
},
"minClientThroughputMbps" : {
"description" : "Minimum client throughput in Mbps.",
"type" : "number",
"default" : 0,
"minimum" : 0,
"maximum" : 100
}
}
},
"channelModeEnabled" : {
"type" : "boolean",
"default" : false
},
"tunnelType" : {
"description" : "Tunnel type configuration of the zone. No_Tunneled is for IPv6 mode",
"type" : "string",
"enum" : [ "No_Tunneled", "RuckusGRE", "SoftGRE", "SoftGREIpsec" ],
"default" : "RuckusGRE"
},
"tunnelProfile" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"backgroundScanning24" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"frequencyInSec" : {
"description" : "Frequency in second",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535,
"default" : 20
}
}
},
"backgroundScanning50" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"frequencyInSec" : {
"description" : "Frequency in second",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535,
"default" : 20
}
}
},
"clientLoadBalancing24" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"adjacentRadioThreshold" : {
"description" : "Adjacent radio threshold",
"type" : "integer",
"minimum" : 1,
"maximum" : 100
}
}
},
"clientLoadBalancing50" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"adjacentRadioThreshold" : {
"description" : "Adjacent radio threshold",
"type" : "integer",
"minimum" : 1,
"maximum" : 100
}
}
},
"bandBalancing" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"mode" : {
"description" : "Band Balancing Mode: BASIC-Withholds probe and authentication responses at connetcion time in heavily loaded band to balance clients to the other band, PROACTIVE-Uses BASIC functionality and actively rebalances clients via 802.11v BTM, STRICT-Uses PROACTIVE functionality and forcefully rebalances clients via 802.11v BTM",
"type" : "string",
"enum" : [ "BASIC", "PROACTIVE", "STRICT" ],
"default" : "BASIC"
},
"wifi24Percentage" : {
"description" : "Percentage of client load on 2.4GHz radio band",
"type" : "integer",
"minimum" : 0,
"maximum" : 100,
"default" : 25
}
}
},
"loadBalancingMethod" : {
"type" : "string",
"enum" : [ "BASED_ON_CLIENT_COUNT", "BASED_ON_CAPACITY", "OFF" ],
"default" : "BASED_ON_CLIENT_COUNT"
},
"rogue" : {
"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" : {
"type" : "integer"
},
"dosBarringPeriod" : {
"type" : "integer",
"default" : 60
},
"dosBarringThreshold" : {
"type" : "integer",
"default" : 5
},
"dosBarringCheckPeriod" : {
"type" : "integer",
"default" : 30
},
"locationBasedService" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"apRebootTimeout" : {
"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" : {
"type" : "string"
},
"locationAdditionalInfo" : {
"type" : "string",
"pattern" : "^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
},
"altitude" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"altitudeUnit" : {
"description" : "altitude unit",
"type" : "string",
"enum" : [ "meters", "floor" ],
"default" : "meters"
},
"altitudeValue" : {
"description" : "altitude value",
"type" : "integer"
}
}
},
"latitude" : {
"type" : "number"
},
"longitude" : {
"type" : "number"
},
"vlanOverlappingEnabled" : {
"type" : "boolean"
},
"nodeAffinityProfile" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"venueProfile" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"autoChannelSelection24" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"channelSelectMode" : {
"description" : "Channel Select Mode",
"type" : "string",
"enum" : [ "None", "BackgroundScanning", "ChannelFly" ],
"default" : "BackgroundScanning"
},
"channelFlyMtbc" : {
"description" : "ChannelFly MTBC",
"type" : "integer",
"default" : 480,
"minimum" : 100,
"maximum" : 1440
}
}
},
"autoChannelSelection50" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"channelSelectMode" : {
"description" : "Channel Select Mode",
"type" : "string",
"enum" : [ "None", "BackgroundScanning", "ChannelFly" ],
"default" : "BackgroundScanning"
},
"channelFlyMtbc" : {
"description" : "ChannelFly MTBC",
"type" : "integer",
"default" : 480,
"minimum" : 100,
"maximum" : 1440
}
}
},
"channelEvaluationInterval" : {
"type" : "integer",
"default" : 600,
"minimum" : 60,
"maximum" : 3600
},
"apMgmtVlan" : {
"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" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"pingEnabled" : {
"description" : "AP ping latency enabled",
"type" : "boolean",
"default" : true
}
}
},
"ipsecProfile" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"ipv6TrafficFilterEnabled" : {
"type" : "integer"
},
"bonjourFencingPolicyEnabled" : {
"type" : "boolean"
},
"bonjourFencingPolicy" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"dhcpSiteConfig" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"siteEnabled" : {
"description" : "DHCP Service Enabling Status",
"type" : "boolean"
},
"dwpdEnabled" : {
"description" : "DHCP Service Dynamic WAN Port Detection",
"type" : "boolean"
},
"manualSelect" : {
"description" : "DHCP Service AP Selection Mode. This value is effective when the siteMode is EnableOnMultipleAPs.",
"type" : "boolean"
},
"siteMode" : {
"description" : "DHCP Service mode",
"type" : "string",
"enum" : [ "EnableOnEachAPs", "EnableOnMultipleAPs", "EnableOnHierarchicalAPs" ]
},
"eth0ProfileId" : {
"type" : "integer"
},
"eth1ProfileId" : {
"type" : "integer"
},
"siteAps" : {
"type" : "array",
"items" : {
"type" : "object",
"description" : "DHCP Site selected APs. The content is effective when the siteMode is EnableOnMultipleAPs.",
"additionalProperties" : false,
"properties" : {
"apMac" : {
"type" : "string"
},
"apName" : {
"type" : "string"
},
"apStatus" : {
"type" : "string",
"enum" : [ "Online", "Offline", "Flagged" ]
},
"apServerEnabled" : {
"type" : "boolean"
},
"apServerPrimary" : {
"type" : "boolean"
},
"apServerIp" : {
"type" : [ "string", "null" ]
},
"apGatewayIp" : {
"type" : "string"
},
"apServerType" : {
"type" : "string"
}
}
}
},
"siteProfileIds" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
}
},
"snmpAgent" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"apSnmpEnabled" : {
"description" : "Enable AP SNMP",
"type" : "boolean"
},
"snmpV2Agent" : {
"description" : "Community List of the SNMP V2 Agent.",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"communityName" : {
"description" : "name of the SNMP Community.",
"type" : "string"
},
"readEnabled" : {
"description" : "read privilege of the SNMP Coummunity",
"type" : "boolean"
},
"writeEnabled" : {
"description" : "write privilege of the SNMP Coummunity",
"type" : "boolean"
},
"notificationEnabled" : {
"description" : "notification privilege of the SNMP Coummunity",
"type" : "boolean"
},
"notificationType" : {
"description" : "type of the notification privilege",
"type" : "string",
"enum" : [ "TRAP", "INFORM" ]
},
"notificationTarget" : {
"description" : "Trap List of the SNMP Coummunity",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"address" : {
"description" : "address of the SNMP Trap",
"type" : "string"
},
"port" : {
"description" : "port number of the SNMP Trap",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
}
},
"required" : [ "address", "port" ]
}
}
},
"required" : [ "communityName" ]
}
},
"snmpV3Agent" : {
"description" : "User List of the SNMP V3 Agent.",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"userName" : {
"description" : "name of the SNMP User.",
"type" : "string"
},
"authProtocol" : {
"description" : "authProtocol of the SNMP User.",
"type" : "string",
"enum" : [ "NONE", "MD5", "SHA" ]
},
"authPassword" : {
"description" : "authPassword of the SNMP User.",
"type" : "string",
"minLength" : 8
},
"privProtocol" : {
"description" : "privProtocol of the SNMP User.",
"type" : "string",
"enum" : [ "NONE", "DES", "AES" ]
},
"privPassword" : {
"description" : "privPassword of the SNMP User.",
"type" : "string",
"minLength" : 8
},
"readEnabled" : {
"description" : "read privilege of the SNMP User",
"type" : "boolean"
},
"writeEnabled" : {
"description" : "write privilege of the SNMP User",
"type" : "boolean"
},
"notificationEnabled" : {
"description" : "notification privilege of the SNMP User",
"type" : "boolean"
},
"notificationType" : {
"description" : "type of the notification privilege",
"type" : "string",
"enum" : [ "TRAP", "INFORM" ]
},
"notificationTarget" : {
"description" : "Trap List of the SNMP User",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"address" : {
"description" : "address of the SNMP Trap",
"type" : "string"
},
"port" : {
"description" : "port number of the SNMP Trap",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
}
},
"required" : [ "address", "port" ]
}
}
},
"required" : [ "userName" ]
}
}
}
},
"recoverySsid" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"recoverySsidPskKey" : {
"description" : "recovery ssid password",
"type" : "string"
},
"recoverySsidEnabled" : {
"description" : "recovery ssid enable/disable",
"type" : "boolean"
}
}
},
"clusterRedundancyEnabled" : {
"type" : "boolean",
"default" : false
},
"rogueApReportThreshold" : {
"type" : "integer"
},
"rogueApAggressivenessMode" : {
"type" : "integer"
},
"rogueApJammingDetection" : {
"type" : "boolean",
"default" : false
},
"rogueApJammingThreshold" : {
"type" : "integer"
},
"directedMulticastFromWiredClientEnabled" : {
"type" : "boolean",
"default" : true
},
"directedMulticastFromWirelessClientEnabled" : {
"type" : "boolean",
"default" : true
},
"directedMulticastFromNetworkEnabled" : {
"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" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"softGreTunnelProflies" : {
"type" : "array",
"items" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"aaaAffinityEnabled" : {
"type" : "boolean"
}
}
}
},
"ipsecProfiles" : {
"type" : "array",
"items" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
}
},
"sshTunnelEncryption" : {
"type" : "string",
"enum" : [ "AES128", "AES256" ],
"default" : "AES128"
},
"lteBandLockChannels" : {
"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"
}
}
}
},
"apHccdEnabled" : {
"type" : "boolean",
"default" : false
},
"apHccdPersist" : {
"type" : "boolean",
"default" : true
}
},
"required" : [ <