Back to top

Virtual SmartZone - Essentials Public API Reference Guide

Overview

This reference guide describes the public APIs supported by the Virtual SmartZone (Essentials). Use the RESTful API commands described in this guide as an alternative way to manage the controller and its managed APs (in addition to the web and command line interfaces).

All API URIs in this guide could use the below all common prefix, where {host} is the IP address of the management interface of the controller.

Prefix Pattern Note
https://{host}:8443/wsg/api/public Recommend
https://{host}:7443/api/public Deprecated Will be removed in the future version

OpenAPI documents

OpenAPI documents is based on OAS 2.0, Please try it for free.
Installed Smart Zone Software Release and link to https://{host}:8443/wsg/apiDoc/openapi for the detail.
You can get the usage at https://swagger.io/, use the Swagger tools to meet your needs.

Version Matrix

SmartZone software has API support according to the following matrix.

SZ Version API Version
6.1 v9_0 v9_1 v10_0 v11_0

Common Request Header

The following parameters are required in the HTTP headers of all API requests.

Parameter Value
Content-Type “application/json;charset=UTF-8”

Common Request URI Parameters

The following parameters are required in the Request URI Parameters of all API requests (except for the logon API).

Parameter Value
serviceTicket {serviceTicket}

serviceTicket is returned as the following parameter in the response payload of the Service Ticket Logon API.

Request Header for Session

Deprecated : Will be removed in the future version, please refer to the [Common Request URI Parameters] section

The following parameters are required in the HTTP headers of all API requests (except for the logon API).

Parameter Value
Cookie “JSESSIONID={JSESSIONID}”

JSESSIONID is returned as the following parameter in the response header of the Session ID Logon API.

Parameter Value
Set-cookie “JSESSIONID={JSESSIONID}; Path=/wsg; Secure”

HTTP Responses

HTTP response status codes indicate whether a specific HTTP request has been successfully completed.
The available status codes are defined by RFC7231 and registered status codes are listed in the IANA Status Code Registry.

Ruckus Wireless Error Codes

When the server is unable to process a request, Ruckus Wireless-specific error code and message are returned in the response body. The following table describes the list of Ruckus Wireless specific error codes.

Code Response
0 Internal server error
101 Bad HTTP request
102 Bad HTTP response
103 Invalid HTTP request body
104 HTTP response body cannot be generated
105 Unsupported API version
150 Cluster not in service
151 Controller node not in service
152 Operation is not allowed because this is a standby cluster
201 No active session
202 Login denied
203 Password expired
204 Account is disabled
205 Account not found
206 Account is locked
207 User is not assigned to an admin user group
211 Insufficient administrative privileges
212 Resource access denied
301 Resource cannot be found
302 Business rule violation
303 Illegal arguments
304 Bulk operation fail

Time Zone

Africa/AbidjanAfrica/AccraAfrica/Addis_Ababa
Africa/AlgiersAfrica/AsmaraAfrica/Asmera
Africa/BamakoAfrica/BanguiAfrica/Banjul
Africa/BissauAfrica/BlantyreAfrica/Brazzaville
Africa/BujumburaAfrica/CairoAfrica/Casablanca
Africa/CeutaAfrica/ConakryAfrica/Dakar
Africa/Dar_es_SalaamAfrica/DjiboutiAfrica/Douala
Africa/El_AaiunAfrica/FreetownAfrica/Gaborone
Africa/HarareAfrica/JohannesburgAfrica/Juba
Africa/KampalaAfrica/KhartoumAfrica/Kigali
Africa/KinshasaAfrica/LagosAfrica/Libreville
Africa/LomeAfrica/LuandaAfrica/Lubumbashi
Africa/LusakaAfrica/MalaboAfrica/Maputo
Africa/MaseruAfrica/MbabaneAfrica/Mogadishu
Africa/MonroviaAfrica/NairobiAfrica/Ndjamena
Africa/NiameyAfrica/NouakchottAfrica/Ouagadougou
Africa/Porto-NovoAfrica/Sao_TomeAfrica/Timbuktu
Africa/TripoliAfrica/TunisAfrica/Windhoek
America/AdakAmerica/AnchorageAmerica/Anguilla
America/AntiguaAmerica/AraguainaAmerica/Argentina/Buenos_Aires
America/Argentina/CatamarcaAmerica/Argentina/ComodRivadaviaAmerica/Argentina/Cordoba
America/Argentina/JujuyAmerica/Argentina/La_RiojaAmerica/Argentina/Mendoza
America/Argentina/Rio_GallegosAmerica/Argentina/SaltaAmerica/Argentina/San_Juan
America/Argentina/San_LuisAmerica/Argentina/TucumanAmerica/Argentina/Ushuaia
America/ArubaAmerica/AsuncionAmerica/Atikokan
America/AtkaAmerica/BahiaAmerica/Bahia_Banderas
America/BarbadosAmerica/BelemAmerica/Belize
America/Blanc-SablonAmerica/Boa_VistaAmerica/Bogota
America/BoiseAmerica/Buenos_AiresAmerica/Cambridge_Bay
America/Campo_GrandeAmerica/CancunAmerica/Caracas
America/CatamarcaAmerica/CayenneAmerica/Cayman
America/ChicagoAmerica/ChihuahuaAmerica/Coral_Harbour
America/CordobaAmerica/Costa_RicaAmerica/Creston
America/CuiabaAmerica/CuracaoAmerica/Danmarkshavn
America/DawsonAmerica/Dawson_CreekAmerica/Denver
America/DetroitAmerica/DominicaAmerica/Edmonton
America/EirunepeAmerica/El_SalvadorAmerica/Ensenada
America/Fort_NelsonAmerica/Fort_WayneAmerica/Fortaleza
America/Glace_BayAmerica/GodthabAmerica/Goose_Bay
America/Grand_TurkAmerica/GrenadaAmerica/Guadeloupe
America/GuatemalaAmerica/GuayaquilAmerica/Guyana
America/HalifaxAmerica/HavanaAmerica/Hermosillo
America/Indiana/IndianapolisAmerica/Indiana/KnoxAmerica/Indiana/Marengo
America/Indiana/PetersburgAmerica/Indiana/Tell_CityAmerica/Indiana/Vevay
America/Indiana/VincennesAmerica/Indiana/WinamacAmerica/Indianapolis
America/InuvikAmerica/IqaluitAmerica/Jamaica
America/JujuyAmerica/JuneauAmerica/Kentucky/Louisville
America/Kentucky/MonticelloAmerica/Knox_INAmerica/Kralendijk
America/La_PazAmerica/LimaAmerica/Los_Angeles
America/LouisvilleAmerica/Lower_PrincesAmerica/Maceio
America/ManaguaAmerica/ManausAmerica/Marigot
America/MartiniqueAmerica/MatamorosAmerica/Mazatlan
America/MendozaAmerica/MenomineeAmerica/Merida
America/MetlakatlaAmerica/Mexico_CityAmerica/Miquelon
America/MonctonAmerica/MonterreyAmerica/Montevideo
America/MontrealAmerica/MontserratAmerica/Nassau
America/New_YorkAmerica/NipigonAmerica/Nome
America/NoronhaAmerica/North_Dakota/BeulahAmerica/North_Dakota/Center
America/North_Dakota/New_SalemAmerica/NuukAmerica/Ojinaga
America/PanamaAmerica/PangnirtungAmerica/Paramaribo
America/PhoenixAmerica/Port-au-PrinceAmerica/Port_of_Spain
America/Porto_AcreAmerica/Porto_VelhoAmerica/Puerto_Rico
America/Punta_ArenasAmerica/Rainy_RiverAmerica/Rankin_Inlet
America/RecifeAmerica/ReginaAmerica/Resolute
America/Rio_BrancoAmerica/RosarioAmerica/Santa_Isabel
America/SantaremAmerica/SantiagoAmerica/Santo_Domingo
America/Sao_PauloAmerica/ScoresbysundAmerica/Shiprock
America/SitkaAmerica/St_BarthelemyAmerica/St_Johns
America/St_KittsAmerica/St_LuciaAmerica/St_Thomas
America/St_VincentAmerica/Swift_CurrentAmerica/Tegucigalpa
America/ThuleAmerica/Thunder_BayAmerica/Tijuana
America/TorontoAmerica/TortolaAmerica/Vancouver
America/VirginAmerica/WhitehorseAmerica/Winnipeg
America/YakutatAmerica/YellowknifeAntarctica/Casey
Antarctica/DavisAntarctica/DumontDUrvilleAntarctica/Macquarie
Antarctica/MawsonAntarctica/McMurdoAntarctica/Palmer
Antarctica/RotheraAntarctica/South_PoleAntarctica/Syowa
Antarctica/TrollAntarctica/VostokArctic/Longyearbyen
Asia/AdenAsia/AlmatyAsia/Amman
Asia/AnadyrAsia/AqtauAsia/Aqtobe
Asia/AshgabatAsia/AshkhabadAsia/Atyrau
Asia/BaghdadAsia/BahrainAsia/Baku
Asia/BangkokAsia/BarnaulAsia/Beirut
Asia/BishkekAsia/BruneiAsia/Calcutta
Asia/ChitaAsia/ChoibalsanAsia/Chongqing
Asia/ChungkingAsia/ColomboAsia/Dacca
Asia/DamascusAsia/DhakaAsia/Dili
Asia/DubaiAsia/DushanbeAsia/Famagusta
Asia/GazaAsia/HarbinAsia/Hebron
Asia/Ho_Chi_MinhAsia/Hong_KongAsia/Hovd
Asia/IrkutskAsia/IstanbulAsia/Jakarta
Asia/JayapuraAsia/JerusalemAsia/Kabul
Asia/KamchatkaAsia/KarachiAsia/Kashgar
Asia/KathmanduAsia/KatmanduAsia/Khandyga
Asia/KolkataAsia/KrasnoyarskAsia/Kuala_Lumpur
Asia/KuchingAsia/KuwaitAsia/Macao
Asia/MacauAsia/MagadanAsia/Makassar
Asia/ManilaAsia/MuscatAsia/Nicosia
Asia/NovokuznetskAsia/NovosibirskAsia/Omsk
Asia/OralAsia/Phnom_PenhAsia/Pontianak
Asia/PyongyangAsia/QatarAsia/Qostanay
Asia/QyzylordaAsia/RangoonAsia/Riyadh
Asia/SaigonAsia/SakhalinAsia/Samarkand
Asia/SeoulAsia/ShanghaiAsia/Singapore
Asia/SrednekolymskAsia/TaipeiAsia/Tashkent
Asia/TbilisiAsia/TehranAsia/Tel_Aviv
Asia/ThimbuAsia/ThimphuAsia/Tokyo
Asia/TomskAsia/Ujung_PandangAsia/Ulaanbaatar
Asia/Ulan_BatorAsia/UrumqiAsia/Ust-Nera
Asia/VientianeAsia/VladivostokAsia/Yakutsk
Asia/YangonAsia/YekaterinburgAsia/Yerevan
Atlantic/AzoresAtlantic/BermudaAtlantic/Canary
Atlantic/Cape_VerdeAtlantic/FaeroeAtlantic/Faroe
Atlantic/Jan_MayenAtlantic/MadeiraAtlantic/Reykjavik
Atlantic/South_GeorgiaAtlantic/St_HelenaAtlantic/Stanley
Australia/ACTAustralia/AdelaideAustralia/Brisbane
Australia/Broken_HillAustralia/CanberraAustralia/Currie
Australia/DarwinAustralia/EuclaAustralia/Hobart
Australia/LHIAustralia/LindemanAustralia/Lord_Howe
Australia/MelbourneAustralia/NSWAustralia/North
Australia/PerthAustralia/QueenslandAustralia/South
Australia/SydneyAustralia/TasmaniaAustralia/Victoria
Australia/WestAustralia/YancowinnaBrazil/Acre
Brazil/DeNoronhaBrazil/EastBrazil/West
CETCST6CDTCanada/Atlantic
Canada/CentralCanada/EasternCanada/Mountain
Canada/NewfoundlandCanada/PacificCanada/Saskatchewan
Canada/YukonChile/ContinentalChile/EasterIsland
CubaEETEST5EDT
EgyptEireEurope/Amsterdam
Europe/AndorraEurope/AstrakhanEurope/Athens
Europe/BelfastEurope/BelgradeEurope/Berlin
Europe/BratislavaEurope/BrusselsEurope/Bucharest
Europe/BudapestEurope/BusingenEurope/Chisinau
Europe/CopenhagenEurope/DublinEurope/Gibraltar
Europe/GuernseyEurope/HelsinkiEurope/Isle_of_Man
Europe/IstanbulEurope/JerseyEurope/Kaliningrad
Europe/KievEurope/KirovEurope/Lisbon
Europe/LjubljanaEurope/LondonEurope/Luxembourg
Europe/MadridEurope/MaltaEurope/Mariehamn
Europe/MinskEurope/MonacoEurope/Moscow
Europe/NicosiaEurope/OsloEurope/Paris
Europe/PodgoricaEurope/PragueEurope/Riga
Europe/RomeEurope/SamaraEurope/San_Marino
Europe/SarajevoEurope/SaratovEurope/Simferopol
Europe/SkopjeEurope/SofiaEurope/Stockholm
Europe/TallinnEurope/TiraneEurope/Tiraspol
Europe/UlyanovskEurope/UzhgorodEurope/Vaduz
Europe/VaticanEurope/ViennaEurope/Vilnius
Europe/VolgogradEurope/WarsawEurope/Zagreb
Europe/ZaporozhyeEurope/ZurichGB
GB-EireGMTGMT0
GreenwichHongkongIceland
Indian/AntananarivoIndian/ChagosIndian/Christmas
Indian/CocosIndian/ComoroIndian/Kerguelen
Indian/MaheIndian/MaldivesIndian/Mauritius
Indian/MayotteIndian/ReunionIran
IsraelJamaicaKwajalein
LibyaMETMST7MDT
Mexico/BajaNorteMexico/BajaSurMexico/General
NZNZ-CHATNavajo
PRCPST8PDTPacific/Apia
Pacific/AucklandPacific/BougainvillePacific/Chatham
Pacific/ChuukPacific/EasterPacific/Efate
Pacific/EnderburyPacific/FakaofoPacific/Fiji
Pacific/FunafutiPacific/GalapagosPacific/Gambier
Pacific/GuadalcanalPacific/GuamPacific/Honolulu
Pacific/JohnstonPacific/KiritimatiPacific/Kosrae
Pacific/KwajaleinPacific/MajuroPacific/Marquesas
Pacific/MidwayPacific/NauruPacific/Niue
Pacific/NorfolkPacific/NoumeaPacific/Pago_Pago
Pacific/PalauPacific/PitcairnPacific/Pohnpei
Pacific/PonapePacific/Port_MoresbyPacific/Rarotonga
Pacific/SaipanPacific/SamoaPacific/Tahiti
Pacific/TarawaPacific/TongatapuPacific/Truk
Pacific/WakePacific/WallisPacific/Yap
PolandPortugalROK
TurkeyUCTUS/Alaska
US/AleutianUS/ArizonaUS/Central
US/East-IndianaUS/EasternUS/Hawaii
US/Indiana-StarkeUS/MichiganUS/Mountain
US/PacificUS/SamoaUTC
UniversalW-SUWET
ZuluESTHST
MSTACTAET
AGTARTAST
BETBSTCAT
CNTCSTCTT
EATECTIET
ISTJSTMIT
NETNSTPLT
PNTPRTPST
SSTVST

Usage for Query Criteria

For further information on how to use the query criteria. Please click the link for the detail.

Not Support Properties

Due to the feature has been changed the design. There below properties are no longer support in all API version as below.

  • Ruckus Wireless AP Zone

    Remove
    clientLoadBalancing24
    clientLoadBalancing50
    wifi24
    wifi50
    dfsChannelEnabled
    cbandChannelEnabled
    cbandChannelLicenseEnabled
    channel144Enabled
    channelModeEnabled
    protectionMode24
    autoChannelSelection24
    autoChannelSelection50
    backgroundScanning24
    backgroundScanning50
  • AP Group

    Remove
    wifi24
    wifi50
    wlanGroup24
    wlanGroup50
    protectionMode24
    autoChannelSelection24
    autoChannelSelection50
  • Access Point Configuration

    Remove
    wifi24
    wifi50
    wlanService24Enabled
    wlanService50Enabled
    wlanGroup24
    wlanGroup50
    protectionMode24
    autoChannelSelection24
    autoChannelSelection50

What’s New

  • API

    • AP Group
      • Disable Radio 2.4G Override
      • Disable Radio 5G Override
      • Disable Radio Lower 5G Override
      • Disable Radio Upper 5G Override
      • Disable Radio 6G Override
      • Disable Radio 2.4G TxPower Override
      • Disable Radio 5G TxPower Override
      • Disable Radio Lower 5G TxPower Override
      • Disable Radio Upper 5G TxPower Override
      • Disable Radio 6G TxPower Override
      • Disable Radio 2.4G ChannelWidth Override
      • Disable Radio 2.4G Channel Override
      • Disable Radio 2.4G ChannelRange Override
      • Disable Radio 5G ChannelWidth Override
      • Disable Radio 5G IndoorChannel Override
      • Disable Radio 5G OutdoorChannel Override
      • Disable Radio 5G IndoorChannelRange Override
      • Disable Radio 5G OutdoorChannelRange Override
      • Disable Radio Lower 5G ChannelWidth Override
      • Disable Radio Lower 5G IndoorChannel Override
      • Disable Radio Lower 5G OutdoorChannel Override
      • Disable Radio Lower 5G IndoorChannelRange Override
      • Disable Radio Lower 5G OutdoorChannelRange Override
      • Disable Radio Upper 5G ChannelWidth Override
      • Disable Radio Upper 5G IndoorChannel Override
      • Disable Radio Upper 5G OutdoorChannel Override
      • Disable Radio Upper 5G IndoorChannelRange Override
      • Disable Radio Upper 5G OutdoorChannelRange Override
      • Disable Radio 6G ChannelWidth Override
      • Disable Radio 6G Channel Override
      • Disable Radio 6G ChannelRange Override
      • Disable WLAN group 2.4G Override
      • Disable WLAN group 5G Override
      • Disable WLAN group lower 5G Override
      • Disable WLAN group upper 5G Override
      • Disable WLAN group 6G Override
      • Disable 2.4GHz radio protection mode override.
      • Disable Radio 2.4G Auto ChannelSelectMode Override
      • Disable Radio 5G Auto ChannelSelectMode Override
      • Disable Radio Lower 5G Auto ChannelSelectMode Override
      • Disable Radio Upper 5G Auto ChannelSelectMode Override
      • Disable Radio 6G Auto ChannelSelectMode Override
    • Access Point Configuration
      • Disable Radio 2.4G Override
      • Disable Radio 5G Override
      • Disable Radio Lower 5G Override
      • Disable Radio Upper 5G Override
      • Disable Radio 6G Override
      • Disable Radio 2.4G TxPower Override
      • Disable Radio 5G TxPower Override
      • Disable Radio Lower 5G TxPower Override
      • Disable Radio Upper 5G TxPower Override
      • Disable Radio 6G TxPower Override
      • Disable Radio 2.4G ChannelWidth Override
      • Disable Radio 2.4G Channel Override
      • Disable Radio 2.4G ChannelRange Override
      • Disable Radio 5G ChannelWidth Override
      • Disable Radio Lower 5G ChannelWidth Override
      • Disable Radio Upper 5G ChannelWidth Override
      • Disable Radio 6G ChannelWidth Override
      • Disable Radio 5G Channel Override
      • Disable Radio Lower 5G Channel Override
      • Disable Radio Upper 5G Channel Override
      • Disable Radio 6G Channel Override
      • Disable Radio 5G ChannelRange Override
      • Disable Radio Lower 5G ChannelRange Override
      • Disable Radio Upper 5G ChannelRange Override
      • Disable Radio 6G ChannelRange Override
      • Disable WLAN Group 2.4G Override
      • Disable WLAN Group 5G Override
      • Disable WLAN Group Lower 5G Override
      • Disable WLAN Group Upper 5G Override
      • Disable WLAN Group 6G Override
      • Disable 2.4GHz radio protection mode override.
      • Disable Radio 2.4G Auto channel selection
      • Disable Radio 5G Auto channel selection
      • Disable Radio Lower 5G Auto channel selection
      • Disable Radio Upper 5G Auto channel selection
      • Disable Radio 6G Auto channel selection
      • Move multiple APs
      • Sync Provision APs to Cloud Service
    • AP SNMP Agent Profile
      • Retrieve
      • Bulk Delete
      • Retrieve List
      • Delete
      • Modify
      • Create
    • AP External Syslog Server Profile
      • Retrieve List
      • Bulk delete Ap Syslog Server Profile
      • Get Ap Syslog Server Profile
      • Update Ap Syslog Server Profile
      • Delete Ap Syslog Server Profile
      • Create Ap Syslog Server Profile
    • Switch Event Management Setting
      • Get Domain Switch Event E-mail Setting
      • Modify Domain Switch Event E-mail Setting
      • Get Domain Switch Event Notification Setting
      • Modify Domain Switch Event Notification Setting
    • System
      • Retrieve SZ Cloud Option Settings
      • Modify SZ Cloud Option Settings
    • URL Filtering Policy
      • Modify URL Filtering policy
    • Ruckus Wireless AP Zone
      • Modify entire zone
      • Disable Background Scanning 2.4G
      • Disable Background Scanning 5G
      • Disable Background Scanning Radio Lower 5G
      • Disable Background Scanning Radio Upper 5G
      • Disable Background Scanning 6G
    • Zone Schedule Upgrade
      • Delete Zone Firmware Schedule Upgrade Task
      • Bulk Delete Zone Firmware Schedule Upgrade Tasks
      • Retrieve Zone Firmware Schedule Upgrade History
      • Modify Zone Firmware Schedule Upgrade Task
      • Create Zone Firmware Schedule Upgrade Task
      • Retrieve Zone Firmware Schedule Upgrade Task List
      • Retrieve Zone Firmware Schedule Upgrade Task
    • Zone Switch Group Link
      • Retrieve - Zone Switch Group Link
      • Retrieve - Zone Switch Group Link
      • Create - Zone Switch Group Link
      • Update - Zone Switch Group Link
      • Delete - Zone Switch Group Link
  • Properties

    • AP Group
      • Create
        • radioConfig
      • Create
        • radioConfig
      • Modify Entire
        • radioConfig
      • Modify Entire
        • radioConfig
      • Retrieve
        • radioConfig
      • Retrieve Default AP Group
        • radioConfig
      • Modify
        • radioConfig
      • Modify
        • radioConfig
    • Access Point Configuration
      • Modify Entire
        • radioConfig
      • Modify Entire
        • radioConfig
      • Retrieve
        • radioConfig
      • Modify
        • radioConfig
      • Modify
        • radioConfig
    • Access Point Operational
      • Retrieve Operational Information
        • wifi6gChannel
    • Cluster Management
      • System configuration restore
        • executeWarningValidate
      • System configuration restore
        • executeWarningValidate
      • Modify Auto Export Backup
        • ftpNamePrefix
      • Modify Auto Export Backup
        • ftpNamePrefix
      • Get Auto Export Backup
        • ftpNamePrefix
    • Administration
      • Create - Admin AAA Server
        • domainId
      • Create - Admin AAA Server
        • domainId
      • Retrieve - Admin AAA Server
        • domainId, creatorUsername, createDateTime
    • System
      • Retrieve Devices Summary
        • dualRadioAps, triRadioAps
      • Retrieve security setting
        • sshAuthMethod
      • Modify security setting
        • sshAuthMethod
      • Modify security setting
        • sshAuthMethod
    • DP DHCP Profile
      • Create DP DHCP profile - pool
        • vlanType
      • Create DP DHCP profile - pool
        • vlanType
      • Modify DP DHCP profile - pool
        • vlanType
      • Modify DP DHCP profile - pool
        • vlanType
      • Retrieve DP DHCP profile - pool
        • vlanType
    • DP NAT Profile
      • Create DHCP NAT profile - pool
        • vlanType
      • Create DHCP NAT profile - pool
        • vlanType
      • Retrieve DP DHCP profile - pool
        • vlanType
      • Modify DHCP NAT profile - pool
        • vlanType
      • Modify DHCP NAT profile - pool
        • vlanType
    • RuckusGRE Tunnel Profile
      • Create
        • keepAlivePeriod, keepAliveRetry, dualTunnel
      • Create
        • keepAlivePeriod, keepAliveRetry, dualTunnel
      • Modify
        • keepAlivePeriod, keepAliveRetry, dualTunnel
      • Modify
        • keepAlivePeriod, keepAliveRetry, dualTunnel
      • Retrieve
        • keepAlivePeriod, keepAliveRetry, dualTunnel
    • Authentication Service
      • Retrieve - Active Directory Authentication Service
        • cnIdentity
      • Create - Active Directory Authentication Service
        • cnIdentity
      • Create - Active Directory Authentication Service
        • cnIdentity
      • Modify - Active Directory Authentication Service
        • cnIdentity
      • Modify - Active Directory Authentication Service
        • cnIdentity
      • Retrieve - LDAP Authentication Service
        • cnIdentity
      • Create - LDAP Authentication Service
        • cnIdentity
      • Create - LDAP Authentication Service
        • cnIdentity
      • Modify - LDAP Authentication Service
        • cnIdentity
      • Modify - LDAP Authentication Service
        • cnIdentity
    • URL Filtering Policy
      • Retrieve URL Filtering policy
        • blockByThreatLevelConfig
      • Create URL Filtering policy
        • blockByThreatLevelConfig
      • Create URL Filtering policy
        • blockByThreatLevelConfig
      • Patch URL Filtering policy
        • blockByThreatLevelConfig
      • Patch URL Filtering policy
        • blockByThreatLevelConfig
    • SCG User
      • Get SCG user
        • sshPublicKeys, credentialExpired
      • Update SCG user
        • sshPublicKeys
      • Update SCG user
        • sshPublicKeys
    • Guest Access
      • Retrieve
        • selfRegistration, smtpServerEnabled, expirationValue, expirationUnit, passEffectSince, passUseDays, maxAllowedDeviceLimitNum, sponsorApproval, sponsorAuthServer, sponsorEmailAddress, notificationMethod, requireLoginAgain, sessionValue, sessionUnit
      • Create
        • selfRegistration, smtpServerEnabled, expirationValue, expirationUnit, passEffectSince, passUseDays, maxAllowedDeviceLimitNum, sponsorApproval, sponsorAuthServer, sponsorEmailAddress, notificationMethod, requireLoginAgain, sessionValue, sessionUnit
      • Create
        • selfRegistration, smtpServerEnabled, expirationValue, expirationUnit, passEffectSince, passUseDays, maxAllowedDeviceLimitNum, sponsorApproval, sponsorAuthServer, sponsorEmailAddress, notificationMethod, requireLoginAgain, sessionValue, sessionUnit
      • Modify
        • selfRegistration, smtpServerEnabled, expirationValue, expirationUnit, passEffectSince, passUseDays, maxAllowedDeviceLimitNum, sponsorApproval, sponsorAuthServer, sponsorEmailAddress, notificationMethod, requireLoginAgain, sessionValue, sessionUnit
      • Modify
        • selfRegistration, smtpServerEnabled, expirationValue, expirationUnit, passEffectSince, passUseDays, maxAllowedDeviceLimitNum, sponsorApproval, sponsorAuthServer, sponsorEmailAddress, notificationMethod, requireLoginAgain, sessionValue, sessionUnit
    • Ruckus Wireless AP Zone
      • Create Zone of IPv6
        • radioConfig
      • Create Zone of IPv6
        • radioConfig
      • Create Zone of Dual
        • radioConfig
      • Create Zone of Dual
        • radioConfig
      • Retrieve
        • radioConfig
      • Modify
        • radioConfig
      • Modify
        • radioConfig
      • Create Zone
        • radioConfig
      • Create Zone
        • radioConfig
    • Ethernet Port Profile
      • Modify - Ethernet Port Porfile
        • accessNetworkType, userSidePortUplinkLimit, userSidePortDownlinkLimit
      • Modify - Ethernet Port Porfile
        • accessNetworkType, userSidePortUplinkLimit, userSidePortDownlinkLimit
      • Modify Entire - Ethernet Port Porfile
        • accessNetworkType, userSidePortUplinkLimit, userSidePortDownlinkLimit
      • Modify Entire - Ethernet Port Porfile
        • accessNetworkType, userSidePortUplinkLimit, userSidePortDownlinkLimit
      • Retrieve - Ethernet Port Porfile
        • accessNetworkType, userSidePortUplinkLimit, userSidePortDownlinkLimit
      • Create - Ethernet Port Porfile
        • accessNetworkType, userSidePortUplinkLimit, userSidePortDownlinkLimit
      • Create - Ethernet Port Porfile
        • accessNetworkType, userSidePortUplinkLimit, userSidePortDownlinkLimit

