Back to top

SmartZone 300 Public API Reference Guide

Overview

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

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

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

Open API document

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

Version Matrix

SmartZone software has API support for up to 3 major API versions, according to the following matrix.

SZ Version API Version
5.1.1 v6_0 v6_1 v7_0 v8_0 v8_1

Common Request Header

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

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

Common Request URI Parameters

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

Parameter Value
serviceTicket {serviceTicket}

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

Request Header for Session

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

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

Parameter Value
Cookie “JSESSIONID={JSESSIONID}”

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

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

HTTP Responses

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

Ruckus Wireless Error Codes

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

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

Time Zone

Africa/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/OjinagaAmerica/Panama
America/PangnirtungAmerica/ParamariboAmerica/Phoenix
America/Port-au-PrinceAmerica/Port_of_SpainAmerica/Porto_Acre
America/Porto_VelhoAmerica/Puerto_RicoAmerica/Punta_Arenas
America/Rainy_RiverAmerica/Rankin_InletAmerica/Recife
America/ReginaAmerica/ResoluteAmerica/Rio_Branco
America/RosarioAmerica/Santa_IsabelAmerica/Santarem
America/SantiagoAmerica/Santo_DomingoAmerica/Sao_Paulo
America/ScoresbysundAmerica/ShiprockAmerica/Sitka
America/St_BarthelemyAmerica/St_JohnsAmerica/St_Kitts
America/St_LuciaAmerica/St_ThomasAmerica/St_Vincent
America/Swift_CurrentAmerica/TegucigalpaAmerica/Thule
America/Thunder_BayAmerica/TijuanaAmerica/Toronto
America/TortolaAmerica/VancouverAmerica/Virgin
America/WhitehorseAmerica/WinnipegAmerica/Yakutat
America/YellowknifeAntarctica/CaseyAntarctica/Davis
Antarctica/DumontDUrvilleAntarctica/MacquarieAntarctica/Mawson
Antarctica/McMurdoAntarctica/PalmerAntarctica/Rothera
Antarctica/South_PoleAntarctica/SyowaAntarctica/Troll
Antarctica/VostokArctic/LongyearbyenAsia/Aden
Asia/AlmatyAsia/AmmanAsia/Anadyr
Asia/AqtauAsia/AqtobeAsia/Ashgabat
Asia/AshkhabadAsia/AtyrauAsia/Baghdad
Asia/BahrainAsia/BakuAsia/Bangkok
Asia/BarnaulAsia/BeirutAsia/Bishkek
Asia/BruneiAsia/CalcuttaAsia/Chita
Asia/ChoibalsanAsia/ChongqingAsia/Chungking
Asia/ColomboAsia/DaccaAsia/Damascus
Asia/DhakaAsia/DiliAsia/Dubai
Asia/DushanbeAsia/FamagustaAsia/Gaza
Asia/HarbinAsia/HebronAsia/Ho_Chi_Minh
Asia/Hong_KongAsia/HovdAsia/Irkutsk
Asia/IstanbulAsia/JakartaAsia/Jayapura
Asia/JerusalemAsia/KabulAsia/Kamchatka
Asia/KarachiAsia/KashgarAsia/Kathmandu
Asia/KatmanduAsia/KhandygaAsia/Kolkata
Asia/KrasnoyarskAsia/Kuala_LumpurAsia/Kuching
Asia/KuwaitAsia/MacaoAsia/Macau
Asia/MagadanAsia/MakassarAsia/Manila
Asia/MuscatAsia/NicosiaAsia/Novokuznetsk
Asia/NovosibirskAsia/OmskAsia/Oral
Asia/Phnom_PenhAsia/PontianakAsia/Pyongyang
Asia/QatarAsia/QyzylordaAsia/Rangoon
Asia/RiyadhAsia/SaigonAsia/Sakhalin
Asia/SamarkandAsia/SeoulAsia/Shanghai
Asia/SingaporeAsia/SrednekolymskAsia/Taipei
Asia/TashkentAsia/TbilisiAsia/Tehran
Asia/Tel_AvivAsia/ThimbuAsia/Thimphu
Asia/TokyoAsia/TomskAsia/Ujung_Pandang
Asia/UlaanbaatarAsia/Ulan_BatorAsia/Urumqi
Asia/Ust-NeraAsia/VientianeAsia/Vladivostok
Asia/YakutskAsia/YangonAsia/Yekaterinburg
Asia/YerevanAtlantic/AzoresAtlantic/Bermuda
Atlantic/CanaryAtlantic/Cape_VerdeAtlantic/Faeroe
Atlantic/FaroeAtlantic/Jan_MayenAtlantic/Madeira
Atlantic/ReykjavikAtlantic/South_GeorgiaAtlantic/St_Helena
Atlantic/StanleyAustralia/ACTAustralia/Adelaide
Australia/BrisbaneAustralia/Broken_HillAustralia/Canberra
Australia/CurrieAustralia/DarwinAustralia/Eucla
Australia/HobartAustralia/LHIAustralia/Lindeman
Australia/Lord_HoweAustralia/MelbourneAustralia/NSW
Australia/NorthAustralia/PerthAustralia/Queensland
Australia/SouthAustralia/SydneyAustralia/Tasmania
Australia/VictoriaAustralia/WestAustralia/Yancowinna
Brazil/AcreBrazil/DeNoronhaBrazil/East
Brazil/WestCETCST6CDT
Canada/AtlanticCanada/CentralCanada/Eastern
Canada/MountainCanada/NewfoundlandCanada/Pacific
Canada/SaskatchewanCanada/YukonChile/Continental
Chile/EasterIslandCubaEET
EST5EDTEgyptEire
Europe/AmsterdamEurope/AndorraEurope/Astrakhan
Europe/AthensEurope/BelfastEurope/Belgrade
Europe/BerlinEurope/BratislavaEurope/Brussels
Europe/BucharestEurope/BudapestEurope/Busingen
Europe/ChisinauEurope/CopenhagenEurope/Dublin
Europe/GibraltarEurope/GuernseyEurope/Helsinki
Europe/Isle_of_ManEurope/IstanbulEurope/Jersey
Europe/KaliningradEurope/KievEurope/Kirov
Europe/LisbonEurope/LjubljanaEurope/London
Europe/LuxembourgEurope/MadridEurope/Malta
Europe/MariehamnEurope/MinskEurope/Monaco
Europe/MoscowEurope/NicosiaEurope/Oslo
Europe/ParisEurope/PodgoricaEurope/Prague
Europe/RigaEurope/RomeEurope/Samara
Europe/San_MarinoEurope/SarajevoEurope/Saratov
Europe/SimferopolEurope/SkopjeEurope/Sofia
Europe/StockholmEurope/TallinnEurope/Tirane
Europe/TiraspolEurope/UlyanovskEurope/Uzhgorod
Europe/VaduzEurope/VaticanEurope/Vienna
Europe/VilniusEurope/VolgogradEurope/Warsaw
Europe/ZagrebEurope/ZaporozhyeEurope/Zurich
GBGB-EireGMT
GMT0GreenwichHongkong
IcelandIndian/AntananarivoIndian/Chagos
Indian/ChristmasIndian/CocosIndian/Comoro
Indian/KerguelenIndian/MaheIndian/Maldives
Indian/MauritiusIndian/MayotteIndian/Reunion
IranIsraelJamaica
KwajaleinLibyaMET
MST7MDTMexico/BajaNorteMexico/BajaSur
Mexico/GeneralNZNZ-CHAT
NavajoPRCPST8PDT
Pacific/ApiaPacific/AucklandPacific/Bougainville
Pacific/ChathamPacific/ChuukPacific/Easter
Pacific/EfatePacific/EnderburyPacific/Fakaofo
Pacific/FijiPacific/FunafutiPacific/Galapagos
Pacific/GambierPacific/GuadalcanalPacific/Guam
Pacific/HonoluluPacific/JohnstonPacific/Kiritimati
Pacific/KosraePacific/KwajaleinPacific/Majuro
Pacific/MarquesasPacific/MidwayPacific/Nauru
Pacific/NiuePacific/NorfolkPacific/Noumea
Pacific/Pago_PagoPacific/PalauPacific/Pitcairn
Pacific/PohnpeiPacific/PonapePacific/Port_Moresby
Pacific/RarotongaPacific/SaipanPacific/Samoa
Pacific/TahitiPacific/TarawaPacific/Tongatapu
Pacific/TrukPacific/WakePacific/Wallis
Pacific/YapPolandPortugal
ROKTurkeyUCT
US/AlaskaUS/AleutianUS/Arizona
US/CentralUS/East-IndianaUS/Eastern
US/HawaiiUS/Indiana-StarkeUS/Michigan
US/MountainUS/PacificUS/Pacific-New
US/SamoaUTCUniversal
W-SUWETZulu
ESTHSTMST
ACTAETAGT
ARTASTBET
BSTCATCNT
CSTCTTEAT
ECTIETIST
JSTMITNET
NSTPLTPNT
PRTPSTSST
VST

Usage for Query Criteria

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

Not Support URIs

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

Not Support Properties

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

  • Hotspot Service

    • CREATE INTERNAL
      Remove
      trafficClassProfileId signatureSigningKey internalNode
  • Hotspot Profile

    • CREATE INTERNAL
      Remove
      trafficClassProfileId signatureSigningKey internalNode
  • SCG USER

    Remove
    companyName

What’s New

  • API

    • AP Group
      • Disable LTE band lock channel override
    • Access Point Configuration
      • Disable LTE band lock channel override
    • Administration
      • Create - Admin AAA Server
      • Retrieve - Admin AAA Server
      • Retrieve List - Admin AAA Server
      • Modify - Admin AAA Server
      • Delete - Admin AAA Server
    • Session Management
      • Retrieve
    • SystemIPsec
      • Retrieve System IPSec
      • Modify System IPSec
    • Vendor Specific Attribute Profile
      • Get Vendor Specific Attribute Profiles
      • Get Vendor Specific Attribute Profile
      • Create Vendor Specific Attribute Profile
      • Modify Entire Vendor Specific Attribute Profile
      • Delete Vendor Specific Attribute Profile
      • Bulk Delete Vendor Specific Attribute Profile
      • Query Vendor Specific Attribute Profiles
    • Wired Client
      • Deauth Wired Client
      • Bulk Deauth Wired Client
  • Properties

    • AP Group
      • Retrieve Default AP Group
        • lteBandLockChannels
      • Modify
        • lteBandLockChannels
      • Modify Recovery SSID Override
        • lteBandLockChannels
      • Create
        • lteBandLockChannels
      • Retrieve
        • lteBandLockChannels
      • Retrieve AP Model
        • lacp
      • Override AP Model
        • lacp
    • Access Point Configuration
      • Modify Specific
        • lacp
      • Modify Recovery SSID Override
        • lteBandLockChannels
      • Retrieve
        • lteBandLockChannels
      • Modify User Location Info
        • lteBandLockChannels
      • Modify
        • lteBandLockChannels
    • Account Security
      • Get the account security profile by id
        • minimumPasswordLength
      • Modify
        • minimumPasswordLength
      • Modify the account security profile
        • minimumPasswordLength
      • Create the account security profile.
        • minimumPasswordLength
    • IPSEC Profile
      • Retrieve
        • tunnelMode
      • Create ipsec
        • tunnelMode
    • System
      • Retrieve NBI
        • radiusAuthType
      • Modify NBI Basic
        • radiusAuthType
      • Retrieve System Time
        • authenticationKey
      • Modify System Time
        • authenticationKey
    • WLAN
      • Modify RADIUS Options
        • vendorSpecificAttributeProfileId
      • Modify Advanced Options
        • dhcp82SubOpt1Format, dhcp82SubOpt2Format, dhcp82SubOpt150Format, dhcp82SubOpt151Format, dhcp82SubOpt151AreaName, dropRandomProbesEnabled
    • WLAN Group
      • Add Member
        • name
    • Ruckus Wireless AP Zone
      • Change the Zone’s IPsec Profiles
        • enforcePriorityZoneAffinityEnable, channel144Enabled, ipsecTunnelMode, lteBandLockChannels, apHccdEnabled, apHccdPersist
      • Create Zone of IPv6
        • zoneAffinityProfileId, enforcePriorityZoneAffinityEnable, channel144Enabled, ipsecTunnelMode, lteBandLockChannels, apHccdEnabled, apHccdPersist
      • Create Zone of Dual
        • zoneAffinityProfileId, enforcePriorityZoneAffinityEnable, channel144Enabled, ipsecTunnelMode, lteBandLockChannels, apHccdEnabled, apHccdPersist
      • Modify entire zone
        • enforcePriorityZoneAffinityEnable, channel144Enabled, ipsecTunnelMode, lteBandLockChannels, apHccdEnabled, apHccdPersist
      • Retrieve AP Model
        • lacp
      • Modify AP Model
        • lacp
      • Retrieve AP Model Common Attribute
        • meshRadioCaps
      • Retrieve
        • channel144Enabled, ipsecTunnelMode, lteBandLockChannels, apHccdEnabled, apHccdPersist
      • Modify
        • enforcePriorityZoneAffinityEnable, channel144Enabled, ipsecTunnelMode, lteBandLockChannels, apHccdEnabled, apHccdPersist
      • Create Zone
        • zoneAffinityProfileId, enforcePriorityZoneAffinityEnable, channel144Enabled, ipsecTunnelMode, lteBandLockChannels, apHccdEnabled, apHccdPersist
    • Web Authentication
      • Retrieve
        • webAuthenticationPortalCustomization
      • Create
        • webAuthenticationPortalCustomization
      • Modify
        • webAuthenticationPortalCustomization

What’s Deprecated

  • API

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"
  ]
}
Schema
{
  "type": "object",
  "properties": {
    "apiSupportVersions": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}

Logon

Service Ticket

  • Logon

POST/v8_1/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/v8_1/serviceTicket

Use this API command to log off of the controller.

URI Parameters
HideShow
serviceTicket
string (required) 
Response  200

Session ID

  • Logon

POST/v8_1/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/v8_1/session

Use this API command to log off of the controller.

Response  200

  • Retrieve

GET/v8_1/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"
    }
  }
}

Session Management

Retrieve

GET/v8_1/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 DHCP/NAT service configuration within Domain

POST/v8_1/rkszones/services/dhcpSiteConfig/query

Use this API command to modify DHCP/NAT service configuration of Domain. Please click the link for the usage of Query Criteria.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
    }
  ],
  "fullTextSearch": {
    "type": "AND",
    "value": ""
  },
  "attributes": [
    "*"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "filters": {
      "description": "Filters used to select specific resource scope",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Group type",
            "type": "string",
            "enum": [
              "SYSTEM",
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "SWITCH_GROUP"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "Operator for filtering",
            "type": "string",
            "enum": [
              "eq"
            ]
          }
        },
        "required": [
          "type",
          "value"
        ]
      }
    },
    "extraFilters": {
      "description": "\"AND\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "VERSION"
            ]
          },
          "value": {
            "description": "Value for filtering",
            "type": "string"
          },
          "operator": {
            "description": "Operator for filtering",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        },
        "required": [
          "type",
          "value"
        ]
      }
    },
    "options": {
      "description": "Specified feature required information.",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "zone_ipmode": {
          "description": "List the zones only with the specified IP Mode.",
          "type": "string",
          "enum": [
            "IPV4",
            "IPV6",
            "IPV4_IPV6"
          ]
        },
        "includeSharedResources": {
          "description": "Include the resources of parent domain as well while querying.",
          "type": "boolean"
        }
      }
    },
    "extraTimeRange": {
      "description": "Specified data time range of selection",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "number"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "number"
        },
        "interval": {
          "description": "time interval in second",
          "type": "number"
        },
        "field": {
          "description": "time field for collecting data",
          "type": "string",
          "enum": [
            "insertionTime"
          ]
        }
      }
    },
    "fullTextSearch": {
      "description": "Specified search string",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "description": "Search logic operator",
          "type": "string",
          "enum": [
            "AND",
            "OR"
          ]
        },
        "value": {
          "description": "Text or number to search",
          "type": "string"
        },
        "fields": {
          "description": "Specific fields to search",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "attributes": {
      "description": "Get specific columns only",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "sortInfo": {
      "description": "About sorting",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sortColumn": {
          "type": "string"
        },
        "dir": {
          "type": "string",
          "enum": [
            "ASC",
            "DESC"
          ]
        }
      }
    },
    "page": {
      "description": "Page number to get",
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "description": "Size of one page",
      "type": "integer",
      "minimum": 1
    },
    "expandDomains": {
      "description": "Whether to expand domains into sub domains/ zones or not",
      "type": "boolean"
    },
    "criteria": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    },
    "query": {
      "description": "Add backward compatibility for UI framework",
      "type": "string"
    }
  }
}
Response  200
HideShow
Body
{
  "totalCount": 2,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "zoneName": "Default Zone",
      "siteEnabled": false,
      "dwpdEnabled": false,
      "manualSelect": false,
      "siteMode": "EnableOnEachAPs",
      "siteProfiles": [],
      "siteAps": []
    },
    {
      "zoneName": "zoneK",
      "siteEnabled": true,
      "dwpdEnabled": false,
      "manualSelect": false,
      "siteMode": "EnableOnEachAPs",
      "siteProfiles": [
        {
          "id": "c1b60951-eeb6-11e6-850a-525400f698b4",
          "zoneId": "fce48fb7-8b89-49f6-8ce5-f52aecfc81ff",
          "name": "P01",
          "description": "",
          "vlanId": 10,
          "subnetNetworkIp": "192.168.10.0",
          "subnetMask": "255.255.255.0",
          "poolStartIp": "192.168.10.1",
          "poolEndIp": "192.168.10.100",
          "primaryDnsIp": "",
          "secondaryDnsIp": "",
          "leaseTimeHours": 0,
          "leaseTimeMinutes": 5
        }
      ],
      "siteAps": [
        {
          "apMac": "EC:8C:A2:01:C5:B0",
          "apServerEnabled": true,
          "apServerPrimary": true,
          "apServerIp": "192.168.10.1",
          "apGatewayIp": "192.168.10.1",
          "apName": "RuckusAP",
          "apStatus": "Offline"
        }
      ]
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "zoneName": {
            "description": "DHCP Service Zone Name",
            "type": "string"
          },
          "siteEnabled": {
            "description": "DHCP Service Enabling Status",
            "type": "boolean"
          },
          "dwpdEnabled": {
            "description": "DHCP Service Dynamic WAN Port Detection",
            "type": "boolean"
          },
          "manualSelect": {
            "description": "DHCP Service AP Selection Mode",
            "type": "boolean"
          },
          "siteMode": {
            "description": "DHCP Service mode",
            "type": "string",
            "enum": [
              "EnableOnEachAPs",
              "EnableOnMultipleAPs",
              "EnableOnHierarchicalAPs"
            ]
          },
          "eth0ProfileId": {
            "type": "integer"
          },
          "eth1ProfileId": {
            "type": "integer"
          },
          "siteAps": {
            "type": "array",
            "items": {
              "type": "object",
              "description": "DHCP Site selected APs",
              "additionalProperties": false,
              "properties": {
                "apMac": {
                  "type": "string"
                },
                "apName": {
                  "type": "string"
                },
                "apStatus": {
                  "type": "string",
                  "enum": [
                    "Online",
                    "Offline",
                    "Flagged"
                  ]
                },
                "apServerEnabled": {
                  "type": "boolean"
                },
                "apServerPrimary": {
                  "type": "boolean"
                },
                "apServerIp": {
                  "type": "string"
                },
                "apGatewayIp": {
                  "type": "string"
                },
                "apServerType": {
                  "type": "string"
                }
              }
            }
          },
          "siteProfiles": {
            "type": "array",
            "items": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "zoneId": {
                  "description": "Zone Id of DHCP Profile",
                  "type": "string"
                },
                "id": {
                  "description": "Identifier of the DHCP Profile",
                  "type": "string"
                },
                "name": {
                  "description": "Name of the DHCP Profile",
                  "type": "string",
                  "minLength": 2,
                  "maxLength": 32,
                  "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
                },
                "description": {
                  "description": "Description of the DHCP Profile",
                  "type": [
                    "string",
                    "null"
                  ],
                  "maxLength": 64
                },
                "vlanId": {
                  "description": "VLAN ID of the DHCP Profile",
                  "type": "integer",
                  "minimum": 1,
                  "maximum": 4094
                },
                "subnetNetworkIp": {
                  "description": "Subnet Network IP of the DHCP Profile",
                  "type": "string"
                },
                "subnetMask": {
                  "description": "Subnet Mask of the DHCP Profile",
                  "type": "string"
                },
                "poolStartIp": {
                  "description": "Pool Starting IP of the DHCP Profile",
                  "type": "string"
                },
                "poolEndIp": {
                  "description": "Pool Ending IP of the DHCP Profile",
                  "type": "string"
                },
                "primaryDnsIp": {
                  "description": "Primany DNS IP of the DHCP Profile",
                  "type": "string"
                },
                "secondaryDnsIp": {
                  "description": "Secondary DNS IP of the DHCP Profile",
                  "type": "string"
                },
                "leaseTimeHours": {
                  "description": "Lease time in hours of the DHCP Profile",
                  "type": "integer",
                  "minimum": 0,
                  "maximum": 24
                },
                "leaseTimeMinutes": {
                  "description": "Lease time in minutes of the DHCP Profile",
                  "type": "integer",
                  "minimum": 0,
                  "maximum": 59
                }
              }
            }
          }
        }
      }
    }
  }
}

Retrieve DHCP/NAT service IP assignment

POST/v8_1/rkszones/{zoneId}/dhcpSite/dhcpSiteConfig/doAssignIp

Use this API command to get the DHCP/NAT service IP assignment when selecting with “Enable on Multiple APs”. In the Manually Select AP mode (the manualSelect is true), the body should contain the selected APs (include the siteAps array). Otherwise, there is no need to include the selected APs in the Auto Select AP mode (see samples).

Request
HideShow
Body
‧ Sample : Assign IP for DHCP Service of EnableOnMultipleAPs with Manually Select AP
{
    "siteEnabled" : true,
    "dwpdEnabled" : false,
    "manualSelect" : true,
    "siteMode" : "EnableOnMultipleAPs",
    "siteAps" : [ {
        "apMac" : "38:FF:36:00:0E:10",
        "apServerEnabled" : true,
        "apServerPrimary" : true
    }, {
        "apMac" : "58:FF:36:00:0E:20",
        "apServerEnabled" : true,
        "apServerPrimary" : true
    } ],
    "siteProfileIds" : [ "75e26590-547f-11e6-9ca7-5a095364c13c", "869bb532-547f-11e6-9ca7-5a095364c13c" ]
}
‧ Sample : Assign IP for DHCP Service of EnableOnMultipleAPs with Auto Select AP
{
    "siteEnabled" : true,
    "dwpdEnabled" : false,
    "manualSelect" : false,
    "siteMode" : "EnableOnMultipleAPs",
    "siteProfileIds" : [ "75e26590-547f-11e6-9ca7-5a095364c13c", "869bb532-547f-11e6-9ca7-5a095364c13c" ]
}
Schema
{
    "description" : "DHCP Service Assign IP For Server and Gateway",
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "siteEnabled" : {
            "description" : "DHCP Service Enabling Status",
            "type" : "boolean"
        },
        "dwpdEnabled" : {
            "description" : "DHCP Service Dynamic WAN Port Detection",
            "type" : "boolean"
        },
        "manualSelect" : {
            "description" : "DHCP Service AP Selection Mode. This value is effective when the siteMode is EnableOnMultipleAPs.",
            "type" : "boolean"
        },
        "siteMode" : {
            "description" : "DHCP Service mode",
            "type" : "string",
            "enum" : [ "EnableOnEachAPs", "EnableOnMultipleAPs", "EnableOnHierarchicalAPs" ]
        },
        "siteAps" : {
            "type" : "array",
            "items" : {
                "type" : "object",
                "description" : "DHCP Site selected APs. The content is effective when the siteMode is EnableOnMultipleAPs.",
                "additionalProperties" : false,
                "properties" : {
                    "apMac" : {
                        "type" : "string"
                    },
                    "apServerEnabled" : {
                        "type" : "boolean"
                    },
                    "apServerPrimary" : {
                        "type" : "boolean"
                    }
                }
            }
        },
        "siteProfileIds" : {
            "type" : "array",
            "items" : {
                "type" : "string"
            }
        }
    }
}
Response  200
HideShow
Body
{
  "zoneName": "zoneK",
  "siteEnabled": true,
  "dwpdEnabled": false,
  "manualSelect": true,
  "siteMode": "EnableOnMultipleAPs",
  "siteAps": [
    {
      "apMac": "38:FF:36:00:0E:20",
      "apServerEnabled": true,
      "apGatewayEnabled": true
    },
    {
      "apMac": "58:FF:36:00:0E:20",
      "apServerEnabled": true,
      "apGatewayEnabled": true
    }
  ],
  "siteProfiles": [
    "75e26590-547f-11e6-9ca7-5a095364c13c",
    "869bb532-547f-11e6-9ca7-5a095364c13c"
  ]
}
Schema
{
  "description": "DHCP Site Configuration in Zone",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "zoneName": {
      "description": "DHCP Service Zone Name",
      "type": "string"
    },
    "siteEnabled": {
      "description": "DHCP Service Enabling Status",
      "type": "boolean"
    },
    "dwpdEnabled": {
      "description": "DHCP Service Dynamic WAN Port Detection",
      "type": "boolean"
    },
    "manualSelect": {
      "description": "DHCP Service AP Selection Mode",
      "type": "boolean"
    },
    "siteMode": {
      "description": "DHCP Service mode",
      "type": "string",
      "enum": [
        "EnableOnEachAPs",
        "EnableOnMultipleAPs",
        "EnableOnHierarchicalAPs"
      ]
    },
    "eth0ProfileId": {
      "type": "integer"
    },
    "eth1ProfileId": {
      "type": "integer"
    },
    "siteAps": {
      "type": "array",
      "items": {
        "type": "object",
        "description": "DHCP Site selected APs",
        "additionalProperties": false,
        "properties": {
          "apMac": {
            "type": "string"
          },
          "apName": {
            "type": "string"
          },
          "apStatus": {
            "type": "string",
            "enum": [
              "Online",
              "Offline",
              "Flagged"
            ]
          },
          "apServerEnabled": {
            "type": "boolean"
          },
          "apServerPrimary": {
            "type": "boolean"
          },
          "apServerIp": {
            "type": "string"
          },
          "apGatewayIp": {
            "type": "string"
          },
          "apServerType": {
            "type": "string"
          }
        }
      }
    },
    "siteProfiles": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "zoneId": {
            "description": "Zone Id of DHCP Profile",
            "type": "string"
          },
          "id": {
            "description": "Identifier of the DHCP Profile",
            "type": "string"
          },
          "name": {
            "description": "Name of the DHCP Profile",
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
          },
          "description": {
            "description": "Description of the DHCP Profile",
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64
          },
          "vlanId": {
            "description": "VLAN ID of the DHCP Profile",
            "type": "integer",
            "minimum": 1,
            "maximum": 4094
          },
          "subnetNetworkIp": {
            "description": "Subnet Network IP of the DHCP Profile",
            "type": "string"
          },
          "subnetMask": {
            "description": "Subnet Mask of the DHCP Profile",
            "type": "string"
          },
          "poolStartIp": {
            "description": "Pool Starting IP of the DHCP Profile",
            "type": "string"
          },
          "poolEndIp": {
            "description": "Pool Ending IP of the DHCP Profile",
            "type": "string"
          },
          "primaryDnsIp": {
            "description": "Primany DNS IP of the DHCP Profile",
            "type": "string"
          },
          "secondaryDnsIp": {
            "description": "Secondary DNS IP of the DHCP Profile",
            "type": "string"
          },
          "leaseTimeHours": {
            "description": "Lease time in hours of the DHCP Profile",
            "type": "integer",
            "minimum": 0,
            "maximum": 24
          },
          "leaseTimeMinutes": {
            "description": "Lease time in minutes of the DHCP Profile",
            "type": "integer",
            "minimum": 0,
            "maximum": 59
          }
        }
      }
    }
  }
}

Modify AP Latency Interval

PATCH/v8_1/rkszones/{id}/apLatencyInterval

Modify AP Latency Interval of a zone.

Request
HideShow
Body
{
  "pingEnabled": true
}
Schema
{
  "description": "AP latency interval",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "pingEnabled": {
      "description": "AP ping latency enabled",
      "type": "boolean"
    }
  }
}
Response  204

Change the Zone's Ruckus GRE Tunnel Profile

PATCH/v8_1/rkszones/{id}/ruckusGreTunnelProfile

Use this API command to change the Zone’s Ruckus GRE Tunnel Profile.

Request
HideShow
Body
{
  "domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
  "zoneAffinityProfileId": "3fd9aa91-df65-11e7-98e1-08002748d78e",
  "enforcePriorityZoneAffinityEnable": false,
  "name": "modifyZoneName",
  "description": "description Zone",
  "countryCode": "US",
  "timezone": {
    "systemTimezone": "America/Whitehorse"
  },
  "login": {
    "apLoginName": "admin",
    "apLoginPassword": "admin!234"
  },
  "mesh": {
    "ssid": "meshSSID",
    "passphrase": "passphrase"
  },
  "dfsChannelEnabled": false,
  "wifi24": {
    "txPower": "Full",
    "channelWidth": 20,
    "channel": 0,
    "channelRange": [
      1,
      2,
      3,
      4,
      5,
      6,
      7,
      8,
      9,
      10,
      11
    ]
  },
  "wifi50": {
    "txPower": "-1dB",
    "channelWidth": 40,
    "indoorChannel": 0,
    "outdoorChannel": 0,
    "indoorChannelRange": [
      36,
      40,
      44,
      48,
      149,
      153,
      157,
      161
    ],
    "outdoorChannelRange": [
      149,
      153,
      157,
      161
    ]
  },
  "protectionMode24": "CTS_ONLY",
  "syslog": {
    "address": "1.1.1.1",
    "port": 514,
    "facility": "Local0",
    "priority": "Error"
  },
  "smartMonitor": {
    "intervalInSec": 10,
    "retryThreshold": 3
  },
  "nodeAffinityProfile": null,
  "venueProfile": null,
  "locationBasedService": null,
  "channelModeEnabled": false,
  "bonjourFencingPolicy": null,
  "tunnelType": "RuckusGRE",
  "tunnelProfile": {
    "id": "f5b92938-aa4e-4d02-90ea-273799ff689b",
    "name": "Default Tunnel Profile"
  },
  "clientAdmissionControl24": {
    "maxRadioLoadPercent": 70,
    "minClientCount": 10,
    "minClientThroughputMbps": 10
  },
  "clientAdmissionControl50": {
    "maxRadioLoadPercent": 70,
    "minClientCount": 10,
    "minClientThroughputMbps": 10
  },
  "backgroundScanning24": {
    "frequencyInSec": 20
  },
  "backgroundScanning50": {
    "frequencyInSec": 20
  },
  "clientLoadBalancing24": {
    "adjacentRadioThreshold": 12
  },
  "clientLoadBalancing50": {
    "adjacentRadioThreshold": 12
  },
  "bandBalancing": {
    "wifi24Percentage": 10
  },
  "loadBalancingMethod": "BASED_ON_CLIENT_COUNT",
  "rogue": {
    "reportType": "All",
    "maliciousTypes": null,
    "protectionEnabled": true
  },
  "dosBarringEnable": 0,
  "dosBarringPeriod": 60,
  "dosBarringThreshold": 5,
  "dosBarringCheckPeriod": 30,
  "apRebootTimeout": {
    "gatewayLossTimeoutInSec": 1800,
    "serverLossTimeoutInSec": 7200
  },
  "location": "location",
  "locationAdditionalInfo": "locationAdditionalInfo",
  "latitude": 23,
  "longitude": 23,
  "vlanOverlappingEnabled": false,
  "autoChannelSelection24": {
    "channelSelectMode": "ChannelFly",
    "channelFlyMtbc": 480
  },
  "autoChannelSelection50": {
    "channelSelectMode": "BackgroundScanning",
    "channelFlyMtbc": 480
  },
  "channelEvaluationInterval": 777,
  "apMgmtVlan": {
    "id": 1,
    "mode": "KEEP"
  },
  "apLatencyInterval": {
    "pingEnabled": true
  },
  "ipsecProfile": {
    "id": "ipsecProfileId",
    "name": "ipsecProfileName"
  },
  "altitude": {
    "altitudeUnit": "meters",
    "altitudeValue": 1
  },
  "bonjourFencingPolicyEnabled": false,
  "snmpAgent": {
    "apSnmpEnabled": true,
    "snmpV2Agent": [
      {
        "communityName": "v2Agent",
        "notificationEnabled": true,
        "readEnabled": true,
        "writeEnabled": true,
        "notificationType": "TRAP",
        "notificationTarget": [
          {
            "address": "172.19.16.20",
            "port": 161
          }
        ]
      }
    ],
    "snmpV3Agent": [
      {
        "userName": "v3Agent",
        "authProtocol": "MD5",
        "authPassword": "admin!234",
        "privProtocol": "DES",
        "privPassword": "admin!234",
        "notificationEnabled": true,
        "readEnabled": true,
        "writeEnabled": true,
        "notificationType": "TRAP",
        "notificationTarget": [
          {
            "address": "172.19.16.20",
            "port": 161
          }
        ]
      }
    ]
  },
  "recoverySsid": {
    "recoverySsidEnabled": true
  },
  "dhcpSiteConfig": {
    "siteEnabled": true,
    "siteMode": "EnableOnEachAPs",
    "siteProfileIds": [
      "75e26590-547f-11e6-9ca7-5a095364c13c",
      "869bb532-547f-11e6-9ca7-5a095364c13c"
    ]
  },
  "rogueApReportThreshold": 40,
  "rogueApAggressivenessMode": 2,
  "rogueApJammingDetection": true,
  "rogueApJammingThreshold": 40,
  "directedMulticastFromWiredClientEnabled": true,
  "directedMulticastFromWirelessClientEnabled": true,
  "directedMulticastFromNetworkEnabled": false,
  "healthCheckSitesEnabled": true,
  "healthCheckSites": [
    "www.google.com",
    "www.live.com:443",
    "www.github.com:443",
    "source.codeaurora.org:443",
    "www.wikipedia.com"
  ],
  "ruckusGreTunnelProfile": {
    "id": "f5b92938-aa4e-4d02-90ea-273799ff689b",
    "name": "Default Tunnel Profile"
  },
  "softGreTunnelProflies": [
    {
      "id": "5a2e41b0-df53-11e7-98e1-08002748d78e",
      "name": "softGre1",
      "aaaAffinityEnabled": true
    },
    {
      "id": "7803e411-df53-11e7-98e1-08002748d78e",
      "name": "softGre2",
      "aaaAffinityEnabled": true
    }
  ],
  "ipsecProfiles": [
    {
      "id": "3fd9aa91-df65-11e7-98e1-08002748d78e",
      "name": "ipsec1"
    }
  ],
  "ipsecTunnelMode": "SOFT_GRE",
  "sshTunnelEncryption": "AES128",
  "lteBandLockChannels": [
    {
      "simCardId": 0,
      "type": "EC25E",
      "channel4g": "B1,B3,B5",
      "channel3g": "B5"
    },
    {
      "simCardId": 1,
      "type": "EC25E",
      "channel4g": "",
      "channel3g": ""
    }
  ],
  "apHccdEnabled": true,
  "apHccdPersist": true
}
Schema
{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "domainId" : {
            "description" : "Identifier of the management domain to which the zone belongs",
            "type" : "string"
        },
        "zoneAffinityProfileId" : {
            "description" : "Identifier of the ZoneAffinityProfile",
            "type" : "string"
        },
        "enforcePriorityZoneAffinityEnable" : {
            "description" : "Enforce the priority of zone affinity",
            "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
        },
        "countryCode" : {
            "description" : "Country code of the zone",
            "type" : "string"
        },
        "timezone" : {
            "description" : "Either systemTimezone or customizedTimezone must be specified",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "systemTimezone" : {
                    "description" : "System defined time zone, please refer to the “Overview > Time Zone” list",
                    "type" : "string"
                },
                "customizedTimezone" : {
                    "description" : "User defined time zone",
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "abbreviation" : {
                            "description" : "Time zone abbreviation",
                            "type" : "string",
                            "pattern" : "^[a-zA-Z]{3,4}$"
                        },
                        "gmtOffset" : {
                            "description" : "GMT offset",
                            "type" : "integer",
                            "minimum" : -11,
                            "maximum" : 14
                        },
                        "gmtOffsetMinute" : {
                            "description" : "GMT offset minute",
                            "type" : "integer",
                            "minimum" : 0,
                            "maximum" : 59
                        },
                        "start" : {
                            "description" : "Daylight saving time start",
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "month" : {
                                    "description" : "Month when daylight saving time begins",
                                    "type" : "integer",
                                    "enum" : [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ]
                                },
                                "week" : {
                                    "description" : "Week of the month (1 for the first week, 2 for the second week, and so on)",
                                    "type" : "integer",
                                    "enum" : [ 1, 2, 3, 4, 5 ]
                                },
                                "day" : {
                                    "description" : "Day of the week (0 for Sunday, 1 for Monday, 2 for Tuesday, and so on)",
                                    "type" : "integer",
                                    "enum" : [ 0, 1, 2, 3, 4, 5, 6 ]
                                },
                                "hour" : {
                                    "description" : "Hour of the day",
                                    "type" : "integer",
                                    "minimum" : 0,
                                    "maximum" : 23
                                }
                            },
                            "required" : [ "month", "week", "day", "hour" ]
                        },
                        "end" : {
                            "description" : "Daylight saving time end",
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "month" : {
                                    "description" : "Month when daylight saving time begins",
                                    "type" : "integer",
                                    "enum" : [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ]
                                },
                                "week" : {
                                    "description" : "Week of the month (1 for the first week, 2 for the second week, and so on)",
                                    "type" : "integer",
                                    "enum" : [ 1, 2, 3, 4, 5 ]
                                },
                                "day" : {
                                    "description" : "Day of the week (0 for Sunday, 1 for Monday, 2 for Tuesday, and so on)",
                                    "type" : "integer",
                                    "enum" : [ 0, 1, 2, 3, 4, 5, 6 ]
                                },
                                "hour" : {
                                    "description" : "Hour of the day",
                                    "type" : "integer",
                                    "minimum" : 0,
                                    "maximum" : 23
                                }
                            },
                            "required" : [ "month", "week", "day", "hour" ]
                        }
                    },
                    "required" : [ "abbreviation", "gmtOffset", "gmtOffsetMinute" ]
                }
            }
        },
        "login" : {
            "description" : "AP administrator account",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "apLoginName" : {
                    "description" : "User name of the AP administrator",
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : "^((?!\$\()[!-_a-~]){1,64}$"
                },
                "apLoginPassword" : {
                    "description" : "Password of the AP administrator",
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : ".*(?=.{8,})(?=.*[a-zA-Z])(?=.*[0-9])(?=.*[_`[email protected]#$%^&*\(\)\[\]\{\}|;:'\",.\<>\/?=+-]).*"
                }
            },
            "required" : [ "apLoginName", "apLoginPassword" ]
        },
        "mesh" : {
            "description" : "Mesh configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "ssid" : {
                    "description" : "SSID of the mesh network",
                    "type" : "string"
                },
                "passphrase" : {
                    "description" : "Passphrase for the mesh network",
                    "type" : "string"
                },
                "meshRadioIdx" : {
                    "description" : "Mesh radio index",
                    "type" : "string",
                    "enum" : [ "Radio24G", "Radio5G" ]
                },
                "zeroTouchStatus" : {
                    "type" : "boolean"
                }
            }
        },
        "dfsChannelEnabled" : {
            "description" : "DFS Channel enabled configuration of the zone, only for the US country code .",
            "type" : "boolean"
        },
        "cbandChannelEnabled" : {
            "description" : "5.8Ghz channels enabled configuration of the zone.",
            "type" : "boolean"
        },
        "cbandChannelLicenseEnabled" : {
            "description" : "5.8Ghz channels license enabled configuration of the zone.",
            "type" : "boolean"
        },
        "channel144Enabled" : {
            "description" : "Channel 144 enabled configuration of the zone.",
            "type" : "boolean"
        },
        "wifi24" : {
            "description" : "AP 2.4GHz radio configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "autoCellSizing" : {
                    "description" : "Auto Cell Sizing",
                    "type" : "boolean"
                },
                "txPower" : {
                    "description" : "Transmission power",
                    "type" : "string",
                    "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ]
                },
                "channelWidth" : {
                    "description" : "Channel width. Zero (0) means Auto.",
                    "type" : "integer",
                    "enum" : [ 0, 20, 40 ]
                },
                "channel" : {
                    "description" : "Channel number",
                    "type" : "integer"
                },
                "channelRange" : {
                    "description" : "Channel range options",
                    "type" : "array",
                    "items" : {
                        "type" : "integer"
                    }
                }
            }
        },
        "wifi50" : {
            "description" : "AP 5GHz radio configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "autoCellSizing" : {
                    "description" : "Auto Cell Sizing",
                    "type" : "boolean"
                },
                "txPower" : {
                    "description" : "Transmission power",
                    "type" : "string",
                    "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ]
                },
                "channelWidth" : {
                    "description" : "Channel width. Zero (0) means Auto. 8080 means 80+80MHz",
                    "type" : "integer",
                    "enum" : [ 0, 20, 40, 80, 8080, 160 ]
                },
                "indoorChannel" : {
                    "description" : "Channel number for Indoor AP",
                    "type" : "integer"
                },
                "outdoorChannel" : {
                    "description" : "Channel number for Outdoor AP",
                    "type" : "integer"
                },
                "indoorSecondaryChannel" : {
                    "description" : "Secondary channel number for Indoor AP (channelWidth is 80+80MHz only)",
                    "type" : "integer"
                },
                "outdoorSecondaryChannel" : {
                    "description" : "Secondary channel number for outdoor AP (channelWidth is 80+80MHz only)",
                    "type" : "integer"
                },
                "indoorChannelRange" : {
                    "description" : "Channel range options for Indoor AP",
                    "type" : "array",
                    "items" : {
                        "type" : "integer"
                    }
                },
                "outdoorChannelRange" : {
                    "description" : "Channel range options for outdoor AP",
                    "type" : "array",
                    "items" : {
                        "type" : "integer"
                    }
                }
            }
        },
        "protectionMode24" : {
            "description" : "AP 2.4GHz Protection mode configuration of the zone.",
            "type" : "string",
            "enum" : [ "NONE", "CTS_ONLY", "RTS_CTS" ]
        },
        "syslog" : {
            "description" : "Syslog configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "flowLevel" : {
                    "description" : "Flow Level of the syslog",
                    "type" : "string",
                    "enum" : [ "GENERAL_LOGS", "CLIENT_FLOW", "ALL" ]
                },
                "address" : {
                    "description" : "Address of the syslog server.",
                    "type" : "string"
                },
                "port" : {
                    "description" : "Port number of the syslog server",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 65535
                },
                "protocol" : {
                    "description" : "Protocol of the syslog server",
                    "type" : "string",
                    "enum" : [ "IPPROTO_TCP", "IPPROTO_UDP" ]
                },
                "secondaryAddress" : {
                    "description" : "Secondary Server Address of the syslog server",
                    "type" : "string"
                },
                "secondaryPort" : {
                    "description" : "Secondary Server Port of the syslog server",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 65535
                },
                "secondaryProtocol" : {
                    "description" : "Secondary Server Protocol of the syslog server",
                    "type" : "string",
                    "enum" : [ "IPPROTO_TCP", "IPPROTO_UDP" ]
                },
                "facility" : {
                    "description" : "Facility of the syslog server",
                    "type" : "string",
                    "enum" : [ "Keep_Original", "Local0", "Local1", "Local2", "Local3", "Local4", "Local5", "Local6", "Local7" ]
                },
                "priority" : {
                    "description" : "Priority of the log messages",
                    "type" : "string",
                    "enum" : [ "Emergency", "Alert", "Critical", "Error", "Warning", "Notice", "Info", "All" ]
                }
            }
        },
        "smartMonitor" : {
            "description" : "Smart monitor configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "intervalInSec" : {
                    "description" : "Interval in seconds. This is required if smartMonitor is enabled",
                    "type" : "integer",
                    "minimum" : 5,
                    "maximum" : 60
                },
                "retryThreshold" : {
                    "description" : "Retry threshold. This is required if smartMonitor is enabled",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 10
                }
            }
        },
        "clientAdmissionControl24" : {
            "description" : "AP client admission control 2.4GHz radio configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "maxRadioLoadPercent" : {
                    "description" : "Maximum radio load percentage.",
                    "type" : "integer",
                    "minimum" : 50,
                    "maximum" : 100
                },
                "minClientCount" : {
                    "description" : "Minimum client count number.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 100
                },
                "minClientThroughputMbps" : {
                    "description" : "Minimum client throughput in Mbps.",
                    "type" : "number",
                    "minimum" : 0,
                    "maximum" : 100
                }
            }
        },
        "clientAdmissionControl50" : {
            "description" : "AP client admission control 5GHz radio configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "maxRadioLoadPercent" : {
                    "description" : "Maximum radio load percentage.",
                    "type" : "integer",
                    "minimum" : 50,
                    "maximum" : 100
                },
                "minClientCount" : {
                    "description" : "Minimum client count number.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 100
                },
                "minClientThroughputMbps" : {
                    "description" : "Minimum client throughput in Mbps.",
                    "type" : "number",
                    "minimum" : 0,
                    "maximum" : 100
                }
            }
        },
        "channelModeEnabled" : {
            "description" : "Channel mode configuration of the zone.",
            "type" : "boolean"
        },
        "tunnelType" : {
            "description" : "Tunnel type configuration of the zone. No_Tunneled is for IPv6 mode",
            "type" : "string",
            "enum" : [ "No_Tunneled", "RuckusGRE", "SoftGRE", "SoftGREIpsec" ]
        },
        "tunnelProfile" : {
            "description" : "Tunnel type configuration of the zone.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "backgroundScanning24" : {
            "description" : "Background scanning on 2.4GHz radio configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "frequencyInSec" : {
                    "description" : "Frequency in second",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 65535
                }
            }
        },
        "backgroundScanning50" : {
            "description" : "Background scanning on 5GHz radio configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "frequencyInSec" : {
                    "description" : "Frequency in second",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 65535
                }
            }
        },
        "clientLoadBalancing24" : {
            "description" : "Client load balancing on 2.4GHz radio configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "adjacentRadioThreshold" : {
                    "description" : "Adjacent radio threshold",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 100
                }
            }
        },
        "clientLoadBalancing50" : {
            "description" : "Client load balancing on 5GHz radio configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "adjacentRadioThreshold" : {
                    "description" : "Adjacent radio threshold",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 100
                }
            }
        },
        "bandBalancing" : {
            "description" : "Band balancing configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "mode" : {
                    "description" : "Band Balancing Mode: BASIC-Withholds probe and authentication responses at connetcion time in heavily loaded band to balance clients to the other band, PROACTIVE-Uses BASIC functionality and actively rebalances clients via 802.11v BTM, STRICT-Uses PROACTIVE functionality and forcefully rebalances clients via 802.11v BTM",
                    "type" : "string",
                    "enum" : [ "BASIC", "PROACTIVE", "STRICT" ]
                },
                "wifi24Percentage" : {
                    "description" : "Percentage of client load on 2.4GHz radio band",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 100
                }
            }
        },
        "loadBalancingMethod" : {
            "type" : "string",
            "enum" : [ "BASED_ON_CLIENT_COUNT", "BASED_ON_CAPACITY", "OFF" ]
        },
        "rogue" : {
            "description" : "Rogue AP detection configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "reportType" : {
                    "description" : "Report type",
                    "type" : "string",
                    "enum" : [ "All", "Malicious" ]
                },
                "maliciousTypes" : {
                    "description" : "Malicious type when reportType is Malicious",
                    "type" : [ "array", "null" ],
                    "items" : {
                        "type" : "string",
                        "enum" : [ "SSIDSpoofing", "SameNetwork", "MACSpoofing" ]
                    }
                },
                "protectionEnabled" : {
                    "description" : "Protection enabled",
                    "type" : "boolean"
                }
            }
        },
        "dosBarringEnable" : {
            "description" : "Enable DoS Protection(Barring UE) of the zone.",
            "type" : "integer"
        },
        "dosBarringPeriod" : {
            "description" : "DoS Protection(Barring UE) blocking period of the zone.",
            "type" : "integer"
        },
        "dosBarringThreshold" : {
            "description" : "DoS Protection(Barring UE) threshold of the zone.",
            "type" : "integer"
        },
        "dosBarringCheckPeriod" : {
            "description" : "DoS Protection(Barring UE) check period of the zone.",
            "type" : "integer"
        },
        "locationBasedService" : {
            "description" : "Location based service configuration of the zone.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "apRebootTimeout" : {
            "description" : "AP reboot timeout of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "gatewayLossTimeoutInSec" : {
                    "description" : "Gateway loss timeout in second",
                    "type" : "integer",
                    "enum" : [ 0, 1800, 3600, 5400, 7200, 9000, 10800, 12600, 14400, 16200, 18000, 19800, 23400, 25200, 27000, 28800, 30600, 32400, 34200, 36000, 37800, 39600, 41400, 43200, 45000, 46800, 48600, 50400, 52200, 54000, 55800, 57600, 59400, 61200, 63000, 64800, 66600, 68400, 70200, 72000, 73800, 75600, 77400, 79200, 81000, 82800, 84600, 86400 ]
                },
                "serverLossTimeoutInSec" : {
                    "description" : "Server loss timeout in second",
                    "type" : "integer",
                    "enum" : [ 0, 7200, 14400, 21600, 28800, 36000, 43200, 50400, 57600, 64800, 72000, 79200, 86400 ]
                }
            }
        },
        "location" : {
            "description" : "Location of the zone.",
            "type" : "string"
        },
        "locationAdditionalInfo" : {
            "description" : "Location additional info of the zone.",
            "type" : "string",
            "pattern" : "^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
        },
        "altitude" : {
            "description" : "GPS Altitude",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "altitudeUnit" : {
                    "description" : "altitude unit",
                    "type" : "string",
                    "enum" : [ "meters", "floor" ]
                },
                "altitudeValue" : {
                    "description" : "altitude value",
                    "type" : "integer"
                }
            }
        },
        "latitude" : {
            "description" : "Latitude coordinate (in decimal format) of the zone",
            "type" : "number"
        },
        "longitude" : {
            "description" : "Longitude coordinate (in decimal format) of the zone",
            "type" : "number"
        },
        "vlanOverlappingEnabled" : {
            "description" : "VLAN pooling overlapping of the zone",
            "type" : "boolean"
        },
        "nodeAffinityProfile" : {
            "description" : "Node affinity profile of the zone.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "venueProfile" : {
            "description" : "Venue profile configuration of the zone.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "autoChannelSelection24" : {
            "description" : "client load balancing on Radio 2.4G, auto channel selection mode",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "channelSelectMode" : {
                    "description" : "Channel Select Mode",
                    "type" : "string",
                    "enum" : [ "None", "BackgroundScanning", "ChannelFly" ]
                },
                "channelFlyMtbc" : {
                    "description" : "ChannelFly MTBC",
                    "type" : "integer",
                    "minimum" : 100,
                    "maximum" : 1440
                }
            }
        },
        "autoChannelSelection50" : {
            "description" : "client load balancing on Radio 5G, auto channel selection mode",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "channelSelectMode" : {
                    "description" : "Channel Select Mode",
                    "type" : "string",
                    "enum" : [ "None", "BackgroundScanning", "ChannelFly" ]
                },
                "channelFlyMtbc" : {
                    "description" : "ChannelFly MTBC",
                    "type" : "integer",
                    "minimum" : 100,
                    "maximum" : 1440
                }
            }
        },
        "channelEvaluationInterval" : {
            "description" : "channel evaluation Interval of the zone",
            "type" : "integer",
            "minimum" : 60,
            "maximum" : 3600
        },
        "apMgmtVlan" : {
            "description" : "ap Management Vlan of the zone",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "mode" : {
                    "description" : "Vlan Mode of the zone",
                    "type" : "string",
                    "enum" : [ "KEEP", "USER_DEFINED" ]
                },
                "id" : {
                    "description" : "Vlan id of the zone",
                    "type" : "integer"
                }
            }
        },
        "apLatencyInterval" : {
            "description" : "AP latency interval",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "pingEnabled" : {
                    "description" : "AP ping latency enabled",
                    "type" : "boolean"
                }
            }
        },
        "ipsecProfile" : {
            "description" : "ipsec profile configuration of the Zone.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "ipv6TrafficFilterEnabled" : {
            "description" : "IPv6 Traffic filtering on the AP",
            "type" : "integer"
        },
        "bonjourFencingPolicyEnabled" : {
            "description" : "Enable Bonjour Fencing Policy on the AP",
            "type" : "boolean"
        },
        "bonjourFencingPolicy" : {
            "description" : "Bonjour Fencing Policy on the AP",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "dhcpSiteConfig" : {
            "description" : "DHCP Site Configuration in Zone",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "siteEnabled" : {
                    "description" : "DHCP Service Enabling Status",
                    "type" : "boolean"
                },
                "dwpdEnabled" : {
                    "description" : "DHCP Service Dynamic WAN Port Detection",
                    "type" : "boolean"
                },
                "manualSelect" : {
                    "description" : "DHCP Service AP Selection Mode. This value is effective when the siteMode is EnableOnMultipleAPs.",
                    "type" : "boolean"
                },
                "siteMode" : {
                    "description" : "DHCP Service mode",
                    "type" : "string",
                    "enum" : [ "EnableOnEachAPs", "EnableOnMultipleAPs", "EnableOnHierarchicalAPs" ]
                },
                "eth0ProfileId" : {
                    "type" : "integer"
                },
                "eth1ProfileId" : {
                    "type" : "integer"
                },
                "siteAps" : {
                    "type" : "array",
                    "items" : {
                        "type" : "object",
                        "description" : "DHCP Site selected APs. The content is effective when the siteMode is EnableOnMultipleAPs.",
                        "additionalProperties" : false,
                        "properties" : {
                            "apMac" : {
                                "type" : "string"
                            },
                            "apName" : {
                                "type" : "string"
                            },
                            "apStatus" : {
                                "type" : "string",
                                "enum" : [ "Online", "Offline", "Flagged" ]
                            },
                            "apServerEnabled" : {
                                "type" : "boolean"
                            },
                            "apServerPrimary" : {
                                "type" : "boolean"
                            },
                            "apServerIp" : {
                                "type" : [ "string", "null" ]
                            },
                            "apGatewayIp" : {
                                "type" : "string"
                            },
                            "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"
                },
                "snmpV2Agent" : {
                    "description" : "Community List of the SNMP V2 Agent.",
                    "type" : "array",
                    "items" : {
                        "type" : "object",
                        "additionalProperties" : false,
                        "properties" : {
                            "communityName" : {
                                "description" : "name of the SNMP Community.",
                                "type" : "string"
                            },
                            "readEnabled" : {
                                "description" : "read privilege of the SNMP Coummunity",
                                "type" : "boolean"
                            },
                            "writeEnabled" : {
                                "description" : "write privilege of the SNMP Coummunity",
                                "type" : "boolean"
                            },
                            "notificationEnabled" : {
                                "description" : "notification privilege of the SNMP Coummunity",
                                "type" : "boolean"
                            },
                            "notificationType" : {
                                "description" : "type of the notification privilege",
                                "type" : "string",
                                "enum" : [ "TRAP", "INFORM" ]
                            },
                            "notificationTarget" : {
                                "description" : "Trap List of the SNMP Coummunity",
                                "type" : "array",
                                "items" : {
                                    "type" : "object",
                                    "additionalProperties" : false,
                                    "properties" : {
                                        "address" : {
                                            "description" : "address of the SNMP Trap",
                                            "type" : "string"
                                        },
                                        "port" : {
                                            "description" : "port number of the SNMP Trap",
                                            "type" : "integer",
                                            "minimum" : 1,
                                            "maximum" : 65535
                                        }
                                    },
                                    "required" : [ "address", "port" ]
                                }
                            }
                        },
                        "required" : [ "communityName" ]
                    }
                },
                "snmpV3Agent" : {
                    "description" : "User List of the SNMP V3 Agent.",
                    "type" : "array",
                    "items" : {
                        "type" : "object",
                        "additionalProperties" : false,
                        "properties" : {
                            "userName" : {
                                "description" : "name of the SNMP User.",
                                "type" : "string"
                            },
                            "authProtocol" : {
                                "description" : "authProtocol of the SNMP User.",
                                "type" : "string",
                                "enum" : [ "NONE", "MD5", "SHA" ]
                            },
                            "authPassword" : {
                                "description" : "authPassword of the SNMP User.",
                                "type" : "string",
                                "minLength" : 8
                            },
                            "privProtocol" : {
                                "description" : "privProtocol of the SNMP User.",
                                "type" : "string",
                                "enum" : [ "NONE", "DES", "AES" ]
                            },
                            "privPassword" : {
                                "description" : "privPassword of the SNMP User.",
                                "type" : "string",
                                "minLength" : 8
                            },
                            "readEnabled" : {
                                "description" : "read privilege of the SNMP User",
                                "type" : "boolean"
                            },
                            "writeEnabled" : {
                                "description" : "write privilege of the SNMP User",
                                "type" : "boolean"
                            },
                            "notificationEnabled" : {
                                "description" : "notification privilege of the SNMP User",
                                "type" : "boolean"
                            },
                            "notificationType" : {
                                "description" : "type of the notification privilege",
                                "type" : "string",
                                "enum" : [ "TRAP", "INFORM" ]
                            },
                            "notificationTarget" : {
                                "description" : "Trap List of the SNMP User",
                                "type" : "array",
                                "items" : {
                                    "type" : "object",
                                    "additionalProperties" : false,
                                    "properties" : {
                                        "address" : {
                                            "description" : "address of the SNMP Trap",
                                            "type" : "string"
                                        },
                                        "port" : {
                                            "description" : "port number of the SNMP Trap",
                                            "type" : "integer",
                                            "minimum" : 1,
                                            "maximum" : 65535
                                        }
                                    },
                                    "required" : [ "address", "port" ]
                                }
                            }
                        },
                        "required" : [ "userName" ]
                    }
                }
            }
        },
        "recoverySsid" : {
            "description" : "Recovery SSID",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "recoverySsidEnabled" : {
                    "description" : "recovery ssid enable/disable",
                    "type" : "boolean"
                }
            }
        },
        "clusterRedundancyEnabled" : {
            "description" : "Enable Cluster redundancy on zone",
            "type" : "boolean"
        },
        "rogueApReportThreshold" : {
            "description" : "Rogue AP report will leave out all entries that have signal strength lower than this threshold.",
            "type" : "integer"
        },
        "rogueApAggressivenessMode" : {
            "description" : "Adjust the frequency interval to de-authenticate rogue APs.",
            "type" : "integer"
        },
        "rogueApJammingDetection" : {
            "description" : "Enable jamming detection.",
            "type" : "boolean"
        },
        "rogueApJammingThreshold" : {
            "type" : "integer"
        },
        "directedMulticastFromWiredClientEnabled" : {
            "description" : "Directed multicast from wired client.",
            "type" : "boolean"
        },
        "directedMulticastFromWirelessClientEnabled" : {
            "description" : "Directed multicast from wireless client.",
            "type" : "boolean"
        },
        "directedMulticastFromNetworkEnabled" : {
            "description" : "Directed multicast from network.",
            "type" : "boolean"
        },
        "healthCheckSitesEnabled" : {
            "description" : "Enabled Health Check Sites. ",
            "type" : "boolean"
        },
        "healthCheckSites" : {
            "description" : "Health Check Sites.",
            "type" : "array",
            "items" : {
                "type" : "string"
            }
        },
        "ruckusGreTunnelProfile" : {
            "description" : "Ruckus GRE Profile for Multiple Tunnel (Start from SZ 5.0)",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "softGreTunnelProflies" : {
            "description" : "SoftGRE Profiles for Multiple Tunnel (Start from SZ 5.0)",
            "type" : "array",
            "items" : {
                "type" : [ "object", "null" ],
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "type" : "string"
                    },
                    "name" : {
                        "type" : "string"
                    },
                    "aaaAffinityEnabled" : {
                        "type" : "boolean"
                    }
                }
            }
        },
        "ipsecProfiles" : {
            "description" : "Ipsec profile for Multiple Tunnel (Start from SZ 5.0)",
            "type" : "array",
            "items" : {
                "type" : [ "object", "null" ],
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "type" : "string"
                    },
                    "name" : {
                        "type" : "string"
                    }
                }
            }
        },
        "ipsecTunnelMode" : {
            "type" : "string",
            "enum" : [ "DISABLE", "SOFT_GRE", "RUCKUS_GRE" ]
        },
        "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"
                    }
                }
            }
        },
        "apHccdEnabled" : {
            "description" : "Historical Connection Failures allows the AP to report historical client connection failures for this zone.",
            "type" : "boolean"
        },
        "apHccdPersist" : {
            "description" : "Allow Historical Connection Failures to be persisted.",
            "type" : "boolean"
        }
    }
}
Response  204