What’s Deprecated

  • API
    • AP Group
      • Disable WLAN group 2.4G Override
      • Disable WLAN group 5G Override
      • Disable Radio 2.4G Override
      • Disable Radio 5G Override
      • Disable Radio 2.4G Auto ChannelSelectMode Override
      • Disable Radio 5G Auto ChannelSelectMode Override
      • Disable Radio 2.4G TxPower Override
      • Disable Radio 5G TxPower Override
      • Disable Radio 2.4G ChannelWidth Override
      • Disable Radio 2.4G Channel Override
      • Disable Radio 2.4G ChannelRange Override
      • Disable Radio 5G ChannelWidth Override
      • Disable Radio 5G IndoorChannel Override
      • Disable Radio 5G OutdoorChannel Override
      • Disable Radio 5G IndoorChannelRange Override
      • Disable Radio 5G OutdoorChannelRange Override
    • Access Point Configuration
      • Disable 2.4GHz radio protection mode override.
      • Disable WLAN Group 2.4G Override
      • Disable WLAN group 5G Override
      • Disable Radio 2.4G Override
      • Disable Radio 5G Override
      • Disable Radio 2.4G Auto channel selection
      • Disable Radio 5G Auto channel selection
      • Disable Radio 2.4G TxPower Override
      • Disable Radio 5G TxPower Override
      • Disable Radio 2.4G ChannelWidth Override
      • Disable Radio 2.4G Channel Override
      • Disable Radio 2.4G ChannelRange Override
      • Disable Radio 5G ChannelWidth Override
      • Disable Radio 5G Channel Override
      • Disable Radio 5G ChannelRange Override
    • Ruckus Wireless AP Zone
      • Disable Background Scanning 2.4G
      • Disable Background Scanning 5G

API Information

Retrieve API information

GET/apiInfo

Use this API command to retrieve API information.

Response  200
HideShow
Body
{
  "apiSupportVersions": [
    "v6_0",
    "v6_1",
    "v7_0",
    "v8_0",
    "v8_1",
    "v8_2",
    "v9_0"
  ]
}
Schema
{
  "type": "object",
  "properties": {
    "apiSupportVersions": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}

Logon

Service Ticket

  • Logon

POST/v11_0/serviceTicket

Use this API command to log on to the controller and acquire a valid service ticket.

Request
HideShow
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"
  ]
}
Response  200
HideShow
Body
{
  "controllerVersion": "5.0.0.0.451",
  "serviceTicket": "ST-8-fZbanC02T6zpzvMFZocF-neil50-451"
}
Schema
{
  "type": "object",
  "properties": {
    "controllerVersion": {
      "type": "string"
    },
    "serviceTicket": {
      "description": "Logon authentication successful, the server generates a service ticket",
      "type": "string"
    }
  }
}

  • Logoff

DELETE/v11_0/serviceTicket

Use this API command to log off of the controller.

URI Parameters
HideShow
serviceTicket
string (required) 
Response  200

Session ID

  • Retrieve

GET/v11_0/session

Use this API command to retrieve information about the current logon session.

Response  200
HideShow
Body
{
  "cpId": "DEV_BLADE_UUID",
  "domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
  "adminRoleId": "69962d35-9447-41a1-aff5-facf1e85c674",
  "mvnoId": "839f87c6-d116-497e-afce-aa8157abd30c",
  "adminId": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25",
  "clientIp": "172.18.193.1",
  "apiVersions": [
    "1_0"
  ],
  "timeZoneUtcOffset": 0
}
Schema
{
  "type": "object",
  "properties": {
    "cpId": {
      "type": "string"
    },
    "domainId": {
      "type": "string"
    },
    "adminRoleId": {
      "type": "string"
    },
    "mvnoId": {
      "type": "string"
    },
    "adminId": {
      "type": "string"
    },
    "clientIp": {
      "type": "string"
    },
    "apiVersions": {
      "description": "API version supported by the client",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "timeZoneUtcOffset": {
      "type": "integer"
    }
  }
}

  • Logon

POST/v11_0/session

Use this API command to log on to the controller and acquire a valid logon session.

Request
HideShow
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"
  ]
}
Response  200
HideShow
Body
{
  "controllerVersion": "1"
}
Schema
{
  "type": "object",
  "properties": {
    "controllerVersion": {
      "type": "string"
    }
  }
}

  • Logoff

DELETE/v11_0/session

Use this API command to log off of the controller.

Response  200

Session Management

Retrieve

GET/v11_0/sessionManagement

Use this API command to retrieve information about the current logon sessions.

Response  200
HideShow
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 List

GET/v11_0/rkszones

Use this API command to retrieve the list of Ruckus Wireless AP zones that belong to a domain.

URI Parameters
HideShow
index
string (optional) 

The index of the first entry to be retrieved. Default: 0

listSize
string (optional) 

The maximum number of entries to be retrieved. Default: 100, Maximum: 1000

domainId
string (optional) 

The domain ID. Default: current logon domain ID

Response  200
HideShow
Body
{
  "totalCount": 2,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "id": "zoneUUID",
      "name": "zoneName"
    },
    {
      "id": "zoneUUID2",
      "name": "zoneName2"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "Identifier of the zone",
            "type": "string"
          },
          "name": {
            "description": "Name of the zone",
            "type": "string"
          },
          "serviceName": {
            "description": "Name of the zone",
            "type": "string"
          }
        }
      }
    }
  }
}

Retrieve Mesh Configuration

GET/v11_0/rkszones/{id}/mesh

Use this API command to retrieve the mesh configuration of a zone.

Response  200
HideShow
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "ssid": {
      "description": "SSID of the mesh network",
      "type": "string"
    },
    "passphrase": {
      "description": "Passphrase for the mesh network. Would be mandatory when the mesh is enabled.",
      "type": "string"
    },
    "meshRadioIdx": {
      "description": "Mesh radio index",
      "type": "string",
      "enum": [
        "Radio24G",
        "Radio5G"
      ],
      "default": "Radio5G"
    },
    "zeroTouchStatus": {
      "type": "boolean"
    }
  }
}

Retrieve AP Model

GET/v11_0/rkszones/{zoneId}/apmodel/{model}

Use this API command to retrieve AP model specific configuration that belong to a zone.

Response  200
HideShow
Body
{
  "ledStatusEnabled": true,
  "lacp": {
    "keepApSetting": false,
    "enabled": true,
    "bondPortProfileId": "ed395d1c-45a7-4d85-994f-244c38c83f2c"
  },
  "lldp": {
    "enabled": true,
    "advertiseIntervalInSec": 30,
    "holdTimeInSec": 120,
    "managementIPTLVEnabled": false
  },
  "cellularSettings": {
    "mobileAPName": "internet",
    "mobileAPName2": "internet",
    "simCardUsage": 0,
    "select3g4g": 0,
    "select3g4g2": 0,
    "dataRoaming": 1,
    "dataRoaming2": 1,
    "wanConnection": 0,
    "wanRecoveryTimer": 60
  },
  "ledMode": null,
  "internalHeaterEnabled": null,
  "poeOutPortEnabled": null,
  "usbPowerEnable": true,
  "poeModeSetting": "Auto",
  "poeTxChain": 2,
  "radioBand": null,
  "externalAntenna24": null,
  "externalAntenna50": null,
  "lanPorts": [
    {
      "portName": "LAN1",
      "enabled": false,
      "ethPortProfile": null
    },
    {
      "portName": "LAN2",
      "enabled": true,
      "ethPortProfile": {
        "id": "0",
        "name": "Default Trunk Port"
      }
    },
    {
      "portName": "LAN3",
      "enabled": true,
      "ethPortProfile": {
        "id": "1",
        "name": "Default Access Port"
      }
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "ledStatusEnabled": {
      "type": [
        "boolean",
        "null"
      ]
    },
    "lldp": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "enabled": {
          "type": "boolean",
          "default": true
        },
        "advertiseIntervalInSec": {
          "type": [
            "integer",
            "null"
          ],
          "minimum": 1,
          "maximum": 300
        },
        "holdTimeInSec": {
          "type": [
            "integer",
            "null"
          ],
          "minimum": 60,
          "maximum": 1200
        },
        "managementIPTLVEnabled": {
          "type": [
            "boolean",
            "null"
          ]
        }
      },
      "required": [
        "enabled"
      ]
    },
    "lacp": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "keepApSetting": {
          "type": "boolean"
        },
        "enabled": {
          "type": "boolean"
        },
        "bondPortProfileId": {
          "type": [
            "string",
            "null"
          ]
        }
      }
    },
    "cellularSettings": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "mobileAPName": {
          "type": [
            "string",
            "null"
          ],
          "maxLength": 100,
          "pattern": "^([!-?A-~]([!-?A-~]){0,62}[!-?A-~]|[!-?A-~]?)$"
        },
        "mobileAPName2": {
          "type": [
            "string",
            "null"
          ],
          "maxLength": 100,
          "pattern": "^([!-?A-~]([!-?A-~]){0,62}[!-?A-~]|[!-?A-~]?)$"
        },
        "simCardUsage": {
          "type": [
            "integer",
            "null"
          ],
          "minimum": 0,
          "maximum": 2
        },
        "select3g4g": {
          "type": "integer",
          "minimum": 0,
          "maximum": 2
        },
        "select3g4g2": {
          "type": "integer",
          "minimum": 0,
          "maximum": 2
        },
        "dataRoaming": {
          "type": [
            "integer",
            "null"
          ],
          "minimum": 0,
          "maximum": 1
        },
        "dataRoaming2": {
          "type": [
            "integer",
            "null"
          ],
          "minimum": 0,
          "maximum": 1
        },
        "wanConnection": {
          "type": "integer",
          "minimum": 0,
          "maximum": 3
        },
        "wanRecoveryTimer": {
          "type": "integer",
          "minimum": 10,
          "maximum": 300
        }
      },
      "required": [
        "select3g4g",
        "select3g4g2",
        "wanConnection",
        "wanRecoveryTimer"
      ]
    },
    "ledMode": {
      "type": [
        "string",
        "null"
      ],
      "enum": [
        null,
        "CableModem",
        "AccessPoint",
        "CableModem_AccessPoint",
        "CableModem_AccessPoint_DEFAULT",
        "ActiveSurgeProtector",
        "ActiveSurgeProtector_ModemOnline_DEFAULT",
        "Off"
      ]
    },
    "internalHeaterEnabled": {
      "type": [
        "boolean",
        "null"
      ]
    },
    "poeOutPortEnabled": {
      "type": [
        "boolean",
        "null"
      ]
    },
    "usbPowerEnable": {
      "type": [
        "boolean",
        "null"
      ]
    },
    "poeModeSetting": {
      "type": [
        "string",
        "null"
      ],
      "enum": [
        "Auto",
        "_802_3af",
        "_802_3at",
        "_802_3atPlus",
        "_802_3bt_Class_5",
        "_802_3bt_Class_6",
        "_802_3bt_Class_7",
        "_802_3bt_Class_8",
        null
      ]
    },
    "poeTxChain": {
      "description": "Option to use 1, 2 or 4 Tx chains while AP power source is 802.3af PoE",
      "default": 2,
      "type": [
        "integer",
        "null"
      ]
    },
    "radioBand": {
      "description": "Band switch between 2.4GHz and 5GHz is provided in single radio AP ZF-7321, ZF-7321-U, and ZF-7441.",
      "type": [
        "string",
        "null"
      ],
      "enum": [
        null,
        "2.4GHz",
        "5GHz"
      ]
    },
    "externalAntenna24": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "properties": {
        "enabled": {
          "type": "boolean"
        },
        "dbi": {
          "type": [
            "integer",
            "null"
          ],
          "minimum": 0,
          "maximum": 90
        },
        "chainMask": {
          "type": [
            "string",
            "null"
          ],
          "enum": [
            null,
            "Two",
            "Three"
          ]
        }
      },
      "required": [
        "enabled"
      ]
    },
    "externalAntenna50": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "properties": {
        "enabled": {
          "type": "boolean"
        },
        "dbi": {
          "type": [
            "integer",
            "null"
          ],
          "minimum": 0,
          "maximum": 90
        },
        "chainMask": {
          "type": [
            "string",
            "null"
          ],
          "enum": [
            null,
            "Two",
            "Three"
          ]
        }
      },
      "required": [
        "enabled"
      ]
    },
    "lanPorts": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "portName": {
            "type": "string",
            "enum": [
              "LAN1",
              "LAN2",
              "LAN3",
              "LAN4",
              "LAN5"
            ]
          },
          "enabled": {
            "type": "boolean"
          },
          "ethPortProfile": {
            "type": [
              "object",
              "null"
            ],
            "additionalProperties": false,
            "properties": {
              "id": {
                "type": "string"
              },
              "name": {
                "type": "string"
              }
            }
          }
        },
        "required": [
          "portName",
          "enabled"
        ]
      }
    }
  }
}

Retrieve AP Model Common Attribute

GET/v11_0/rkszones/{zoneId}/apmodel/{model}/commonAttribute

Use this API command to retrieve AP model common attribute that belong to a zone.

Response  200
HideShow
Body
{
  "nonEditablePorts": [
    2
  ],
  "isAllowDisableExtAnt": null,
  "nonVisiblePorts": [
    2
  ],
  "hasScanRadio": null,
  "hasCablemodem": true,
  "hasGps": false,
  "isDualRadio": true,
  "isOutdoor": false,
  "maxChannelization24G": 40,
  "maxChannelization5G": 80,
  "maxClientsUpper": 256,
  "maxWlanNum24G": 15,
  "maxWlanNum5G": 16,
  "noAvc": false,
  "noMesh": false,
  "meshRadioCaps": "1,2",
  "reserved5GWlanForMesh": 3,
  "support11AC": true,
  "supportChannelization160": null,
  "supportAPUsbSoftwarePackage": null,
  "supportBandSwitch": false,
  "supportBonjour": true,
  "supportIpsec": false,
  "supportLBS": true,
  "supportResetCablemodem": true,
  "allowDfsCountry": "US",
  "ram": 512,
  "numOfCores": 4,
  "cpuFrequency": 600,
  "scalingFactor": 1,
  "capabilityScore": 75
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "nonEditablePorts": {
      "type": "array",
      "items": {
        "type": "integer"
      }
    },
    "isAllowDisableExtAnt": {
      "type": [
        "boolean",
        "null"
      ]
    },
    "nonVisiblePorts": {
      "type": "array",
      "items": {
        "type": "integer"
      }
    },
    "hasScanRadio": {
      "type": [
        "boolean",
        "null"
      ]
    },
    "hasCablemodem": {
      "type": [
        "boolean",
        "null"
      ]
    },
    "hasGps": {
      "type": [
        "boolean",
        "null"
      ]
    },
    "isDualRadio": {
      "type": [
        "boolean",
        "null"
      ]
    },
    "isOutdoor": {
      "type": [
        "boolean",
        "null"
      ]
    },
    "maxChannelization24G": {
      "type": "integer"
    },
    "maxChannelization5G": {
      "type": "integer"
    },
    "maxClientsUpper": {
      "type": "integer"
    },
    "maxWlanNum24G": {
      "type": "integer"
    },
    "maxWlanNum5G": {
      "type": "integer"
    },
    "noAvc": {
      "type": [
        "boolean",
        "null"
      ]
    },
    "noMesh": {
      "type": [
        "boolean",
        "null"
      ]
    },
    "meshRadioCaps": {
      "type": "string"
    },
    "reserved5GWlanForMesh": {
      "type": "integer"
    },
    "support11AC": {
      "type": [
        "boolean",
        "null"
      ]
    },
    "supportChannelization160": {
      "type": [
        "boolean",
        "null"
      ]
    },
    "supportAPUsbSoftwarePackage": {
      "type": [
        "boolean",
        "null"
      ]
    },
    "supportBandSwitch": {
      "type": [
        "boolean",
        "null"
      ]
    },
    "supportBonjour": {
      "type": [
        "boolean",
        "null"
      ]
    },
    "supportIpsec": {
      "type": [
        "boolean",
        "null"
      ]
    },
    "supportLBS": {
      "type": [
        "boolean",
        "null"
      ]
    },
    "supportResetCablemodem": {
      "type": [
        "boolean",
        "null"
      ]
    },
    "allowDfsCountry": {
      "type": "string"
    },
    "ram": {
      "type": "integer"
    },
    "numOfCores": {
      "type": "integer"
    },
    "cpuFrequency": {
      "type": "integer"
    },
    "scalingFactor": {
      "type": "integer"
    },
    "capabilityScore": {
      "type": "integer",
      "format": "int64"
    },
    "poeModeCaps": {
      "type": "string"
    }
  }
}

Retrieve AP Firmware List

GET/v11_0/rkszones/{zoneId}/apFirmware

Use this API command to retrieve AP Firmware the list that belong to a zone.

Response  200
HideShow
Body
[
  {
    "firmwareVersion": "3.4.0.101.492",
    "unsupportedApModelSummary": [
      {
        "model": "R300",
        "amount": 1
      }
    ],
    "supported": false
  },
  {
    "firmwareVersion": "3.4.0.101.505",
    "unsupportedApModelSummary": [],
    "supported": true
  }
]
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "firmwareVersion": {
            "description": "version of the AP firmare",
            "type": "string"
          },
          "unsupportedApModelSummary": {
            "description": "summary of the AP Model is unsupported for AP firmware version.",
            "type": "array",
            "items": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "model": {
                  "description": "name of the AP Model",
                  "type": "string"
                },
                "amount": {
                  "description": "amount of the AP Model",
                  "type": "integer"
                }
              }
            }
          },
          "supported": {
            "description": "version of the AP firmare is supported for Upgrade or Downgrade.",
            "type": "boolean"
          }
        }
      }
    }
  }
}

Get Available GRE Tunnel Profiles.

GET/v11_0/rkszones/{zoneId}/availableTunnelProfiles

Get available GRE tunnel profiles of this Zone.

Response  200
HideShow
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "Tunnel Profile ID",
            "type": "string"
          },
          "name": {
            "description": "Tunnel Profile Name",
            "type": "string"
          },
          "tunnelType": {
            "description": "Tunnel Profile Type (\"RuckusGRE\", \"SoftGRE\",or \"Ipsec\")",
            "type": "string",
            "enum": [
              "RuckusGRE",
              "SoftGRE",
              "Ipsec"
            ]
          },
          "ipMode": {
            "description": "Tunnel Profile's IP Mode",
            "type": "string",
            "enum": [
              "IPV4",
              "IPV6",
              "IPV4_IPV6"
            ]
          },
          "aaaAffinityEnabled": {
            "description": "Enable AAA affinity (Soft GRE only)",
            "type": "boolean"
          }
        }
      }
    }
  }
}

Get available IPSec Tunnel Profiles.

GET/v11_0/rkszones/{zoneId}/availableIpsecProfiles

Get available IPSec tunnel profiles of this Zone.

Response  200
HideShow
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "Tunnel Profile ID",
            "type": "string"
          },
          "name": {
            "description": "Tunnel Profile Name",
            "type": "string"
          },
          "tunnelType": {
            "description": "Tunnel Profile Type (\"RuckusGRE\", \"SoftGRE\",or \"Ipsec\")",
            "type": "string",
            "enum": [
              "RuckusGRE",
              "SoftGRE",
              "Ipsec"
            ]
          },
          "ipMode": {
            "description": "Tunnel Profile's IP Mode",
            "type": "string",
            "enum": [
              "IPV4",
              "IPV6",
              "IPV4_IPV6"
            ]
          },
          "aaaAffinityEnabled": {
            "description": "Enable AAA affinity (Soft GRE only)",
            "type": "boolean"
          }
        }
      }
    }
  }
}

Retrieve

GET/v11_0/rkszones/{id}

Use this API command to retrieve Ruckus Wireless AP zones configuration.