Change the Zone's SoftGRE Tunnel Profiles

PATCH/v8_1/rkszones/{id}/softGreTunnelProflies

Use this API command to change the Zone’s SoftGRE tunnel profiles.

Request
HideShow
Body
{
  "domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
  "zoneAffinityProfileId": "3fd9aa91-df65-11e7-98e1-08002748d78e",
  "enforcePriorityZoneAffinityEnable": false,
  "name": "modifyZoneName",
  "description": "description Zone",
  "countryCode": "US",
  "timezone": {
    "systemTimezone": "America/Whitehorse"
  },
  "login": {
    "apLoginName": "admin",
    "apLoginPassword": "admin!234"
  },
  "mesh": {
    "ssid": "meshSSID",
    "passphrase": "passphrase"
  },
  "dfsChannelEnabled": false,
  "wifi24": {
    "txPower": "Full",
    "channelWidth": 20,
    "channel": 0,
    "channelRange": [
      1,
      2,
      3,
      4,
      5,
      6,
      7,
      8,
      9,
      10,
      11
    ]
  },
  "wifi50": {
    "txPower": "-1dB",
    "channelWidth": 40,
    "indoorChannel": 0,
    "outdoorChannel": 0,
    "indoorChannelRange": [
      36,
      40,
      44,
      48,
      149,
      153,
      157,
      161
    ],
    "outdoorChannelRange": [
      149,
      153,
      157,
      161
    ]
  },
  "protectionMode24": "CTS_ONLY",
  "syslog": {
    "address": "1.1.1.1",
    "port": 514,
    "facility": "Local0",
    "priority": "Error"
  },
  "smartMonitor": {
    "intervalInSec": 10,
    "retryThreshold": 3
  },
  "nodeAffinityProfile": null,
  "venueProfile": null,
  "locationBasedService": null,
  "channelModeEnabled": false,
  "bonjourFencingPolicy": null,
  "tunnelType": "RuckusGRE",
  "tunnelProfile": {
    "id": "f5b92938-aa4e-4d02-90ea-273799ff689b",
    "name": "Default Tunnel Profile"
  },
  "clientAdmissionControl24": {
    "maxRadioLoadPercent": 70,
    "minClientCount": 10,
    "minClientThroughputMbps": 10
  },
  "clientAdmissionControl50": {
    "maxRadioLoadPercent": 70,
    "minClientCount": 10,
    "minClientThroughputMbps": 10
  },
  "backgroundScanning24": {
    "frequencyInSec": 20
  },
  "backgroundScanning50": {
    "frequencyInSec": 20
  },
  "clientLoadBalancing24": {
    "adjacentRadioThreshold": 12
  },
  "clientLoadBalancing50": {
    "adjacentRadioThreshold": 12
  },
  "bandBalancing": {
    "wifi24Percentage": 10
  },
  "loadBalancingMethod": "BASED_ON_CLIENT_COUNT",
  "rogue": {
    "reportType": "All",
    "maliciousTypes": null,
    "protectionEnabled": true
  },
  "dosBarringEnable": 0,
  "dosBarringPeriod": 60,
  "dosBarringThreshold": 5,
  "dosBarringCheckPeriod": 30,
  "apRebootTimeout": {
    "gatewayLossTimeoutInSec": 1800,
    "serverLossTimeoutInSec": 7200
  },
  "location": "location",
  "locationAdditionalInfo": "locationAdditionalInfo",
  "latitude": 23,
  "longitude": 23,
  "vlanOverlappingEnabled": false,
  "autoChannelSelection24": {
    "channelSelectMode": "ChannelFly",
    "channelFlyMtbc": 480
  },
  "autoChannelSelection50": {
    "channelSelectMode": "BackgroundScanning",
    "channelFlyMtbc": 480
  },
  "channelEvaluationInterval": 777,
  "apMgmtVlan": {
    "id": 1,
    "mode": "KEEP"
  },
  "apLatencyInterval": {
    "pingEnabled": true
  },
  "ipsecProfile": {
    "id": "ipsecProfileId",
    "name": "ipsecProfileName"
  },
  "altitude": {
    "altitudeUnit": "meters",
    "altitudeValue": 1
  },
  "bonjourFencingPolicyEnabled": false,
  "snmpAgent": {
    "apSnmpEnabled": true,
    "snmpV2Agent": [
      {
        "communityName": "v2Agent",
        "notificationEnabled": true,
        "readEnabled": true,
        "writeEnabled": true,
        "notificationType": "TRAP",
        "notificationTarget": [
          {
            "address": "172.19.16.20",
            "port": 161
          }
        ]
      }
    ],
    "snmpV3Agent": [
      {
        "userName": "v3Agent",
        "authProtocol": "MD5",
        "authPassword": "admin!234",
        "privProtocol": "DES",
        "privPassword": "admin!234",
        "notificationEnabled": true,
        "readEnabled": true,
        "writeEnabled": true,
        "notificationType": "TRAP",
        "notificationTarget": [
          {
            "address": "172.19.16.20",
            "port": 161
          }
        ]
      }
    ]
  },
  "recoverySsid": {
    "recoverySsidEnabled": true
  },
  "dhcpSiteConfig": {
    "siteEnabled": true,
    "siteMode": "EnableOnEachAPs",
    "siteProfileIds": [
      "75e26590-547f-11e6-9ca7-5a095364c13c",
      "869bb532-547f-11e6-9ca7-5a095364c13c"
    ]
  },
  "rogueApReportThreshold": 40,
  "rogueApAggressivenessMode": 2,
  "rogueApJammingDetection": true,
  "rogueApJammingThreshold": 40,
  "directedMulticastFromWiredClientEnabled": true,
  "directedMulticastFromWirelessClientEnabled": true,
  "directedMulticastFromNetworkEnabled": false,
  "healthCheckSitesEnabled": true,
  "healthCheckSites": [
    "www.google.com",
    "www.live.com:443",
    "www.github.com:443",
    "source.codeaurora.org:443",
    "www.wikipedia.com"
  ],
  "ruckusGreTunnelProfile": {
    "id": "f5b92938-aa4e-4d02-90ea-273799ff689b",
    "name": "Default Tunnel Profile"
  },
  "softGreTunnelProflies": [
    {
      "id": "5a2e41b0-df53-11e7-98e1-08002748d78e",
      "name": "softGre1",
      "aaaAffinityEnabled": true
    },
    {
      "id": "7803e411-df53-11e7-98e1-08002748d78e",
      "name": "softGre2",
      "aaaAffinityEnabled": true
    }
  ],
  "ipsecProfiles": [
    {
      "id": "3fd9aa91-df65-11e7-98e1-08002748d78e",
      "name": "ipsec1"
    }
  ],
  "ipsecTunnelMode": "SOFT_GRE",
  "sshTunnelEncryption": "AES128",
  "lteBandLockChannels": [
    {
      "simCardId": 0,
      "type": "EC25E",
      "channel4g": "B1,B3,B5",
      "channel3g": "B5"
    },
    {
      "simCardId": 1,
      "type": "EC25E",
      "channel4g": "",
      "channel3g": ""
    }
  ],
  "apHccdEnabled": true,
  "apHccdPersist": true
}
Schema
{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "domainId" : {
            "description" : "Identifier of the management domain to which the zone belongs",
            "type" : "string"
        },
        "zoneAffinityProfileId" : {
            "description" : "Identifier of the ZoneAffinityProfile",
            "type" : "string"
        },
        "enforcePriorityZoneAffinityEnable" : {
            "description" : "Enforce the priority of zone affinity",
            "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
        },
        "countryCode" : {
            "description" : "Country code of the zone",
            "type" : "string"
        },
        "timezone" : {
            "description" : "Either systemTimezone or customizedTimezone must be specified",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "systemTimezone" : {
                    "description" : "System defined time zone, please refer to the “Overview > Time Zone” list",
                    "type" : "string"
                },
                "customizedTimezone" : {
                    "description" : "User defined time zone",
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "abbreviation" : {
                            "description" : "Time zone abbreviation",
                            "type" : "string",
                            "pattern" : "^[a-zA-Z]{3,4}$"
                        },
                        "gmtOffset" : {
                            "description" : "GMT offset",
                            "type" : "integer",
                            "minimum" : -11,
                            "maximum" : 14
                        },
                        "gmtOffsetMinute" : {
                            "description" : "GMT offset minute",
                            "type" : "integer",
                            "minimum" : 0,
                            "maximum" : 59
                        },
                        "start" : {
                            "description" : "Daylight saving time start",
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "month" : {
                                    "description" : "Month when daylight saving time begins",
                                    "type" : "integer",
                                    "enum" : [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ]
                                },
                                "week" : {
                                    "description" : "Week of the month (1 for the first week, 2 for the second week, and so on)",
                                    "type" : "integer",
                                    "enum" : [ 1, 2, 3, 4, 5 ]
                                },
                                "day" : {
                                    "description" : "Day of the week (0 for Sunday, 1 for Monday, 2 for Tuesday, and so on)",
                                    "type" : "integer",
                                    "enum" : [ 0, 1, 2, 3, 4, 5, 6 ]
                                },
                                "hour" : {
                                    "description" : "Hour of the day",
                                    "type" : "integer",
                                    "minimum" : 0,
                                    "maximum" : 23
                                }
                            },
                            "required" : [ "month", "week", "day", "hour" ]
                        },
                        "end" : {
                            "description" : "Daylight saving time end",
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "month" : {
                                    "description" : "Month when daylight saving time begins",
                                    "type" : "integer",
                                    "enum" : [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ]
                                },
                                "week" : {
                                    "description" : "Week of the month (1 for the first week, 2 for the second week, and so on)",
                                    "type" : "integer",
                                    "enum" : [ 1, 2, 3, 4, 5 ]
                                },
                                "day" : {
                                    "description" : "Day of the week (0 for Sunday, 1 for Monday, 2 for Tuesday, and so on)",
                                    "type" : "integer",
                                    "enum" : [ 0, 1, 2, 3, 4, 5, 6 ]
                                },
                                "hour" : {
                                    "description" : "Hour of the day",
                                    "type" : "integer",
                                    "minimum" : 0,
                                    "maximum" : 23
                                }
                            },
                            "required" : [ "month", "week", "day", "hour" ]
                        }
                    },
                    "required" : [ "abbreviation", "gmtOffset", "gmtOffsetMinute" ]
                }
            }
        },
        "login" : {
            "description" : "AP administrator account",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "apLoginName" : {
                    "description" : "User name of the AP administrator",
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : "^((?!\$\()[!-_a-~]){1,64}$"
                },
                "apLoginPassword" : {
                    "description" : "Password of the AP administrator",
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : ".*(?=.{8,})(?=.*[a-zA-Z])(?=.*[0-9])(?=.*[_`[email protected]#$%^&*\(\)\[\]\{\}|;:'\",.\<>\/?=+-]).*"
                }
            },
            "required" : [ "apLoginName", "apLoginPassword" ]
        },
        "mesh" : {
            "description" : "Mesh configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "ssid" : {
                    "description" : "SSID of the mesh network",
                    "type" : "string"
                },
                "passphrase" : {
                    "description" : "Passphrase for the mesh network",
                    "type" : "string"
                },
                "meshRadioIdx" : {
                    "description" : "Mesh radio index",
                    "type" : "string",
                    "enum" : [ "Radio24G", "Radio5G" ]
                },
                "zeroTouchStatus" : {
                    "type" : "boolean"
                }
            }
        },
        "dfsChannelEnabled" : {
            "description" : "DFS Channel enabled configuration of the zone, only for the US country code .",
            "type" : "boolean"
        },
        "cbandChannelEnabled" : {
            "description" : "5.8Ghz channels enabled configuration of the zone.",
            "type" : "boolean"
        },
        "cbandChannelLicenseEnabled" : {
            "description" : "5.8Ghz channels license enabled configuration of the zone.",
            "type" : "boolean"
        },
        "channel144Enabled" : {
            "description" : "Channel 144 enabled configuration of the zone.",
            "type" : "boolean"
        },
        "wifi24" : {
            "description" : "AP 2.4GHz radio configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "autoCellSizing" : {
                    "description" : "Auto Cell Sizing",
                    "type" : "boolean"
                },
                "txPower" : {
                    "description" : "Transmission power",
                    "type" : "string",
                    "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ]
                },
                "channelWidth" : {
                    "description" : "Channel width. Zero (0) means Auto.",
                    "type" : "integer",
                    "enum" : [ 0, 20, 40 ]
                },
                "channel" : {
                    "description" : "Channel number",
                    "type" : "integer"
                },
                "channelRange" : {
                    "description" : "Channel range options",
                    "type" : "array",
                    "items" : {
                        "type" : "integer"
                    }
                }
            }
        },
        "wifi50" : {
            "description" : "AP 5GHz radio configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "autoCellSizing" : {
                    "description" : "Auto Cell Sizing",
                    "type" : "boolean"
                },
                "txPower" : {
                    "description" : "Transmission power",
                    "type" : "string",
                    "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ]
                },
                "channelWidth" : {
                    "description" : "Channel width. Zero (0) means Auto. 8080 means 80+80MHz",
                    "type" : "integer",
                    "enum" : [ 0, 20, 40, 80, 8080, 160 ]
                },
                "indoorChannel" : {
                    "description" : "Channel number for Indoor AP",
                    "type" : "integer"
                },
                "outdoorChannel" : {
                    "description" : "Channel number for Outdoor AP",
                    "type" : "integer"
                },
                "indoorSecondaryChannel" : {
                    "description" : "Secondary channel number for Indoor AP (channelWidth is 80+80MHz only)",
                    "type" : "integer"
                },
                "outdoorSecondaryChannel" : {
                    "description" : "Secondary channel number for outdoor AP (channelWidth is 80+80MHz only)",
                    "type" : "integer"
                },
                "indoorChannelRange" : {
                    "description" : "Channel range options for Indoor AP",
                    "type" : "array",
                    "items" : {
                        "type" : "integer"
                    }
                },
                "outdoorChannelRange" : {
                    "description" : "Channel range options for outdoor AP",
                    "type" : "array",
                    "items" : {
                        "type" : "integer"
                    }
                }
            }
        },
        "protectionMode24" : {
            "description" : "AP 2.4GHz Protection mode configuration of the zone.",
            "type" : "string",
            "enum" : [ "NONE", "CTS_ONLY", "RTS_CTS" ]
        },
        "syslog" : {
            "description" : "Syslog configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "flowLevel" : {
                    "description" : "Flow Level of the syslog",
                    "type" : "string",
                    "enum" : [ "GENERAL_LOGS", "CLIENT_FLOW", "ALL" ]
                },
                "address" : {
                    "description" : "Address of the syslog server.",
                    "type" : "string"
                },
                "port" : {
                    "description" : "Port number of the syslog server",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 65535
                },
                "protocol" : {
                    "description" : "Protocol of the syslog server",
                    "type" : "string",
                    "enum" : [ "IPPROTO_TCP", "IPPROTO_UDP" ]
                },
                "secondaryAddress" : {
                    "description" : "Secondary Server Address of the syslog server",
                    "type" : "string"
                },
                "secondaryPort" : {
                    "description" : "Secondary Server Port of the syslog server",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 65535
                },
                "secondaryProtocol" : {
                    "description" : "Secondary Server Protocol of the syslog server",
                    "type" : "string",
                    "enum" : [ "IPPROTO_TCP", "IPPROTO_UDP" ]
                },
                "facility" : {
                    "description" : "Facility of the syslog server",
                    "type" : "string",
                    "enum" : [ "Keep_Original", "Local0", "Local1", "Local2", "Local3", "Local4", "Local5", "Local6", "Local7" ]
                },
                "priority" : {
                    "description" : "Priority of the log messages",
                    "type" : "string",
                    "enum" : [ "Emergency", "Alert", "Critical", "Error", "Warning", "Notice", "Info", "All" ]
                }
            }
        },
        "smartMonitor" : {
            "description" : "Smart monitor configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "intervalInSec" : {
                    "description" : "Interval in seconds. This is required if smartMonitor is enabled",
                    "type" : "integer",
                    "minimum" : 5,
                    "maximum" : 60
                },
                "retryThreshold" : {
                    "description" : "Retry threshold. This is required if smartMonitor is enabled",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 10
                }
            }
        },
        "clientAdmissionControl24" : {
            "description" : "AP client admission control 2.4GHz radio configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "maxRadioLoadPercent" : {
                    "description" : "Maximum radio load percentage.",
                    "type" : "integer",
                    "minimum" : 50,
                    "maximum" : 100
                },
                "minClientCount" : {
                    "description" : "Minimum client count number.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 100
                },
                "minClientThroughputMbps" : {
                    "description" : "Minimum client throughput in Mbps.",
                    "type" : "number",
                    "minimum" : 0,
                    "maximum" : 100
                }
            }
        },
        "clientAdmissionControl50" : {
            "description" : "AP client admission control 5GHz radio configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "maxRadioLoadPercent" : {
                    "description" : "Maximum radio load percentage.",
                    "type" : "integer",
                    "minimum" : 50,
                    "maximum" : 100
                },
                "minClientCount" : {
                    "description" : "Minimum client count number.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 100
                },
                "minClientThroughputMbps" : {
                    "description" : "Minimum client throughput in Mbps.",
                    "type" : "number",
                    "minimum" : 0,
                    "maximum" : 100
                }
            }
        },
        "channelModeEnabled" : {
            "description" : "Channel mode configuration of the zone.",
            "type" : "boolean"
        },
        "tunnelType" : {
            "description" : "Tunnel type configuration of the zone. No_Tunneled is for IPv6 mode",
            "type" : "string",
            "enum" : [ "No_Tunneled", "RuckusGRE", "SoftGRE", "SoftGREIpsec" ]
        },
        "tunnelProfile" : {
            "description" : "Tunnel type configuration of the zone.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "backgroundScanning24" : {
            "description" : "Background scanning on 2.4GHz radio configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "frequencyInSec" : {
                    "description" : "Frequency in second",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 65535
                }
            }
        },
        "backgroundScanning50" : {
            "description" : "Background scanning on 5GHz radio configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "frequencyInSec" : {
                    "description" : "Frequency in second",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 65535
                }
            }
        },
        "clientLoadBalancing24" : {
            "description" : "Client load balancing on 2.4GHz radio configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "adjacentRadioThreshold" : {
                    "description" : "Adjacent radio threshold",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 100
                }
            }
        },
        "clientLoadBalancing50" : {
            "description" : "Client load balancing on 5GHz radio configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "adjacentRadioThreshold" : {
                    "description" : "Adjacent radio threshold",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 100
                }
            }
        },
        "bandBalancing" : {
            "description" : "Band balancing configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "mode" : {
                    "description" : "Band Balancing Mode: BASIC-Withholds probe and authentication responses at connetcion time in heavily loaded band to balance clients to the other band, PROACTIVE-Uses BASIC functionality and actively rebalances clients via 802.11v BTM, STRICT-Uses PROACTIVE functionality and forcefully rebalances clients via 802.11v BTM",
                    "type" : "string",
                    "enum" : [ "BASIC", "PROACTIVE", "STRICT" ]
                },
                "wifi24Percentage" : {
                    "description" : "Percentage of client load on 2.4GHz radio band",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 100
                }
            }
        },
        "loadBalancingMethod" : {
            "type" : "string",
            "enum" : [ "BASED_ON_CLIENT_COUNT", "BASED_ON_CAPACITY", "OFF" ]
        },
        "rogue" : {
            "description" : "Rogue AP detection configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "reportType" : {
                    "description" : "Report type",
                    "type" : "string",
                    "enum" : [ "All", "Malicious" ]
                },
                "maliciousTypes" : {
                    "description" : "Malicious type when reportType is Malicious",
                    "type" : [ "array", "null" ],
                    "items" : {
                        "type" : "string",
                        "enum" : [ "SSIDSpoofing", "SameNetwork", "MACSpoofing" ]
                    }
                },
                "protectionEnabled" : {
                    "description" : "Protection enabled",
                    "type" : "boolean"
                }
            }
        },
        "dosBarringEnable" : {
            "description" : "Enable DoS Protection(Barring UE) of the zone.",
            "type" : "integer"
        },
        "dosBarringPeriod" : {
            "description" : "DoS Protection(Barring UE) blocking period of the zone.",
            "type" : "integer"
        },
        "dosBarringThreshold" : {
            "description" : "DoS Protection(Barring UE) threshold of the zone.",
            "type" : "integer"
        },
        "dosBarringCheckPeriod" : {
            "description" : "DoS Protection(Barring UE) check period of the zone.",
            "type" : "integer"
        },
        "locationBasedService" : {
            "description" : "Location based service configuration of the zone.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "apRebootTimeout" : {
            "description" : "AP reboot timeout of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "gatewayLossTimeoutInSec" : {
                    "description" : "Gateway loss timeout in second",
                    "type" : "integer",
                    "enum" : [ 0, 1800, 3600, 5400, 7200, 9000, 10800, 12600, 14400, 16200, 18000, 19800, 23400, 25200, 27000, 28800, 30600, 32400, 34200, 36000, 37800, 39600, 41400, 43200, 45000, 46800, 48600, 50400, 52200, 54000, 55800, 57600, 59400, 61200, 63000, 64800, 66600, 68400, 70200, 72000, 73800, 75600, 77400, 79200, 81000, 82800, 84600, 86400 ]
                },
                "serverLossTimeoutInSec" : {
                    "description" : "Server loss timeout in second",
                    "type" : "integer",
                    "enum" : [ 0, 7200, 14400, 21600, 28800, 36000, 43200, 50400, 57600, 64800, 72000, 79200, 86400 ]
                }
            }
        },
        "location" : {
            "description" : "Location of the zone.",
            "type" : "string"
        },
        "locationAdditionalInfo" : {
            "description" : "Location additional info of the zone.",
            "type" : "string",
            "pattern" : "^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
        },
        "altitude" : {
            "description" : "GPS Altitude",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "altitudeUnit" : {
                    "description" : "altitude unit",
                    "type" : "string",
                    "enum" : [ "meters", "floor" ]
                },
                "altitudeValue" : {
                    "description" : "altitude value",
                    "type" : "integer"
                }
            }
        },
        "latitude" : {
            "description" : "Latitude coordinate (in decimal format) of the zone",
            "type" : "number"
        },
        "longitude" : {
            "description" : "Longitude coordinate (in decimal format) of the zone",
            "type" : "number"
        },
        "vlanOverlappingEnabled" : {
            "description" : "VLAN pooling overlapping of the zone",
            "type" : "boolean"
        },
        "nodeAffinityProfile" : {
            "description" : "Node affinity profile of the zone.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "venueProfile" : {
            "description" : "Venue profile configuration of the zone.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "autoChannelSelection24" : {
            "description" : "client load balancing on Radio 2.4G, auto channel selection mode",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "channelSelectMode" : {
                    "description" : "Channel Select Mode",
                    "type" : "string",
                    "enum" : [ "None", "BackgroundScanning", "ChannelFly" ]
                },
                "channelFlyMtbc" : {
                    "description" : "ChannelFly MTBC",
                    "type" : "integer",
                    "minimum" : 100,
                    "maximum" : 1440
                }
            }
        },
        "autoChannelSelection50" : {
            "description" : "client load balancing on Radio 5G, auto channel selection mode",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "channelSelectMode" : {
                    "description" : "Channel Select Mode",
                    "type" : "string",
                    "enum" : [ "None", "BackgroundScanning", "ChannelFly" ]
                },
                "channelFlyMtbc" : {
                    "description" : "ChannelFly MTBC",
                    "type" : "integer",
                    "minimum" : 100,
                    "maximum" : 1440
                }
            }
        },
        "channelEvaluationInterval" : {
            "description" : "channel evaluation Interval of the zone",
            "type" : "integer",
            "minimum" : 60,
            "maximum" : 3600
        },
        "apMgmtVlan" : {
            "description" : "ap Management Vlan of the zone",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "mode" : {
                    "description" : "Vlan Mode of the zone",
                    "type" : "string",
                    "enum" : [ "KEEP", "USER_DEFINED" ]
                },
                "id" : {
                    "description" : "Vlan id of the zone",
                    "type" : "integer"
                }
            }
        },
        "apLatencyInterval" : {
            "description" : "AP latency interval",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "pingEnabled" : {
                    "description" : "AP ping latency enabled",
                    "type" : "boolean"
                }
            }
        },
        "ipsecProfile" : {
            "description" : "ipsec profile configuration of the Zone.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "ipv6TrafficFilterEnabled" : {
            "description" : "IPv6 Traffic filtering on the AP",
            "type" : "integer"
        },
        "bonjourFencingPolicyEnabled" : {
            "description" : "Enable Bonjour Fencing Policy on the AP",
            "type" : "boolean"
        },
        "bonjourFencingPolicy" : {
            "description" : "Bonjour Fencing Policy on the AP",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "dhcpSiteConfig" : {
            "description" : "DHCP Site Configuration in Zone",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "siteEnabled" : {
                    "description" : "DHCP Service Enabling Status",
                    "type" : "boolean"
                },
                "dwpdEnabled" : {
                    "description" : "DHCP Service Dynamic WAN Port Detection",
                    "type" : "boolean"
                },
                "manualSelect" : {
                    "description" : "DHCP Service AP Selection Mode. This value is effective when the siteMode is EnableOnMultipleAPs.",
                    "type" : "boolean"
                },
                "siteMode" : {
                    "description" : "DHCP Service mode",
                    "type" : "string",
                    "enum" : [ "EnableOnEachAPs", "EnableOnMultipleAPs", "EnableOnHierarchicalAPs" ]
                },
                "eth0ProfileId" : {
                    "type" : "integer"
                },
                "eth1ProfileId" : {
                    "type" : "integer"
                },
                "siteAps" : {
                    "type" : "array",
                    "items" : {
                        "type" : "object",
                        "description" : "DHCP Site selected APs. The content is effective when the siteMode is EnableOnMultipleAPs.",
                        "additionalProperties" : false,
                        "properties" : {
                            "apMac" : {
                                "type" : "string"
                            },
                            "apName" : {
                                "type" : "string"
                            },
                            "apStatus" : {
                                "type" : "string",
                                "enum" : [ "Online", "Offline", "Flagged" ]
                            },
                            "apServerEnabled" : {
                                "type" : "boolean"
                            },
                            "apServerPrimary" : {
                                "type" : "boolean"
                            },
                            "apServerIp" : {
                                "type" : [ "string", "null" ]
                            },
                            "apGatewayIp" : {
                                "type" : "string"
                            },
                            "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"
                },
                "snmpV2Agent" : {
                    "description" : "Community List of the SNMP V2 Agent.",
                    "type" : "array",
                    "items" : {
                        "type" : "object",
                        "additionalProperties" : false,
                        "properties" : {
                            "communityName" : {
                                "description" : "name of the SNMP Community.",
                                "type" : "string"
                            },
                            "readEnabled" : {
                                "description" : "read privilege of the SNMP Coummunity",
                                "type" : "boolean"
                            },
                            "writeEnabled" : {
                                "description" : "write privilege of the SNMP Coummunity",
                                "type" : "boolean"
                            },
                            "notificationEnabled" : {
                                "description" : "notification privilege of the SNMP Coummunity",
                                "type" : "boolean"
                            },
                            "notificationType" : {
                                "description" : "type of the notification privilege",
                                "type" : "string",
                                "enum" : [ "TRAP", "INFORM" ]
                            },
                            "notificationTarget" : {
                                "description" : "Trap List of the SNMP Coummunity",
                                "type" : "array",
                                "items" : {
                                    "type" : "object",
                                    "additionalProperties" : false,
                                    "properties" : {
                                        "address" : {
                                            "description" : "address of the SNMP Trap",
                                            "type" : "string"
                                        },
                                        "port" : {
                                            "description" : "port number of the SNMP Trap",
                                            "type" : "integer",
                                            "minimum" : 1,
                                            "maximum" : 65535
                                        }
                                    },
                                    "required" : [ "address", "port" ]
                                }
                            }
                        },
                        "required" : [ "communityName" ]
                    }
                },
                "snmpV3Agent" : {
                    "description" : "User List of the SNMP V3 Agent.",
                    "type" : "array",
                    "items" : {
                        "type" : "object",
                        "additionalProperties" : false,
                        "properties" : {
                            "userName" : {
                                "description" : "name of the SNMP User.",
                                "type" : "string"
                            },
                            "authProtocol" : {
                                "description" : "authProtocol of the SNMP User.",
                                "type" : "string",
                                "enum" : [ "NONE", "MD5", "SHA" ]
                            },
                            "authPassword" : {
                                "description" : "authPassword of the SNMP User.",
                                "type" : "string",
                                "minLength" : 8
                            },
                            "privProtocol" : {
                                "description" : "privProtocol of the SNMP User.",
                                "type" : "string",
                                "enum" : [ "NONE", "DES", "AES" ]
                            },
                            "privPassword" : {
                                "description" : "privPassword of the SNMP User.",
                                "type" : "string",
                                "minLength" : 8
                            },
                            "readEnabled" : {
                                "description" : "read privilege of the SNMP User",
                                "type" : "boolean"
                            },
                            "writeEnabled" : {
                                "description" : "write privilege of the SNMP User",
                                "type" : "boolean"
                            },
                            "notificationEnabled" : {
                                "description" : "notification privilege of the SNMP User",
                                "type" : "boolean"
                            },
                            "notificationType" : {
                                "description" : "type of the notification privilege",
                                "type" : "string",
                                "enum" : [ "TRAP", "INFORM" ]
                            },
                            "notificationTarget" : {
                                "description" : "Trap List of the SNMP User",
                                "type" : "array",
                                "items" : {
                                    "type" : "object",
                                    "additionalProperties" : false,
                                    "properties" : {
                                        "address" : {
                                            "description" : "address of the SNMP Trap",
                                            "type" : "string"
                                        },
                                        "port" : {
                                            "description" : "port number of the SNMP Trap",
                                            "type" : "integer",
                                            "minimum" : 1,
                                            "maximum" : 65535
                                        }
                                    },
                                    "required" : [ "address", "port" ]
                                }
                            }
                        },
                        "required" : [ "userName" ]
                    }
                }
            }
        },
        "recoverySsid" : {
            "description" : "Recovery SSID",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "recoverySsidEnabled" : {
                    "description" : "recovery ssid enable/disable",
                    "type" : "boolean"
                }
            }
        },
        "clusterRedundancyEnabled" : {
            "description" : "Enable Cluster redundancy on zone",
            "type" : "boolean"
        },
        "rogueApReportThreshold" : {
            "description" : "Rogue AP report will leave out all entries that have signal strength lower than this threshold.",
            "type" : "integer"
        },
        "rogueApAggressivenessMode" : {
            "description" : "Adjust the frequency interval to de-authenticate rogue APs.",
            "type" : "integer"
        },
        "rogueApJammingDetection" : {
            "description" : "Enable jamming detection.",
            "type" : "boolean"
        },
        "rogueApJammingThreshold" : {
            "type" : "integer"
        },
        "directedMulticastFromWiredClientEnabled" : {
            "description" : "Directed multicast from wired client.",
            "type" : "boolean"
        },
        "directedMulticastFromWirelessClientEnabled" : {
            "description" : "Directed multicast from wireless client.",
            "type" : "boolean"
        },
        "directedMulticastFromNetworkEnabled" : {
            "description" : "Directed multicast from network.",
            "type" : "boolean"
        },
        "healthCheckSitesEnabled" : {
            "description" : "Enabled Health Check Sites. ",
            "type" : "boolean"
        },
        "healthCheckSites" : {
            "description" : "Health Check Sites.",
            "type" : "array",
            "items" : {
                "type" : "string"
            }
        },
        "ruckusGreTunnelProfile" : {
            "description" : "Ruckus GRE Profile for Multiple Tunnel (Start from SZ 5.0)",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "softGreTunnelProflies" : {
            "description" : "SoftGRE Profiles for Multiple Tunnel (Start from SZ 5.0)",
            "type" : "array",
            "items" : {
                "type" : [ "object", "null" ],
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "type" : "string"
                    },
                    "name" : {
                        "type" : "string"
                    },
                    "aaaAffinityEnabled" : {
                        "type" : "boolean"
                    }
                }
            }
        },
        "ipsecProfiles" : {
            "description" : "Ipsec profile for Multiple Tunnel (Start from SZ 5.0)",
            "type" : "array",
            "items" : {
                "type" : [ "object", "null" ],
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "type" : "string"
                    },
                    "name" : {
                        "type" : "string"
                    }
                }
            }
        },
        "ipsecTunnelMode" : {
            "type" : "string",
            "enum" : [ "DISABLE", "SOFT_GRE", "RUCKUS_GRE" ]
        },
        "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"
                    }
                }
            }
        },
        "apHccdEnabled" : {
            "description" : "Historical Connection Failures allows the AP to report historical client connection failures for this zone.",
            "type" : "boolean"
        },
        "apHccdPersist" : {
            "description" : "Allow Historical Connection Failures to be persisted.",
            "type" : "boolean"
        }
    }
}
Response  204