Response  200
HideShow
Body
{
  "id": "ad5ffab1-b3ed-4b36-b054-bc723a977dbb",
  "domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
  "name": "public-api-zone-ipv6",
  "description": null,
  "countryCode": "US",
  "version": "3.1.0.0.55",
  "timezone": {
    "systemTimezone": "UTC",
    "customizedTimezone": null
  },
  "ipMode": "IPV6",
  "login": {
    "apLoginName": "admin",
    "apLoginPassword": "admin!234"
  },
  "mesh": null,
  "dfsChannelEnabled": false,
  "cbandChannelEnabled": false,
  "cbandChannelLicenseEnabled": false,
  "channel144Enabled": false,
  "wifi24": {
    "txPower": "Full",
    "channelWidth": 20,
    "channel": 0,
    "channelRange": [
      1,
      2,
      3,
      4,
      5,
      6,
      7,
      8,
      9,
      10,
      11
    ],
    "availableChannelRange": [
      1,
      2,
      3,
      4,
      5,
      6,
      7,
      8,
      9,
      10,
      11
    ]
  },
  "wifi50": {
    "txPower": "-1dB",
    "channelWidth": 40,
    "indoorChannel": 0,
    "outdoorChannel": 0,
    "indoorChannelRange": [
      36,
      40,
      44,
      48,
      149,
      153,
      157,
      161
    ],
    "outdoorChannelRange": [
      149,
      153,
      157,
      161
    ],
    "availableIndoorChannelRange": [
      36,
      40,
      44,
      48,
      149,
      153,
      157,
      161
    ],
    "availableOutdoorChannelRange": [
      149,
      153,
      157,
      161
    ]
  },
  "protectionMode24": "CTS_ONLY",
  "syslog": null,
  "smartMonitor": null,
  "clientAdmissionControl24": null,
  "clientAdmissionControl50": null,
  "channelModeEnabled": false,
  "tunnelType": "SoftGREIpsec",
  "tunnelProfile": {
    "id": "tunnelProfileId",
    "name": "tunnelProfileName"
  },
  "backgroundScanning24": null,
  "backgroundScanning50": null,
  "loadBalancing": {
    "loadBalancingMethod": "BASED_ON_CLIENT_COUNT",
    "clientLoadBalancing24": {
      "adjacentRadioThreshold": 12
    },
    "clientLoadBalancing50": {
      "adjacentRadioThreshold": 12
    },
    "bandBalancing": {
      "wifi24Percentage": 10
    },
    "steeringMode": "BASIC"
  },
  "rogue": null,
  "locationBasedService": null,
  "apRebootTimeout": {
    "gatewayLossTimeoutInSec": 1800,
    "serverLossTimeoutInSec": 7200
  },
  "location": null,
  "locationAdditionalInfo": null,
  "latitude": null,
  "longitude": null,
  "vlanOverlappingEnabled": false,
  "nodeAffinityProfile": null,
  "venueProfile": null,
  "autoChannelSelection24": {
    "channelSelectMode": "ChannelFly",
    "channelFlyMtbc": 480
  },
  "autoChannelSelection50": {
    "channelSelectMode": "BackgroundScanning",
    "channelFlyMtbc": 480
  },
  "channelEvaluationInterval": 777,
  "apMgmtVlan": {
    "id": 1,
    "mode": "KEEP"
  },
  "ipsecProfile": {
    "id": "ipsecProfileId",
    "name": "ipsecProfileName"
  },
  "autoPurgeExpiredDpsk": "OneDay",
  "altitude": {
    "altitudeUnit": "meters",
    "altitudeValue": 1
  },
  "bonjourFencingPolicyEnabled": true,
  "bonjourFencingPolicy": {
    "id": "bonjourFencingPolicyId",
    "name": "bonjourFencingPolicyName"
  },
  "recoverySsid": {
    "recoverySsidEnabled": true
  },
  "dhcpSiteConfig": {
    "zoneName": "zoneK",
    "siteEnabled": true,
    "portSelectionEnabled": false,
    "dwpdEnabled": false,
    "manualSelect": true,
    "siteMode": "EnableOnMultipleAPs",
    "siteAps": [
      {
        "apMac": "38:FF:36:00:0E:10",
        "apServerEnabled": true,
        "apServerPrimary": true
      },
      {
        "apMac": "58:FF:36:00:0E:20",
        "apServerEnabled": true,
        "apServerPrimary": false
      }
    ],
    "siteProfileIds": [
      "75e26590-547f-11e6-9ca7-5a095364c13c",
      "869bb532-547f-11e6-9ca7-5a095364c13c"
    ]
  },
  "snmpAgent": {
    "apSnmpEnabled": true,
    "snmpV2Agent": [
      {
        "communityName": "v2Agent",
        "notificationEnabled": true,
        "readEnabled": true,
        "writeEnabled": true,
        "notificationType": "TRAP",
        "notificationTarget": [
          {
            "address": "172.19.16.20",
            "port": 161
          }
        ]
      }
    ],
    "snmpV3Agent": [
      {
        "userName": "v3Agent",
        "authProtocol": "MD5",
        "authPassword": "admin!234",
        "privProtocol": "DES",
        "privPassword": "admin!234",
        "notificationEnabled": true,
        "readEnabled": true,
        "writeEnabled": true,
        "notificationType": "TRAP",
        "notificationTarget": [
          {
            "address": "172.19.16.20",
            "port": 161
          }
        ]
      }
    ]
  },
  "rogueApReportThreshold": 40,
  "rogueApAggressivenessMode": 2,
  "rogueApJammingDetection": true,
  "rogueApJammingThreshold": 40,
  "directedMulticastFromWiredClientEnabled": true,
  "directedMulticastFromWirelessClientEnabled": true,
  "directedMulticastFromNetworkEnabled": false,
  "healthCheckSitesEnabled": true,
  "healthCheckSites": [
    "www.google.com",
    "www.live.com:443",
    "www.github.com:443",
    "source.codeaurora.org:443",
    "www.wikipedia.com"
  ],
  "rkusGreTunnelProfile": {
    "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"
    }
  ],
  "paloAltoFirewallProfileId": "2f59b0f4-c86f-11e8-a8d5-f2801f1b9fd1",
  "apHccdEnabled": true,
  "apHccdPersist": true,
  "rksGreForwardBroadcast": false
}
Schema
{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "id" : {
            "description" : "Identifier of the zone",
            "type" : "string"
        },
        "domainId" : {
            "description" : "Identifier of the management domain to which the zone belongs",
            "type" : "string"
        },
        "name" : {
            "description" : "Name of the zone",
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 32,
            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$"
        },
        "description" : {
            "description" : "Description of the zone",
            "type" : [ "string", "null" ],
            "maxLength" : 64
        },
        "version" : {
            "description" : "AP firmware version of the zone",
            "type" : "string",
            "pattern" : "^\d+\.\d+\.\d+\.\d+\.\d+$"
        },
        "countryCode" : {
            "description" : "Country code of the zone",
            "type" : "string"
        },
        "timezone" : {
            "description" : "Time zone",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "systemTimezone" : {
                    "description" : "System defined time zone, please refer to the 'Overview > Time Zone' list",
                    "type" : "string"
                },
                "customizedTimezone" : {
                    "description" : "User defined time zone",
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "abbreviation" : {
                            "description" : "Time zone abbreviation",
                            "type" : "string",
                            "pattern" : "^[a-zA-Z]{3,4}$"
                        },
                        "gmtOffset" : {
                            "description" : "GMT offset",
                            "type" : "integer",
                            "minimum" : -11,
                            "maximum" : 14
                        },
                        "gmtOffsetMinute" : {
                            "description" : "GMT offset minute",
                            "type" : "integer",
                            "minimum" : 0,
                            "maximum" : 59
                        },
                        "start" : {
                            "description" : "Daylight saving time start",
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "month" : {
                                    "description" : "Month when daylight saving time begins",
                                    "type" : "integer",
                                    "enum" : [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ]
                                },
                                "week" : {
                                    "description" : "Week of the month (1 for the first week, 2 for the second week, and so on)",
                                    "type" : "integer",
                                    "enum" : [ 1, 2, 3, 4, 5 ]
                                },
                                "day" : {
                                    "description" : "Day of the week (0 for Sunday, 1 for Monday, 2 for Tuesday, and so on)",
                                    "type" : "integer",
                                    "enum" : [ 0, 1, 2, 3, 4, 5, 6 ]
                                },
                                "hour" : {
                                    "description" : "Hour of the day",
                                    "type" : "integer",
                                    "minimum" : 0,
                                    "maximum" : 23
                                }
                            },
                            "required" : [ "month", "week", "day", "hour" ]
                        },
                        "end" : {
                            "description" : "Daylight saving time end",
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "month" : {
                                    "description" : "Month when daylight saving time begins",
                                    "type" : "integer",
                                    "enum" : [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ]
                                },
                                "week" : {
                                    "description" : "Week of the month (1 for the first week, 2 for the second week, and so on)",
                                    "type" : "integer",
                                    "enum" : [ 1, 2, 3, 4, 5 ]
                                },
                                "day" : {
                                    "description" : "Day of the week (0 for Sunday, 1 for Monday, 2 for Tuesday, and so on)",
                                    "type" : "integer",
                                    "enum" : [ 0, 1, 2, 3, 4, 5, 6 ]
                                },
                                "hour" : {
                                    "description" : "Hour of the day",
                                    "type" : "integer",
                                    "minimum" : 0,
                                    "maximum" : 23
                                }
                            },
                            "required" : [ "month", "week", "day", "hour" ]
                        }
                    },
                    "required" : [ "abbreviation", "gmtOffset", "gmtOffsetMinute" ]
                }
            }
        },
        "login" : {
            "description" : "AP administrator account",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "apLoginName" : {
                    "description" : "User name of the AP administrator",
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : "^((?!\$\()[!-_a-~]){1,64}$"
                },
                "apLoginPassword" : {
                    "description" : "Password of the AP administrator",
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : ".*(?=.{8,})(?=.*[a-zA-Z])(?=.*[0-9])(?=.*[_`[email protected]#$%^&*\(\)\[\]\{\}|;:'\",.\<>\/?=+-]).*"
                }
            },
            "required" : [ "apLoginName", "apLoginPassword" ]
        },
        "ipMode" : {
            "description" : "IP mode of the zone",
            "type" : "string",
            "enum" : [ "IPV4", "IPV6", "IPV4_IPV6" ]
        },
        "mesh" : {
            "description" : "Mesh configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "ssid" : {
                    "description" : "SSID of the mesh network",
                    "type" : "string"
                },
                "passphrase" : {
                    "description" : "Passphrase for the mesh network. Would be mandatory when the mesh is enabled.",
                    "type" : "string"
                },
                "meshRadioIdx" : {
                    "description" : "Mesh radio index",
                    "type" : "string",
                    "enum" : [ "Radio24G", "Radio5G" ],
                    "default" : "Radio5G"
                },
                "zeroTouchStatus" : {
                    "type" : "boolean"
                }
            }
        },
        "syslog" : {
            "description" : "Syslog configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "syslogConfigType" : {
                    "description" : "Syslog configuration type.",
                    "type" : "string",
                    "enum" : [ "CUSTOM", "AP_SYSLOG_SERVER_PROFILE" ],
                    "default" : "CUSTOM"
                },
                "syslogServerProfileId" : {
                    "description" : "Syslog server profile ID.",
                    "type" : "string"
                },
                "flowLevel" : {
                    "description" : "Flow Level of the syslog",
                    "type" : "string",
                    "enum" : [ "GENERAL_LOGS", "CLIENT_FLOW", "ALL" ],
                    "default" : "GENERAL_LOGS"
                },
                "address" : {
                    "description" : "Address of the syslog server.",
                    "type" : "string"
                },
                "port" : {
                    "description" : "Port number of the syslog server",
                    "type" : "integer",
                    "default" : 514,
                    "minimum" : 1,
                    "maximum" : 65535
                },
                "protocol" : {
                    "description" : "Protocol of the syslog server",
                    "type" : "string",
                    "enum" : [ "IPPROTO_TCP", "IPPROTO_UDP" ],
                    "default" : "IPPROTO_TCP"
                },
                "secondaryAddress" : {
                    "description" : "Secondary Server Address of the syslog server",
                    "type" : "string"
                },
                "secondaryPort" : {
                    "description" : "Secondary Server Port of the syslog server",
                    "type" : "integer",
                    "default" : 514,
                    "minimum" : 1,
                    "maximum" : 65535
                },
                "secondaryProtocol" : {
                    "description" : "Secondary Server Protocol of the syslog server",
                    "type" : "string",
                    "enum" : [ "IPPROTO_TCP", "IPPROTO_UDP" ],
                    "default" : "IPPROTO_TCP"
                },
                "facility" : {
                    "description" : "Facility of the syslog server",
                    "type" : "string",
                    "enum" : [ "Keep_Original", "Local0", "Local1", "Local2", "Local3", "Local4", "Local5", "Local6", "Local7" ],
                    "default" : "Keep_Original"
                },
                "priority" : {
                    "description" : "Priority of the log messages",
                    "type" : "string",
                    "enum" : [ "Emergency", "Alert", "Critical", "Error", "Warning", "Notice", "Info", "All" ],
                    "default" : "Error"
                }
            }
        },
        "smartMonitor" : {
            "description" : "Smart monitor configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "intervalInSec" : {
                    "description" : "Interval in seconds. This is required if smartMonitor is enabled",
                    "type" : "integer",
                    "default" : 10,
                    "minimum" : 5,
                    "maximum" : 60
                },
                "retryThreshold" : {
                    "description" : "Retry threshold. This is required if smartMonitor is enabled",
                    "type" : "integer",
                    "default" : 3,
                    "minimum" : 1,
                    "maximum" : 10
                }
            }
        },
        "clientAdmissionControl24" : {
            "description" : "AP client admission control 2.4GHz radio configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "maxRadioLoadPercent" : {
                    "description" : "Maximum radio load percentage.",
                    "type" : "integer",
                    "default" : 75,
                    "minimum" : 50,
                    "maximum" : 100
                },
                "minClientCount" : {
                    "description" : "Minimum client count number.",
                    "type" : "integer",
                    "default" : 10,
                    "minimum" : 0,
                    "maximum" : 100
                },
                "minClientThroughputMbps" : {
                    "description" : "Minimum client throughput in Mbps.",
                    "type" : "number",
                    "default" : 0,
                    "minimum" : 0,
                    "maximum" : 100
                }
            }
        },
        "clientAdmissionControl50" : {
            "description" : "AP client admission control 5GHz radio configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "maxRadioLoadPercent" : {
                    "description" : "Maximum radio load percentage.",
                    "type" : "integer",
                    "default" : 75,
                    "minimum" : 50,
                    "maximum" : 100
                },
                "minClientCount" : {
                    "description" : "Minimum client count number.",
                    "type" : "integer",
                    "default" : 10,
                    "minimum" : 0,
                    "maximum" : 100
                },
                "minClientThroughputMbps" : {
                    "description" : "Minimum client throughput in Mbps.",
                    "type" : "number",
                    "default" : 0,
                    "minimum" : 0,
                    "maximum" : 100
                }
            }
        },
        "tunnelType" : {
            "description" : "Tunnel type configuration of the zone. No_Tunneled is for IPv6 mode",
            "type" : "string",
            "enum" : [ "No_Tunneled", "RuckusGRE", "SoftGRE", "SoftGREIpsec" ],
            "default" : "RuckusGRE"
        },
        "tunnelProfile" : {
            "description" : "Tunnel type configuration of the zone.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "loadBalancing" : {
            "description" : "Load Balancing configuration of the zone",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "loadBalancingMethod" : {
                    "type" : "string",
                    "enum" : [ "BASED_ON_CLIENT_COUNT", "BASED_ON_CAPACITY", "OFF" ],
                    "default" : "BASED_ON_CLIENT_COUNT"
                },
                "bandBalancing" : {
                    "description" : "Band Balancing configuration of the zone.",
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "wifi24Percentage" : {
                            "description" : "Percentage of client load on 2.4GHz radio band",
                            "type" : "integer",
                            "minimum" : 0,
                            "maximum" : 100,
                            "default" : 25
                        }
                    }
                },
                "steeringMode" : {
                    "description" : "Steering Mode: BASIC-Withholds probe and authentication responses at connetcion time in heavily loaded band to balance clients to the other band, PROACTIVE-Uses BASIC functionality and actively rebalances clients via 802.11v BTM, STRICT-Uses PROACTIVE functionality and forcefully rebalances clients via 802.11v BTM",
                    "type" : "string",
                    "enum" : [ "BASIC", "PROACTIVE", "STRICT" ],
                    "default" : "BASIC"
                }
            }
        },
        "rogue" : {
            "description" : "Rogue AP detection configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "reportType" : {
                    "description" : "Report type",
                    "type" : "string",
                    "enum" : [ "All", "Malicious" ]
                },
                "maliciousTypes" : {
                    "description" : "Malicious type when reportType is Malicious",
                    "type" : [ "array", "null" ],
                    "items" : {
                        "type" : "string",
                        "enum" : [ "SSIDSpoofing", "SameNetwork", "MACSpoofing" ]
                    }
                },
                "protectionEnabled" : {
                    "description" : "Protection enabled",
                    "type" : "boolean"
                }
            }
        },
        "dosBarringEnable" : {
            "description" : "Enable DoS Protection(Barring UE) of the zone.",
            "type" : "integer"
        },
        "dosBarringPeriod" : {
            "description" : "DoS Protection(Barring UE) blocking period of the zone.",
            "type" : "integer"
        },
        "dosBarringThreshold" : {
            "description" : "DoS Protection(Barring UE) threshold of the zone.",
            "type" : "integer"
        },
        "dosBarringCheckPeriod" : {
            "description" : "DoS Protection(Barring UE) check period of the zone.",
            "type" : "integer"
        },
        "locationBasedService" : {
            "description" : "Location based service configuration of the zone.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "apRebootTimeout" : {
            "description" : "AP reboot timeout of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "gatewayLossTimeoutInSec" : {
                    "description" : "Gateway loss timeout in second",
                    "type" : "integer",
                    "enum" : [ 0, 1800, 3600, 5400, 7200, 9000, 10800, 12600, 14400, 16200, 18000, 19800, 23400, 25200, 27000, 28800, 30600, 32400, 34200, 36000, 37800, 39600, 41400, 43200, 45000, 46800, 48600, 50400, 52200, 54000, 55800, 57600, 59400, 61200, 63000, 64800, 66600, 68400, 70200, 72000, 73800, 75600, 77400, 79200, 81000, 82800, 84600, 86400 ],
                    "default" : 1800
                },
                "serverLossTimeoutInSec" : {
                    "description" : "Server loss timeout in second",
                    "type" : "integer",
                    "enum" : [ 0, 7200, 14400, 21600, 28800, 36000, 43200, 50400, 57600, 64800, 72000, 79200, 86400 ],
                    "default" : 7200
                }
            }
        },
        "location" : {
            "description" : "Location of the Zone.",
            "type" : "string"
        },
        "locationAdditionalInfo" : {
            "description" : "Location additional info of the zone.",
            "type" : "string"
        },
        "altitude" : {
            "description" : "GPS Altitude",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "altitudeUnit" : {
                    "description" : "altitude unit",
                    "type" : "string",
                    "enum" : [ "meters", "floor" ],
                    "default" : "meters"
                },
                "altitudeValue" : {
                    "description" : "altitude value",
                    "type" : "integer"
                }
            }
        },
        "latitude" : {
            "description" : "Latitude coordinate (in decimal format) of the zone",
            "type" : "number"
        },
        "longitude" : {
            "description" : "Longitude coordinate (in decimal format) of the zone",
            "type" : "number"
        },
        "vlanOverlappingEnabled" : {
            "description" : "VLAN pooling overlapping of the zone",
            "type" : "boolean"
        },
        "nodeAffinityProfile" : {
            "description" : "Node affinity profile of the zone.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "venueProfile" : {
            "description" : "venue profile configuration of the Zone.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "channelEvaluationInterval" : {
            "description" : "channel evaluation Interval of the zone",
            "type" : "integer",
            "default" : 600,
            "minimum" : 60,
            "maximum" : 3600
        },
        "apMgmtVlan" : {
            "description" : "ap Management Vlan of the zone",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "mode" : {
                    "description" : "Vlan Mode of the zone",
                    "type" : "string",
                    "enum" : [ "KEEP", "USER_DEFINED" ],
                    "default" : "KEEP"
                },
                "id" : {
                    "description" : "Vlan id of the zone",
                    "type" : "integer",
                    "default" : "1"
                }
            }
        },
        "apLatencyInterval" : {
            "description" : "AP latency interval",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "pingEnabled" : {
                    "description" : "AP ping latency enabled",
                    "type" : "boolean",
                    "default" : true
                }
            }
        },
        "ipsecProfile" : {
            "description" : "ipsec profile configuration of the Zone.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "ipv6TrafficFilterEnabled" : {
            "description" : "IPv6 Traffic filtering on the AP",
            "type" : "integer"
        },
        "restrictedApAccessEnabled" : {
            "description" : "Enable Restricted AP Access of the zone.",
            "type" : "boolean"
        },
        "restrictedApAccessProfileId" : {
            "description" : "Restricted AP Access Profile Id of the zone.",
            "type" : "string"
        },
        "bonjourFencingPolicyEnabled" : {
            "description" : "Enable Bonjour Fencing Policy on the AP",
            "type" : "boolean"
        },
        "bonjourFencingPolicy" : {
            "description" : "Bonjour Fencing Policy on the AP",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "dhcpSiteConfig" : {
            "description" : "DHCP Site Config in Zone",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "siteEnabled" : {
                    "description" : "DHCP Service Enabling Status",
                    "type" : "boolean"
                },
                "portSelectionEnabled" : {
                    "description" : "DHCP Port Selection Enabled",
                    "type" : "boolean"
                },
                "dwpdEnabled" : {
                    "description" : "DHCP Service Dynamic WAN Port Detection",
                    "type" : "boolean"
                },
                "manualSelect" : {
                    "description" : "DHCP Service AP Selection Mode. This value is effective when the siteMode is EnableOnMultipleAPs.",
                    "type" : "boolean"
                },
                "siteMode" : {
                    "description" : "DHCP Service mode",
                    "type" : "string",
                    "enum" : [ "EnableOnEachAPs", "EnableOnMultipleAPs", "EnableOnHierarchicalAPs" ]
                },
                "eth0ProfileId" : {
                    "type" : "integer"
                },
                "eth1ProfileId" : {
                    "type" : "integer"
                },
                "siteAps" : {
                    "type" : "array",
                    "items" : {
                        "type" : "object",
                        "description" : "DHCP Site selected APs. The content is effective when the siteMode is EnableOnMultipleAPs.",
                        "additionalProperties" : false,
                        "properties" : {
                            "apMac" : {
                                "type" : "string"
                            },
                            "apName" : {
                                "type" : "string"
                            },
                            "apStatus" : {
                                "type" : "string",
                                "enum" : [ "Online", "Offline", "Flagged" ]
                            },
                            "apServerEnabled" : {
                                "type" : "boolean"
                            },
                            "apServerPrimary" : {
                                "type" : "boolean"
                            },
                            "apServerIp" : {
                                "type" : [ "string", "null" ]
                            },
                            "apGatewayIp" : {
                                "type" : "string"
                            },
                            "apServerType" : {
                                "type" : "string"
                            }
                        }
                    }
                },
                "siteProfileIds" : {
                    "type" : "array",
                    "items" : {
                        "type" : "string"
                    }
                }
            }
        },
        "snmpAgent" : {
            "description" : "AP SNMP Options",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "apSnmpEnabled" : {
                    "description" : "Enable AP SNMP",
                    "type" : "boolean"
                },
                "snmpConfigType" : {
                    "description" : "The config type of SNMP",
                    "type" : "string",
                    "enum" : [ "CUSTOM", "AP_SNMP_AGENT_PROFILE" ],
                    "default" : "CUSTOM"
                },
                "apSnmpAgentProfileId" : {
                    "type" : "string"
                },
                "snmpV2Agent" : {
                    "description" : "Community List of the SNMP V2 Agent.",
                    "type" : "array",
                    "items" : {
                        "type" : "object",
                        "additionalProperties" : false,
                        "properties" : {
                            "communityName" : {
                                "description" : "name of the SNMP Community.",
                                "type" : "string"
                            },
                            "readEnabled" : {
                                "description" : "read privilege of the SNMP Coummunity",
                                "type" : "boolean"
                            },
                            "writeEnabled" : {
                                "description" : "write privilege of the SNMP Coummunity",
                                "type" : "boolean"
                            },
                            "notificationEnabled" : {
                                "description" : "notification privilege of the SNMP Coummunity",
                                "type" : "boolean"
                            },
                            "notificationType" : {
                                "description" : "type of the notification privilege",
                                "type" : "string",
                                "enum" : [ "TRAP", "INFORM" ]
                            },
                            "notificationTarget" : {
                                "description" : "Trap List of the SNMP Coummunity",
                                "type" : "array",
                                "items" : {
                                    "type" : "object",
                                    "additionalProperties" : false,
                                    "properties" : {
                                        "address" : {
                                            "description" : "address of the SNMP Trap",
                                            "type" : "string"
                                        },
                                        "port" : {
                                            "description" : "port number of the SNMP Trap",
                                            "type" : "integer",
                                            "minimum" : 1,
                                            "maximum" : 65535
                                        }
                                    },
                                    "required" : [ "address", "port" ]
                                }
                            }
                        },
                        "required" : [ "communityName", "readEnabled", "writeEnabled", "notificationEnabled" ]
                    }
                },
                "snmpV3Agent" : {
                    "description" : "User List of the SNMP V3 Agent.",
                    "type" : "array",
                    "items" : {
                        "type" : "object",
                        "additionalProperties" : false,
                        "properties" : {
                            "userName" : {
                                "description" : "name of the SNMP User.",
                                "type" : "string"
                            },
                            "authProtocol" : {
                                "description" : "authProtocol of the SNMP User.",
                                "type" : "string",
                                "enum" : [ "NONE", "MD5", "SHA" ]
                            },
                            "authPassword" : {
                                "description" : "authPassword of the SNMP User.",
                                "type" : "string",
                                "minLength" : 8
                            },
                            "privProtocol" : {
                                "description" : "privProtocol of the SNMP User.",
                                "type" : "string",
                                "enum" : [ "NONE", "DES", "AES" ]
                            },
                            "privPassword" : {
                                "description" : "privPassword of the SNMP User.",
                                "type" : "string",
                                "minLength" : 8
                            },
                            "readEnabled" : {
                                "description" : "read privilege of the SNMP User",
                                "type" : "boolean"
                            },
                            "writeEnabled" : {
                                "description" : "write privilege of the SNMP User",
                                "type" : "boolean"
                            },
                            "notificationEnabled" : {
                                "description" : "notification privilege of the SNMP User",
                                "type" : "boolean"
                            },
                            "notificationType" : {
                                "description" : "type of the notification privilege",
                                "type" : "string",
                                "enum" : [ "TRAP", "INFORM" ]
                            },
                            "notificationTarget" : {
                                "description" : "Trap List of the SNMP User",
                                "type" : "array",
                                "items" : {
                                    "type" : "object",
                                    "additionalProperties" : false,
                                    "properties" : {
                                        "address" : {
                                            "description" : "address of the SNMP Trap",
                                            "type" : "string"
                                        },
                                        "port" : {
                                            "description" : "port number of the SNMP Trap",
                                            "type" : "integer",
                                            "minimum" : 1,
                                            "maximum" : 65535
                                        }
                                    },
                                    "required" : [ "address", "port" ]
                                }
                            }
                        },
                        "required" : [ "userName", "readEnabled", "writeEnabled", "notificationEnabled" ]
                    }
                }
            }
        },
        "recoverySsid" : {
            "description" : "Recovery SSID",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "recoverySsidPskKey" : {
                    "description" : "Custom recovery ssid passphrase. If passphrase has been customized, this property cannot be empty in the future. ",
                    "type" : "string"
                },
                "recoverySsidEnabled" : {
                    "description" : "recovery ssid enable/disable",
                    "type" : "boolean"
                }
            }
        },
        "clusterRedundancyEnabled" : {
            "description" : "Enable Cluster redundancy on zone",
            "type" : "boolean"
        },
        "rogueApReportThreshold" : {
            "description" : "Rogue AP report will leave out all entries that have signal strength lower than this threshold.",
            "type" : "integer"
        },
        "rogueApAggressivenessMode" : {
            "description" : "Adjust the frequency interval to de-authenticate rogue APs.",
            "type" : "integer"
        },
        "rogueApJammingDetection" : {
            "description" : "Enable jamming detection.",
            "type" : "boolean"
        },
        "rogueApJammingThreshold" : {
            "type" : "integer"
        },
        "directedMulticastFromWiredClientEnabled" : {
            "description" : "Directed multicast from wired client.",
            "type" : "boolean"
        },
        "directedMulticastFromWirelessClientEnabled" : {
            "description" : "Directed multicast from wireless client.",
            "type" : "boolean"
        },
        "directedMulticastFromNetworkEnabled" : {
            "description" : "Directed multicast from network.",
            "type" : "boolean"
        },
        "healthCheckSitesEnabled" : {
            "description" : "Enabled Health Check Sites. ",
            "type" : "boolean",
            "default" : false
        },
        "healthCheckSites" : {
            "description" : "Health Check Sites.",
            "type" : "array",
            "items" : {
                "type" : "string"
            }
        },
        "ruckusGreTunnelProfile" : {
            "description" : "Ruckus GRE Profile for Multiple Tunnel (Start from SZ 5.0)",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "softGreTunnelProflies" : {
            "description" : "SoftGRE Profiles for Multiple Tunnel (Start from SZ 5.0)",
            "type" : "array",
            "items" : {
                "type" : [ "object", "null" ],
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "type" : "string"
                    },
                    "name" : {
                        "type" : "string"
                    },
                    "aaaAffinityEnabled" : {
                        "type" : "boolean"
                    }
                }
            }
        },
        "ipsecProfiles" : {
            "description" : "Ipsec profile for Multiple Tunnel (Start from SZ 5.0)",
            "type" : "array",
            "items" : {
                "type" : [ "object", "null" ],
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "type" : "string"
                    },
                    "name" : {
                        "type" : "string"
                    }
                }
            }
        },
        "ipsecTunnelMode" : {
            "type" : "string",
            "enum" : [ "DISABLE", "SOFT_GRE", "RUCKUS_GRE" ]
        },
        "rksGreForwardBroadcast" : {
            "description" : "Ruckus GRE tunnel broadcast packet forwarding",
            "type" : "boolean",
            "default" : false
        },
        "sshTunnelEncryption" : {
            "type" : "string",
            "enum" : [ "AES128", "AES256" ]
        },
        "lteBandLockChannels" : {
            "description" : "LTE band lock channels options",
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "simCardId" : {
                        "description" : "SIM card ID(Primary:0, Secondary:1)",
                        "type" : "integer"
                    },
                    "type" : {
                        "description" : "LTE chipset SKU type",
                        "type" : "string"
                    },
                    "channel4g" : {
                        "description" : "LTE 4G channels",
                        "type" : "string"
                    },
                    "channel3g" : {
                        "description" : "LTE 3G channels",
                        "type" : "string"
                    }
                }
            }
        },
        "paloAltoFirewallProfileId" : {
            "type" : "string"
        },
        "apHccdEnabled" : {
            "description" : "Historical Connection Failures allows the AP to report historical client connection failures for this zone.",
            "type" : "boolean",
            "default" : false
        },
        "apHccdPersist" : {
            "description" : "Allow Historical Connection Failures to be persisted.",
            "type" : "boolean",
            "default" : true
        },
        "aaaAffinityEnabled" : {
            "type" : "boolean"
        },
        "awsVenue" : {
            "description" : "Venue Code",
            "type" : "string",
            "minLength" : 0,
            "maxLength" : 64,
            "pattern" : "^[!-~]{0,63}[!-~]$|^$"
        },
        "dpGroupId" : {
            "description" : "DP Group ID",
            "type" : "string"
        },
        "enforcePriorityDpGroupEnable" : {
            "type" : "boolean"
        },
        "myRuckusConfig" : {
            "description" : "My.Ruckus configuration",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "aclForTunnelWlanAndVlanEnable" : {
                    "description" : "My.Ruckus support for tunnel-wlan/vlan",
                    "type" : "boolean"
                }
            },
            "required" : [ "aclForTunnelWlanAndVlanEnable" ]
        },
        "apHttp2CertChkEnable" : {
            "type" : "boolean"
        },
        "bssColoringEnable" : {
            "description" : "BSS coloring mechanism enabled.",
            "type" : "boolean"
        },
        "radioConfig" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "radio24g" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "autoCellSizing" : {
                            "type" : "boolean"
                        },
                        "txPower" : {
                            "type" : "string",
                            "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
                            "default" : "Full"
                        },
                        "channelWidth" : {
                            "type" : "integer",
                            "enum" : [ 0, 20, 40 ],
                            "default" : 0
                        },
                        "channel" : {
                            "type" : "integer"
                        },
                        "channelRange" : {
                            "type" : "array",
                            "items" : {
                                "type" : "integer"
                            }
                        },
                        "availableChannelRange" : {
                            "type" : "array",
                            "items" : {
                                "type" : "integer"
                            }
                        },
                        "wlanGroupId" : {
                            "type" : "string"
                        },
                        "wlanServiceEnabled" : {
                            "type" : "boolean"
                        },
                        "protectionMode" : {
                            "type" : "string",
                            "enum" : [ "NONE", "CTS_ONLY", "RTS_CTS" ],
                            "default" : "RTS_CTS"
                        },
                        "backgroundScanning" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "frequencyInSec" : {
                                    "type" : "integer",
                                    "minimum" : 1,
                                    "maximum" : 65535,
                                    "default" : 20
                                }
                            },
                            "required" : [ "frequencyInSec" ]
                        },
                        "autoChannelSelection" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "channelSelectMode" : {
                                    "type" : "string",
                                    "enum" : [ "None", "BackgroundScanning", "ChannelFly" ],
                                    "default" : "BackgroundScanning"
                                },
                                "channelFlyMtbc" : {
                                    "type" : "integer",
                                    "default" : 480,
                                    "minimum" : 100,
                                    "maximum" : 1440
                                },
                                "channelFlyChangeFrequency" : {
                                    "type" : "integer",
                                    "default" : 33,
                                    "minimum" : 1,
                                    "maximum" : 100
                                },
                                "channelFlyOptimizationTimePeriod" : {
                                    "type" : "array",
                                    "items" : {
                                        "type" : "string",
                                        "pattern" : "^([0-1][0-9]|2[0-3]):00-(([0-1][0-9]|2[0-4]):00)$"
                                    }
                                }
                            }
                        }
                    }
                },
                "radio5g" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "autoCellSizing" : {
                            "type" : "boolean"
                        },
                        "txPower" : {
                            "type" : "string",
                            "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
                            "default" : "Full"
                        },
                        "channelWidth" : {
                            "type" : "integer",
                            "enum" : [ 0, 20, 40, 80, 8080, 160 ],
                            "default" : 0
                        },
                        "channel" : {
                            "type" : "integer"
                        },
                        "channelIndoor" : {
                            "type" : "integer"
                        },
                        "secondaryChannel" : {
                            "type" : "integer"
                        },
                        "secondaryChannelIndoor" : {
                            "type" : "integer"
                        },
                        "channelRange" : {
                            "type" : "array",
                            "items" : {
                                "type" : "integer"
                            }
                        },
                        "channelRangeIndoor" : {
                            "type" : "array",
                            "items" : {
                                "type" : "integer"
                            }
                        },
                        "dfsChannelEnabled" : {
                            "type" : "boolean"
                        },
                        "cbandChannelEnabled" : {
                            "type" : "boolean"
                        },
                        "cbandChannelLicenseEnabled" : {
                            "type" : "boolean"
                        },
                        "channel144Enabled" : {
                            "type" : "boolean"
                        },
                        "channelModeEnabled" : {
                            "type" : "boolean"
                        },
                        "availableChannelRange" : {
                            "type" : "array",
                            "items" : {
                                "type" : "integer"
                            }
                        },
                        "availableChannelRangeIndoor" : {
                            "type" : "array",
                            "items" : {
                                "type" : "integer"
                            }
                        },
                        "wlanGroupId" : {
                            "type" : "string"
                        },
                        "protectionMode" : {
                            "type" : "string",
                            "enum" : [ "NONE", "CTS_ONLY", "RTS_CTS" ],
                            "default" : "RTS_CTS"
                        },
                        "backgroundScanning" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "frequencyInSec" : {
                                    "type" : "integer",
                                    "minimum" : 1,
                                    "maximum" : 65535,
                                    "default" : 20
                                }
                            },
                            "required" : [ "frequencyInSec" ]
                        },
                        "autoChannelSelection" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "channelSelectMode" : {
                                    "type" : "string",
                                    "enum" : [ "None", "BackgroundScanning", "ChannelFly" ],
                                    "default" : "BackgroundScanning"
                                },
                                "channelFlyMtbc" : {
                                    "type" : "integer",
                                    "default" : 480,
                                    "minimum" : 100,
                                    "maximum" : 1440
                                },
                                "channelFlyChangeFrequency" : {
                                    "type" : "integer",
                                    "default" : 33,
                                    "minimum" : 1,
                                    "maximum" : 100
                                },
                                "channelFlyOptimizationTimePeriod" : {
                                    "type" : "array",
                                    "items" : {
                                        "type" : "string",
                                        "pattern" : "^([0-1][0-9]|2[0-3]):00-(([0-1][0-9]|2[0-4]):00)$"
                                    }
                                }
                            }
                        }
                    }
                },
                "radio5gUpper" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "autoCellSizing" : {
                            "type" : "boolean"
                        },
                        "txPower" : {
                            "type" : "string",
                            "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
                            "default" : "Full"
                        },
                        "channelWidth" : {
                            "type" : "integer",
                            "enum" : [ 0, 20, 40, 80, 8080, 160 ],
                            "default" : 0
                        },
                        "channel" : {
                            "type" : "integer"
                        },
                        "channelIndoor" : {
                            "type" : "integer"
                        },
                        "secondaryChannel" : {
                            "type" : "integer"
                        },
                        "secondaryChannelIndoor" : {
                            "type" : "integer"
                        },
                        "channelRange" : {
                            "type" : "array",
                            "items" : {
                                "type" : "integer"
                            }
                        },
                        "channelRangeIndoor" : {
                            "type" : "array",
                            "items" : {
                                "type" : "integer"
                            }
                        },
                        "dfsChannelEnabled" : {
                            "type" : "boolean"
                        },
                        "cbandChannelEnabled" : {
                            "type" : "boolean"
                        },
                        "cbandChannelLicenseEnabled" : {
                            "type" : "boolean"
                        },
                        "channel144Enabled" : {
                            "type" : "boolean"
                        },
                        "channelModeEnabled" : {
                            "type" : "boolean"
                        },
                        "availableChannelRange" : {
                            "type" : "array",
                            "items" : {
                                "type" : "integer"
                            }
                        },
                        "availableChannelRangeIndoor" : {
                            "type" : "array",
                            "items" : {
                                "type" : "integer"
                            }
                        },
                        "wlanGroupId" : {
                            "type" : "string"
                        },
                        "protectionMode" : {
                            "type" : "string",
                            "enum" : [ "NONE", "CTS_ONLY", "RTS_CTS" ],
                            "default" : "RTS_CTS"
                        },
                        "backgroundScanning" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "frequencyInSec" : {
                                    "type" : "integer",
                                    "minimum" : 1,
                                    "maximum" : 65535,
                                    "default" : 20
                                }
                            },
                            "required" : [ "frequencyInSec" ]
                        },
                        "autoChannelSelection" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "channelSelectMode" : {
                                    "type" : "string",
                                    "enum" : [ "None", "BackgroundScanning", "ChannelFly" ],
                                    "default" : "BackgroundScanning"
                                },
                                "channelFlyMtbc" : {
                                    "type" : "integer",
                                    "default" : 480,
                                    "minimum" : 100,
                                    "maximum" : 1440
                                },
                                "channelFlyChangeFrequency" : {
                                    "type" : "integer",
                                    "default" : 33,
                                    "minimum" : 1,
                                    "maximum" : 100
                                },
                                "channelFlyOptimizationTimePeriod" : {
                                    "type" : "array",
                                    "items" : {
                                        "type" : "string",
                                        "pattern" : "^([0-1][0-9]|2[0-3]):00-(([0-1][0-9]|2[0-4]):00)$"
                                    }
                                }
                            }
                        }
                    }
                },
                "radio5gLower" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "autoCellSizing" : {
                            "type" : "boolean"
                        },
                        "txPower" : {
                            "type" : "string",
                            "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
                            "default" : "Full"
                        },
                        "channelWidth" : {
                            "type" : "integer",
                            "enum" : [ 0, 20, 40, 80, 8080, 160 ],
                            "default" : 0
                        },
                        "channel" : {
                            "type" : "integer"
                        },
                        "channelIndoor" : {
                            "type" : "integer"
                        },
                        "secondaryChannel" : {
                            "type" : "integer"
                        },
                        "secondaryChannelIndoor" : {
                            "type" : "integer"
                        },
                        "channelRange" : {
                            "type" : "array",
                            "items" : {
                                "type" : "integer"
                            }
                        },
                        "channelRangeIndoor" : {
                            "type" : "array",
                            "items" : {
                                "type" : "integer"
                            }
                        },
                        "dfsChannelEnabled" : {
                            "type" : "boolean"
                        },
                        "cbandChannelEnabled" : {
                            "type" : "boolean"
                        },
                        "cbandChannelLicenseEnabled" : {
                            "type" : "boolean"
                        },
                        "channel144Enabled" : {
                            "type" : "boolean"
                        },
                        "channelModeEnabled" : {
                            "type" : "boolean"
                        },
                        "availableChannelRange" : {
                            "type" : "array",
                            "items" : {
                                "type" : "integer"
                            }
                        },
                        "availableChannelRangeIndoor" : {
                            "type" : "array",
                            "items" : {
                                "type" : "integer"
                            }
                        },
                        "wlanGroupId" : {
                            "type" : "string"
                        },
                        "protectionMode" : {
                            "type" : "string",
                            "enum" : [ "NONE", "CTS_ONLY", "RTS_CTS" ],
                            "default" : "RTS_CTS"
                        },
                        "backgroundScanning" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "frequencyInSec" : {
                                    "type" : "integer",
                                    "minimum" : 1,
                                    "maximum" : 65535,
                                    "default" : 20
                                }
                            },
                            "required" : [ "frequencyInSec" ]
                        },
                        "autoChannelSelection" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "channelSelectMode" : {
                                    "type" : "string",
                                    "enum" : [ "None", "BackgroundScanning", "ChannelFly" ],
                                    "default" : "BackgroundScanning"
                                },
                                "channelFlyMtbc" : {
                                    "type" : "integer",
                                    "default" : 480,
                                    "minimum" : 100,
                                    "maximum" : 1440
                                },
                                "channelFlyChangeFrequency" : {
                                    "type" : "integer",
                                    "default" : 33,
                                    "minimum" : 1,
                                    "maximum" : 100
                                },
                                "channelFlyOptimizationTimePeriod" : {
                                    "type" : "array",
                                    "items" : {
                                        "type" : "string",
                                        "pattern" : "^([0-1][0-9]|2[0-3]):00-(([0-1][0-9]|2[0-4]):00)$"
                                    }
                                }
                            }
                        }
                    }
                },
                "radio6g" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "autoCellSizing" : {
                            "type" : "boolean"
                        },
                        "txPower" : {
                            "type" : "string",
                            "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
                            "default" : "Full"
                        },
                        "channelWidth" : {
                            "type" : "integer",
                            "enum" : [ 0, 20, 40, 80, 8080, 160 ],
                            "default" : 0
                        },
                        "channel" : {
                            "type" : "integer"
                        },
                        "channelRange" : {
                            "type" : "array",
                            "items" : {
                                "type" : "integer"
                            }
                        },
                        "lowPowerIndoorModeEnabled" : {
                            "type" : "boolean"
                        },
                        "availableChannelRange" : {
                            "type" : "array",
                            "items" : {
                                "type" : "integer"
                            }
                        },
                        "wlanGroupId" : {
                            "type" : "string"
                        },
                        "wlanServiceEnabled" : {
                            "type" : "boolean"
                        },
                        "protectionMode" : {
                            "type" : "string",
                            "enum" : [ "NONE", "CTS_ONLY", "RTS_CTS" ],
                            "default" : "RTS_CTS"
                        },
                        "backgroundScanning" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "frequencyInSec" : {
                                    "type" : "integer",
                                    "minimum" : 1,
                                    "maximum" : 65535,
                                    "default" : 20
                                }
                            },
                            "required" : [ "frequencyInSec" ]
                        },
                        "autoChannelSelection" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "channelSelectMode" : {
                                    "type" : "string",
                                    "enum" : [ "None", "BackgroundScanning", "ChannelFly" ],
                                    "default" : "BackgroundScanning"
                                },
                                "channelFlyMtbc" : {
                                    "type" : "integer",
                                    "default" : 480,
                                    "minimum" : 100,
                                    "maximum" : 1440
                                },
                                "channelFlyChangeFrequency" : {
                                    "type" : "integer",
                                    "default" : 33,
                                    "minimum" : 1,
                                    "maximum" : 100
                                },
                                "channelFlyOptimizationTimePeriod" : {
                                    "type" : "array",
                                    "items" : {
                                        "type" : "string",
                                        "pattern" : "^([0-1][0-9]|2[0-3]):00-(([0-1][0-9]|2[0-4]):00)$"
                                    }
                                }
                            }
                        }
                    }
                },
                "dual5gEnabled" : {
                    "type" : "boolean"
                }
            }
        }
    }
}