Change the Zone's IPsec Profiles

PATCH/v8_1/rkszones/{id}/ipsecProfiles

Use this API command to change the Zone’s IPsec profiles.

Request
HideShow
Body
{
  "domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
  "zoneAffinityProfileId": "3fd9aa91-df65-11e7-98e1-08002748d78e",
  "enforcePriorityZoneAffinityEnable": false,
  "name": "modifyZoneName",
  "description": "description Zone",
  "countryCode": "US",
  "timezone": {
    "systemTimezone": "America/Whitehorse"
  },
  "login": {
    "apLoginName": "admin",
    "apLoginPassword": "admin!234"
  },
  "mesh": {
    "ssid": "meshSSID",
    "passphrase": "passphrase"
  },
  "dfsChannelEnabled": false,
  "wifi24": {
    "txPower": "Full",
    "channelWidth": 20,
    "channel": 0,
    "channelRange": [
      1,
      2,
      3,
      4,
      5,
      6,
      7,
      8,
      9,
      10,
      11
    ]
  },
  "wifi50": {
    "txPower": "-1dB",
    "channelWidth": 40,
    "indoorChannel": 0,
    "outdoorChannel": 0,
    "indoorChannelRange": [
      36,
      40,
      44,
      48,
      149,
      153,
      157,
      161
    ],
    "outdoorChannelRange": [
      149,
      153,
      157,
      161
    ]
  },
  "protectionMode24": "CTS_ONLY",
  "syslog": {
    "address": "1.1.1.1",
    "port": 514,
    "facility": "Local0",
    "priority": "Error"
  },
  "smartMonitor": {
    "intervalInSec": 10,
    "retryThreshold": 3
  },
  "nodeAffinityProfile": null,
  "venueProfile": null,
  "locationBasedService": null,
  "channelModeEnabled": false,
  "bonjourFencingPolicy": null,
  "tunnelType": "RuckusGRE",
  "tunnelProfile": {
    "id": "f5b92938-aa4e-4d02-90ea-273799ff689b",
    "name": "Default Tunnel Profile"
  },
  "clientAdmissionControl24": {
    "maxRadioLoadPercent": 70,
    "minClientCount": 10,
    "minClientThroughputMbps": 10
  },
  "clientAdmissionControl50": {
    "maxRadioLoadPercent": 70,
    "minClientCount": 10,
    "minClientThroughputMbps": 10
  },
  "backgroundScanning24": {
    "frequencyInSec": 20
  },
  "backgroundScanning50": {
    "frequencyInSec": 20
  },
  "clientLoadBalancing24": {
    "adjacentRadioThreshold": 12
  },
  "clientLoadBalancing50": {
    "adjacentRadioThreshold": 12
  },
  "bandBalancing": {
    "wifi24Percentage": 10
  },
  "loadBalancingMethod": "BASED_ON_CLIENT_COUNT",
  "rogue": {
    "reportType": "All",
    "maliciousTypes": null,
    "protectionEnabled": true
  },
  "dosBarringEnable": 0,
  "dosBarringPeriod": 60,
  "dosBarringThreshold": 5,
  "dosBarringCheckPeriod": 30,
  "apRebootTimeout": {
    "gatewayLossTimeoutInSec": 1800,
    "serverLossTimeoutInSec": 7200
  },
  "location": "location",
  "locationAdditionalInfo": "locationAdditionalInfo",
  "latitude": 23,
  "longitude": 23,
  "vlanOverlappingEnabled": false,
  "autoChannelSelection24": {
    "channelSelectMode": "ChannelFly",
    "channelFlyMtbc": 480
  },
  "autoChannelSelection50": {
    "channelSelectMode": "BackgroundScanning",
    "channelFlyMtbc": 480
  },
  "channelEvaluationInterval": 777,
  "apMgmtVlan": {
    "id": 1,
    "mode": "KEEP"
  },
  "apLatencyInterval": {
    "pingEnabled": true
  },
  "ipsecProfile": {
    "id": "ipsecProfileId",
    "name": "ipsecProfileName"
  },
  "altitude": {
    "altitudeUnit": "meters",
    "altitudeValue": 1
  },
  "bonjourFencingPolicyEnabled": false,
  "snmpAgent": {
    "apSnmpEnabled": true,
    "snmpV2Agent": [
      {
        "communityName": "v2Agent",
        "notificationEnabled": true,
        "readEnabled": true,
        "writeEnabled": true,
        "notificationType": "TRAP",
        "notificationTarget": [
          {
            "address": "172.19.16.20",
            "port": 161
          }
        ]
      }
    ],
    "snmpV3Agent": [
      {
        "userName": "v3Agent",
        "authProtocol": "MD5",
        "authPassword": "admin!234",
        "privProtocol": "DES",
        "privPassword": "admin!234",
        "notificationEnabled": true,
        "readEnabled": true,
        "writeEnabled": true,
        "notificationType": "TRAP",
        "notificationTarget": [
          {
            "address": "172.19.16.20",
            "port": 161
          }
        ]
      }
    ]
  },
  "recoverySsid": {
    "recoverySsidEnabled": true
  },
  "dhcpSiteConfig": {
    "siteEnabled": true,
    "siteMode": "EnableOnEachAPs",
    "siteProfileIds": [
      "75e26590-547f-11e6-9ca7-5a095364c13c",
      "869bb532-547f-11e6-9ca7-5a095364c13c"
    ]
  },
  "rogueApReportThreshold": 40,
  "rogueApAggressivenessMode": 2,
  "rogueApJammingDetection": true,
  "rogueApJammingThreshold": 40,
  "directedMulticastFromWiredClientEnabled": true,
  "directedMulticastFromWirelessClientEnabled": true,
  "directedMulticastFromNetworkEnabled": false,
  "healthCheckSitesEnabled": true,
  "healthCheckSites": [
    "www.google.com",
    "www.live.com:443",
    "www.github.com:443",
    "source.codeaurora.org:443",
    "www.wikipedia.com"
  ],
  "ruckusGreTunnelProfile": {
    "id": "f5b92938-aa4e-4d02-90ea-273799ff689b",
    "name": "Default Tunnel Profile"
  },
  "softGreTunnelProflies": [
    {
      "id": "5a2e41b0-df53-11e7-98e1-08002748d78e",
      "name": "softGre1",
      "aaaAffinityEnabled": true
    },
    {
      "id": "7803e411-df53-11e7-98e1-08002748d78e",
      "name": "softGre2",
      "aaaAffinityEnabled": true
    }
  ],
  "ipsecProfiles": [
    {
      "id": "3fd9aa91-df65-11e7-98e1-08002748d78e",
      "name": "ipsec1"
    }
  ],
  "ipsecTunnelMode": "SOFT_GRE",
  "sshTunnelEncryption": "AES128",
  "lteBandLockChannels": [
    {
      "simCardId": 0,
      "type": "EC25E",
      "channel4g": "B1,B3,B5",
      "channel3g": "B5"
    },
    {
      "simCardId": 1,
      "type": "EC25E",
      "channel4g": "",
      "channel3g": ""
    }
  ],
  "apHccdEnabled": true,
  "apHccdPersist": true
}
Schema
{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "domainId" : {
            "description" : "Identifier of the management domain to which the zone belongs",
            "type" : "string"
        },
        "zoneAffinityProfileId" : {
            "description" : "Identifier of the ZoneAffinityProfile",
            "type" : "string"
        },
        "enforcePriorityZoneAffinityEnable" : {
            "description" : "Enforce the priority of zone affinity",
            "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
        },
        "countryCode" : {
            "description" : "Country code of the zone",
            "type" : "string"
        },
        "timezone" : {
            "description" : "Either systemTimezone or customizedTimezone must be specified",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "systemTimezone" : {
                    "description" : "System defined time zone, please refer to the “Overview > Time Zone” list",
                    "type" : "string"
                },
                "customizedTimezone" : {
                    "description" : "User defined time zone",
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "abbreviation" : {
                            "description" : "Time zone abbreviation",
                            "type" : "string",
                            "pattern" : "^[a-zA-Z]{3,4}$"
                        },
                        "gmtOffset" : {
                            "description" : "GMT offset",
                            "type" : "integer",
                            "minimum" : -11,
                            "maximum" : 14
                        },
                        "gmtOffsetMinute" : {
                            "description" : "GMT offset minute",
                            "type" : "integer",
                            "minimum" : 0,
                            "maximum" : 59
                        },
                        "start" : {
                            "description" : "Daylight saving time start",
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "month" : {
                                    "description" : "Month when daylight saving time begins",
                                    "type" : "integer",
                                    "enum" : [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ]
                                },
                                "week" : {
                                    "description" : "Week of the month (1 for the first week, 2 for the second week, and so on)",
                                    "type" : "integer",
                                    "enum" : [ 1, 2, 3, 4, 5 ]
                                },
                                "day" : {
                                    "description" : "Day of the week (0 for Sunday, 1 for Monday, 2 for Tuesday, and so on)",
                                    "type" : "integer",
                                    "enum" : [ 0, 1, 2, 3, 4, 5, 6 ]
                                },
                                "hour" : {
                                    "description" : "Hour of the day",
                                    "type" : "integer",
                                    "minimum" : 0,
                                    "maximum" : 23
                                }
                            },
                            "required" : [ "month", "week", "day", "hour" ]
                        },
                        "end" : {
                            "description" : "Daylight saving time end",
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "month" : {
                                    "description" : "Month when daylight saving time begins",
                                    "type" : "integer",
                                    "enum" : [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ]
                                },
                                "week" : {
                                    "description" : "Week of the month (1 for the first week, 2 for the second week, and so on)",
                                    "type" : "integer",
                                    "enum" : [ 1, 2, 3, 4, 5 ]
                                },
                                "day" : {
                                    "description" : "Day of the week (0 for Sunday, 1 for Monday, 2 for Tuesday, and so on)",
                                    "type" : "integer",
                                    "enum" : [ 0, 1, 2, 3, 4, 5, 6 ]
                                },
                                "hour" : {
                                    "description" : "Hour of the day",
                                    "type" : "integer",
                                    "minimum" : 0,
                                    "maximum" : 23
                                }
                            },
                            "required" : [ "month", "week", "day", "hour" ]
                        }
                    },
                    "required" : [ "abbreviation", "gmtOffset", "gmtOffsetMinute" ]
                }
            }
        },
        "login" : {
            "description" : "AP administrator account",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "apLoginName" : {
                    "description" : "User name of the AP administrator",
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : "^((?!\$\()[!-_a-~]){1,64}$"
                },
                "apLoginPassword" : {
                    "description" : "Password of the AP administrator",
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : ".*(?=.{8,})(?=.*[a-zA-Z])(?=.*[0-9])(?=.*[_`[email protected]#$%^&*\(\)\[\]\{\}|;:'\",.\<>\/?=+-]).*"
                }
            },
            "required" : [ "apLoginName", "apLoginPassword" ]
        },
        "mesh" : {
            "description" : "Mesh configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "ssid" : {
                    "description" : "SSID of the mesh network",
                    "type" : "string"
                },
                "passphrase" : {
                    "description" : "Passphrase for the mesh network",
                    "type" : "string"
                },
                "meshRadioIdx" : {
                    "description" : "Mesh radio index",
                    "type" : "string",
                    "enum" : [ "Radio24G", "Radio5G" ]
                },
                "zeroTouchStatus" : {
                    "type" : "boolean"
                }
            }
        },
        "dfsChannelEnabled" : {
            "description" : "DFS Channel enabled configuration of the zone, only for the US country code .",
            "type" : "boolean"
        },
        "cbandChannelEnabled" : {
            "description" : "5.8Ghz channels enabled configuration of the zone.",
            "type" : "boolean"
        },
        "cbandChannelLicenseEnabled" : {
            "description" : "5.8Ghz channels license enabled configuration of the zone.",
            "type" : "boolean"
        },
        "channel144Enabled" : {
            "description" : "Channel 144 enabled configuration of the zone.",
            "type" : "boolean"
        },
        "wifi24" : {
            "description" : "AP 2.4GHz radio configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "autoCellSizing" : {
                    "description" : "Auto Cell Sizing",
                    "type" : "boolean"
                },
                "txPower" : {
                    "description" : "Transmission power",
                    "type" : "string",
                    "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ]
                },
                "channelWidth" : {
                    "description" : "Channel width. Zero (0) means Auto.",
                    "type" : "integer",
                    "enum" : [ 0, 20, 40 ]
                },
                "channel" : {
                    "description" : "Channel number",
                    "type" : "integer"
                },
                "channelRange" : {
                    "description" : "Channel range options",
                    "type" : "array",
                    "items" : {
                        "type" : "integer"
                    }
                }
            }
        },
        "wifi50" : {
            "description" : "AP 5GHz radio configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "autoCellSizing" : {
                    "description" : "Auto Cell Sizing",
                    "type" : "boolean"
                },
                "txPower" : {
                    "description" : "Transmission power",
                    "type" : "string",
                    "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ]
                },
                "channelWidth" : {
                    "description" : "Channel width. Zero (0) means Auto. 8080 means 80+80MHz",
                    "type" : "integer",
                    "enum" : [ 0, 20, 40, 80, 8080, 160 ]
                },
                "indoorChannel" : {
                    "description" : "Channel number for Indoor AP",
                    "type" : "integer"
                },
                "outdoorChannel" : {
                    "description" : "Channel number for Outdoor AP",
                    "type" : "integer"
                },
                "indoorSecondaryChannel" : {
                    "description" : "Secondary channel number for Indoor AP (channelWidth is 80+80MHz only)",
                    "type" : "integer"
                },
                "outdoorSecondaryChannel" : {
                    "description" : "Secondary channel number for outdoor AP (channelWidth is 80+80MHz only)",
                    "type" : "integer"
                },
                "indoorChannelRange" : {
                    "description" : "Channel range options for Indoor AP",
                    "type" : "array",
                    "items" : {
                        "type" : "integer"
                    }
                },
                "outdoorChannelRange" : {
                    "description" : "Channel range options for outdoor AP",
                    "type" : "array",
                    "items" : {
                        "type" : "integer"
                    }
                }
            }
        },
        "protectionMode24" : {
            "description" : "AP 2.4GHz Protection mode configuration of the zone.",
            "type" : "string",
            "enum" : [ "NONE", "CTS_ONLY", "RTS_CTS" ]
        },
        "syslog" : {
            "description" : "Syslog configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "flowLevel" : {
                    "description" : "Flow Level of the syslog",
                    "type" : "string",
                    "enum" : [ "GENERAL_LOGS", "CLIENT_FLOW", "ALL" ]
                },
                "address" : {
                    "description" : "Address of the syslog server.",
                    "type" : "string"
                },
                "port" : {
                    "description" : "Port number of the syslog server",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 65535
                },
                "protocol" : {
                    "description" : "Protocol of the syslog server",
                    "type" : "string",
                    "enum" : [ "IPPROTO_TCP", "IPPROTO_UDP" ]
                },
                "secondaryAddress" : {
                    "description" : "Secondary Server Address of the syslog server",
                    "type" : "string"
                },
                "secondaryPort" : {
                    "description" : "Secondary Server Port of the syslog server",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 65535
                },
                "secondaryProtocol" : {
                    "description" : "Secondary Server Protocol of the syslog server",
                    "type" : "string",
                    "enum" : [ "IPPROTO_TCP", "IPPROTO_UDP" ]
                },
                "facility" : {
                    "description" : "Facility of the syslog server",
                    "type" : "string",
                    "enum" : [ "Keep_Original", "Local0", "Local1", "Local2", "Local3", "Local4", "Local5", "Local6", "Local7" ]
                },
                "priority" : {
                    "description" : "Priority of the log messages",
                    "type" : "string",
                    "enum" : [ "Emergency", "Alert", "Critical", "Error", "Warning", "Notice", "Info", "All" ]
                }
            }
        },
        "smartMonitor" : {
            "description" : "Smart monitor configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "intervalInSec" : {
                    "description" : "Interval in seconds. This is required if smartMonitor is enabled",
                    "type" : "integer",
                    "minimum" : 5,
                    "maximum" : 60
                },
                "retryThreshold" : {
                    "description" : "Retry threshold. This is required if smartMonitor is enabled",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 10
                }
            }
        },
        "clientAdmissionControl24" : {
            "description" : "AP client admission control 2.4GHz radio configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "maxRadioLoadPercent" : {
                    "description" : "Maximum radio load percentage.",
                    "type" : "integer",
                    "minimum" : 50,
                    "maximum" : 100
                },
                "minClientCount" : {
                    "description" : "Minimum client count number.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 100
                },
                "minClientThroughputMbps" : {
                    "description" : "Minimum client throughput in Mbps.",
                    "type" : "number",
                    "minimum" : 0,
                    "maximum" : 100
                }
            }
        },
        "clientAdmissionControl50" : {
            "description" : "AP client admission control 5GHz radio configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "maxRadioLoadPercent" : {
                    "description" : "Maximum radio load percentage.",
                    "type" : "integer",
                    "minimum" : 50,
                    "maximum" : 100
                },
                "minClientCount" : {
                    "description" : "Minimum client count number.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 100
                },
                "minClientThroughputMbps" : {
                    "description" : "Minimum client throughput in Mbps.",
                    "type" : "number",
                    "minimum" : 0,
                    "maximum" : 100
                }
            }
        },
        "channelModeEnabled" : {
            "description" : "Channel mode configuration of the zone.",
            "type" : "boolean"
        },
        "tunnelType" : {
            "description" : "Tunnel type configuration of the zone. No_Tunneled is for IPv6 mode",
            "type" : "string",
            "enum" : [ "No_Tunneled", "RuckusGRE", "SoftGRE", "SoftGREIpsec" ]
        },
        "tunnelProfile" : {
            "description" : "Tunnel type configuration of the zone.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "backgroundScanning24" : {
            "description" : "Background scanning on 2.4GHz radio configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "frequencyInSec" : {
                    "description" : "Frequency in second",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 65535
                }
            }
        },
        "backgroundScanning50" : {
            "description" : "Background scanning on 5GHz radio configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "frequencyInSec" : {
                    "description" : "Frequency in second",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 65535
                }
            }
        },
        "clientLoadBalancing24" : {
            "description" : "Client load balancing on 2.4GHz radio configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "adjacentRadioThreshold" : {
                    "description" : "Adjacent radio threshold",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 100
                }
            }
        },
        "clientLoadBalancing50" : {
            "description" : "Client load balancing on 5GHz radio configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "adjacentRadioThreshold" : {
                    "description" : "Adjacent radio threshold",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 100
                }
            }
        },
        "bandBalancing" : {
            "description" : "Band balancing configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "mode" : {
                    "description" : "Band Balancing Mode: BASIC-Withholds probe and authentication responses at connetcion time in heavily loaded band to balance clients to the other band, PROACTIVE-Uses BASIC functionality and actively rebalances clients via 802.11v BTM, STRICT-Uses PROACTIVE functionality and forcefully rebalances clients via 802.11v BTM",
                    "type" : "string",
                    "enum" : [ "BASIC", "PROACTIVE", "STRICT" ]
                },
                "wifi24Percentage" : {
                    "description" : "Percentage of client load on 2.4GHz radio band",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 100
                }
            }
        },
        "loadBalancingMethod" : {
            "type" : "string",
            "enum" : [ "BASED_ON_CLIENT_COUNT", "BASED_ON_CAPACITY", "OFF" ]
        },
        "rogue" : {
            "description" : "Rogue AP detection configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "reportType" : {
                    "description" : "Report type",
                    "type" : "string",
                    "enum" : [ "All", "Malicious" ]
                },
                "maliciousTypes" : {
                    "description" : "Malicious type when reportType is Malicious",
                    "type" : [ "array", "null" ],
                    "items" : {
                        "type" : "string",
                        "enum" : [ "SSIDSpoofing", "SameNetwork", "MACSpoofing" ]
                    }
                },
                "protectionEnabled" : {
                    "description" : "Protection enabled",
                    "type" : "boolean"
                }
            }
        },
        "dosBarringEnable" : {
            "description" : "Enable DoS Protection(Barring UE) of the zone.",
            "type" : "integer"
        },
        "dosBarringPeriod" : {
            "description" : "DoS Protection(Barring UE) blocking period of the zone.",
            "type" : "integer"
        },
        "dosBarringThreshold" : {
            "description" : "DoS Protection(Barring UE) threshold of the zone.",
            "type" : "integer"
        },
        "dosBarringCheckPeriod" : {
            "description" : "DoS Protection(Barring UE) check period of the zone.",
            "type" : "integer"
        },
        "locationBasedService" : {
            "description" : "Location based service configuration of the zone.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "apRebootTimeout" : {
            "description" : "AP reboot timeout of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "gatewayLossTimeoutInSec" : {
                    "description" : "Gateway loss timeout in second",
                    "type" : "integer",
                    "enum" : [ 0, 1800, 3600, 5400, 7200, 9000, 10800, 12600, 14400, 16200, 18000, 19800, 23400, 25200, 27000, 28800, 30600, 32400, 34200, 36000, 37800, 39600, 41400, 43200, 45000, 46800, 48600, 50400, 52200, 54000, 55800, 57600, 59400, 61200, 63000, 64800, 66600, 68400, 70200, 72000, 73800, 75600, 77400, 79200, 81000, 82800, 84600, 86400 ]
                },
                "serverLossTimeoutInSec" : {
                    "description" : "Server loss timeout in second",
                    "type" : "integer",
                    "enum" : [ 0, 7200, 14400, 21600, 28800, 36000, 43200, 50400, 57600, 64800, 72000, 79200, 86400 ]
                }
            }
        },
        "location" : {
            "description" : "Location of the zone.",
            "type" : "string"
        },
        "locationAdditionalInfo" : {
            "description" : "Location additional info of the zone.",
            "type" : "string",
            "pattern" : "^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
        },
        "altitude" : {
            "description" : "GPS Altitude",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "altitudeUnit" : {
                    "description" : "altitude unit",
                    "type" : "string",
                    "enum" : [ "meters", "floor" ]
                },
                "altitudeValue" : {
                    "description" : "altitude value",
                    "type" : "integer"
                }
            }
        },
        "latitude" : {
            "description" : "Latitude coordinate (in decimal format) of the zone",
            "type" : "number"
        },
        "longitude" : {
            "description" : "Longitude coordinate (in decimal format) of the zone",
            "type" : "number"
        },
        "vlanOverlappingEnabled" : {
            "description" : "VLAN pooling overlapping of the zone",
            "type" : "boolean"
        },
        "nodeAffinityProfile" : {
            "description" : "Node affinity profile of the zone.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "venueProfile" : {
            "description" : "Venue profile configuration of the zone.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "autoChannelSelection24" : {
            "description" : "client load balancing on Radio 2.4G, auto channel selection mode",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "channelSelectMode" : {
                    "description" : "Channel Select Mode",
                    "type" : "string",
                    "enum" : [ "None", "BackgroundScanning", "ChannelFly" ]
                },
                "channelFlyMtbc" : {
                    "description" : "ChannelFly MTBC",
                    "type" : "integer",
                    "minimum" : 100,
                    "maximum" : 1440
                }
            }
        },
        "autoChannelSelection50" : {
            "description" : "client load balancing on Radio 5G, auto channel selection mode",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "channelSelectMode" : {
                    "description" : "Channel Select Mode",
                    "type" : "string",
                    "enum" : [ "None", "BackgroundScanning", "ChannelFly" ]
                },
                "channelFlyMtbc" : {
                    "description" : "ChannelFly MTBC",
                    "type" : "integer",
                    "minimum" : 100,
                    "maximum" : 1440
                }
            }
        },
        "channelEvaluationInterval" : {
            "description" : "channel evaluation Interval of the zone",
            "type" : "integer",
            "minimum" : 60,
            "maximum" : 3600
        },
        "apMgmtVlan" : {
            "description" : "ap Management Vlan of the zone",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "mode" : {
                    "description" : "Vlan Mode of the zone",
                    "type" : "string",
                    "enum" : [ "KEEP", "USER_DEFINED" ]
                },
                "id" : {
                    "description" : "Vlan id of the zone",
                    "type" : "integer"
                }
            }
        },
        "apLatencyInterval" : {
            "description" : "AP latency interval",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "pingEnabled" : {
                    "description" : "AP ping latency enabled",
                    "type" : "boolean"
                }
            }
        },
        "ipsecProfile" : {
            "description" : "ipsec profile configuration of the Zone.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "ipv6TrafficFilterEnabled" : {
            "description" : "IPv6 Traffic filtering on the AP",
            "type" : "integer"
        },
        "bonjourFencingPolicyEnabled" : {
            "description" : "Enable Bonjour Fencing Policy on the AP",
            "type" : "boolean"
        },
        "bonjourFencingPolicy" : {
            "description" : "Bonjour Fencing Policy on the AP",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "dhcpSiteConfig" : {
            "description" : "DHCP Site Configuration in Zone",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "siteEnabled" : {
                    "description" : "DHCP Service Enabling Status",
                    "type" : "boolean"
                },
                "dwpdEnabled" : {
                    "description" : "DHCP Service Dynamic WAN Port Detection",
                    "type" : "boolean"
                },
                "manualSelect" : {
                    "description" : "DHCP Service AP Selection Mode. This value is effective when the siteMode is EnableOnMultipleAPs.",
                    "type" : "boolean"
                },
                "siteMode" : {
                    "description" : "DHCP Service mode",
                    "type" : "string",
                    "enum" : [ "EnableOnEachAPs", "EnableOnMultipleAPs", "EnableOnHierarchicalAPs" ]
                },
                "eth0ProfileId" : {
                    "type" : "integer"
                },
                "eth1ProfileId" : {
                    "type" : "integer"
                },
                "siteAps" : {
                    "type" : "array",
                    "items" : {
                        "type" : "object",
                        "description" : "DHCP Site selected APs. The content is effective when the siteMode is EnableOnMultipleAPs.",
                        "additionalProperties" : false,
                        "properties" : {
                            "apMac" : {
                                "type" : "string"
                            },
                            "apName" : {
                                "type" : "string"
                            },
                            "apStatus" : {
                                "type" : "string",
                                "enum" : [ "Online", "Offline", "Flagged" ]
                            },
                            "apServerEnabled" : {
                                "type" : "boolean"
                            },
                            "apServerPrimary" : {
                                "type" : "boolean"
                            },
                            "apServerIp" : {
                                "type" : [ "string", "null" ]
                            },
                            "apGatewayIp" : {
                                "type" : "string"
                            },
                            "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"
                },
                "snmpV2Agent" : {
                    "description" : "Community List of the SNMP V2 Agent.",
                    "type" : "array",
                    "items" : {
                        "type" : "object",
                        "additionalProperties" : false,
                        "properties" : {
                            "communityName" : {
                                "description" : "name of the SNMP Community.",
                                "type" : "string"
                            },
                            "readEnabled" : {
                                "description" : "read privilege of the SNMP Coummunity",
                                "type" : "boolean"
                            },
                            "writeEnabled" : {
                                "description" : "write privilege of the SNMP Coummunity",
                                "type" : "boolean"
                            },
                            "notificationEnabled" : {
                                "description" : "notification privilege of the SNMP Coummunity",
                                "type" : "boolean"
                            },
                            "notificationType" : {
                                "description" : "type of the notification privilege",
                                "type" : "string",
                                "enum" : [ "TRAP", "INFORM" ]
                            },
                            "notificationTarget" : {
                                "description" : "Trap List of the SNMP Coummunity",
                                "type" : "array",
                                "items" : {
                                    "type" : "object",
                                    "additionalProperties" : false,
                                    "properties" : {
                                        "address" : {
                                            "description" : "address of the SNMP Trap",
                                            "type" : "string"
                                        },
                                        "port" : {
                                            "description" : "port number of the SNMP Trap",
                                            "type" : "integer",
                                            "minimum" : 1,
                                            "maximum" : 65535
                                        }
                                    },
                                    "required" : [ "address", "port" ]
                                }
                            }
                        },
                        "required" : [ "communityName" ]
                    }
                },
                "snmpV3Agent" : {
                    "description" : "User List of the SNMP V3 Agent.",
                    "type" : "array",
                    "items" : {
                        "type" : "object",
                        "additionalProperties" : false,
                        "properties" : {
                            "userName" : {
                                "description" : "name of the SNMP User.",
                                "type" : "string"
                            },
                            "authProtocol" : {
                                "description" : "authProtocol of the SNMP User.",
                                "type" : "string",
                                "enum" : [ "NONE", "MD5", "SHA" ]
                            },
                            "authPassword" : {
                                "description" : "authPassword of the SNMP User.",
                                "type" : "string",
                                "minLength" : 8
                            },
                            "privProtocol" : {
                                "description" : "privProtocol of the SNMP User.",
                                "type" : "string",
                                "enum" : [ "NONE", "DES", "AES" ]
                            },
                            "privPassword" : {
                                "description" : "privPassword of the SNMP User.",
                                "type" : "string",
                                "minLength" : 8
                            },
                            "readEnabled" : {
                                "description" : "read privilege of the SNMP User",
                                "type" : "boolean"
                            },
                            "writeEnabled" : {
                                "description" : "write privilege of the SNMP User",
                                "type" : "boolean"
                            },
                            "notificationEnabled" : {
                                "description" : "notification privilege of the SNMP User",
                                "type" : "boolean"
                            },
                            "notificationType" : {
                                "description" : "type of the notification privilege",
                                "type" : "string",
                                "enum" : [ "TRAP", "INFORM" ]
                            },
                            "notificationTarget" : {
                                "description" : "Trap List of the SNMP User",
                                "type" : "array",
                                "items" : {
                                    "type" : "object",
                                    "additionalProperties" : false,
                                    "properties" : {
                                        "address" : {
                                            "description" : "address of the SNMP Trap",
                                            "type" : "string"
                                        },
                                        "port" : {
                                            "description" : "port number of the SNMP Trap",
                                            "type" : "integer",
                                            "minimum" : 1,
                                            "maximum" : 65535
                                        }
                                    },
                                    "required" : [ "address", "port" ]
                                }
                            }
                        },
                        "required" : [ "userName" ]
                    }
                }
            }
        },
        "recoverySsid" : {
            "description" : "Recovery SSID",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "recoverySsidEnabled" : {
                    "description" : "recovery ssid enable/disable",
                    "type" : "boolean"
                }
            }
        },
        "clusterRedundancyEnabled" : {
            "description" : "Enable Cluster redundancy on zone",
            "type" : "boolean"
        },
        "rogueApReportThreshold" : {
            "description" : "Rogue AP report will leave out all entries that have signal strength lower than this threshold.",
            "type" : "integer"
        },
        "rogueApAggressivenessMode" : {
            "description" : "Adjust the frequency interval to de-authenticate rogue APs.",
            "type" : "integer"
        },
        "rogueApJammingDetection" : {
            "description" : "Enable jamming detection.",
            "type" : "boolean"
        },
        "rogueApJammingThreshold" : {
            "type" : "integer"
        },
        "directedMulticastFromWiredClientEnabled" : {
            "description" : "Directed multicast from wired client.",
            "type" : "boolean"
        },
        "directedMulticastFromWirelessClientEnabled" : {
            "description" : "Directed multicast from wireless client.",
            "type" : "boolean"
        },
        "directedMulticastFromNetworkEnabled" : {
            "description" : "Directed multicast from network.",
            "type" : "boolean"
        },
        "healthCheckSitesEnabled" : {
            "description" : "Enabled Health Check Sites. ",
            "type" : "boolean"
        },
        "healthCheckSites" : {
            "description" : "Health Check Sites.",
            "type" : "array",
            "items" : {
                "type" : "string"
            }
        },
        "ruckusGreTunnelProfile" : {
            "description" : "Ruckus GRE Profile for Multiple Tunnel (Start from SZ 5.0)",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "softGreTunnelProflies" : {
            "description" : "SoftGRE Profiles for Multiple Tunnel (Start from SZ 5.0)",
            "type" : "array",
            "items" : {
                "type" : [ "object", "null" ],
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "type" : "string"
                    },
                    "name" : {
                        "type" : "string"
                    },
                    "aaaAffinityEnabled" : {
                        "type" : "boolean"
                    }
                }
            }
        },
        "ipsecProfiles" : {
            "description" : "Ipsec profile for Multiple Tunnel (Start from SZ 5.0)",
            "type" : "array",
            "items" : {
                "type" : [ "object", "null" ],
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "type" : "string"
                    },
                    "name" : {
                        "type" : "string"
                    }
                }
            }
        },
        "ipsecTunnelMode" : {
            "type" : "string",
            "enum" : [ "DISABLE", "SOFT_GRE", "RUCKUS_GRE" ]
        },
        "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"
                    }
                }
            }
        },
        "apHccdEnabled" : {
            "description" : "Historical Connection Failures allows the AP to report historical client connection failures for this zone.",
            "type" : "boolean"
        },
        "apHccdPersist" : {
            "description" : "Allow Historical Connection Failures to be persisted.",
            "type" : "boolean"
        }
    }
}
Response  204