Create Zone of IPv6

POST/v11_0/rkszones/ipv6

Use this API command to create a new Ruckus Wireless AP zone of IPv6.

Request
HideShow
Body
{
  "domainId": "domainUUID",
  "dpGroupProfileId": "3fd9aa91-df65-11e7-98e1-08002748d78e",
  "enforcePriorityDpGroupEnable": false,
  "name": "zoneName",
  "description": "description Zone",
  "version": "3.0.0.0.145",
  "countryCode": "US",
  "timezone": {
    "systemTimezone": "UTC",
    "customizedTimezone": null
  },
  "login": {
    "apLoginName": "apLoginName",
    "apLoginPassword": "apLoginPassword"
  },
  "mesh": {
    "ssid": "meshSSID"
  },
  "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": "keep_Original",
    "priority": "Error"
  },
  "smartMonitor": {
    "intervalInSec": 10,
    "retryThreshold": 3
  },
  "clientAdmissionControl24": {
    "maxRadioLoadPercent": 75,
    "minClientCount": "10",
    "minClientThroughputMbps": 0
  },
  "clientAdmissionControl50": {
    "maxRadioLoadPercent": 75,
    "minClientCount": "10",
    "minClientThroughputMbps": 0
  },
  "channelModeEnabled": false,
  "tunnelType": "RuckusGRE",
  "tunnelProfile": {
    "id": "tunnelProfileId",
    "name": "tunnelProfileName"
  },
  "aaaAffinityEnabled": false,
  "backgroundScanning24": {
    "frequencyInSec": 20
  },
  "backgroundScanning50": {
    "frequencyInSec": 20
  },
  "loadBalancing": {
    "loadBalancingMethod": "BASED_ON_CLIENT_COUNT",
    "clientLoadBalancing24": {
      "adjacentRadioThreshold": 12
    },
    "clientLoadBalancing50": {
      "adjacentRadioThreshold": 12
    },
    "bandBalancing": {
      "wifi24Percentage": 10
    },
    "steeringMode": "BASIC"
  },
  "rogue": {
    "reportType": "All",
    "maliciousTypes": null,
    "protectionEnabled": true
  },
  "dosBarringEnable": 0,
  "dosBarringPeriod": 60,
  "dosBarringThreshold": 5,
  "dosBarringCheckPeriod": 30,
  "locationBasedService": {
    "id": "lbsId",
    "name": "lbsName"
  },
  "apRebootTimeout": {
    "gatewayLossTimeoutInSec": 1800,
    "serverLossTimeoutInSec": 7200
  },
  "location": "location",
  "locationAdditionalInfo": "locationAdditionalInfo",
  "latitude": 23,
  "longitude": 23,
  "vlanOverlappingEnabled": false,
  "nodeAffinityProfile": {
    "id": "nodeAffinityProfileId",
    "name": "nodeAffinityProfileName"
  },
  "venueProfile": {
    "id": "venueProfileId",
    "name": "venueProfileName"
  },
  "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": true,
  "bonjourFencingPolicy": {
    "id": "bonjourFencingPolicyId",
    "name": "bonjourFencingPolicyName"
  },
  "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"
  ],
  "rkusGreTunnelProfile": {
    "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"
    }
  ],
  "lteBandLockChannels": [
    {
      "simCardId": 0,
      "lteRadioChannels": [
        {
          "type": "EC25E",
          "channel4g": [
            "B1",
            "B3",
            "B5"
          ],
          "channel3g": [
            "B5"
          ]
        }
      ]
    },
    {
      "simCardId": 1,
      "lteRadioChannels": [
        {
          "type": "EC25E",
          "channel4g": [],
          "channel3g": []
        }
      ]
    }
  ],
  "paloAltoFirewallProfileId": "2f59b0f4-c86f-11e8-a8d5-f2801f1b9fd1",
  "apHccdEnabled": true,
  "apHccdPersist": true
}
Schema
{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "domainId" : {
            "description" : "Identifier of the management domain to which the zone belongs",
            "type" : "string"
        },
        "dpGroupId" : {
            "description" : "DP Group ID",
            "type" : "string"
        },
        "enforcePriorityDpGroupEnable" : {
            "description" : "Enable to enforce priority of DP Group",
            "type" : "boolean"
        },
        "name" : {
            "description" : "Name of the zone",
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 32,
            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$"
        },
        "description" : {
            "description" : "Description of the zone",
            "type" : [ "string", "null" ],
            "maxLength" : 64
        },
        "version" : {
            "description" : "AP firmware version of the zone",
            "type" : "string",
            "pattern" : "^\d+\.\d+\.\d+\.\d+\.\d+$"
        },
        "countryCode" : {
            "description" : "Country code of the zone",
            "type" : "string"
        },
        "login" : {
            "description" : "AP administrator account",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "apLoginName" : {
                    "description" : "User name of the AP administrator",
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : "^((?!\$\()[!-_a-~]){1,64}$"
                },
                "apLoginPassword" : {
                    "description" : "Password of the AP administrator",
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : ".*(?=.{8,})(?=.*[a-zA-Z])(?=.*[0-9])(?=.*[_`[email protected]#$%^&*\(\)\[\]\{\}|;:'\",.\<>\/?=+-]).*"
                }
            },
            "required" : [ "apLoginName", "apLoginPassword" ]
        },
        "timezone" : {
            "description" : "Either systemTimezone or customizedTimezone must be specified",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "systemTimezone" : {
                    "description" : "System defined time zone, please refer to the 'Overview > Time Zone' list",
                    "type" : "string"
                },
                "customizedTimezone" : {
                    "description" : "User defined time zone",
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "abbreviation" : {
                            "description" : "Time zone abbreviation",
                            "type" : "string",
                            "pattern" : "^[a-zA-Z]{3,4}$"
                        },
                        "gmtOffset" : {
                            "description" : "GMT offset",
                            "type" : "integer",
                            "minimum" : -11,
                            "maximum" : 14
                        },
                        "gmtOffsetMinute" : {
                            "description" : "GMT offset minute",
                            "type" : "integer",
                            "minimum" : 0,
                            "maximum" : 59
                        },
                        "start" : {
                            "description" : "Daylight saving time start",
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "month" : {
                                    "description" : "Month when daylight saving time begins",
                                    "type" : "integer",
                                    "enum" : [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ]
                                },
                                "week" : {
                                    "description" : "Week of the month (1 for the first week, 2 for the second week, and so on)",
                                    "type" : "integer",
                                    "enum" : [ 1, 2, 3, 4, 5 ]
                                },
                                "day" : {
                                    "description" : "Day of the week (0 for Sunday, 1 for Monday, 2 for Tuesday, and so on)",
                                    "type" : "integer",
                                    "enum" : [ 0, 1, 2, 3, 4, 5, 6 ]
                                },
                                "hour" : {
                                    "description" : "Hour of the day",
                                    "type" : "integer",
                                    "minimum" : 0,
                                    "maximum" : 23
                                }
                            },
                            "required" : [ "month", "week", "day", "hour" ]
                        },
                        "end" : {
                            "description" : "Daylight saving time end",
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "month" : {
                                    "description" : "Month when daylight saving time begins",
                                    "type" : "integer",
                                    "enum" : [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ]
                                },
                                "week" : {
                                    "description" : "Week of the month (1 for the first week, 2 for the second week, and so on)",
                                    "type" : "integer",
                                    "enum" : [ 1, 2, 3, 4, 5 ]
                                },
                                "day" : {
                                    "description" : "Day of the week (0 for Sunday, 1 for Monday, 2 for Tuesday, and so on)",
                                    "type" : "integer",
                                    "enum" : [ 0, 1, 2, 3, 4, 5, 6 ]
                                },
                                "hour" : {
                                    "description" : "Hour of the day",
                                    "type" : "integer",
                                    "minimum" : 0,
                                    "maximum" : 23
                                }
                            },
                            "required" : [ "month", "week", "day", "hour" ]
                        }
                    },
                    "required" : [ "abbreviation", "gmtOffset", "gmtOffsetMinute" ]
                }
            }
        },
        "mesh" : {
            "description" : "Mesh configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "ssid" : {
                    "description" : "SSID of the mesh network",
                    "type" : "string"
                },
                "passphrase" : {
                    "description" : "Passphrase for the mesh network. Would be mandatory when the mesh is enabled.",
                    "type" : "string"
                },
                "meshRadioIdx" : {
                    "description" : "Mesh radio index",
                    "type" : "string",
                    "enum" : [ "Radio24G", "Radio5G" ],
                    "default" : "Radio5G"
                },
                "zeroTouchStatus" : {
                    "type" : "boolean"
                }
            }
        },
        "syslog" : {
            "description" : "Syslog configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "syslogConfigType" : {
                    "description" : "Syslog configuration type.",
                    "type" : "string",
                    "enum" : [ "CUSTOM", "AP_SYSLOG_SERVER_PROFILE" ],
                    "default" : "CUSTOM"
                },
                "syslogServerProfileId" : {
                    "description" : "Syslog server profile ID.",
                    "type" : "string"
                },
                "flowLevel" : {
                    "description" : "Flow Level of the syslog",
                    "type" : "string",
                    "enum" : [ "GENERAL_LOGS", "CLIENT_FLOW", "ALL" ],
                    "default" : "GENERAL_LOGS"
                },
                "address" : {
                    "description" : "Address of the syslog server.",
                    "type" : "string"
                },
                "port" : {
                    "description" : "Port number of the syslog server",
                    "type" : "integer",
                    "default" : 514,
                    "minimum" : 1,
                    "maximum" : 65535
                },
                "protocol" : {
                    "description" : "Protocol of the syslog server",
                    "type" : "string",
                    "enum" : [ "IPPROTO_TCP", "IPPROTO_UDP" ],
                    "default" : "IPPROTO_TCP"
                },
                "secondaryAddress" : {
                    "description" : "Secondary Server Address of the syslog server",
                    "type" : "string"
                },
                "secondaryPort" : {
                    "description" : "Secondary Server Port of the syslog server",
                    "type" : "integer",
                    "default" : 514,
                    "minimum" : 1,
                    "maximum" : 65535
                },
                "secondaryProtocol" : {
                    "description" : "Secondary Server Protocol of the syslog server",
                    "type" : "string",
                    "enum" : [ "IPPROTO_TCP", "IPPROTO_UDP" ],
                    "default" : "IPPROTO_TCP"
                },
                "facility" : {
                    "description" : "Facility of the syslog server",
                    "type" : "string",
                    "enum" : [ "Keep_Original", "Local0", "Local1", "Local2", "Local3", "Local4", "Local5", "Local6", "Local7" ],
                    "default" : "Keep_Original"
                },
                "priority" : {
                    "description" : "Priority of the log messages",
                    "type" : "string",
                    "enum" : [ "Emergency", "Alert", "Critical", "Error", "Warning", "Notice", "Info", "All" ],
                    "default" : "Error"
                }
            }
        },
        "smartMonitor" : {
            "description" : "Smart monitor configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "intervalInSec" : {
                    "description" : "Interval in seconds. This is required if smartMonitor is enabled",
                    "type" : "integer",
                    "default" : 10,
                    "minimum" : 5,
                    "maximum" : 60
                },
                "retryThreshold" : {
                    "description" : "Retry threshold. This is required if smartMonitor is enabled",
                    "type" : "integer",
                    "default" : 3,
                    "minimum" : 1,
                    "maximum" : 10
                }
            }
        },
        "clientAdmissionControl24" : {
            "description" : "AP client admission control 2.4GHz radio configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "maxRadioLoadPercent" : {
                    "description" : "Maximum radio load percentage.",
                    "type" : "integer",
                    "default" : 75,
                    "minimum" : 50,
                    "maximum" : 100
                },
                "minClientCount" : {
                    "description" : "Minimum client count number.",
                    "type" : "integer",
                    "default" : 10,
                    "minimum" : 0,
                    "maximum" : 100
                },
                "minClientThroughputMbps" : {
                    "description" : "Minimum client throughput in Mbps.",
                    "type" : "number",
                    "default" : 0,
                    "minimum" : 0,
                    "maximum" : 100
                }
            }
        },
        "clientAdmissionControl50" : {
            "description" : "AP client admission control 5GHz radio configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "maxRadioLoadPercent" : {
                    "description" : "Maximum radio load percentage.",
                    "type" : "integer",
                    "default" : 75,
                    "minimum" : 50,
                    "maximum" : 100
                },
                "minClientCount" : {
                    "description" : "Minimum client count number.",
                    "type" : "integer",
                    "default" : 10,
                    "minimum" : 0,
                    "maximum" : 100
                },
                "minClientThroughputMbps" : {
                    "description" : "Minimum client throughput in Mbps.",
                    "type" : "number",
                    "default" : 0,
                    "minimum" : 0,
                    "maximum" : 100
                }
            }
        },
        "tunnelType" : {
            "description" : "Tunnel type configuration of the zone. No_Tunneled is for IPv6 mode",
            "type" : "string",
            "enum" : [ "No_Tunneled", "RuckusGRE", "SoftGRE", "SoftGREIpsec" ],
            "default" : "RuckusGRE"
        },
        "tunnelProfile" : {
            "description" : "Tunnel type configuration of the zone.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "loadBalancing" : {
            "description" : "Load Balancing configuration of the zone",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "loadBalancingMethod" : {
                    "type" : "string",
                    "enum" : [ "BASED_ON_CLIENT_COUNT", "BASED_ON_CAPACITY", "OFF" ],
                    "default" : "BASED_ON_CLIENT_COUNT"
                },
                "bandBalancing" : {
                    "description" : "Band Balancing configuration of the zone.",
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "wifi24Percentage" : {
                            "description" : "Percentage of client load on 2.4GHz radio band",
                            "type" : "integer",
                            "minimum" : 0,
                            "maximum" : 100,
                            "default" : 25
                        }
                    }
                },
                "steeringMode" : {
                    "description" : "Steering Mode: BASIC-Withholds probe and authentication responses at connetcion time in heavily loaded band to balance clients to the other band, PROACTIVE-Uses BASIC functionality and actively rebalances clients via 802.11v BTM, STRICT-Uses PROACTIVE functionality and forcefully rebalances clients via 802.11v BTM",
                    "type" : "string",
                    "enum" : [ "BASIC", "PROACTIVE", "STRICT" ],
                    "default" : "BASIC"
                }
            }
        },
        "rogue" : {
            "description" : "Rogue AP detection configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "reportType" : {
                    "description" : "Report type",
                    "type" : "string",
                    "enum" : [ "All", "Malicious" ]
                },
                "maliciousTypes" : {
                    "description" : "Malicious type when reportType is Malicious",
                    "type" : [ "array", "null" ],
                    "items" : {
                        "type" : "string",
                        "enum" : [ "SSIDSpoofing", "SameNetwork", "MACSpoofing" ]
                    }
                },
                "protectionEnabled" : {
                    "description" : "Protection enabled",
                    "type" : "boolean"
                }
            }
        },
        "dosBarringEnable" : {
            "description" : "Enable DoS Protection(Barring UE) of the zone.",
            "type" : "integer"
        },
        "dosBarringPeriod" : {
            "description" : "DoS Protection(Barring UE) blocking period of the zone.",
            "type" : "integer",
            "default" : 60
        },
        "dosBarringThreshold" : {
            "description" : "DoS Protection(Barring UE) threshold of the zone.",
            "type" : "integer",
            "default" : 5
        },
        "dosBarringCheckPeriod" : {
            "description" : "DoS Protection(Barring UE) check period of the zone.",
            "type" : "integer",
            "default" : 30
        },
        "locationBasedService" : {
            "description" : "Location based service configuration of the zone.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "apRebootTimeout" : {
            "description" : "AP reboot timeout of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "gatewayLossTimeoutInSec" : {
                    "description" : "Gateway loss timeout in second",
                    "type" : "integer",
                    "enum" : [ 0, 1800, 3600, 5400, 7200, 9000, 10800, 12600, 14400, 16200, 18000, 19800, 23400, 25200, 27000, 28800, 30600, 32400, 34200, 36000, 37800, 39600, 41400, 43200, 45000, 46800, 48600, 50400, 52200, 54000, 55800, 57600, 59400, 61200, 63000, 64800, 66600, 68400, 70200, 72000, 73800, 75600, 77400, 79200, 81000, 82800, 84600, 86400 ],
                    "default" : 1800
                },
                "serverLossTimeoutInSec" : {
                    "description" : "Server loss timeout in second",
                    "type" : "integer",
                    "enum" : [ 0, 7200, 14400, 21600, 28800, 36000, 43200, 50400, 57600, 64800, 72000, 79200, 86400 ],
                    "default" : 7200
                }
            }
        },
        "location" : {
            "description" : "Location of the zone.",
            "type" : "string"
        },
        "locationAdditionalInfo" : {
            "description" : "Location additional info of the zone.",
            "type" : "string"
        },
        "altitude" : {
            "description" : "GPS Altitude",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "altitudeUnit" : {
                    "description" : "altitude unit",
                    "type" : "string",
                    "enum" : [ "meters", "floor" ],
                    "default" : "meters"
                },
                "altitudeValue" : {
                    "description" : "altitude value",
                    "type" : "integer"
                }
            }
        },
        "latitude" : {
            "description" : "Latitude coordinate (in decimal format) of the zone",
            "type" : "number"
        },
        "longitude" : {
            "description" : "Longitude coordinate (in decimal format) of the zone",
            "type" : "number"
        },
        "vlanOverlappingEnabled" : {
            "description" : "VLAN pooling overlapping of the zone",
            "type" : "boolean"
        },
        "nodeAffinityProfile" : {
            "description" : "Node affinity profile of the zone.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "venueProfile" : {
            "description" : "Venue profile configuration of the zone.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "channelEvaluationInterval" : {
            "description" : "channel evaluation Interval of the zone",
            "type" : "integer",
            "default" : 600,
            "minimum" : 60,
            "maximum" : 3600
        },
        "apMgmtVlan" : {
            "description" : "ap Management Vlan of the zone",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "mode" : {
                    "description" : "Vlan Mode of the zone",
                    "type" : "string",
                    "enum" : [ "KEEP", "USER_DEFINED" ],
                    "default" : "KEEP"
                },
                "id" : {
                    "description" : "Vlan id of the zone",
                    "type" : "integer",
                    "default" : "1"
                }
            }
        },
        "apLatencyInterval" : {
            "description" : "AP latency interval",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "pingEnabled" : {
                    "description" : "AP ping latency enabled",
                    "type" : "boolean",
                    "default" : true
                }
            }
        },
        "ipsecProfile" : {
            "description" : "ipsec profile configuration of the Zone.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "ipv6TrafficFilterEnabled" : {
            "description" : "IPv6 Traffic filtering on the AP",
            "type" : "integer"
        },
        "bonjourFencingPolicyEnabled" : {
            "description" : "Enable Bonjour Fencing Policy on the AP",
            "type" : "boolean"
        },
        "bonjourFencingPolicy" : {
            "description" : "Bonjour Fencing Policy on the AP",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "dhcpSiteConfig" : {
            "description" : "DHCP Site Configuration in Zone",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "siteEnabled" : {
                    "description" : "DHCP Service Enabling Status",
                    "type" : "boolean"
                },
                "portSelectionEnabled" : {
                    "description" : "DHCP Port Selection Enabled",
                    "type" : "boolean"
                },
                "dwpdEnabled" : {
                    "description" : "DHCP Service Dynamic WAN Port Detection",
                    "type" : "boolean"
                },
                "manualSelect" : {
                    "description" : "DHCP Service AP Selection Mode. This value is effective when the siteMode is EnableOnMultipleAPs.",
                    "type" : "boolean"
                },
                "siteMode" : {
                    "description" : "DHCP Service mode",
                    "type" : "string",
                    "enum" : [ "EnableOnEachAPs", "EnableOnMultipleAPs", "EnableOnHierarchicalAPs" ]
                },
                "eth0ProfileId" : {
                    "type" : "integer"
                },
                "eth1ProfileId" : {
                    "type" : "integer"
                },
                "siteAps" : {
                    "type" : "array",
                    "items" : {
                        "type" : "object",
                        "description" : "DHCP Site selected APs. The content is effective when the siteMode is EnableOnMultipleAPs.",
                        "additionalProperties" : false,
                        "properties" : {
                            "apMac" : {
                                "type" : "string"
                            },
                            "apName" : {
                                "type" : "string"
                            },
                            "apStatus" : {
                                "type" : "string",
                                "enum" : [ "Online", "Offline", "Flagged" ]
                            },
                            "apServerEnabled" : {
                                "type" : "boolean"
                            },
                            "apServerPrimary" : {
                                "type" : "boolean"
                            },
                            "apServerIp" : {
                                "type" : [ "string", "null" ]
                            },
                            "apGatewayIp" : {
                                "type" : "string"
                            },
                            "apServerType" : {
                                "type" : "string"
                            }
                        }
                    }
                },
                "siteProfileIds" : {
                    "type" : "array",
                    "items" : {
                        "type" : "string"
                    }
                }
            }
        },
        "snmpAgent" : {
            "description" : "AP SNMP Options",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "apSnmpEnabled" : {
                    "description" : "Enable AP SNMP",
                    "type" : "boolean"
                },
                "snmpConfigType" : {
                    "description" : "The config type of SNMP",
                    "type" : "string",
                    "enum" : [ "CUSTOM", "AP_SNMP_AGENT_PROFILE" ],
                    "default" : "CUSTOM"
                },
                "apSnmpAgentProfileId" : {
                    "type" : "string"
                },
                "snmpV2Agent" : {
                    "description" : "Community List of the SNMP V2 Agent.",
                    "type" : "array",
                    "items" : {
                        "type" : "object",
                        "additionalProperties" : false,
                        "properties" : {
                            "communityName" : {
                                "description" : "name of the SNMP Community.",
                                "type" : "string"
                            },
                            "readEnabled" : {
                                "description" : "read privilege of the SNMP Coummunity",
                                "type" : "boolean"
                            },
                            "writeEnabled" : {
                                "description" : "write privilege of the SNMP Coummunity",
                                "type" : "boolean"
                            },
                            "notificationEnabled" : {
                                "description" : "notification privilege of the SNMP Coummunity",
                                "type" : "boolean"
                            },
                            "notificationType" : {
                                "description" : "type of the notification privilege",
                                "type" : "string",
                                "enum" : [ "TRAP", "INFORM" ]
                            },
                            "notificationTarget" : {
                                "description" : "Trap List of the SNMP Coummunity",
                                "type" : "array",
                                "items" : {
                                    "type" : "object",
                                    "additionalProperties" : false,
                                    "properties" : {
                                        "address" : {
                                            "description" : "address of the SNMP Trap",
                                            "type" : "string"
                                        },
                                        "port" : {
                                            "description" : "port number of the SNMP Trap",
                                            "type" : "integer",
                                            "minimum" : 1,
                                            "maximum" : 65535
                                        }
                                    },
                                    "required" : [ "address", "port" ]
                                }
                            }
                        },
                        "required" : [ "communityName", "readEnabled", "writeEnabled", "notificationEnabled" ]
                    }
                },
                "snmpV3Agent" : {
                    "description" : "User List of the SNMP V3 Agent.",
                    "type" : "array",
                    "items" : {
                        "type" : "object",
                        "additionalProperties" : false,
                        "properties" : {
                            "userName" : {
                                "description" : "name of the SNMP User.",
                                "type" : "string"
                            },
                            "authProtocol" : {
                                "description" : "authProtocol of the SNMP User.",
                                "type" : "string",
                                "enum" : [ "NONE", "MD5", "SHA" ]
                            },
                            "authPassword" : {
                                "description" : "authPassword of the SNMP User.",
                                "type" : "string",
                                "minLength" : 8
                            },
                            "privProtocol" : {
                                "description" : "privProtocol of the SNMP User.",
                                "type" : "string",
                                "enum" : [ "NONE", "DES", "AES" ]
                            },
                            "privPassword" : {
                                "description" : "privPassword of the SNMP User.",
                                "type" : "string",
                                "minLength" : 8
                            },
                            "readEnabled" : {
                                "description" : "read privilege of the SNMP User",
                                "type" : "boolean"
                            },
                            "writeEnabled" : {
                                "description" : "write privilege of the SNMP User",
                                "type" : "boolean"
                            },
                            "notificationEnabled" : {
                                "description" : "notification privilege of the SNMP User",
                                "type" : "boolean"
                            },
                            "notificationType" : {
                                "description" : "type of the notification privilege",
                                "type" : "string",
                                "enum" : [ "TRAP", "INFORM" ]
                            },
                            "notificationTarget" : {
                                "description" : "Trap List of the SNMP User",
                                "type" : "array",
                                "items" : {
                                    "type" : "object",
                                    "additionalProperties" : false,
                                    "properties" : {
                                        "address" : {
                                            "description" : "address of the SNMP Trap",
                                            "type" : "string"
                                        },
                                        "port" : {
                                            "description" : "port number of the SNMP Trap",
                                            "type" : "integer",
                                            "minimum" : 1,
                                            "maximum" : 65535
                                        }
                                    },
                                    "required" : [ "address", "port" ]
                                }
                            }
                        },
                        "required" : [ "userName", "readEnabled", "writeEnabled", "notificationEnabled" ]
                    }
                }
            }
        },
        "recoverySsid" : {
            "description" : "Recovery SSID",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "recoverySsidPskKey" : {
                    "description" : "Custom recovery ssid passphrase. If passphrase has been customized, this property cannot be empty in the future. ",
                    "type" : "string"
                },
                "recoverySsidEnabled" : {
                    "description" : "recovery ssid enable/disable",
                    "type" : "boolean"
                }
            }
        },
        "clusterRedundancyEnabled" : {
            "description" : "Enable Cluster redundancy on zone.",
            "type" : "boolean",
            "default" : false
        },
        "rogueApReportThreshold" : {
            "description" : "Rogue AP report will leave out all entries that have signal strength lower than this threshold.",
            "type" : "integer"
        },
        "rogueApAggressivenessMode" : {
            "description" : "Adjust the frequency interval to de-authenticate rogue APs.",
            "type" : "integer"
        },
        "rogueApJammingDetection" : {
            "description" : "Enable jamming detection.",
            "type" : "boolean",
            "default" : false
        },
        "rogueApJammingThreshold" : {
            "type" : "integer"
        },
        "directedMulticastFromWiredClientEnabled" : {
            "description" : "Directed multicast from wired client.",
            "type" : "boolean",
            "default" : true
        },
        "directedMulticastFromWirelessClientEnabled" : {
            "description" : "Directed multicast from wireless client.",
            "type" : "boolean",
            "default" : true
        },
        "directedMulticastFromNetworkEnabled" : {
            "description" : "Directed multicast from network.",
            "type" : "boolean",
            "default" : true
        },
        "healthCheckSitesEnabled" : {
            "description" : "Enabled Health Check Sites. ",
            "type" : "boolean",
            "default" : false
        },
        "healthCheckSites" : {
            "description" : "Health Check Sites.",
            "type" : "array",
            "items" : {
                "type" : "string"
            }
        },
        "ruckusGreTunnelProfile" : {
            "description" : "Ruckus GRE Profile for Multiple Tunnel (Start from SZ 5.0)",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "softGreTunnelProflies" : {
            "description" : "SoftGRE Profiles for Multiple Tunnel (Start from SZ 5.0)",
            "type" : "array",
            "items" : {
                "type" : [ "object", "null" ],
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "type" : "string"
                    },
                    "name" : {
                        "type" : "string"
                    },
                    "aaaAffinityEnabled" : {
                        "type" : "boolean"
                    }
                }
            }
        },
        "ipsecProfiles" : {
            "description" : "Ipsec profile for Multiple Tunnel (Start from SZ 5.0)",
            "type" : "array",
            "items" : {
                "type" : [ "object", "null" ],
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "type" : "string"
                    },
                    "name" : {
                        "type" : "string"
                    }
                }
            }
        },
        "ipsecTunnelMode" : {
            "type" : "string",
            "enum" : [ "DISABLE", "SOFT_GRE", "RUCKUS_GRE" ]
        },
        "rksGreForwardBroadcast" : {
            "description" : "Ruckus GRE tunnel broadcast packet forwarding",
            "type" : "boolean",
            "default" : false
        },
        "sshTunnelEncryption" : {
            "type" : "string",
            "enum" : [ "AES128", "AES256" ],
            "default" : "AES128"
        },
        "lteBandLockChannels" : {
            "description" : "LTE band lock channels options",
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "simCardId" : {
                        "description" : "SIM card ID(Primary:0, Secondary:1)",
                        "type" : "integer"
                    },
                    "type" : {
                        "description" : "LTE chipset SKU type",
                        "type" : "string"
                    },
                    "channel4g" : {
                        "description" : "LTE 4G channels",
                        "type" : "string"
                    },
                    "channel3g" : {
                        "description" : "LTE 3G channels",
                        "type" : "string"
                    }
                }
            }
        },
        "paloAltoFirewallProfileId" : {
            "type" : "string"
        },
        "apHccdEnabled" : {
            "description" : "Historical Connection Failures allows the AP to report historical client connection failures for this zone.",
            "type" : "boolean",
            "default" : false
        },
        "apHccdPersist" : {
            "description" : "Allow Historical Connection Failures to be persisted.",
            "type" : "boolean",
            "default" : true
        },
        "myRuckusConfig" : {
            "description" : "My.Ruckus configuration",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "aclForTunnelWlanAndVlanEnable" : {
                    "description" : "My.Ruckus support for tunnel-wlan/vlan",
                    "type" : "boolean"
                }
            },
            "required" : [ "aclForTunnelWlanAndVlanEnable" ]
        },
        "apHttp2CertChkEnable" : {
            "type" : "boolean"
        },
        "bssColoringEnable" : {
            "description" : "Turn on/off BSS coloring mechanism.",
            "type" : "boolean",
            "default" : true
        },
        "radioConfig" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "radio24g" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "autoCellSizing" : {
                            "type" : "boolean"
                        },
                        "txPower" : {
                            "type" : "string",
                            "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
                            "default" : "Full"
                        },
                        "channelWidth" : {
                            "type" : "integer",
                            "enum" : [ 0, 20, 40 ],
                            "default" : 0
                        },
                        "channel" : {
                            "type" : "integer"
                        },
                        "channelRange" : {
                            "type" : "array",
                            "items" : {
                                "type" : "integer"
                            },
                            "minItems" : 1
                        },
                        "backgroundScanning" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "frequencyInSec" : {
                                    "type" : "integer",
                                    "minimum" : 1,
                                    "maximum" : 65535,
                                    "default" : 20
                                }
                            },
                            "required" : [ "frequencyInSec" ]
                        },
                        "protectionMode" : {
                            "type" : "string",
                            "enum" : [ "NONE", "CTS_ONLY", "RTS_CTS" ],
                            "default" : "RTS_CTS"
                        },
                        "autoChannelSelection" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "channelSelectMode" : {
                                    "type" : "string",
                                    "enum" : [ "None", "BackgroundScanning", "ChannelFly" ],
                                    "default" : "BackgroundScanning"
                                },
                                "channelFlyMtbc" : {
                                    "type" : "integer",
                                    "default" : 480,
                                    "minimum" : 100,
                                    "maximum" : 1440
                                },
                                "channelFlyChangeFrequency" : {
                                    "type" : "integer",
                                    "default" : 33,
                                    "minimum" : 1,
                                    "maximum" : 100
                                },
                                "channelFlyOptimizationTimePeriod" : {
                                    "type" : "array",
                                    "items" : {
                                        "type" : "string",
                                        "pattern" : "^([0-1][0-9]|2[0-3]):00-(([0-1][0-9]|2[0-4]):00)$"
                                    }
                                }
                            }
                        }
                    }
                },
                "radio5g" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "autoCellSizing" : {
                            "type" : "boolean"
                        },
                        "txPower" : {
                            "type" : "string",
                            "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
                            "default" : "Full"
                        },
                        "channelWidth" : {
                            "type" : "integer",
                            "enum" : [ 0, 20, 40, 80, 8080, 160 ],
                            "default" : 0
                        },
                        "channel" : {
                            "type" : "integer"
                        },
                        "channelIndoor" : {
                            "type" : "integer"
                        },
                        "channelRange" : {
                            "type" : "array",
                            "items" : {
                                "type" : "integer"
                            },
                            "minItems" : 1
                        },
                        "channelRangeIndoor" : {
                            "type" : "array",
                            "items" : {
                                "type" : "integer"
                            }
                        },
                        "secondaryChannel" : {
                            "type" : "integer"
                        },
                        "secondaryChannelIndoor" : {
                            "type" : "integer"
                        },
                        "dfsChannelEnabled" : {
                            "type" : "boolean"
                        },
                        "cbandChannelEnabled" : {
                            "type" : "boolean"
                        },
                        "cbandChannelLicenseEnabled" : {
                            "type" : "boolean"
                        },
                        "channel144Enabled" : {
                            "type" : "boolean"
                        },
                        "channelModeEnabled" : {
                            "type" : "boolean"
                        },
                        "backgroundScanning" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "frequencyInSec" : {
                                    "type" : "integer",
                                    "minimum" : 1,
                                    "maximum" : 65535,
                                    "default" : 20
                                }
                            },
                            "required" : [ "frequencyInSec" ]
                        },
                        "autoChannelSelection" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "channelSelectMode" : {
                                    "type" : "string",
                                    "enum" : [ "None", "BackgroundScanning", "ChannelFly" ],
                                    "default" : "BackgroundScanning"
                                },
                                "channelFlyMtbc" : {
                                    "type" : "integer",
                                    "default" : 480,
                                    "minimum" : 100,
                                    "maximum" : 1440
                                },
                                "channelFlyChangeFrequency" : {
                                    "type" : "integer",
                                    "default" : 33,
                                    "minimum" : 1,
                                    "maximum" : 100
                                },
                                "channelFlyOptimizationTimePeriod" : {
                                    "type" : "array",
                                    "items" : {
                                        "type" : "string",
                                        "pattern" : "^([0-1][0-9]|2[0-3]):00-(([0-1][0-9]|2[0-4]):00)$"
                                    }
                                }
                            }
                        }
                    }
                },
                "radio5gLower" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "autoCellSizing" : {
                            "type" : "boolean"
                        },
                        "txPower" : {
                            "type" : "string",
                            "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
                            "default" : "Full"
                        },
                        "channelWidth" : {
                            "type" : "integer",
                            "enum" : [ 0, 20, 40, 80, 8080, 160 ],
                            "default" : 0
                        },
                        "channel" : {
                            "type" : "integer"
                        },
                        "channelIndoor" : {
                            "type" : "integer"
                        },
                        "channelRange" : {
                            "type" : "array",
                            "items" : {
                                "type" : "integer"
                            },
                            "minItems" : 1
                        },
                        "channelRangeIndoor" : {
                            "type" : "array",
                            "items" : {
                                "type" : "integer"
                            }
                        },
                        "secondaryChannel" : {
                            "type" : "integer"
                        },
                        "secondaryChannelIndoor" : {
                            "type" : "integer"
                        },
                        "dfsChannelEnabled" : {
                            "type" : "boolean"
                        },
                        "cbandChannelEnabled" : {
                            "type" : "boolean"
                        },
                        "cbandChannelLicenseEnabled" : {
                            "type" : "boolean"
                        },
                        "channel144Enabled" : {
                            "type" : "boolean"
                        },
                        "channelModeEnabled" : {
                            "type" : "boolean"
                        },
                        "backgroundScanning" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "frequencyInSec" : {
                                    "type" : "integer",
                                    "minimum" : 1,
                                    "maximum" : 65535,
                                    "default" : 20
                                }
                            },
                            "required" : [ "frequencyInSec" ]
                        },
                        "autoChannelSelection" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "channelSelectMode" : {
                                    "type" : "string",
                                    "enum" : [ "None", "BackgroundScanning", "ChannelFly" ],
                                    "default" : "BackgroundScanning"
                                },
                                "channelFlyMtbc" : {
                                    "type" : "integer",
                                    "default" : 480,
                                    "minimum" : 100,
                                    "maximum" : 1440
                                },
                                "channelFlyChangeFrequency" : {
                                    "type" : "integer",
                                    "default" : 33,
                                    "minimum" : 1,
                                    "maximum" : 100
                                },
                                "channelFlyOptimizationTimePeriod" : {
                                    "type" : "array",
                                    "items" : {
                                        "type" : "string",
                                        "pattern" : "^([0-1][0-9]|2[0-3]):00-(([0-1][0-9]|2[0-4]):00)$"
                                    }
                                }
                            }
                        }
                    }
                },
                "radio5gUpper" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "autoCellSizing" : {
                            "type" : "boolean"
                        },
                        "txPower" : {
                            "type" : "string",
                            "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
                            "default" : "Full"
                        },
                        "channelWidth" : {
                            "type" : "integer",
                            "enum" : [ 0, 20, 40, 80, 8080, 160 ],
                            "default" : 0
                        },
                        "channel" : {
                            "type" : "integer"
                        },
                        "channelIndoor" : {
                            "type" : "integer"
                        },
                        "channelRange" : {
                            "type" : "array",
                            "items" : {
                                "type" : "integer"
                            },
                            "minItems" : 1
                        },
                        "channelRangeIndoor" : {
                            "type" : "array",
                            "items" : {
                                "type" : "integer"
                            }
                        },
                        "secondaryChannel" : {
                            "type" : "integer"
                        },
                        "secondaryChannelIndoor" : {
                            "type" : "integer"
                        },
                        "dfsChannelEnabled" : {
                            "type" : "boolean"
                        },
                        "cbandChannelEnabled" : {
                            "type" : "boolean"
                        },
                        "cbandChannelLicenseEnabled" : {
                            "type" : "boolean"
                        },
                        "channel144Enabled" : {
                            "type" : "boolean"
                        },
                        "channelModeEnabled" : {
                            "type" : "boolean"
                        },
                        "backgroundScanning" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "frequencyInSec" : {
                                    "type" : "integer",
                                    "minimum" : 1,
                                    "maximum" : 65535,
                                    "default" : 20
                                }
                            },
                            "required" : [ "frequencyInSec" ]
                        },
                        "autoChannelSelection" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "channelSelectMode" : {
                                    "type" : "string",
                                    "enum" : [ "None", "BackgroundScanning", "ChannelFly" ],
                                    "default" : "BackgroundScanning"
                                },
                                "channelFlyMtbc" : {
                                    "type" : "integer",
                                    "default" : 480,
                                    "minimum" : 100,
                                    "maximum" : 1440
                                },
                                "channelFlyChangeFrequency" : {
                                    "type" : "integer",
                                    "default" : 33,
                                    "minimum" : 1,
                                    "maximum" : 100
                                },
                                "channelFlyOptimizationTimePeriod" : {
                                    "type" : "array",
                                    "items" : {
                                        "type" : "string",
                                        "pattern" : "^([0-1][0-9]|2[0-3]):00-(([0-1][0-9]|2[0-4]):00)$"
                                    }
                                }
                            }
                        }
                    }
                },
                "radio6g" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "autoCellSizing" : {
                            "type" : "boolean"
                        },
                        "txPower" : {
                            "type" : "string",
                            "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
                            "default" : "Full"
                        },
                        "channelWidth" : {
                            "type" : "integer",
                            "enum" : [ 0, 20, 40, 80, 8080, 160 ],
                            "default" : 0
                        },
                        "channel" : {
                            "type" : "integer"
                        },
                        "channelRange" : {
                            "type" : "array",
                            "items" : {
                                "type" : "integer"
                            },
                            "minItems" : 1
                        },
                        "lowPowerIndoorModeEnabled" : {
                            "type" : "boolean"
                        },
                        "backgroundScanning" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "frequencyInSec" : {
                                    "type" : "integer",
                                    "minimum" : 1,
                                    "maximum" : 65535,
                                    "default" : 20
                                }
                            },
                            "required" : [ "frequencyInSec" ]
                        },
                        "autoChannelSelection" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "channelSelectMode" : {
                                    "type" : "string",
                                    "enum" : [ "None", "BackgroundScanning", "ChannelFly" ],
                                    "default" : "BackgroundScanning"
                                },
                                "channelFlyMtbc" : {
                                    "type" : "integer",
                                    "default" : 480,
                                    "minimum" : 100,
                                    "maximum" : 1440
                                },
                                "channelFlyChangeFrequency" : {
                                    "type" : "integer",
                                    "default" : 33,
                                    "minimum" : 1,
                                    "maximum" : 100
                                },
                                "channelFlyOptimizationTimePeriod" : {
                                    "type" : "array",
                                    "items" : {
                                        "type" : "string",
                                        "pattern" : "^([0-1][0-9]|2[0-3]):00-(([0-1][0-9]|2[0-4]):00)$"
                                    }
                                }
                            }
                        }
                    }
                },
                "dual5gEnabled" : {
                    "type" : "boolean"
                }
            }
        }
    },
    "required" : [ "name", "login" ]
}
Response  201
HideShow
Body
{
  "id": "zoneUUID"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Create Zone of Dual

POST/v11_0/rkszones/dual

Use this API command to create a new Ruckus Wireless AP zone of IPv4/IPv6.

Request
HideShow
Body
{
  "domainId": "domainUUID",
  "dpGroupProfileId": "3fd9aa91-df65-11e7-98e1-08002748d78e",
  "enforcePriorityDpGroupEnable": false,
  "name": "zoneName",
  "description": "description Zone",
  "version": "3.0.0.0.145",
  "countryCode": "US",
  "timezone": {
    "systemTimezone": "UTC",
    "customizedTimezone": null
  },
  "login": {
    "apLoginName": "apLoginName",
    "apLoginPassword": "apLoginPassword"
  },
  "mesh": {
    "ssid": "meshSSID"
  },
  "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": "keep_Original",
    "priority": "Error"
  },
  "smartMonitor": {
    "intervalInSec": 10,
    "retryThreshold": 3
  },
  "clientAdmissionControl24": {
    "maxRadioLoadPercent": 75,
    "minClientCount": "10",
    "minClientThroughputMbps": 0
  },
  "clientAdmissionControl50": {
    "maxRadioLoadPercent": 75,
    "minClientCount": "10",
    "minClientThroughputMbps": 0
  },
  "channelModeEnabled": false,
  "tunnelType": "RuckusGRE",
  "tunnelProfile": {
    "id": "tunnelProfileId",
    "name": "tunnelProfileName"
  },
  "aaaAffinityEnabled": false,
  "backgroundScanning24": {
    "frequencyInSec": 20
  },
  "backgroundScanning50": {
    "frequencyInSec": 20
  },
  "loadBalancing": {
    "loadBalancingMethod": "BASED_ON_CLIENT_COUNT",
    "clientLoadBalancing24": {
      "adjacentRadioThreshold": 12
    },
    "clientLoadBalancing50": {
      "adjacentRadioThreshold": 12
    },
    "bandBalancing": {
      "wifi24Percentage": 10
    },
    "steeringMode": "BASIC"
  },
  "rogue": {
    "reportType": "All",
    "maliciousTypes": null,
    "protectionEnabled": true
  },
  "dosBarringEnable": 0,
  "dosBarringPeriod": 60,
  "dosBarringThreshold": 5,
  "dosBarringCheckPeriod": 30,
  "locationBasedService": {
    "id": "lbsId",
    "name": "lbsName"
  },
  "apRebootTimeout": {
    "gatewayLossTimeoutInSec": 1800,
    "serverLossTimeoutInSec": 7200
  },
  "location": "location",
  "locationAdditionalInfo": "locationAdditionalInfo",
  "latitude": 23,
  "longitude": 23,
  "vlanOverlappingEnabled": false,
  "nodeAffinityProfile": {
    "id": "nodeAffinityProfileId",
    "name": "nodeAffinityProfileName"
  },
  "venueProfile": {
    "id": "venueProfileId",
    "name": "venueProfileName"
  },
  "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": true,
  "bonjourFencingPolicy": {
    "id": "bonjourFencingPolicyId",
    "name": "bonjourFencingPolicyName"
  },
  "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"
  ],
  "rkusGreTunnelProfile": {
    "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"
    }
  ],
  "lteBandLockChannels": [
    {
      "simCardId": 0,
      "lteRadioChannels": [
        {
          "type": "EC25E",
          "channel4g": [
            "B1",
            "B3",
            "B5"
          ],
          "channel3g": [
            "B5"
          ]
        }
      ]
    },
    {
      "simCardId": 1,
      "lteRadioChannels": [
        {
          "type": "EC25E",
          "channel4g": [],
          "channel3g": []
        }
      ]
    }
  ],
  "paloAltoFirewallProfileId": "2f59b0f4-c86f-11e8-a8d5-f2801f1b9fd1",
  "apHccdEnabled": true,
  "apHccdPersist": true
}
Schema
{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "domainId" : {
            "description" : "Identifier of the management domain to which the zone belongs",
            "type" : "string"
        },
        "dpGroupId" : {
            "description" : "DP Group ID",
            "type" : "string"
        },
        "enforcePriorityDpGroupEnable" : {
            "description" : "Enable to enforce priority of DP Group",
            "type" : "boolean"
        },
        "name" : {
            "description" : "Name of the zone",
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 32,
            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$"
        },
        "description" : {
            "description" : "Description of the zone",
            "type" : [ "string", "null" ],
            "maxLength" : 64
        },
        "version" : {
            "description" : "AP firmware version of the zone",
            "type" : "string",
            "pattern" : "^\d+\.\d+\.\d+\.\d+\.\d+$"
        },
        "countryCode" : {
            "description" : "Country code of the zone",
            "type" : "string"
        },
        "login" : {
            "description" : "AP administrator account",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "apLoginName" : {
                    "description" : "User name of the AP administrator",
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : "^((?!\$\()[!-_a-~]){1,64}$"
                },
                "apLoginPassword" : {
                    "description" : "Password of the AP administrator",
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : ".*(?=.{8,})(?=.*[a-zA-Z])(?=.*[0-9])(?=.*[_`[email protected]#$%^&*\(\)\[\]\{\}|;:'\",.\<>\/?=+-]).*"
                }
            },
            "required" : [ "apLoginName", "apLoginPassword" ]
        },
        "timezone" : {
            "description" : "Either systemTimezone or customizedTimezone must be specified",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "systemTimezone" : {
                    "description" : "System defined time zone, please refer to the 'Overview > Time Zone' list",
                    "type" : "string"
                },
                "customizedTimezone" : {
                    "description" : "User defined time zone",
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "abbreviation" : {
                            "description" : "Time zone abbreviation",
                            "type" : "string",
                            "pattern" : "^[a-zA-Z]{3,4}$"
                        },
                        "gmtOffset" : {
                            "description" : "GMT offset",
                            "type" : "integer",
                            "minimum" : -11,
                            "maximum" : 14
                        },
                        "gmtOffsetMinute" : {
                            "description" : "GMT offset minute",
                            "type" : "integer",
                            "minimum" : 0,
                            "maximum" : 59
                        },
                        "start" : {
                            "description" : "Daylight saving time start",
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "month" : {
                                    "description" : "Month when daylight saving time begins",
                                    "type" : "integer",
                                    "enum" : [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ]
                                },
                                "week" : {
                                    "description" : "Week of the month (1 for the first week, 2 for the second week, and so on)",
                                    "type" : "integer",
                                    "enum" : [ 1, 2, 3, 4, 5 ]
                                },
                                "day" : {
                                    "description" : "Day of the week (0 for Sunday, 1 for Monday, 2 for Tuesday, and so on)",
                                    "type" : "integer",
                                    "enum" : [ 0, 1, 2, 3, 4, 5, 6 ]
                                },
                                "hour" : {
                                    "description" : "Hour of the day",
                                    "type" : "integer",
                                    "minimum" : 0,
                                    "maximum" : 23
                                }
                            },
                            "required" : [ "month", "week", "day", "hour" ]
                        },
                        "end" : {
                            "description" : "Daylight saving time end",
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "month" : {
                                    "description" : "Month when daylight saving time begins",
                                    "type" : "integer",
                                    "enum" : [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ]
                                },
                                "week" : {
                                    "description" : "Week of the month (1 for the first week, 2 for the second week, and so on)",
                                    "type" : "integer",
                                    "enum" : [ 1, 2, 3, 4, 5 ]
                                },
                                "day" : {
                                    "description" : "Day of the week (0 for Sunday, 1 for Monday, 2 for Tuesday, and so on)",
                                    "type" : "integer",
                                    "enum" : [ 0, 1, 2, 3, 4, 5, 6 ]
                                },
                                "hour" : {
                                    "description" : "Hour of the day",
                                    "type" : "integer",
                                    "minimum" : 0,
                                    "maximum" : 23
                                }
                            },
                            "required" : [ "month", "week", "day", "hour" ]
                        }
                    },
                    "required" : [ "abbreviation", "gmtOffset", "gmtOffsetMinute" ]
                }
            }
        },
        "mesh" : {
            "description" : "Mesh configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "ssid" : {
                    "description" : "SSID of the mesh network",
                    "type" : "string"
                },
                "passphrase" : {
                    "description" : "Passphrase for the mesh network. Would be mandatory when the mesh is enabled.",
                    "type" : "string"
                },
                "meshRadioIdx" : {
                    "description" : "Mesh radio index",
                    "type" : "string",
                    "enum" : [ "Radio24G", "Radio5G" ],
                    "default" : "Radio5G"
                },
                "zeroTouchStatus" : {
                    "type" : "boolean"
                }
            }
        },
        "syslog" : {
            "description" : "Syslog configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "syslogConfigType" : {
                    "description" : "Syslog configuration type.",
                    "type" : "string",
                    "enum" : [ "CUSTOM", "AP_SYSLOG_SERVER_PROFILE" ],
                    "default" : "CUSTOM"
                },
                "syslogServerProfileId" : {
                    "description" : "Syslog server profile ID.",
                    "type" : "string"
                },
                "flowLevel" : {
                    "description" : "Flow Level of the syslog",
                    "type" : "string",
                    "enum" : [ "GENERAL_LOGS", "CLIENT_FLOW", "ALL" ],
                    "default" : "GENERAL_LOGS"
                },
                "address" : {
                    "description" : "Address of the syslog server.",
                    "type" : "string"
                },
                "port" : {
                    "description" : "Port number of the syslog server",
                    "type" : "integer",
                    "default" : 514,
                    "minimum" : 1,
                    "maximum" : 65535
                },
                "protocol" : {
                    "description" : "Protocol of the syslog server",
                    "type" : "string",
                    "enum" : [ "IPPROTO_TCP", "IPPROTO_UDP" ],
                    "default" : "IPPROTO_TCP"
                },
                "secondaryAddress" : {
                    "description" : "Secondary Server Address of the syslog server",
                    "type" : "string"
                },
                "secondaryPort" : {
                    "description" : "Secondary Server Port of the syslog server",
                    "type" : "integer",
                    "default" : 514,
                    "minimum" : 1,
                    "maximum" : 65535
                },
                "secondaryProtocol" : {
                    "description" : "Secondary Server Protocol of the syslog server",
                    "type" : "string",
                    "enum" : [ "IPPROTO_TCP", "IPPROTO_UDP" ],
                    "default" : "IPPROTO_TCP"
                },
                "facility" : {
                    "description" : "Facility of the syslog server",
                    "type" : "string",
                    "enum" : [ "Keep_Original", "Local0", "Local1", "Local2", "Local3", "Local4", "Local5", "Local6", "Local7" ],
                    "default" : "Keep_Original"
                },
                "priority" : {
                    "description" : "Priority of the log messages",
                    "type" : "string",
                    "enum" : [ "Emergency", "Alert", "Critical", "Error", "Warning", "Notice", "Info", "All" ],
                    "default" : "Error"
                }
            }
        },
        "smartMonitor" : {
            "description" : "Smart monitor configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "intervalInSec" : {
                    "description" : "Interval in seconds. This is required if smartMonitor is enabled",
                    "type" : "integer",
                    "default" : 10,
                    "minimum" : 5,
                    "maximum" : 60
                },
                "retryThreshold" : {
                    "description" : "Retry threshold. This is required if smartMonitor is enabled",
                    "type" : "integer",
                    "default" : 3,
                    "minimum" : 1,
                    "maximum" : 10
                }
            }
        },
        "clientAdmissionControl24" : {
            "description" : "AP client admission control 2.4GHz radio configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "maxRadioLoadPercent" : {
                    "description" : "Maximum radio load percentage.",
                    "type" : "integer",
                    "default" : 75,
                    "minimum" : 50,
                    "maximum" : 100
                },
                "minClientCount" : {
                    "description" : "Minimum client count number.",
                    "type" : "integer",
                    "default" : 10,
                    "minimum" : 0,
                    "maximum" : 100
                },
                "minClientThroughputMbps" : {
                    "description" : "Minimum client throughput in Mbps.",
                    "type" : "number",
                    "default" : 0,
                    "minimum" : 0,
                    "maximum" : 100
                }
            }
        },
        "clientAdmissionControl50" : {
            "description" : "AP client admission control 5GHz radio configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "maxRadioLoadPercent" : {
                    "description" : "Maximum radio load percentage.",
                    "type" : "integer",
                    "default" : 75,
                    "minimum" : 50,
                    "maximum" : 100
                },
                "minClientCount" : {
                    "description" : "Minimum client count number.",
                    "type" : "integer",
                    "default" : 10,
                    "minimum" : 0,
                    "maximum" : 100
                },
                "minClientThroughputMbps" : {
                    "description" : "Minimum client throughput in Mbps.",
                    "type" : "number",
                    "default" : 0,
                    "minimum" : 0,
                    "maximum" : 100
                }
            }
        },
        "tunnelType" : {
            "description" : "Tunnel type configuration of the zone. No_Tunneled is for IPv6 mode",
            "type" : "string",
            "enum" : [ "No_Tunneled", "RuckusGRE", "SoftGRE", "SoftGREIpsec" ],
            "default" : "RuckusGRE"
        },
        "tunnelProfile" : {
            "description" : "Tunnel type configuration of the zone.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "loadBalancing" : {
            "description" : "Load Balancing configuration of the zone",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "loadBalancingMethod" : {
                    "type" : "string",
                    "enum" : [ "BASED_ON_CLIENT_COUNT", "BASED_ON_CAPACITY", "OFF" ],
                    "default" : "BASED_ON_CLIENT_COUNT"
                },
                "bandBalancing" : {
                    "description" : "Band Balancing configuration of the zone.",
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "wifi24Percentage" : {
                            "description" : "Percentage of client load on 2.4GHz radio band",
                            "type" : "integer",
                            "minimum" : 0,
                            "maximum" : 100,
                            "default" : 25
                        }
                    }
                },
                "steeringMode" : {
                    "description" : "Steering Mode: BASIC-Withholds probe and authentication responses at connetcion time in heavily loaded band to balance clients to the other band, PROACTIVE-Uses BASIC functionality and actively rebalances clients via 802.11v BTM, STRICT-Uses PROACTIVE functionality and forcefully rebalances clients via 802.11v BTM",
                    "type" : "string",
                    "enum" : [ "BASIC", "PROACTIVE", "STRICT" ],
                    "default" : "BASIC"
                }
            }
        },
        "rogue" : {
            "description" : "Rogue AP detection configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "reportType" : {
                    "description" : "Report type",
                    "type" : "string",
                    "enum" : [ "All", "Malicious" ]
                },
                "maliciousTypes" : {
                    "description" : "Malicious type when reportType is Malicious",
                    "type" : [ "array", "null" ],
                    "items" : {
                        "type" : "string",
                        "enum" : [ "SSIDSpoofing", "SameNetwork", "MACSpoofing" ]
                    }
                },
                "protectionEnabled" : {
                    "description" : "Protection enabled",
                    "type" : "boolean"
                }
            }
        },
        "dosBarringEnable" : {
            "description" : "Enable DoS Protection(Barring UE) of the zone.",
            "type" : "integer"
        },
        "dosBarringPeriod" : {
            "description" : "DoS Protection(Barring UE) blocking period of the zone.",
            "type" : "integer",
            "default" : 60
        },
        "dosBarringThreshold" : {
            "description" : "DoS Protection(Barring UE) threshold of the zone.",
            "type" : "integer",
            "default" : 5
        },
        "dosBarringCheckPeriod" : {
            "description" : "DoS Protection(Barring UE) check period of the zone.",
            "type" : "integer",
            "default" : 30
        },
        "locationBasedService" : {
            "description" : "Location based service configuration of the zone.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "apRebootTimeout" : {
            "description" : "AP reboot timeout of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "gatewayLossTimeoutInSec" : {
                    "description" : "Gateway loss timeout in second",
                    "type" : "integer",
                    "enum" : [ 0, 1800, 3600, 5400, 7200, 9000, 10800, 12600, 14400, 16200, 18000, 19800, 23400, 25200, 27000, 28800, 30600, 32400, 34200, 36000, 37800, 39600, 41400, 43200, 45000, 46800, 48600, 50400, 52200, 54000, 55800, 57600, 59400, 61200, 63000, 64800, 66600, 68400, 70200, 72000, 73800, 75600, 77400, 79200, 81000, 82800, 84600, 86400 ],
                    "default" : 1800
                },
                "serverLossTimeoutInSec" : {
                    "description" : "Server loss timeout in second",
                    "type" : "integer",
                    "enum" : [ 0, 7200, 14400, 21600, 28800, 36000, 43200, 50400, 57600, 64800, 72000, 79200, 86400 ],
                    "default" : 7200
                }
            }
        },
        "location" : {
            "description" : "Location of the zone.",
            "type" : "string"
        },
        "locationAdditionalInfo" : {
            "description" : "Location additional info of the zone.",
            "type" : "string"
        },
        "altitude" : {
            "description" : "GPS Altitude",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "altitudeUnit" : {
                    "description" : "altitude unit",
                    "type" : "string",
                    "enum" : [ "meters", "floor" ],
                    "default" : "meters"
                },
                "altitudeValue" : {
                    "description" : "altitude value",
                    "type" : "integer"
                }
            }
        },
        "latitude" : {
            "description" : "Latitude coordinate (in decimal format) of the zone",
            "type" : "number"
        },
        "longitude" : {
            "description" : "Longitude coordinate (in decimal format) of the zone",
            "type" : "number"
        },
        "vlanOverlappingEnabled" : {
            "description" : "VLAN pooling overlapping of the zone",
            "type" : "boolean"
        },
        "nodeAffinityProfile" : {
            "description" : "Node affinity profile of the zone.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "venueProfile" : {
            "description" : "Venue profile configuration of the zone.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "channelEvaluationInterval" : {
            "description" : "channel evaluation Interval of the zone",
            "type" : "integer",
            "default" : 600,
            "minimum" : 60,
            "maximum" : 3600
        },
        "apMgmtVlan" : {
            "description" : "ap Management Vlan of the zone",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "mode" : {
                    "description" : "Vlan Mode of the zone",
                    "type" : "string",
                    "enum" : [ "KEEP", "USER_DEFINED" ],
                    "default" : "KEEP"
                },
                "id" : {
                    "description" : "Vlan id of the zone",
                    "type" : "integer",
                    "default" : "1"
                }
            }
        },
        "apLatencyInterval" : {
            "description" : "AP latency interval",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "pingEnabled" : {
                    "description" : "AP ping latency enabled",
                    "type" : "boolean",
                    "default" : true
                }
            }
        },
        "ipsecProfile" : {
            "description" : "ipsec profile configuration of the Zone.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "ipv6TrafficFilterEnabled" : {
            "description" : "IPv6 Traffic filtering on the AP",
            "type" : "integer"
        },
        "bonjourFencingPolicyEnabled" : {
            "description" : "Enable Bonjour Fencing Policy on the AP",
            "type" : "boolean"
        },
        "bonjourFencingPolicy" : {
            "description" : "Bonjour Fencing Policy on the AP",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "dhcpSiteConfig" : {
            "description" : "DHCP Site Configuration in Zone",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "siteEnabled" : {
                    "description" : "DHCP Service Enabling Status",
                    "type" : "boolean"
                },
                "portSelectionEnabled" : {
                    "description" : "DHCP Port Selection Enabled",
                    "type" : "boolean"
                },
                "dwpdEnabled" : {
                    "description" : "DHCP Service Dynamic WAN Port Detection",
                    "type" : "boolean"
                },
                "manualSelect" : {
                    "description" : "DHCP Service AP Selection Mode. This value is effective when the siteMode is EnableOnMultipleAPs.",
                    "type" : "boolean"
                },
                "siteMode" : {
                    "description" : "DHCP Service mode",
                    "type" : "string",
                    "enum" : [ "EnableOnEachAPs", "EnableOnMultipleAPs", "EnableOnHierarchicalAPs" ]
                },
                "eth0ProfileId" : {
                    "type" : "integer"
                },
                "eth1ProfileId" : {
                    "type" : "integer"
                },
                "siteAps" : {
                    "type" : "array",
                    "items" : {
                        "type" : "object",
                        "description" : "DHCP Site selected APs. The content is effective when the siteMode is EnableOnMultipleAPs.",
                        "additionalProperties" : false,
                        "properties" : {
                            "apMac" : {
                                "type" : "string"
                            },
                            "apName" : {
                                "type" : "string"
                            },
                            "apStatus" : {
                                "type" : "string",
                                "enum" : [ "Online", "Offline", "Flagged" ]
                            },
                            "apServerEnabled" : {
                                "type" : "boolean"
                            },
                            "apServerPrimary" : {
                                "type" : "boolean"
                            },
                            "apServerIp" : {
                                "type" : [ "string", "null" ]
                            },
                            "apGatewayIp" : {
                                "type" : "string"
                            },
                            "apServerType" : {
                                "type" : "string"
                            }
                        }
                    }
                },
                "siteProfileIds" : {
                    "type" : "array",
                    "items" : {
                        "type" : "string"
                    }
                }
            }
        },
        "snmpAgent" : {
            "description" : "AP SNMP Options",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "apSnmpEnabled" : {
                    "description" : "Enable AP SNMP",
                    "type" : "boolean"
                },
                "snmpConfigType" : {
                    "description" : "The config type of SNMP",
                    "type" : "string",
                    "enum" : [ "CUSTOM", "AP_SNMP_AGENT_PROFILE" ],
                    "default" : "CUSTOM"
                },
                "apSnmpAgentProfileId" : {
                    "type" : "string"
                },
                "snmpV2Agent" : {
                    "description" : "Community List of the SNMP V2 Agent.",
                    "type" : "array",
                    "items" : {
                        "type" : "object",
                        "additionalProperties" : false,
                        "properties" : {
                            "communityName" : {
                                "description" : "name of the SNMP Community.",
                                "type" : "string"
                            },
                            "readEnabled" : {
                                "description" : "read privilege of the SNMP Coummunity",
                                "type" : "boolean"
                            },
                            "writeEnabled" : {
                                "description" : "write privilege of the SNMP Coummunity",
                                "type" : "boolean"
                            },
                            "notificationEnabled" : {
                                "description" : "notification privilege of the SNMP Coummunity",
                                "type" : "boolean"
                            },
                            "notificationType" : {
                                "description" : "type of the notification privilege",
                                "type" : "string",
                                "enum" : [ "TRAP", "INFORM" ]
                            },
                            "notificationTarget" : {
                                "description" : "Trap List of the SNMP Coummunity",
                                "type" : "array",
                                "items" : {
                                    "type" : "object",
                                    "additionalProperties" : false,
                                    "properties" : {
                                        "address" : {
                                            "description" : "address of the SNMP Trap",
                                            "type" : "string"
                                        },
                                        "port" : {
                                            "description" : "port number of the SNMP Trap",
                                            "type" : "integer",
                                            "minimum" : 1,
                                            "maximum" : 65535
                                        }
                                    },
                                    "required" : [ "address", "port" ]
                                }
                            }
                        },
                        "required" : [ "communityName", "readEnabled", "writeEnabled", "notificationEnabled" ]
                    }
                },
                "snmpV3Agent" : {
                    "description" : "User List of the SNMP V3 Agent.",
                    "type" : "array",
                    "items" : {
                        "type" : "object",
                        "additionalProperties" : false,
                        "properties" : {
                            "userName" : {
                                "description" : "name of the SNMP User.",
                                "type" : "string"
                            },
                            "authProtocol" : {
                                "description" : "authProtocol of the SNMP User.",
                                "type" : "string",
                                "enum" : [ "NONE", "MD5", "SHA" ]
                            },
                            "authPassword" : {
                                "description" : "authPassword of the SNMP User.",
                                "type" : "string",
                                "minLength" : 8
                            },
                            "privProtocol" : {
                                "description" : "privProtocol of the SNMP User.",
                                "type" : "string",
                                "enum" : [ "NONE", "DES", "AES" ]
                            },
                            "privPassword" : {
                                "description" : "privPassword of the SNMP User.",
                                "type" : "string",
                                "minLength" : 8
                            },
                            "readEnabled" : {
                                "description" : "read privilege of the SNMP User",
                                "type" : "boolean"
                            },
                            "writeEnabled" : {
                                "description" : "write privilege of the SNMP User",
                                "type" : "boolean"
                            },
                            "notificationEnabled" : {
                                "description" : "notification privilege of the SNMP User",
                                "type" : "boolean"
                            },
                            "notificationType" : {
                                "description" : "type of the notification privilege",
                                "type" : "string",
                                "enum" : [ "TRAP", "INFORM" ]
                            },
                            "notificationTarget" : {
                                "description" : "Trap List of the SNMP User",
                                "type" : "array",
                                "items" : {
                                    "type" : "object",
                                    "additionalProperties" : false,
                                    "properties" : {
                                        "address" : {
                                            "description" : "address of the SNMP Trap",
                                            "type" : "string"
                                        },
                                        "port" : {
                                            "description" : "port number of the SNMP Trap",
                                            "type" : "integer",
                                            "minimum" : 1,
                                            "maximum" : 65535
                                        }
                                    },
                                    "required" : [ "address", "port" ]
                                }
                            }
                        },
                        "required" : [ "userName", "readEnabled", "writeEnabled", "notificationEnabled" ]
                    }
                }
            }
        },
        "recoverySsid" : {
            "description" : "Recovery SSID",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "recoverySsidPskKey" : {
                    "description" : "Custom recovery ssid passphrase. If passphrase has been customized, this property cannot be empty in the future. ",
                    "type" : "string"
                },
                "recoverySsidEnabled" : {
                    "description" : "recovery ssid enable/disable",
                    "type" : "boolean"
                }
            }
        },
        "clusterRedundancyEnabled" : {
            "description" : "Enable Cluster redundancy on zone.",
            "type" : "boolean",
            "default" : false
        },
        "rogueApReportThreshold" : {
            "description" : "Rogue AP report will leave out all entries that have signal strength lower than this threshold.",
            "type" : "integer"
        },
        "rogueApAggressivenessMode" : {
            "description" : "Adjust the frequency interval to de-authenticate rogue APs.",
            "type" : "integer"
        },
        "rogueApJammingDetection" : {
            "description" : "Enable jamming detection.",
            "type" : "boolean",
            "default" : false
        },
        "rogueApJammingThreshold" : {
            "type" : "integer"
        },
        "directedMulticastFromWiredClientEnabled" : {
            "description" : "Directed multicast from wired client.",
            "type" : "boolean",
            "default" : true
        },
        "directedMulticastFromWirelessClientEnabled" : {
            "description" : "Directed multicast from wireless client.",
            "type" : "boolean",
            "default" : true
        },
        "directedMulticastFromNetworkEnabled" : {
            "description" : "Directed multicast from network.",
            "type" : "boolean",
            "default" : true
        },
        "healthCheckSitesEnabled" : {
            "description" : "Enabled Health Check Sites. ",
            "type" : "boolean",
            "default" : false
        },
        "healthCheckSites" : {
            "description" : "Health Check Sites.",
            "type" : "array",
            "items" : {
                "type" : "string"
            }
        },
        "ruckusGreTunnelProfile" : {
            "description" : "Ruckus GRE Profile for Multiple Tunnel (Start from SZ 5.0)",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "softGreTunnelProflies" : {
            "description" : "SoftGRE Profiles for Multiple Tunnel (Start from SZ 5.0)",
            "type" : "array",
            "items" : {
                "type" : [ "object", "null" ],
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "type" : "string"
                    },
                    "name" : {
                        "type" : "string"
                    },
                    "aaaAffinityEnabled" : {
                        "type" : "boolean"
                    }
                }
            }
        },
        "ipsecProfiles" : {
            "description" : "Ipsec profile for Multiple Tunnel (Start from SZ 5.0)",
            "type" : "array",
            "items" : {
                "type" : [ "object", "null" ],
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "type" : "string"
                    },
                    "name" : {
                        "type" : "string"
                    }
                }
            }
        },
        "ipsecTunnelMode" : {
            "type" : "string",
            "enum" : [ "DISABLE", "SOFT_GRE", "RUCKUS_GRE" ]
        },
        "rksGreForwardBroadcast" : {
            "description" : "Ruckus GRE tunnel broadcast packet forwarding",
            "type" : "boolean",
            "default" : false
        },
        "sshTunnelEncryption" : {
            "type" : "string",
            "enum" : [ "AES128", "AES256" ],
            "default" : "AES128"
        },
        "lteBandLockChannels" : {
            "description" : "LTE band lock channels options",
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "simCardId" : {
                        "description" : "SIM card ID(Primary:0, Secondary:1)",
                        "type" : "integer"
                    },
                    "type" : {
                        "description" : "LTE chipset SKU type",
                        "type" : "string"
                    },
                    "channel4g" : {
                        "description" : "LTE 4G channels",
                        "type" : "string"
                    },
                    "channel3g" : {
                        "description" : "LTE 3G channels",
                        "type" : "string"
                    }
                }
            }
        },
        "paloAltoFirewallProfileId" : {
            "type" : "string"
        },
        "apHccdEnabled" : {
            "description" : "Historical Connection Failures allows the AP to report historical client connection failures for this zone.",
            "type" : "boolean",
            "default" : false
        },
        "apHccdPersist" : {
            "description" : "Allow Historical Connection Failures to be persisted.",
            "type" : "boolean",
            "default" : true
        },
        "myRuckusConfig" : {
            "description" : "My.Ruckus configuration",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "aclForTunnelWlanAndVlanEnable" : {
                    "description" : "My.Ruckus support for tunnel-wlan/vlan",
                    "type" : "boolean"
                }
            },
            "required" : [ "aclForTunnelWlanAndVlanEnable" ]
        },
        "apHttp2CertChkEnable" : {
            "type" : "boolean"
        },
        "bssColoringEnable" : {
            "description" : "Turn on/off BSS coloring mechanism.",
            "type" : "boolean",
            "default" : true
        },
        "radioConfig" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "radio24g" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "autoCellSizing" : {
                            "type" : "boolean"
                        },
                        "txPower" : {
                            "type" : "string",
                            "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
                            "default" : "Full"
                        },
                        "channelWidth" : {
                            "type" : "integer",
                            "enum" : [ 0, 20, 40 ],
                            "default" : 0
                        },
                        "channel" : {
                            "type" : "integer"
                        },
                        "channelRange" : {
                            "type" : "array",
                            "items" : {
                                "type" : "integer"
                            },
                            "minItems" : 1
                        },
                        "backgroundScanning" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "frequencyInSec" : {
                                    "type" : "integer",
                                    "minimum" : 1,
                                    "maximum" : 65535,
                                    "default" : 20
                                }
                            },
                            "required" : [ "frequencyInSec" ]
                        },
                        "protectionMode" : {
                            "type" : "string",
                            "enum" : [ "NONE", "CTS_ONLY", "RTS_CTS" ],
                            "default" : "RTS_CTS"
                        },
                        "autoChannelSelection" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "channelSelectMode" : {
                                    "type" : "string",
                                    "enum" : [ "None", "BackgroundScanning", "ChannelFly" ],
                                    "default" : "BackgroundScanning"
                                },
                                "channelFlyMtbc" : {
                                    "type" : "integer",
                                    "default" : 480,
                                    "minimum" : 100,
                                    "maximum" : 1440
                                },
                                "channelFlyChangeFrequency" : {
                                    "type" : "integer",
                                    "default" : 33,
                                    "minimum" : 1,
                                    "maximum" : 100
                                },
                                "channelFlyOptimizationTimePeriod" : {
                                    "type" : "array",
                                    "items" : {
                                        "type" : "string",
                                        "pattern" : "^([0-1][0-9]|2[0-3]):00-(([0-1][0-9]|2[0-4]):00)$"
                                    }
                                }
                            }
                        }
                    }
                },
                "radio5g" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "autoCellSizing" : {
                            "type" : "boolean"
                        },
                        "txPower" : {
                            "type" : "string",
                            "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
                            "default" : "Full"
                        },
                        "channelWidth" : {
                            "type" : "integer",
                            "enum" : [ 0, 20, 40, 80, 8080, 160 ],
                            "default" : 0
                        },
                        "channel" : {
                            "type" : "integer"
                        },
                        "channelIndoor" : {
                            "type" : "integer"
                        },
                        "channelRange" : {
                            "type" : "array",
                            "items" : {
                                "type" : "integer"
                            },
                            "minItems" : 1
                        },
                        "channelRangeIndoor" : {
                            "type" : "array",
                            "items" : {
                                "type" : "integer"
                            }
                        },
                        "secondaryChannel" : {
                            "type" : "integer"
                        },
                        "secondaryChannelIndoor" : {
                            "type" : "integer"
                        },
                        "dfsChannelEnabled" : {
                            "type" : "boolean"
                        },
                        "cbandChannelEnabled" : {
                            "type" : "boolean"
                        },
                        "cbandChannelLicenseEnabled" : {
                            "type" : "boolean"
                        },
                        "channel144Enabled" : {
                            "type" : "boolean"
                        },
                        "channelModeEnabled" : {
                            "type" : "boolean"
                        },
                        "backgroundScanning" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "frequencyInSec" : {
                                    "type" : "integer",
                                    "minimum" : 1,
                                    "maximum" : 65535,
                                    "default" : 20
                                }
                            },
                            "required" : [ "frequencyInSec" ]
                        },
                        "autoChannelSelection" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "channelSelectMode" : {
                                    "type" : "string",
                                    "enum" : [ "None", "BackgroundScanning", "ChannelFly" ],
                                    "default" : "BackgroundScanning"
                                },
                                "channelFlyMtbc" : {
                                    "type" : "integer",
                                    "default" : 480,
                                    "minimum" : 100,
                                    "maximum" : 1440
                                },
                                "channelFlyChangeFrequency" : {
                                    "type" : "integer",
                                    "default" : 33,
                                    "minimum" : 1,
                                    "maximum" : 100
                                },
                                "channelFlyOptimizationTimePeriod" : {
                                    "type" : "array",
                                    "items" : {
                                        "type" : "string",
                                        "pattern" : "^([0-1][0-9]|2[0-3]):00-(([0-1][0-9]|2[0-4]):00)$"
                                    }
                                }
                            }
                        }
                    }
                },
                "radio5gLower" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "autoCellSizing" : {
                            "type" : "boolean"
                        },
                        "txPower" : {
                            "type" : "string",
                            "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
                            "default" : "Full"
                        },
                        "channelWidth" : {
                            "type" : "integer",
                            "enum" : [ 0, 20, 40, 80, 8080, 160 ],
                            "default" : 0
                        },
                        "channel" : {
                            "type" : "integer"
                        },
                        "channelIndoor" : {
                            "type" : "integer"
                        },
                        "channelRange" : {
                            "type" : "array",
                            "items" : {
                                "type" : "integer"
                            },
                            "minItems" : 1
                        },
                        "channelRangeIndoor" : {
                            "type" : "array",
                            "items" : {
                                "type" : "integer"
                            }
                        },
                        "secondaryChannel" : {
                            "type" : "integer"
                        },
                        "secondaryChannelIndoor" : {
                            "type" : "integer"
                        },
                        "dfsChannelEnabled" : {
                            "type" : "boolean"
                        },
                        "cbandChannelEnabled" : {
                            "type" : "boolean"
                        },
                        "cbandChannelLicenseEnabled" : {
                            "type" : "boolean"
                        },
                        "channel144Enabled" : {
                            "type" : "boolean"
                        },
                        "channelModeEnabled" : {
                            "type" : "boolean"
                        },
                        "backgroundScanning" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "frequencyInSec" : {
                                    "type" : "integer",
                                    "minimum" : 1,
                                    "maximum" : 65535,
                                    "default" : 20
                                }
                            },
                            "required" : [ "frequencyInSec" ]
                        },
                        "autoChannelSelection" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "channelSelectMode" : {
                                    "type" : "string",
                                    "enum" : [ "None", "BackgroundScanning", "ChannelFly" ],
                                    "default" : "BackgroundScanning"
                                },
                                "channelFlyMtbc" : {
                                    "type" : "integer",
                                    "default" : 480,
                                    "minimum" : 100,
                                    "maximum" : 1440
                                },
                                "channelFlyChangeFrequency" : {
                                    "type" : "integer",
                                    "default" : 33,
                                    "minimum" : 1,
                                    "maximum" : 100
                                },
                                "channelFlyOptimizationTimePeriod" : {
                                    "type" : "array",
                                    "items" : {
                                        "type" : "string",
                                        "pattern" : "^([0-1][0-9]|2[0-3]):00-(([0-1][0-9]|2[0-4]):00)$"
                                    }
                                }
                            }
                        }
                    }
                },
                "radio5gUpper" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "autoCellSizing" : {
                            "type" : "boolean"
                        },
                        "txPower" : {
                            "type" : "string",
                            "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
                            "default" : "Full"
                        },
                        "channelWidth" : {
                            "type" : "integer",
                            "enum" : [ 0, 20, 40, 80, 8080, 160 ],
                            "default" : 0
                        },
                        "channel" : {
                            "type" : "integer"
                        },
                        "channelIndoor" : {
                            "type" : "integer"
                        },
                        "channelRange" : {
                            "type" : "array",
                            "items" : {
                                "type" : "integer"
                            },
                            "minItems" : 1
                        },
                        "channelRangeIndoor" : {
                            "type" : "array",
                            "items" : {
                                "type" : "integer"
                            }
                        },
                        "secondaryChannel" : {
                            "type" : "integer"
                        },
                        "secondaryChannelIndoor" : {
                            "type" : "integer"
                        },
                        "dfsChannelEnabled" : {
                            "type" : "boolean"
                        },
                        "cbandChannelEnabled" : {
                            "type" : "boolean"
                        },
                        "cbandChannelLicenseEnabled" : {
                            "type" : "boolean"
                        },
                        "channel144Enabled" : {
                            "type" : "boolean"
                        },
                        "channelModeEnabled" : {
                            "type" : "boolean"
                        },
                        "backgroundScanning" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "frequencyInSec" : {
                                    "type" : "integer",
                                    "minimum" : 1,
                                    "maximum" : 65535,
                                    "default" : 20
                                }
                            },
                            "required" : [ "frequencyInSec" ]
                        },
                        "autoChannelSelection" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "channelSelectMode" : {
                                    "type" : "string",
                                    "enum" : [ "None", "BackgroundScanning", "ChannelFly" ],
                                    "default" : "BackgroundScanning"
                                },
                                "channelFlyMtbc" : {
                                    "type" : "integer",
                                    "default" : 480,
                                    "minimum" : 100,
                                    "maximum" : 1440
                                },
                                "channelFlyChangeFrequency" : {
                                    "type" : "integer",
                                    "default" : 33,
                                    "minimum" : 1,
                                    "maximum" : 100
                                },
                                "channelFlyOptimizationTimePeriod" : {
                                    "type" : "array",
                                    "items" : {
                                        "type" : "string",
                                        "pattern" : "^([0-1][0-9]|2[0-3]):00-(([0-1][0-9]|2[0-4]):00)$"
                                    }
                                }
                            }
                        }
                    }
                },
                "radio6g" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "autoCellSizing" : {
                            "type" : "boolean"
                        },
                        "txPower" : {
                            "type" : "string",
                            "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
                            "default" : "Full"
                        },
                        "channelWidth" : {
                            "type" : "integer",
                            "enum" : [ 0, 20, 40, 80, 8080, 160 ],
                            "default" : 0
                        },
                        "channel" : {
                            "type" : "integer"
                        },
                        "channelRange" : {
                            "type" : "array",
                            "items" : {
                                "type" : "integer"
                            },
                            "minItems" : 1
                        },
                        "lowPowerIndoorModeEnabled" : {
                            "type" : "boolean"
                        },
                        "backgroundScanning" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "frequencyInSec" : {
                                    "type" : "integer",
                                    "minimum" : 1,
                                    "maximum" : 65535,
                                    "default" : 20
                                }
                            },
                            "required" : [ "frequencyInSec" ]
                        },
                        "autoChannelSelection" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "channelSelectMode" : {
                                    "type" : "string",
                                    "enum" : [ "None", "BackgroundScanning", "ChannelFly" ],
                                    "default" : "BackgroundScanning"
                                },
                                "channelFlyMtbc" : {
                                    "type" : "integer",
                                    "default" : 480,
                                    "minimum" : 100,
                                    "maximum" : 1440
                                },
                                "channelFlyChangeFrequency" : {
                                    "type" : "integer",
                                    "default" : 33,
                                    "minimum" : 1,
                                    "maximum" : 100
                                },
                                "channelFlyOptimizationTimePeriod" : {
                                    "type" : "array",
                                    "items" : {
                                        "type" : "string",
                                        "pattern" : "^([0-1][0-9]|2[0-3]):00-(([0-1][0-9]|2[0-4]):00)$"
                                    }
                                }
                            }
                        }
                    }
                },
                "dual5gEnabled" : {
                    "type" : "boolean"
                }
            }
        }
    },
    "required" : [ "name", "login" ]
}
Response  201
HideShow
Body
{
  "id": "zoneUUID"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Create Zone

POST/v11_0/rkszones

Use this API command to create a new Ruckus Wireless AP zone.

Request
HideShow
Body
{
  "domainId": "domainUUID",
  "dpGroupProfileId": "3fd9aa91-df65-11e7-98e1-08002748d78e",
  "enforcePriorityDpGroupEnable": false,
  "name": "zoneName",
  "description": "description Zone",
  "version": "3.0.0.0.145",
  "countryCode": "US",
  "timezone": {
    "systemTimezone": "UTC",
    "customizedTimezone": null
  },
  "login": {
    "apLoginName": "apLoginName",
    "apLoginPassword": "apLoginPassword"
  },
  "mesh": {
    "ssid": "meshSSID"
  },
  "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": "keep_Original",
    "priority": "Error"
  },
  "smartMonitor": {
    "intervalInSec": 10,
    "retryThreshold": 3
  },
  "clientAdmissionControl24": {
    "maxRadioLoadPercent": 75,
    "minClientCount": "10",
    "minClientThroughputMbps": 0
  },
  "clientAdmissionControl50": {
    "maxRadioLoadPercent": 75,
    "minClientCount": "10",
    "minClientThroughputMbps": 0
  },
  "channelModeEnabled": false,
  "tunnelType": "RuckusGRE",
  "tunnelProfile": {
    "id": "tunnelProfileId",
    "name": "tunnelProfileName"
  },
  "aaaAffinityEnabled": false,
  "backgroundScanning24": {
    "frequencyInSec": 20
  },
  "backgroundScanning50": {
    "frequencyInSec": 20
  },
  "loadBalancing": {
    "loadBalancingMethod": "BASED_ON_CLIENT_COUNT",
    "clientLoadBalancing24": {
      "adjacentRadioThreshold": 12
    },
    "clientLoadBalancing50": {
      "adjacentRadioThreshold": 12
    },
    "bandBalancing": {
      "wifi24Percentage": 10
    },
    "steeringMode": "BASIC"
  },
  "rogue": {
    "reportType": "All",
    "maliciousTypes": null,
    "protectionEnabled": true
  },
  "dosBarringEnable": 0,
  "dosBarringPeriod": 60,
  "dosBarringThreshold": 5,
  "dosBarringCheckPeriod": 30,
  "locationBasedService": {
    "id": "lbsId",
    "name": "lbsName"
  },
  "apRebootTimeout": {
    "gatewayLossTimeoutInSec": 1800,
    "serverLossTimeoutInSec": 7200
  },
  "location": "location",
  "locationAdditionalInfo": "locationAdditionalInfo",
  "latitude": 23,
  "longitude": 23,
  "vlanOverlappingEnabled": false,
  "nodeAffinityProfile": {
    "id": "nodeAffinityProfileId",
    "name": "nodeAffinityProfileName"
  },
  "venueProfile": {
    "id": "venueProfileId",
    "name": "venueProfileName"
  },
  "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": true,
  "bonjourFencingPolicy": {
    "id": "bonjourFencingPolicyId",
    "name": "bonjourFencingPolicyName"
  },
  "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"
  ],
  "rkusGreTunnelProfile": {
    "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"
    }
  ],
  "lteBandLockChannels": [
    {
      "simCardId": 0,
      "lteRadioChannels": [
        {
          "type": "EC25E",
          "channel4g": [
            "B1",
            "B3",
            "B5"
          ],
          "channel3g": [
            "B5"
          ]
        }
      ]
    },
    {
      "simCardId": 1,
      "lteRadioChannels": [
        {
          "type": "EC25E",
          "channel4g": [],
          "channel3g": []
        }
      ]
    }
  ],
  "paloAltoFirewallProfileId": "2f59b0f4-c86f-11e8-a8d5-f2801f1b9fd1",
  "apHccdEnabled": true,
  "apHccdPersist": true
}
Schema
{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "domainId" : {
            "description" : "Identifier of the management domain to which the zone belongs",
            "type" : "string"
        },
        "dpGroupId" : {
            "description" : "DP Group ID",
            "type" : "string"
        },
        "enforcePriorityDpGroupEnable" : {
            "description" : "Enable to enforce priority of DP Group",
            "type" : "boolean"
        },
        "name" : {
            "description" : "Name of the zone",
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 32,
            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$"
        },
        "description" : {
            "description" : "Description of the zone",
            "type" : [ "string", "null" ],
            "maxLength" : 64
        },
        "version" : {
            "description" : "AP firmware version of the zone",
            "type" : "string",
            "pattern" : "^\d+\.\d+\.\d+\.\d+\.\d+$"
        },
        "countryCode" : {
            "description" : "Country code of the zone",
            "type" : "string"
        },
        "login" : {
            "description" : "AP administrator account",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "apLoginName" : {
                    "description" : "User name of the AP administrator",
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : "^((?!\$\()[!-_a-~]){1,64}$"
                },
                "apLoginPassword" : {
                    "description" : "Password of the AP administrator",
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : ".*(?=.{8,})(?=.*[a-zA-Z])(?=.*[0-9])(?=.*[_`[email protected]#$%^&*\(\)\[\]\{\}|;:'\",.\<>\/?=+-]).*"
                }
            },
            "required" : [ "apLoginName", "apLoginPassword" ]
        },
        "timezone" : {
            "description" : "Either systemTimezone or customizedTimezone must be specified",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "systemTimezone" : {
                    "description" : "System defined time zone, please refer to the 'Overview > Time Zone' list",
                    "type" : "string"
                },
                "customizedTimezone" : {
                    "description" : "User defined time zone",
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "abbreviation" : {
                            "description" : "Time zone abbreviation",
                            "type" : "string",
                            "pattern" : "^[a-zA-Z]{3,4}$"
                        },
                        "gmtOffset" : {
                            "description" : "GMT offset",
                            "type" : "integer",
                            "minimum" : -11,
                            "maximum" : 14
                        },
                        "gmtOffsetMinute" : {
                            "description" : "GMT offset minute",
                            "type" : "integer",
                            "minimum" : 0,
                            "maximum" : 59
                        },
                        "start" : {
                            "description" : "Daylight saving time start",
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "month" : {
                                    "description" : "Month when daylight saving time begins",
                                    "type" : "integer",
                                    "enum" : [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ]
                                },
                                "week" : {
                                    "description" : "Week of the month (1 for the first week, 2 for the second week, and so on)",
                                    "type" : "integer",
                                    "enum" : [ 1, 2, 3, 4, 5 ]
                                },
                                "day" : {
                                    "description" : "Day of the week (0 for Sunday, 1 for Monday, 2 for Tuesday, and so on)",
                                    "type" : "integer",
                                    "enum" : [ 0, 1, 2, 3, 4, 5, 6 ]
                                },
                                "hour" : {
                                    "description" : "Hour of the day",
                                    "type" : "integer",
                                    "minimum" : 0,
                                    "maximum" : 23
                                }
                            },
                            "required" : [ "month", "week", "day", "hour" ]
                        },
                        "end" : {
                            "description" : "Daylight saving time end",
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "month" : {
                                    "description" : "Month when daylight saving time begins",
                                    "type" : "integer",
                                    "enum" : [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ]
                                },
                                "week" : {
                                    "description" : "Week of the month (1 for the first week, 2 for the second week, and so on)",
                                    "type" : "integer",
                                    "enum" : [ 1, 2, 3, 4, 5 ]
                                },
                                "day" : {
                                    "description" : "Day of the week (0 for Sunday, 1 for Monday, 2 for Tuesday, and so on)",
                                    "type" : "integer",
                                    "enum" : [ 0, 1, 2, 3, 4, 5, 6 ]
                                },
                                "hour" : {
                                    "description" : "Hour of the day",
                                    "type" : "integer",
                                    "minimum" : 0,
                                    "maximum" : 23
                                }
                            },
                            "required" : [ "month", "week", "day", "hour" ]
                        }
                    },
                    "required" : [ "abbreviation", "gmtOffset", "gmtOffsetMinute" ]
                }
            }
        },
        "mesh" : {
            "description" : "Mesh configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "ssid" : {
                    "description" : "SSID of the mesh network",
                    "type" : "string"
                },
                "passphrase" : {
                    "description" : "Passphrase for the mesh network. Would be mandatory when the mesh is enabled.",
                    "type" : "string"
                },
                "meshRadioIdx" : {
                    "description" : "Mesh radio index",
                    "type" : "string",
                    "enum" : [ "Radio24G", "Radio5G" ],
                    "default" : "Radio5G"
                },
                "zeroTouchStatus" : {
                    "type" : "boolean"
                }
            }
        },
        "syslog" : {
            "description" : "Syslog configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "syslogConfigType" : {
                    "description" : "Syslog configuration type.",
                    "type" : "string",
                    "enum" : [ "CUSTOM", "AP_SYSLOG_SERVER_PROFILE" ],
                    "default" : "CUSTOM"
                },
                "syslogServerProfileId" : {
                    "description" : "Syslog server profile ID.",
                    "type" : "string"
                },
                "flowLevel" : {
                    "description" : "Flow Level of the syslog",
                    "type" : "string",
                    "enum" : [ "GENERAL_LOGS", "CLIENT_FLOW", "ALL" ],
                    "default" : "GENERAL_LOGS"
                },
                "address" : {
                    "description" : "Address of the syslog server.",
                    "type" : "string"
                },
                "port" : {
                    "description" : "Port number of the syslog server",
                    "type" : "integer",
                    "default" : 514,
                    "minimum" : 1,
                    "maximum" : 65535
                },
                "protocol" : {
                    "description" : "Protocol of the syslog server",
                    "type" : "string",
                    "enum" : [ "IPPROTO_TCP", "IPPROTO_UDP" ],
                    "default" : "IPPROTO_TCP"
                },
                "secondaryAddress" : {
                    "description" : "Secondary Server Address of the syslog server",
                    "type" : "string"
                },
                "secondaryPort" : {
                    "description" : "Secondary Server Port of the syslog server",
                    "type" : "integer",
                    "default" : 514,
                    "minimum" : 1,
                    "maximum" : 65535
                },
                "secondaryProtocol" : {
                    "description" : "Secondary Server Protocol of the syslog server",
                    "type" : "string",
                    "enum" : [ "IPPROTO_TCP", "IPPROTO_UDP" ],
                    "default" : "IPPROTO_TCP"
                },
                "facility" : {
                    "description" : "Facility of the syslog server",
                    "type" : "string",
                    "enum" : [ "Keep_Original", "Local0", "Local1", "Local2", "Local3", "Local4", "Local5", "Local6", "Local7" ],
                    "default" : "Keep_Original"
                },
                "priority" : {
                    "description" : "Priority of the log messages",
                    "type" : "string",
                    "enum" : [ "Emergency", "Alert", "Critical", "Error", "Warning", "Notice", "Info", "All" ],
                    "default" : "Error"
                }
            }
        },
        "smartMonitor" : {
            "description" : "Smart monitor configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "intervalInSec" : {
                    "description" : "Interval in seconds. This is required if smartMonitor is enabled",
                    "type" : "integer",
                    "default" : 10,
                    "minimum" : 5,
                    "maximum" : 60
                },
                "retryThreshold" : {
                    "description" : "Retry threshold. This is required if smartMonitor is enabled",
                    "type" : "integer",
                    "default" : 3,
                    "minimum" : 1,
                    "maximum" : 10
                }
            }
        },
        "clientAdmissionControl24" : {
            "description" : "AP client admission control 2.4GHz radio configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "maxRadioLoadPercent" : {
                    "description" : "Maximum radio load percentage.",
                    "type" : "integer",
                    "default" : 75,
                    "minimum" : 50,
                    "maximum" : 100
                },
                "minClientCount" : {
                    "description" : "Minimum client count number.",
                    "type" : "integer",
                    "default" : 10,
                    "minimum" : 0,
                    "maximum" : 100
                },
                "minClientThroughputMbps" : {
                    "description" : "Minimum client throughput in Mbps.",
                    "type" : "number",
                    "default" : 0,
                    "minimum" : 0,
                    "maximum" : 100
                }
            }
        },
        "clientAdmissionControl50" : {
            "description" : "AP client admission control 5GHz radio configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "maxRadioLoadPercent" : {
                    "description" : "Maximum radio load percentage.",
                    "type" : "integer",
                    "default" : 75,
                    "minimum" : 50,
                    "maximum" : 100
                },
                "minClientCount" : {
                    "description" : "Minimum client count number.",
                    "type" : "integer",
                    "default" : 10,
                    "minimum" : 0,
                    "maximum" : 100
                },
                "minClientThroughputMbps" : {
                    "description" : "Minimum client throughput in Mbps.",
                    "type" : "number",
                    "default" : 0,
                    "minimum" : 0,
                    "maximum" : 100
                }
            }
        },
        "tunnelType" : {
            "description" : "Tunnel type configuration of the zone. No_Tunneled is for IPv6 mode",
            "type" : "string",
            "enum" : [ "No_Tunneled", "RuckusGRE", "SoftGRE", "SoftGREIpsec" ],
            "default" : "RuckusGRE"
        },
        "tunnelProfile" : {
            "description" : "Tunnel type configuration of the zone.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "loadBalancing" : {
            "description" : "Load Balancing configuration of the zone",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "loadBalancingMethod" : {
                    "type" : "string",
                    "enum" : [ "BASED_ON_CLIENT_COUNT", "BASED_ON_CAPACITY", "OFF" ],
                    "default" : "BASED_ON_CLIENT_COUNT"
                },
                "bandBalancing" : {
                    "description" : "Band Balancing configuration of the zone.",
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "wifi24Percentage" : {
                            "description" : "Percentage of client load on 2.4GHz radio band",
                            "type" : "integer",
                            "minimum" : 0,
                            "maximum" : 100,
                            "default" : 25
                        }
                    }
                },
                "steeringMode" : {
                    "description" : "Steering Mode: BASIC-Withholds probe and authentication responses at connetcion time in heavily loaded band to balance clients to the other band, PROACTIVE-Uses BASIC functionality and actively rebalances clients via 802.11v BTM, STRICT-Uses PROACTIVE functionality and forcefully rebalances clients via 802.11v BTM",
                    "type" : "string",
                    "enum" : [ "BASIC", "PROACTIVE", "STRICT" ],
                    "default" : "BASIC"
                }
            }
        },
        "rogue" : {
            "description" : "Rogue AP detection configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "reportType" : {
                    "description" : "Report type",
                    "type" : "string",
                    "enum" : [ "All", "Malicious" ]
                },
                "maliciousTypes" : {
                    "description" : "Malicious type when reportType is Malicious",
                    "type" : [ "array", "null" ],
                    "items" : {
                        "type" : "string",
                        "enum" : [ "SSIDSpoofing", "SameNetwork", "MACSpoofing" ]
                    }
                },
                "protectionEnabled" : {
                    "description" : "Protection enabled",
                    "type" : "boolean"
                }
            }
        },
        "dosBarringEnable" : {
            "description" : "Enable DoS Protection(Barring UE) of the zone.",
            "type" : "integer"
        },
        "dosBarringPeriod" : {
            "description" : "DoS Protection(Barring UE) blocking period of the zone.",
            "type" : "integer",
            "default" : 60
        },
        "dosBarringThreshold" : {
            "description" : "DoS Protection(Barring UE) threshold of the zone.",
            "type" : "integer",
            "default" : 5
        },
        "dosBarringCheckPeriod" : {
            "description" : "DoS Protection(Barring UE) check period of the zone.",
            "type" : "integer",
            "default" : 30
        },
        "locationBasedService" : {
            "description" : "Location based service configuration of the zone.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "apRebootTimeout" : {
            "description" : "AP reboot timeout of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "gatewayLossTimeoutInSec" : {
                    "description" : "Gateway loss timeout in second",
                    "type" : "integer",
                    "enum" : [ 0, 1800, 3600, 5400, 7200, 9000, 10800, 12600, 14400, 16200, 18000, 19800, 23400, 25200, 27000, 28800, 30600, 32400, 34200, 36000, 37800, 39600, 41400, 43200, 45000, 46800, 48600, 50400, 52200, 54000, 55800, 57600, 59400, 61200, 63000, 64800, 66600, 68400, 70200, 72000, 73800, 75600, 77400, 79200, 81000, 82800, 84600, 86400 ],
                    "default" : 1800
                },
                "serverLossTimeoutInSec" : {
                    "description" : "Server loss timeout in second",
                    "type" : "integer",
                    "enum" : [ 0, 7200, 14400, 21600, 28800, 36000, 43200, 50400, 57600, 64800, 72000, 79200, 86400 ],
                    "default" : 7200
                }
            }
        },
        "location" : {
            "description" : "Location of the zone.",
            "type" : "string"
        },
        "locationAdditionalInfo" : {
            "description" : "Location additional info of the zone.",
            "type" : "string"
        },
        "altitude" : {
            "description" : "GPS Altitude",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "altitudeUnit" : {
                    "description" : "altitude unit",
                    "type" : "string",
                    "enum" : [ "meters", "floor" ],
                    "default" : "meters"
                },
                "altitudeValue" : {
                    "description" : "altitude value",
                    "type" : "integer"
                }
            }
        },
        "latitude" : {
            "description" : "Latitude coordinate (in decimal format) of the zone",
            "type" : "number"
        },
        "longitude" : {
            "description" : "Longitude coordinate (in decimal format) of the zone",
            "type" : "number"
        },
        "vlanOverlappingEnabled" : {
            "description" : "VLAN pooling overlapping of the zone",
            "type" : "boolean"
        },
        "nodeAffinityProfile" : {
            "description" : "Node affinity profile of the zone.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "venueProfile" : {
            "description" : "Venue profile configuration of the zone.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "channelEvaluationInterval" : {
            "description" : "channel evaluation Interval of the zone",
            "type" : "integer",
            "default" : 600,
            "minimum" : 60,
            "maximum" : 3600
        },
        "apMgmtVlan" : {
            "description" : "ap Management Vlan of the zone",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "mode" : {
                    "description" : "Vlan Mode of the zone",
                    "type" : "string",
                    "enum" : [ "KEEP", "USER_DEFINED" ],
                    "default" : "KEEP"
                },
                "id" : {
                    "description" : "Vlan id of the zone",
                    "type" : "integer",
                    "default" : "1"
                }
            }
        },
        "apLatencyInterval" : {
            "description" : "AP latency interval",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "pingEnabled" : {
                    "description" : "AP ping latency enabled",
                    "type" : "boolean",
                    "default" : true
                }
            }
        },
        "ipsecProfile" : {
            "description" : "ipsec profile configuration of the Zone.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "ipv6TrafficFilterEnabled" : {
            "description" : "IPv6 Traffic filtering on the AP",
            "type" : "integer"
        },
        "bonjourFencingPolicyEnabled" : {
            "description" : "Enable Bonjour Fencing Policy on the AP",
            "type" : "boolean"
        },
        "bonjourFencingPolicy" : {
            "description" : "Bonjour Fencing Policy on the AP",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "dhcpSiteConfig" : {
            "description" : "DHCP Site Configuration in Zone",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "siteEnabled" : {
                    "description" : "DHCP Service Enabling Status",
                    "type" : "boolean"
                },
                "portSelectionEnabled" : {
                    "description" : "DHCP Port Selection Enabled",
                    "type" : "boolean"
                },
                "dwpdEnabled" : {
                    "description" : "DHCP Service Dynamic WAN Port Detection",
                    "type" : "boolean"
                },
                "manualSelect" : {
                    "description" : "DHCP Service AP Selection Mode. This value is effective when the siteMode is EnableOnMultipleAPs.",
                    "type" : "boolean"
                },
                "siteMode" : {
                    "description" : "DHCP Service mode",
                    "type" : "string",
                    "enum" : [ "EnableOnEachAPs", "EnableOnMultipleAPs", "EnableOnHierarchicalAPs" ]
                },
                "eth0ProfileId" : {
                    "type" : "integer"
                },
                "eth1ProfileId" : {
                    "type" : "integer"
                },
                "siteAps" : {
                    "type" : "array",
                    "items" : {
                        "type" : "object",
                        "description" : "DHCP Site selected APs. The content is effective when the siteMode is EnableOnMultipleAPs.",
                        "additionalProperties" : false,
                        "properties" : {
                            "apMac" : {
                                "type" : "string"
                            },
                            "apName" : {
                                "type" : "string"
                            },
                            "apStatus" : {
                                "type" : "string",
                                "enum" : [ "Online", "Offline", "Flagged" ]
                            },
                            "apServerEnabled" : {
                                "type" : "boolean"
                            },
                            "apServerPrimary" : {
                                "type" : "boolean"
                            },
                            "apServerIp" : {
                                "type" : [ "string", "null" ]
                            },
                            "apGatewayIp" : {
                                "type" : "string"
                            },
                            "apServerType" : {
                                "type