Retrieve List

GET/v8_1/rkszones

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

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

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"
          }
        }
      }
    }
  }
}

Clear Mesh Configuration

DELETE/v8_1/rkszones/{id}/mesh

Use this API command to disable mesh networking.

Response  204

Disable Syslog

DELETE/v8_1/rkszones/{id}/syslog

Use this API command to disable syslog configuration for APs that belong to a zone.

Response  204

Disable Smart Monitor

DELETE/v8_1/rkszones/{id}/smartMonitor

Use this API command to disable smart monitor for APs that belong to a zone.

Response  204

Disable Client Admission Control 2.4G

DELETE/v8_1/rkszones/{id}/clientAdmissionControl24

Use this API command to disable client admission control 2.4GHz radio configuration for APs that belong to a zone.

Response  204

Disable Client Admission Control 5G

DELETE/v8_1/rkszones/{id}/clientAdmissionControl50

Use this API command to disable client admission control 5GHz radio configuration for APs that belong to a zone.

Response  204

Disable Background Scanning 2.4G

DELETE/v8_1/rkszones/{id}/backgroundScanning24

Use this API command to disable background scanning 2.4GHz radio configuration for APs that belong to a zone.

Response  204

Disable Background Scanning 5G

DELETE/v8_1/rkszones/{id}/backgroundScanning50

Use this API command to disable background scanning 5GHz radio configuration for APs that belong to a zone.

Response  204

Disable Client Load Balancing 2.4G

DELETE/v8_1/rkszones/{id}/clientLoadBalancing24

Use this API command to disable client load balancing 2.4GHz radio configuration for APs that belong to a zone.

Response  204

Disable Client Load Balancing 5G

DELETE/v8_1/rkszones/{id}/clientLoadBalancing50

Use this API command to disable client load balancing 5GHz radio configuration for APs that belong to a zone.

Response  204

Disable Band Balancing

DELETE/v8_1/rkszones/{id}/bandBalancing

Use this API command to disable band balancing for APs that belong to a zone.

Response  204

Clear Hotspot2.0 Venue Profile

DELETE/v8_1/rkszones/{id}/venueProfile

Use this API command to clear Hotspot 2.0 venue profile for APs that belong to a zone.

Response  204

Disable Rogue

DELETE/v8_1/rkszones/{id}/rogue

Use this API command to disable rogue AP detection for APs that belong to a zone.

Response  204

Disable Location Based Service

DELETE/v8_1/rkszones/{id}/locationBasedService

Use this API command to disable location based service for APs that belong to a zone.

Response  204

Disable Altitude

DELETE/v8_1/rkszones/{id}/altitude

Use this API command to disable altitude configuration of zone.

Response  204

Clear AP SNMP Options

DELETE/v8_1/rkszones/{id}/snmpAgent

Use this API command to clear SNMPv2 and SNMPv3 agent that belong to a zone.

Response  204

Clear zone recovery SSID

DELETE/v8_1/rkszones/{id}/recoverySsid

Use this API command to clear recovery ssid setting of a zone.

Response  204

Create Zone of IPv6

POST/v8_1/rkszones/ipv6

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

Request
HideShow
Body
{
  "domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
  "zoneAffinityProfileId": "3fd9aa91-df65-11e7-98e1-08002748d78e",
  "enforcePriorityZoneAffinityEnable": false,
  "name": "createZoneName",
  "description": "description Zone",
  "countryCode": "US",
  "timezone": {
    "customizedTimezone": {
      "abbreviation": "TPE",
      "gmtOffset": 0,
      "gmtOffsetMinute": 0
    }
  },
  "login": {
    "apLoginName": "admin",
    "apLoginPassword": "admin!234"
  },
  "dfsChannelEnabled": false,
  "wifi24": {
    "txPower": "Full",
    "channelWidth": 20,
    "channel": 0,
    "channelRange": [
      1,
      2,
      3,
      4,
      5,
      6,
      7,
      8,
      9,
      10,
      11
    ]
  },
  "wifi50": {
    "txPower": "-1dB",
    "channelWidth": 40,
    "indoorChannel": 0,
    "outdoorChannel": 0,
    "indoorChannelRange": [
      36,
      40,
      44,
      48,
      149,
      153,
      157,
      161
    ],
    "outdoorChannelRange": [
      149,
      153,
      157,
      161
    ]
  },
  "protectionMode24": "CTS_ONLY",
  "syslog": {
    "flowLevel": "GENERAL_LOGS",
    "address": "1.1.1.1",
    "port": 514,
    "protocol": "IPPROTO_TCP",
    "secondaryAddress": "2.2.2.2",
    "secondaryPort": 514,
    "secondaryProtocol": "IPPROTO_TCP",
    "facility": "Local0",
    "priority": "Error"
  },
  "smartMonitor": {
    "intervalInSec": 10,
    "retryThreshold": 3
  },
  "channelModeEnabled": false,
  "tunnelType": "RuckusGRE",
  "backgroundScanning24": {
    "frequencyInSec": 20
  },
  "backgroundScanning50": {
    "frequencyInSec": 20
  },
  "clientLoadBalancing24": {
    "adjacentRadioThreshold": 12
  },
  "clientLoadBalancing50": {
    "adjacentRadioThreshold": 12
  },
  "bandBalancing": {
    "wifi24Percentage": 10
  },
  "loadBalancingMethod": "BASED_ON_CLIENT_COUNT",
  "rogue": {
    "reportType": "All",
    "maliciousTypes": null,
    "protectionEnabled": true
  },
  "dosBarringEnable": 0,
  "dosBarringPeriod": 60,
  "dosBarringThreshold": 5,
  "dosBarringCheckPeriod": 30,
  "apRebootTimeout": {
    "gatewayLossTimeoutInSec": 1800,
    "serverLossTimeoutInSec": 7200
  },
  "location": "location",
  "locationAdditionalInfo": "locationAdditionalInfo",
  "latitude": 23,
  "longitude": 23,
  "vlanOverlappingEnabled": false,
  "autoChannelSelection24": {
    "channelSelectMode": "ChannelFly",
    "channelFlyMtbc": 480
  },
  "autoChannelSelection50": {
    "channelSelectMode": "BackgroundScanning",
    "channelFlyMtbc": 480
  },
  "channelEvaluationInterval": 777,
  "apMgmtVlan": {
    "id": 1,
    "mode": "KEEP"
  },
  "apLatencyInterval": {
    "pingEnabled": true
  },
  "ipsecProfile": {
    "id": "ipsecProfileId",
    "name": "ipsecProfileName"
  },
  "altitude": {
    "altitudeUnit": "meters",
    "altitudeValue": 1
  },
  "bonjourFencingPolicyEnabled": false,
  "snmpAgent": {
    "apSnmpEnabled": true,
    "snmpV2Agent": [
      {
        "communityName": "v2Agent",
        "notificationEnabled": true,
        "readEnabled": true,
        "writeEnabled": true,
        "notificationType": "TRAP",
        "notificationTarget": [
          {
            "address": "172.19.16.20",
            "port": 161
          }
        ]
      }
    ],
    "snmpV3Agent": [
      {
        "userName": "v3Agent",
        "authProtocol": "MD5",
        "authPassword": "admin!234",
        "privProtocol": "DES",
        "privPassword": "admin!234",
        "notificationEnabled": true,
        "readEnabled": true,
        "writeEnabled": true,
        "notificationType": "TRAP",
        "notificationTarget": [
          {
            "address": "172.19.16.20",
            "port": 161
          }
        ]
      }
    ]
  },
  "recoverySsid": {
    "recoverySsidEnabled": true
  },
  "dhcpSiteConfig": {
    "siteEnabled": true,
    "siteMode": "EnableOnEachAPs",
    "siteProfileIds": [
      "75e26590-547f-11e6-9ca7-5a095364c13c",
      "869bb532-547f-11e6-9ca7-5a095364c13c"
    ]
  },
  "rogueApReportThreshold": 40,
  "rogueApAggressivenessMode": 2,
  "rogueApJammingDetection": true,
  "rogueApJammingThreshold": 40,
  "directedMulticastFromWiredClientEnabled": true,
  "directedMulticastFromWirelessClientEnabled": true,
  "directedMulticastFromNetworkEnabled": false,
  "healthCheckSitesEnabled": true,
  "healthCheckSites": [
    "www.google.com",
    "www.live.com:443",
    "www.github.com:443",
    "source.codeaurora.org:443",
    "www.wikipedia.com"
  ],
  "ruckusGreTunnelProfile": {
    "id": "f5b92938-aa4e-4d02-90ea-273799ff689b",
    "name": "Default Tunnel Profile"
  },
  "softGreTunnelProflies": [
    {
      "id": "5a2e41b0-df53-11e7-98e1-08002748d78e",
      "name": "softGre1",
      "aaaAffinityEnabled": false
    },
    {
      "id": "7803e411-df53-11e7-98e1-08002748d78e",
      "name": "softGre2",
      "aaaAffinityEnabled": true
    },
    {
      "id": "664de4f1-df53-11e7-98e1-08002748d78e",
      "name": "softGre3",
      "aaaAffinityEnabled": false
    }
  ],
  "ipsecProfiles": [
    {
      "id": "3fd9aa91-df65-11e7-98e1-08002748d78e",
      "name": "ipsec1"
    },
    {
      "id": "832aa331-df65-11e7-98e1-08002748d78e",
      "name": "ipsec2"
    }
  ],
  "ipsecTunnelMode": "SOFT_GRE",
  "sshTunnelEncryption": "AES128",
  "apHccdEnabled": true,
  "apHccdPersist": true
}
Schema
{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "domainId" : {
            "description" : "Identifier of the management domain to which the zone belongs",
            "type" : "string"
        },
        "zoneAffinityProfileId" : {
            "description" : "Zone affinity profile of the zone",
            "type" : "string"
        },
        "enforcePriorityZoneAffinityEnable" : {
            "description" : "Enforced the priority of Affinity Profile.",
            "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",
                    "type" : "string"
                },
                "meshRadioIdx" : {
                    "description" : "Mesh radio index",
                    "type" : "string",
                    "enum" : [ "Radio24G", "Radio5G" ],
                    "default" : "Radio5G"
                },
                "zeroTouchStatus" : {
                    "type" : "boolean"
                }
            }
        },
        "dfsChannelEnabled" : {
            "description" : "DFS Channel enabled configuration of the zone, only for the US country code.",
            "type" : "boolean",
            "default" : false
        },
        "cbandChannelEnabled" : {
            "description" : "5.8Ghz channels enabled configuration of the zone.",
            "type" : "boolean",
            "default" : false
        },
        "cbandChannelLicenseEnabled" : {
            "description" : "5.8Ghz channels license enabled configuration of the zone.",
            "type" : "boolean",
            "default" : false
        },
        "channel144Enabled" : {
            "description" : "Channel 144 enabled configuration of the zone.",
            "type" : "boolean",
            "default" : false
        },
        "wifi24" : {
            "description" : "AP 2.4GHz radio configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "autoCellSizing" : {
                    "description" : "Auto Cell Sizing",
                    "type" : "boolean"
                },
                "txPower" : {
                    "description" : "Transmission power",
                    "type" : "string",
                    "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
                    "default" : "Full"
                },
                "channelWidth" : {
                    "description" : "Channel width. Zero (0) means Auto.",
                    "type" : "integer",
                    "enum" : [ 0, 20, 40 ],
                    "default" : 0
                },
                "channel" : {
                    "description" : "Channel number",
                    "type" : "integer"
                },
                "channelRange" : {
                    "description" : "Channel range options",
                    "type" : "array",
                    "items" : {
                        "type" : "integer"
                    }
                }
            }
        },
        "wifi50" : {
            "description" : "AP 5GHz radio configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "autoCellSizing" : {
                    "description" : "Auto Cell Sizing",
                    "type" : "boolean"
                },
                "txPower" : {
                    "description" : "Transmission power",
                    "type" : "string",
                    "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
                    "default" : "Full"
                },
                "channelWidth" : {
                    "description" : "Channel width. Zero (0) means Auto. 8080 means 80+80MHz",
                    "type" : "integer",
                    "enum" : [ 0, 20, 40, 80, 8080, 160 ],
                    "default" : 0
                },
                "indoorChannel" : {
                    "description" : "Channel number for Indoor AP",
                    "type" : "integer"
                },
                "outdoorChannel" : {
                    "description" : "Channel number for Outdoor AP",
                    "type" : "integer"
                },
                "indoorSecondaryChannel" : {
                    "description" : "Secondary channel number for Indoor AP (channelWidth is 80+80MHz only)",
                    "type" : "integer"
                },
                "outdoorSecondaryChannel" : {
                    "description" : "Secondary channel number for outdoor AP (channelWidth is 80+80MHz only)",
                    "type" : "integer"
                },
                "indoorChannelRange" : {
                    "description" : "Channel range options for Indoor AP",
                    "type" : "array",
                    "items" : {
                        "type" : "integer"
                    }
                },
                "outdoorChannelRange" : {
                    "description" : "Channel range options for outdoor AP",
                    "type" : "array",
                    "items" : {
                        "type" : "integer"
                    }
                }
            }
        },
        "protectionMode24" : {
            "description" : "AP 2.4GHz Protection mode configuration of the zone.",
            "type" : "string",
            "enum" : [ "NONE", "CTS_ONLY", "RTS_CTS" ],
            "default" : "RTS_CTS"
        },
        "syslog" : {
            "description" : "Syslog configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "flowLevel" : {
                    "description" : "Flow Level of the syslog",
                    "type" : "string",
                    "enum" : [ "GENERAL_LOGS", "CLIENT_FLOW", "ALL" ],
                    "default" : "GENERAL_LOGS"
                },
                "address" : {
                    "description" : "Address of the syslog server.",
                    "type" : "string"
                },
                "port" : {
                    "description" : "Port number of the syslog server",
                    "type" : "integer",
                    "default" : 514,
                    "minimum" : 1,
                    "maximum" : 65535
                },
                "protocol" : {
                    "description" : "Protocol of the syslog server",
                    "type" : "string",
                    "enum" : [ "IPPROTO_TCP", "IPPROTO_UDP" ],
                    "default" : "IPPROTO_TCP"
                },
                "secondaryAddress" : {
                    "description" : "Secondary Server Address of the syslog server",
                    "type" : "string"
                },
                "secondaryPort" : {
                    "description" : "Secondary Server Port of the syslog server",
                    "type" : "integer",
                    "default" : 514,
                    "minimum" : 1,
                    "maximum" : 65535
                },
                "secondaryProtocol" : {
                    "description" : "Secondary Server Protocol of the syslog server",
                    "type" : "string",
                    "enum" : [ "IPPROTO_TCP", "IPPROTO_UDP" ],
                    "default" : "IPPROTO_TCP"
                },
                "facility" : {
                    "description" : "Facility of the syslog server",
                    "type" : "string",
                    "enum" : [ "Keep_Original", "Local0", "Local1", "Local2", "Local3", "Local4", "Local5", "Local6", "Local7" ],
                    "default" : "Keep_Original"
                },
                "priority" : {
                    "description" : "Priority of the log messages",
                    "type" : "string",
                    "enum" : [ "Emergency", "Alert", "Critical", "Error", "Warning", "Notice", "Info", "All" ],
                    "default" : "Error"
                }
            }
        },
        "smartMonitor" : {
            "description" : "Smart monitor configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "intervalInSec" : {
                    "description" : "Interval in seconds. This is required if smartMonitor is enabled",
                    "type" : "integer",
                    "default" : 10,
                    "minimum" : 5,
                    "maximum" : 60
                },
                "retryThreshold" : {
                    "description" : "Retry threshold. This is required if smartMonitor is enabled",
                    "type" : "integer",
                    "default" : 3,
                    "minimum" : 1,
                    "maximum" : 10
                }
            }
        },
        "clientAdmissionControl24" : {
            "description" : "AP client admission control 2.4GHz radio configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "maxRadioLoadPercent" : {
                    "description" : "Maximum radio load percentage.",
                    "type" : "integer",
                    "default" : 75,
                    "minimum" : 50,
                    "maximum" : 100
                },
                "minClientCount" : {
                    "description" : "Minimum client count number.",
                    "type" : "integer",
                    "default" : 10,
                    "minimum" : 0,
                    "maximum" : 100
                },
                "minClientThroughputMbps" : {
                    "description" : "Minimum client throughput in Mbps.",
                    "type" : "number",
                    "default" : 0,
                    "minimum" : 0,
                    "maximum" : 100
                }
            }
        },
        "clientAdmissionControl50" : {
            "description" : "AP client admission control 5GHz radio configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "maxRadioLoadPercent" : {
                    "description" : "Maximum radio load percentage.",
                    "type" : "integer",
                    "default" : 75,
                    "minimum" : 50,
                    "maximum" : 100
                },
                "minClientCount" : {
                    "description" : "Minimum client count number.",
                    "type" : "integer",
                    "default" : 10,
                    "minimum" : 0,
                    "maximum" : 100
                },
                "minClientThroughputMbps" : {
                    "description" : "Minimum client throughput in Mbps.",
                    "type" : "number",
                    "default" : 0,
                    "minimum" : 0,
                    "maximum" : 100
                }
            }
        },
        "channelModeEnabled" : {
            "description" : "Channel mode configuration of the zone.",
            "type" : "boolean",
            "default" : false
        },
        "tunnelType" : {
            "description" : "Tunnel type configuration of the zone. No_Tunneled is for IPv6 mode",
            "type" : "string",
            "enum" : [ "No_Tunneled", "RuckusGRE", "SoftGRE", "SoftGREIpsec" ],
            "default" : "RuckusGRE"
        },
        "tunnelProfile" : {
            "description" : "Tunnel type configuration of the zone.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "backgroundScanning24" : {
            "description" : "Background scanning on 2.4GHz radio configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "frequencyInSec" : {
                    "description" : "Frequency in second",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 65535,
                    "default" : 20
                }
            }
        },
        "backgroundScanning50" : {
            "description" : "Background scanning on 5GHz radio configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "frequencyInSec" : {
                    "description" : "Frequency in second",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 65535,
                    "default" : 20
                }
            }
        },
        "clientLoadBalancing24" : {
            "description" : "Client load balancing on 2.4GHz radio configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "adjacentRadioThreshold" : {
                    "description" : "Adjacent radio threshold",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 100
                }
            }
        },
        "clientLoadBalancing50" : {
            "description" : "Client load balancing on 5GHz radio configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "adjacentRadioThreshold" : {
                    "description" : "Adjacent radio threshold",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 100
                }
            }
        },
        "bandBalancing" : {
            "description" : "Band balancing configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "mode" : {
                    "description" : "Band Balancing Mode: BASIC-Withholds probe and authentication responses at connetcion time in heavily loaded band to balance clients to the other band, PROACTIVE-Uses BASIC functionality and actively rebalances clients via 802.11v BTM, STRICT-Uses PROACTIVE functionality and forcefully rebalances clients via 802.11v BTM",
                    "type" : "string",
                    "enum" : [ "BASIC", "PROACTIVE", "STRICT" ],
                    "default" : "BASIC"
                },
                "wifi24Percentage" : {
                    "description" : "Percentage of client load on 2.4GHz radio band",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 100,
                    "default" : 25
                }
            }
        },
        "loadBalancingMethod" : {
            "type" : "string",
            "enum" : [ "BASED_ON_CLIENT_COUNT", "BASED_ON_CAPACITY", "OFF" ],
            "default" : "BASED_ON_CLIENT_COUNT"
        },
        "rogue" : {
            "description" : "Rogue AP detection configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "reportType" : {
                    "description" : "Report type",
                    "type" : "string",
                    "enum" : [ "All", "Malicious" ]
                },
                "maliciousTypes" : {
                    "description" : "Malicious type when reportType is Malicious",
                    "type" : [ "array", "null" ],
                    "items" : {
                        "type" : "string",
                        "enum" : [ "SSIDSpoofing", "SameNetwork", "MACSpoofing" ]
                    }
                },
                "protectionEnabled" : {
                    "description" : "Protection enabled",
                    "type" : "boolean"
                }
            }
        },
        "dosBarringEnable" : {
            "description" : "Enable DoS Protection(Barring UE) of the zone.",
            "type" : "integer"
        },
        "dosBarringPeriod" : {
            "description" : "DoS Protection(Barring UE) blocking period of the zone.",
            "type" : "integer",
            "default" : 60
        },
        "dosBarringThreshold" : {
            "description" : "DoS Protection(Barring UE) threshold of the zone.",
            "type" : "integer",
            "default" : 5
        },
        "dosBarringCheckPeriod" : {
            "description" : "DoS Protection(Barring UE) check period of the zone.",
            "type" : "integer",
            "default" : 30
        },
        "locationBasedService" : {
            "description" : "Location based service configuration of the zone.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "apRebootTimeout" : {
            "description" : "AP reboot timeout of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "gatewayLossTimeoutInSec" : {
                    "description" : "Gateway loss timeout in second",
                    "type" : "integer",
                    "enum" : [ 0, 1800, 3600, 5400, 7200, 9000, 10800, 12600, 14400, 16200, 18000, 19800, 23400, 25200, 27000, 28800, 30600, 32400, 34200, 36000, 37800, 39600, 41400, 43200, 45000, 46800, 48600, 50400, 52200, 54000, 55800, 57600, 59400, 61200, 63000, 64800, 66600, 68400, 70200, 72000, 73800, 75600, 77400, 79200, 81000, 82800, 84600, 86400 ],
                    "default" : 1800
                },
                "serverLossTimeoutInSec" : {
                    "description" : "Server loss timeout in second",
                    "type" : "integer",
                    "enum" : [ 0, 7200, 14400, 21600, 28800, 36000, 43200, 50400, 57600, 64800, 72000, 79200, 86400 ],
                    "default" : 7200
                }
            }
        },
        "location" : {
            "description" : "Location of the zone.",
            "type" : "string"
        },
        "locationAdditionalInfo" : {
            "description" : "Location additional info of the zone.",
            "type" : "string",
            "pattern" : "^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
        },
        "altitude" : {
            "description" : "GPS Altitude",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "altitudeUnit" : {
                    "description" : "altitude unit",
                    "type" : "string",
                    "enum" : [ "meters", "floor" ],
                    "default" : "meters"
                },
                "altitudeValue" : {
                    "description" : "altitude value",
                    "type" : "integer"
                }
            }
        },
        "latitude" : {
            "description" : "Latitude coordinate (in decimal format) of the zone",
            "type" : "number"
        },
        "longitude" : {
            "description" : "Longitude coordinate (in decimal format) of the zone",
            "type" : "number"
        },
        "vlanOverlappingEnabled" : {
            "description" : "VLAN pooling overlapping of the zone",
            "type" : "boolean"
        },
        "nodeAffinityProfile" : {
            "description" : "Node affinity profile of the zone.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "venueProfile" : {
            "description" : "Venue profile configuration of the zone.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "autoChannelSelection24" : {
            "description" : "client load balancing on Radio 2.4G, auto channel selection mode",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "channelSelectMode" : {
                    "description" : "Channel Select Mode",
                    "type" : "string",
                    "enum" : [ "None", "BackgroundScanning", "ChannelFly" ],
                    "default" : "BackgroundScanning"
                },
                "channelFlyMtbc" : {
                    "description" : "ChannelFly MTBC",
                    "type" : "integer",
                    "default" : 480,
                    "minimum" : 100,
                    "maximum" : 1440
                }
            }
        },
        "autoChannelSelection50" : {
            "description" : "client load balancing on Radio 5G, auto channel selection mode",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "channelSelectMode" : {
                    "description" : "Channel Select Mode",
                    "type" : "string",
                    "enum" : [ "None", "BackgroundScanning", "ChannelFly" ],
                    "default" : "BackgroundScanning"
                },
                "channelFlyMtbc" : {
                    "description" : "ChannelFly MTBC",
                    "type" : "integer",
                    "default" : 480,
                    "minimum" : 100,
                    "maximum" : 1440
                }
            }
        },
        "channelEvaluationInterval" : {
            "description" : "channel evaluation Interval of the zone",
            "type" : "integer",
            "default" : 600,
            "minimum" : 60,
            "maximum" : 3600
        },
        "apMgmtVlan" : {
            "description" : "ap Management Vlan of the zone",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "mode" : {
                    "description" : "Vlan Mode of the zone",
                    "type" : "string",
                    "enum" : [ "KEEP", "USER_DEFINED" ],
                    "default" : "KEEP"
                },
                "id" : {
                    "description" : "Vlan id of the zone",
                    "type" : "integer",
                    "default" : "1"
                }
            }
        },
        "apLatencyInterval" : {
            "description" : "AP latency interval",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "pingEnabled" : {
                    "description" : "AP ping latency enabled",
                    "type" : "boolean",
                    "default" : true
                }
            }
        },
        "ipsecProfile" : {
            "description" : "ipsec profile configuration of the Zone.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "ipv6TrafficFilterEnabled" : {
            "description" : "IPv6 Traffic filtering on the AP",
            "type" : "integer"
        },
        "bonjourFencingPolicyEnabled" : {
            "description" : "Enable Bonjour Fencing Policy on the AP",
            "type" : "boolean"
        },
        "bonjourFencingPolicy" : {
            "description" : "Bonjour Fencing Policy on the AP",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "dhcpSiteConfig" : {
            "description" : "DHCP Site Configuration in Zone",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "siteEnabled" : {
                    "description" : "DHCP Service Enabling Status",
                    "type" : "boolean"
                },
                "dwpdEnabled" : {
                    "description" : "DHCP Service Dynamic WAN Port Detection",
                    "type" : "boolean"
                },
                "manualSelect" : {
                    "description" : "DHCP Service AP Selection Mode. This value is effective when the siteMode is EnableOnMultipleAPs.",
                    "type" : "boolean"
                },
                "siteMode" : {
                    "description" : "DHCP Service mode",
                    "type" : "string",
                    "enum" : [ "EnableOnEachAPs", "EnableOnMultipleAPs", "EnableOnHierarchicalAPs" ]
                },
                "eth0ProfileId" : {
                    "type" : "integer"
                },
                "eth1ProfileId" : {
                    "type" : "integer"
                },
                "siteAps" : {
                    "type" : "array",
                    "items" : {
                        "type" : "object",
                        "description" : "DHCP Site selected APs. The content is effective when the siteMode is EnableOnMultipleAPs.",
                        "additionalProperties" : false,
                        "properties" : {
                            "apMac" : {
                                "type" : "string"
                            },
                            "apName" : {
                                "type" : "string"
                            },
                            "apStatus" : {
                                "type" : "string",
                                "enum" : [ "Online", "Offline", "Flagged" ]
                            },
                            "apServerEnabled" : {
                                "type" : "boolean"
                            },
                            "apServerPrimary" : {
                                "type" : "boolean"
                            },
                            "apServerIp" : {
                                "type" : [ "string", "null" ]
                            },
                            "apGatewayIp" : {
                                "type" : "string"
                            },
                            "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"
                },
                "snmpV2Agent" : {
                    "description" : "Community List of the SNMP V2 Agent.",
                    "type" : "array",
                    "items" : {
                        "type" : "object",
                        "additionalProperties" : false,
                        "properties" : {
                            "communityName" : {
                                "description" : "name of the SNMP Community.",
                                "type" : "string"
                            },
                            "readEnabled" : {
                                "description" : "read privilege of the SNMP Coummunity",
                                "type" : "boolean"
                            },
                            "writeEnabled" : {
                                "description" : "write privilege of the SNMP Coummunity",
                                "type" : "boolean"
                            },
                            "notificationEnabled" : {
                                "description" : "notification privilege of the SNMP Coummunity",
                                "type" : "boolean"
                            },
                            "notificationType" : {
                                "description" : "type of the notification privilege",
                                "type" : "string",
                                "enum" : [ "TRAP", "INFORM" ]
                            },
                            "notificationTarget" : {
                                "description" : "Trap List of the SNMP Coummunity",
                                "type" : "array",
                                "items" : {
                                    "type" : "object",
                                    "additionalProperties" : false,
                                    "properties" : {
                                        "address" : {
                                            "description" : "address of the SNMP Trap",
                                            "type" : "string"
                                        },
                                        "port" : {
                                            "description" : "port number of the SNMP Trap",
                                            "type" : "integer",
                                            "minimum" : 1,
                                            "maximum" : 65535
                                        }
                                    },
                                    "required" : [ "address", "port" ]
                                }
                            }
                        },
                        "required" : [ "communityName" ]
                    }
                },
                "snmpV3Agent" : {
                    "description" : "User List of the SNMP V3 Agent.",
                    "type" : "array",
                    "items" : {
                        "type" : "object",
                        "additionalProperties" : false,
                        "properties" : {
                            "userName" : {
                                "description" : "name of the SNMP User.",
                                "type" : "string"
                            },
                            "authProtocol" : {
                                "description" : "authProtocol of the SNMP User.",
                                "type" : "string",
                                "enum" : [ "NONE", "MD5", "SHA" ]
                            },
                            "authPassword" : {
                                "description" : "authPassword of the SNMP User.",
                                "type" : "string",
                                "minLength" : 8
                            },
                            "privProtocol" : {
                                "description" : "privProtocol of the SNMP User.",
                                "type" : "string",
                                "enum" : [ "NONE", "DES", "AES" ]
                            },
                            "privPassword" : {
                                "description" : "privPassword of the SNMP User.",
                                "type" : "string",
                                "minLength" : 8
                            },
                            "readEnabled" : {
                                "description" : "read privilege of the SNMP User",
                                "type" : "boolean"
                            },
                            "writeEnabled" : {
                                "description" : "write privilege of the SNMP User",
                                "type" : "boolean"
                            },
                            "notificationEnabled" : {
                                "description" : "notification privilege of the SNMP User",
                                "type" : "boolean"
                            },
                            "notificationType" : {
                                "description" : "type of the notification privilege",
                                "type" : "string",
                                "enum" : [ "TRAP", "INFORM" ]
                            },
                            "notificationTarget" : {
                                "description" : "Trap List of the SNMP User",
                                "type" : "array",
                                "items" : {
                                    "type" : "object",
                                    "additionalProperties" : false,
                                    "properties" : {
                                        "address" : {
                                            "description" : "address of the SNMP Trap",
                                            "type" : "string"
                                        },
                                        "port" : {
                                            "description" : "port number of the SNMP Trap",
                                            "type" : "integer",
                                            "minimum" : 1,
                                            "maximum" : 65535
                                        }
                                    },
                                    "required" : [ "address", "port" ]
                                }
                            }
                        },
                        "required" : [ "userName" ]
                    }
                }
            }
        },
        "recoverySsid" : {
            "description" : "Recovery SSID",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "recoverySsidEnabled" : {
                    "description" : "recovery ssid enable/disable",
                    "type" : "boolean"
                }
            }
        },
        "clusterRedundancyEnabled" : {
            "description" : "Enable Cluster redundancy on zone.",
            "type" : "boolean",
            "default" : false
        },
        "rogueApReportThreshold" : {
            "description" : "Rogue AP report will leave out all entries that have signal strength lower than this threshold.",
            "type" : "integer"
        },
        "rogueApAggressivenessMode" : {
            "description" : "Adjust the frequency interval to de-authenticate rogue APs.",
            "type" : "integer"
        },
        "rogueApJammingDetection" : {
            "description" : "Enable jamming detection.",
            "type" : "boolean",
            "default" : false
        },
        "rogueApJammingThreshold" : {
            "type" : "integer"
        },
        "directedMulticastFromWiredClientEnabled" : {
            "description" : "Directed multicast from wired client.",
            "type" : "boolean",
            "default" : true
        },
        "directedMulticastFromWirelessClientEnabled" : {
            "description" : "Directed multicast from wireless client.",
            "type" : "boolean",
            "default" : true
        },
        "directedMulticastFromNetworkEnabled" : {
            "description" : "Directed multicast from network.",
            "type" : "boolean",
            "default" : true
        },
        "healthCheckSitesEnabled" : {
            "description" : "Enabled Health Check Sites. ",
            "type" : "boolean",
            "default" : false
        },
        "healthCheckSites" : {
            "description" : "Health Check Sites.",
            "type" : "array",
            "items" : {
                "type" : "string"
            }
        },
        "ruckusGreTunnelProfile" : {
            "description" : "Ruckus GRE Profile for Multiple Tunnel (Start from SZ 5.0)",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "softGreTunnelProflies" : {
            "description" : "SoftGRE Profiles for Multiple Tunnel (Start from SZ 5.0)",
            "type" : "array",
            "items" : {
                "type" : [ "object", "null" ],
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "type" : "string"
                    },
                    "name" : {
                        "type" : "string"
                    },
                    "aaaAffinityEnabled" : {
                        "type" : "boolean"
                    }
                }
            }
        },
        "ipsecProfiles" : {
            "description" : "Ipsec profile for Multiple Tunnel (Start from SZ 5.0)",
            "type" : "array",
            "items" : {
                "type" : [ "object", "null" ],
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "type" : "string"
                    },
                    "name" : {
                        "type" : "string"
                    }
                }
            }
        },
        "ipsecTunnelMode" : {
            "type" : "string",
            "enum" : [ "DISABLE", "SOFT_GRE", "RUCKUS_GRE" ]
        },
        "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"
                    }
                }
            }
        },
        "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
        }
    },
    "required" : [ "name", "login" ]
}
Response  201
HideShow
Body
{
  "id": "zoneUUID"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Create Zone of Dual

POST/v8_1/rkszones/dual

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

Request
HideShow
Body
{
  "domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
  "zoneAffinityProfileId": "3fd9aa91-df65-11e7-98e1-08002748d78e",
  "enforcePriorityZoneAffinityEnable": false,
  "name": "createZoneName",
  "description": "description Zone",
  "countryCode": "US",
  "timezone": {
    "customizedTimezone": {
      "abbreviation": "TPE",
      "gmtOffset": 0,
      "gmtOffsetMinute": 0
    }
  },
  "login": {
    "apLoginName": "admin",
    "apLoginPassword": "admin!234"
  },
  "dfsChannelEnabled": false,
  "wifi24": {
    "txPower": "Full",
    "channelWidth": 20,
    "channel": 0,
    "channelRange": [
      1,
      2,
      3,
      4,
      5,
      6,
      7,
      8,
      9,
      10,
      11
    ]
  },
  "wifi50": {
    "txPower": "-1dB",
    "channelWidth": 40,
    "indoorChannel": 0,
    "outdoorChannel": 0,
    "indoorChannelRange": [
      36,
      40,
      44,
      48,
      149,
      153,
      157,
      161
    ],
    "outdoorChannelRange": [
      149,
      153,
      157,
      161
    ]
  },
  "protectionMode24": "CTS_ONLY",
  "syslog": {
    "flowLevel": "GENERAL_LOGS",
    "address": "1.1.1.1",
    "port": 514,
    "protocol": "IPPROTO_TCP",
    "secondaryAddress": "2.2.2.2",
    "secondaryPort": 514,
    "secondaryProtocol": "IPPROTO_TCP",
    "facility": "Local0",
    "priority": "Error"
  },
  "smartMonitor": {
    "intervalInSec": 10,
    "retryThreshold": 3
  },
  "channelModeEnabled": false,
  "tunnelType": "RuckusGRE",
  "backgroundScanning24": {
    "frequencyInSec": 20
  },
  "backgroundScanning50": {
    "frequencyInSec": 20
  },
  "clientLoadBalancing24": {
    "adjacentRadioThreshold": 12
  },
  "clientLoadBalancing50": {
    "adjacentRadioThreshold": 12
  },
  "bandBalancing": {
    "wifi24Percentage": 10
  },
  "loadBalancingMethod": "BASED_ON_CLIENT_COUNT",
  "rogue": {
    "reportType": "All",
    "maliciousTypes": null,
    "protectionEnabled": true
  },
  "dosBarringEnable": 0,
  "dosBarringPeriod": 60,
  "dosBarringThreshold": 5,
  "dosBarringCheckPeriod": 30,
  "apRebootTimeout": {
    "gatewayLossTimeoutInSec": 1800,
    "serverLossTimeoutInSec": 7200
  },
  "location": "location",
  "locationAdditionalInfo": "locationAdditionalInfo",
  "latitude": 23,
  "longitude": 23,
  "vlanOverlappingEnabled": false,
  "autoChannelSelection24": {
    "channelSelectMode": "ChannelFly",
    "channelFlyMtbc": 480
  },
  "autoChannelSelection50": {
    "channelSelectMode": "BackgroundScanning",
    "channelFlyMtbc": 480
  },
  "channelEvaluationInterval": 777,
  "apMgmtVlan": {
    "id": 1,
    "mode": "KEEP"
  },
  "apLatencyInterval": {
    "pingEnabled": true
  },
  "ipsecProfile": {
    "id": "ipsecProfileId",
    "name": "ipsecProfileName"
  },
  "altitude": {
    "altitudeUnit": "meters",
    "altitudeValue": 1
  },
  "bonjourFencingPolicyEnabled": false,
  "snmpAgent": {
    "apSnmpEnabled": true,
    "snmpV2Agent": [
      {
        "communityName": "v2Agent",
        "notificationEnabled": true,
        "readEnabled": true,
        "writeEnabled": true,
        "notificationType": "TRAP",
        "notificationTarget": [
          {
            "address": "172.19.16.20",
            "port": 161
          }
        ]
      }
    ],
    "snmpV3Agent": [
      {
        "userName": "v3Agent",
        "authProtocol": "MD5",
        "authPassword": "admin!234",
        "privProtocol": "DES",
        "privPassword": "admin!234",
        "notificationEnabled": true,
        "readEnabled": true,
        "writeEnabled": true,
        "notificationType": "TRAP",
        "notificationTarget": [
          {
            "address": "172.19.16.20",
            "port": 161
          }
        ]
      }
    ]
  },
  "recoverySsid": {
    "recoverySsidEnabled": true
  },
  "dhcpSiteConfig": {
    "siteEnabled": true,
    "siteMode": "EnableOnEachAPs",
    "siteProfileIds": [
      "75e26590-547f-11e6-9ca7-5a095364c13c",
      "869bb532-547f-11e6-9ca7-5a095364c13c"
    ]
  },
  "rogueApReportThreshold": 40,
  "rogueApAggressivenessMode": 2,
  "rogueApJammingDetection": true,
  "rogueApJammingThreshold": 40,
  "directedMulticastFromWiredClientEnabled": true,
  "directedMulticastFromWirelessClientEnabled": true,
  "directedMulticastFromNetworkEnabled": false,
  "healthCheckSitesEnabled": true,
  "healthCheckSites": [
    "www.google.com",
    "www.live.com:443",
    "www.github.com:443",
    "source.codeaurora.org:443",
    "www.wikipedia.com"
  ],
  "ruckusGreTunnelProfile": {
    "id": "f5b92938-aa4e-4d02-90ea-273799ff689b",
    "name": "Default Tunnel Profile"
  },
  "softGreTunnelProflies": [
    {
      "id": "5a2e41b0-df53-11e7-98e1-08002748d78e",
      "name": "softGre1",
      "aaaAffinityEnabled": false
    },
    {
      "id": "7803e411-df53-11e7-98e1-08002748d78e",
      "name": "softGre2",
      "aaaAffinityEnabled": true
    },
    {
      "id": "664de4f1-df53-11e7-98e1-08002748d78e",
      "name": "softGre3",
      "aaaAffinityEnabled": false
    }
  ],
  "ipsecProfiles": [
    {
      "id": "3fd9aa91-df65-11e7-98e1-08002748d78e",
      "name": "ipsec1"
    },
    {
      "id": "832aa331-df65-11e7-98e1-08002748d78e",
      "name": "ipsec2"
    }
  ],
  "ipsecTunnelMode": "SOFT_GRE",
  "sshTunnelEncryption": "AES128",
  "apHccdEnabled": true,
  "apHccdPersist": true
}
Schema
{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "domainId" : {
            "description" : "Identifier of the management domain to which the zone belongs",
            "type" : "string"
        },
        "zoneAffinityProfileId" : {
            "description" : "Zone affinity profile of the zone",
            "type" : "string"
        },
        "enforcePriorityZoneAffinityEnable" : {
            "description" : "Enforced the priority of Affinity Profile.",
            "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",
                    "type" : "string"
                },
                "meshRadioIdx" : {
                    "description" : "Mesh radio index",
                    "type" : "string",
                    "enum" : [ "Radio24G", "Radio5G" ],
                    "default" : "Radio5G"
                },
                "zeroTouchStatus" : {
                    "type" : "boolean"
                }
            }
        },
        "dfsChannelEnabled" : {
            "description" : "DFS Channel enabled configuration of the zone, only for the US country code.",
            "type" : "boolean",
            "default" : false
        },
        "cbandChannelEnabled" : {
            "description" : "5.8Ghz channels enabled configuration of the zone.",
            "type" : "boolean",
            "default" : false
        },
        "cbandChannelLicenseEnabled" : {
            "description" : "5.8Ghz channels license enabled configuration of the zone.",
            "type" : "boolean",
            "default" : false
        },
        "channel144Enabled" : {
            "description" : "Channel 144 enabled configuration of the zone.",
            "type" : "boolean",
            "default" : false
        },
        "wifi24" : {
            "description" : "AP 2.4GHz radio configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "autoCellSizing" : {
                    "description" : "Auto Cell Sizing",
                    "type" : "boolean"
                },
                "txPower" : {
                    "description" : "Transmission power",
                    "type" : "string",
                    "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
                    "default" : "Full"
                },
                "channelWidth" : {
                    "description" : "Channel width. Zero (0) means Auto.",
                    "type" : "integer",
                    "enum" : [ 0, 20, 40 ],
                    "default" : 0
                },
                "channel" : {
                    "description" : "Channel number",
                    "type" : "integer"
                },
                "channelRange" : {
                    "description" : "Channel range options",
                    "type" : "array",
                    "items" : {
                        "type" : "integer"
                    }
                }
            }
        },
        "wifi50" : {
            "description" : "AP 5GHz radio configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "autoCellSizing" : {
                    "description" : "Auto Cell Sizing",
                    "type" : "boolean"
                },
                "txPower" : {
                    "description" : "Transmission power",
                    "type" : "string",
                    "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
                    "default" : "Full"
                },
                "channelWidth" : {
                    "description" : "Channel width. Zero (0) means Auto. 8080 means 80+80MHz",
                    "type" : "integer",
                    "enum" : [ 0, 20, 40, 80, 8080, 160 ],
                    "default" : 0
                },
                "indoorChannel" : {
                    "description" : "Channel number for Indoor AP",
                    "type" : "integer"
                },
                "outdoorChannel" : {
                    "description" : "Channel number for Outdoor AP",
                    "type" : "integer"
                },
                "indoorSecondaryChannel" : {
                    "description" : "Secondary channel number for Indoor AP (channelWidth is 80+80MHz only)",
                    "type" : "integer"
                },
                "outdoorSecondaryChannel" : {
                    "description" : "Secondary channel number for outdoor AP (channelWidth is 80+80MHz only)",
                    "type" : "integer"
                },
                "indoorChannelRange" : {
                    "description" : "Channel range options for Indoor AP",
                    "type" : "array",
                    "items" : {
                        "type" : "integer"
                    }
                },
                "outdoorChannelRange" : {
                    "description" : "Channel range options for outdoor AP",
                    "type" : "array",
                    "items" : {
                        "type" : "integer"
                    }
                }
            }
        },
        "protectionMode24" : {
            "description" : "AP 2.4GHz Protection mode configuration of the zone.",
            "type" : "string",
            "enum" : [ "NONE", "CTS_ONLY", "RTS_CTS" ],
            "default" : "RTS_CTS"
        },
        "syslog" : {
            "description" : "Syslog configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "flowLevel" : {
                    "description" : "Flow Level of the syslog",
                    "type" : "string",
                    "enum" : [ "GENERAL_LOGS", "CLIENT_FLOW", "ALL" ],
                    "default" : "GENERAL_LOGS"
                },
                "address" : {
                    "description" : "Address of the syslog server.",
                    "type" : "string"
                },
                "port" : {
                    "description" : "Port number of the syslog server",
                    "type" : "integer",
                    "default" : 514,
                    "minimum" : 1,
                    "maximum" : 65535
                },
                "protocol" : {
                    "description" : "Protocol of the syslog server",
                    "type" : "string",
                    "enum" : [ "IPPROTO_TCP", "IPPROTO_UDP" ],
                    "default" : "IPPROTO_TCP"
                },
                "secondaryAddress" : {
                    "description" : "Secondary Server Address of the syslog server",
                    "type" : "string"
                },
                "secondaryPort" : {
                    "description" : "Secondary Server Port of the syslog server",
                    "type" : "integer",
                    "default" : 514,
                    "minimum" : 1,
                    "maximum" : 65535
                },
                "secondaryProtocol" : {
                    "description" : "Secondary Server Protocol of the syslog server",
                    "type" : "string",
                    "enum" : [ "IPPROTO_TCP", "IPPROTO_UDP" ],
                    "default" : "IPPROTO_TCP"
                },
                "facility" : {
                    "description" : "Facility of the syslog server",
                    "type" : "string",
                    "enum" : [ "Keep_Original", "Local0", "Local1", "Local2", "Local3", "Local4", "Local5", "Local6", "Local7" ],
                    "default" : "Keep_Original"
                },
                "priority" : {
                    "description" : "Priority of the log messages",
                    "type" : "string",
                    "enum" : [ "Emergency", "Alert", "Critical", "Error", "Warning", "Notice", "Info", "All" ],
                    "default" : "Error"
                }
            }
        },
        "smartMonitor" : {
            "description" : "Smart monitor configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "intervalInSec" : {
                    "description" : "Interval in seconds. This is required if smartMonitor is enabled",
                    "type" : "integer",
                    "default" : 10,
                    "minimum" : 5,
                    "maximum" : 60
                },
                "retryThreshold" : {
                    "description" : "Retry threshold. This is required if smartMonitor is enabled",
                    "type" : "integer",
                    "default" : 3,
                    "minimum" : 1,
                    "maximum" : 10
                }
            }
        },
        "clientAdmissionControl24" : {
            "description" : "AP client admission control 2.4GHz radio configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "maxRadioLoadPercent" : {
                    "description" : "Maximum radio load percentage.",
                    "type" : "integer",
                    "default" : 75,
                    "minimum" : 50,
                    "maximum" : 100
                },
                "minClientCount" : {
                    "description" : "Minimum client count number.",
                    "type" : "integer",
                    "default" : 10,
                    "minimum" : 0,
                    "maximum" : 100
                },
                "minClientThroughputMbps" : {
                    "description" : "Minimum client throughput in Mbps.",
                    "type" : "number",
                    "default" : 0,
                    "minimum" : 0,
                    "maximum" : 100
                }
            }
        },
        "clientAdmissionControl50" : {
            "description" : "AP client admission control 5GHz radio configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "maxRadioLoadPercent" : {
                    "description" : "Maximum radio load percentage.",
                    "type" : "integer",
                    "default" : 75,
                    "minimum" : 50,
                    "maximum" : 100
                },
                "minClientCount" : {
                    "description" : "Minimum client count number.",
                    "type" : "integer",
                    "default" : 10,
                    "minimum" : 0,
                    "maximum" : 100
                },
                "minClientThroughputMbps" : {
                    "description" : "Minimum client throughput in Mbps.",
                    "type" : "number",
                    "default" : 0,
                    "minimum" : 0,
                    "maximum" : 100
                }
            }
        },
        "channelModeEnabled" : {
            "description" : "Channel mode configuration of the zone.",
            "type" : "boolean",
            "default" : false
        },
        "tunnelType" : {
            "description" : "Tunnel type configuration of the zone. No_Tunneled is for IPv6 mode",
            "type" : "string",
            "enum" : [ "No_Tunneled", "RuckusGRE", "SoftGRE", "SoftGREIpsec" ],
            "default" : "RuckusGRE"
        },
        "tunnelProfile" : {
            "description" : "Tunnel type configuration of the zone.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "backgroundScanning24" : {
            "description" : "Background scanning on 2.4GHz radio configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "frequencyInSec" : {
                    "description" : "Frequency in second",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 65535,
                    "default" : 20
                }
            }
        },
        "backgroundScanning50" : {
            "description" : "Background scanning on 5GHz radio configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "frequencyInSec" : {
                    "description" : "Frequency in second",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 65535,
                    "default" : 20
                }
            }
        },
        "clientLoadBalancing24" : {
            "description" : "Client load balancing on 2.4GHz radio configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "adjacentRadioThreshold" : {
                    "description" : "Adjacent radio threshold",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 100
                }
            }
        },
        "clientLoadBalancing50" : {
            "description" : "Client load balancing on 5GHz radio configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "adjacentRadioThreshold" : {
                    "description" : "Adjacent radio threshold",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 100
                }
            }
        },
        "bandBalancing" : {
            "description" : "Band balancing configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "mode" : {
                    "description" : "Band Balancing Mode: BASIC-Withholds probe and authentication responses at connetcion time in heavily loaded band to balance clients to the other band, PROACTIVE-Uses BASIC functionality and actively rebalances clients via 802.11v BTM, STRICT-Uses PROACTIVE functionality and forcefully rebalances clients via 802.11v BTM",
                    "type" : "string",
                    "enum" : [ "BASIC", "PROACTIVE", "STRICT" ],
                    "default" : "BASIC"
                },
                "wifi24Percentage" : {
                    "description" : "Percentage of client load on 2.4GHz radio band",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 100,
                    "default" : 25
                }
            }
        },
        "loadBalancingMethod" : {
            "type" : "string",
            "enum" : [ "BASED_ON_CLIENT_COUNT", "BASED_ON_CAPACITY", "OFF" ],
            "default" : "BASED_ON_CLIENT_COUNT"
        },
        "rogue" : {
            "description" : "Rogue AP detection configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "reportType" : {
                    "description" : "Report type",
                    "type" : "string",
                    "enum" : [ "All", "Malicious" ]
                },
                "maliciousTypes" : {
                    "description" : "Malicious type when reportType is Malicious",
                    "type" : [ "array", "null" ],
                    "items" : {
                        "type" : "string",
                        "enum" : [ "SSIDSpoofing", "SameNetwork", "MACSpoofing" ]
                    }
                },
                "protectionEnabled" : {
                    "description" : "Protection enabled",
                    "type" : "boolean"
                }
            }
        },
        "dosBarringEnable" : {
            "description" : "Enable DoS Protection(Barring UE) of the zone.",
            "type" : "integer"
        },
        "dosBarringPeriod" : {
            "description" : "DoS Protection(Barring UE) blocking period of the zone.",
            "type" : "integer",
            "default" : 60
        },
        "dosBarringThreshold" : {
            "description" : "DoS Protection(Barring UE) threshold of the zone.",
            "type" : "integer",
            "default" : 5
        },
        "dosBarringCheckPeriod" : {
            "description" : "DoS Protection(Barring UE) check period of the zone.",
            "type" : "integer",
            "default" : 30
        },
        "locationBasedService" : {
            "description" : "Location based service configuration of the zone.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "apRebootTimeout" : {
            "description" : "AP reboot timeout of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "gatewayLossTimeoutInSec" : {
                    "description" : "Gateway loss timeout in second",
                    "type" : "integer",
                    "enum" : [ 0, 1800, 3600, 5400, 7200, 9000, 10800, 12600, 14400, 16200, 18000, 19800, 23400, 25200, 27000, 28800, 30600, 32400, 34200, 36000, 37800, 39600, 41400, 43200, 45000, 46800, 48600, 50400, 52200, 54000, 55800, 57600, 59400, 61200, 63000, 64800, 66600, 68400, 70200, 72000, 73800, 75600, 77400, 79200, 81000, 82800, 84600, 86400 ],
                    "default" : 1800
                },
                "serverLossTimeoutInSec" : {
                    "description" : "Server loss timeout in second",
                    "type" : "integer",
                    "enum" : [ 0, 7200, 14400, 21600, 28800, 36000, 43200, 50400, 57600, 64800, 72000, 79200, 86400 ],
                    "default" : 7200
                }
            }
        },
        "location" : {
            "description" : "Location of the zone.",
            "type" : "string"
        },
        "locationAdditionalInfo" : {
            "description" : "Location additional info of the zone.",
            "type" : "string",
            "pattern" : "^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
        },
        "altitude" : {
            "description" : "GPS Altitude",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "altitudeUnit" : {
                    "description" : "altitude unit",
                    "type" : "string",
                    "enum" : [ "meters", "floor" ],
                    "default" : "meters"
                },
                "altitudeValue" : {
                    "description" : "altitude value",
                    "type" : "integer"
                }
            }
        },
        "latitude" : {
            "description" : "Latitude coordinate (in decimal format) of the zone",
            "type" : "number"
        },
        "longitude" : {
            "description" : "Longitude coordinate (in decimal format) of the zone",
            "type" : "number"
        },
        "vlanOverlappingEnabled" : {
            "description" : "VLAN pooling overlapping of the zone",
            "type" : "boolean"
        },
        "nodeAffinityProfile" : {
            "description" : "Node affinity profile of the zone.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "