Back to top

vSCG Carrier Kumo Public API Reference Guide

Overview

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

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

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

Open API document

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

Version Matrix

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

VSCGCKUMO Version API Version
5.1.1 v6_0 v6_1 v7_0 v8_0 v8_1

Common Request Header

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

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

Common Request URI Parameters

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

Parameter Value
serviceTicket {serviceTicket}

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

Request Header for Session

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

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

Parameter Value
Cookie “JSESSIONID={JSESSIONID}”

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

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

HTTP Responses

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

Ruckus Wireless Error Codes

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

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

Time Zone

Africa/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.

  • Flexi-VPN
Remove
PATCH /system/flexiVpnGlobalSetting
GET /system/flexiVpnGlobalSetting

Not Support Properties

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

  • Hotspot Service

    • CREATE INTERNAL
      Remove
      trafficClassProfileId signatureSigningKey internalNode
  • FLEXI-VPN

    • MODIFY FLEXI-VPN PROFILE
      Remove
      wlanId
  • L3 ROAMING

    • RETRIVE L3 ROAMING CONFIGURATION
    • RETRIEVE L3 ROAMING BASIC CONFIGURATION
    • MODIFY L3 ROAMING BASIC CONFIGURATION
      Remove
      featureEnabled
  • SCG USER

    Remove
    companyName

What’s New

  • API

    • AP Group
      • Disable LTE band lock channel override
    • Access Point Configuration
      • Disable LTE band lock channel override
    • Administration
      • Create - Admin AAA Server
      • Retrieve - Admin AAA Server
      • Retrieve List - Admin AAA Server
      • Modify - Admin AAA Server
      • Delete - Admin AAA Server
    • Session Management
      • Retrieve
    • SystemIPsec
      • Retrieve System IPSec
      • Modify System IPSec
    • Vendor Specific Attribute Profile
      • Get Vendor Specific Attribute Profiles
      • Get Vendor Specific Attribute Profile
      • Create Vendor Specific Attribute Profile
      • Modify Entire Vendor Specific Attribute Profile
      • Delete Vendor Specific Attribute Profile
      • Bulk Delete Vendor Specific Attribute Profile
      • Query Vendor Specific Attribute Profiles
    • Wired Client
      • Deauth Wired Client
      • Bulk Deauth Wired Client
  • 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
      • Modify
        • lteBandLockChannels
      • Modify AP Config
        • lteBandLockChannels
      • Retrieve
        • 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
    • Zone Affinity Profile
      • Get one zone affinity profile
        • zoneAffinityListWithPriority
    • System
      • Retrieve NBI
        • radiusAuthType
      • Modify NBI Basic
        • radiusAuthType
      • Retrieve System Time
        • authenticationKey
      • Modify System Time
        • authenticationKey
    • WLAN
      • Create - Hotspot 2.0 Open
        • flexiVpnProfile, timeboundWhitelist
      • Create - Hotspot 2.0 OSEN
        • flexiVpnProfile, timeboundWhitelist
      • Modify RADIUS Options
        • vendorSpecificAttributeProfileId
      • Modify Advanced Options
        • dhcp82SubOpt1Format, dhcp82SubOpt2Format, dhcp82SubOpt150Format, dhcp82SubOpt151Format, dhcp82SubOpt151AreaName, dropRandomProbesEnabled
    • WLAN Group
      • Add Member
        • name
    • Ruckus Wireless AP Zone
      • Change the Zone’s IPsec Profiles
        • channel144Enabled, lteBandLockChannels, apHccdEnabled, apHccdPersist
      • Create Zone of IPv6
        • zoneAffinityProfileId, enforcePriorityZoneAffinityEnable, channel144Enabled, lteBandLockChannels, apHccdEnabled, apHccdPersist
      • Create Zone of Dual
        • zoneAffinityProfileId, enforcePriorityZoneAffinityEnable, channel144Enabled, lteBandLockChannels, apHccdEnabled, apHccdPersist
      • Modify entire zone
        • channel144Enabled, lteBandLockChannels, apHccdEnabled, apHccdPersist
      • Retrieve AP Model
        • lacp
      • Modify AP Model
        • lacp
      • Retrieve AP Model Common Attribute
        • meshRadioCaps
      • Retrieve
        • channel144Enabled, lteBandLockChannels, apHccdEnabled, apHccdPersist
      • Modify
        • channel144Enabled, lteBandLockChannels, apHccdEnabled, apHccdPersist
      • Create Zone
        • zoneAffinityProfileId, enforcePriorityZoneAffinityEnable, channel144Enabled, lteBandLockChannels, apHccdEnabled, apHccdPersist
    • 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
{
  "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
{
    "additionalProperties" : false,
    "properties" : {
        "altitude" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "altitudeUnit" : {
                    "description" : "altitude unit",
                    "type" : "string",
                    "enum" : [ "meters", "floor" ]
                },
                "altitudeValue" : {
                    "description" : "altitude value",
                    "type" : "integer"
                }
            }
        },
        "apMgmtVlan" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "mode" : {
                    "description" : "Vlan Mode of the zone",
                    "type" : "string",
                    "enum" : [ "KEEP", "USER_DEFINED" ]
                },
                "id" : {
                    "description" : "Vlan id of the zone",
                    "type" : "integer"
                }
            }
        },
        "apLatencyInterval" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "pingEnabled" : {
                    "description" : "AP ping latency enabled",
                    "type" : "boolean"
                }
            }
        },
        "apRebootTimeout" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "gatewayLossTimeoutInSec" : {
                    "description" : "Gateway loss timeout in second",
                    "type" : "integer",
                    "enum" : [ 0, 1800, 3600, 5400, 7200, 9000, 10800, 12600, 14400, 16200, 18000, 19800, 23400, 25200, 27000, 28800, 30600, 32400, 34200, 36000, 37800, 39600, 41400, 43200, 45000, 46800, 48600, 50400, 52200, 54000, 55800, 57600, 59400, 61200, 63000, 64800, 66600, 68400, 70200, 72000, 73800, 75600, 77400, 79200, 81000, 82800, 84600, 86400 ]
                },
                "serverLossTimeoutInSec" : {
                    "description" : "Server loss timeout in second",
                    "type" : "integer",
                    "enum" : [ 0, 7200, 14400, 21600, 28800, 36000, 43200, 50400, 57600, 64800, 72000, 79200, 86400 ]
                }
            }
        },
        "autoChannelSelection24" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "channelSelectMode" : {
                    "description" : "Channel Select Mode",
                    "type" : "string",
                    "enum" : [ "None", "BackgroundScanning", "ChannelFly" ]
                },
                "channelFlyMtbc" : {
                    "description" : "ChannelFly MTBC",
                    "type" : "integer",
                    "minimum" : 100,
                    "maximum" : 1440
                }
            }
        },
        "autoChannelSelection50" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "channelSelectMode" : {
                    "description" : "Channel Select Mode",
                    "type" : "string",
                    "enum" : [ "None", "BackgroundScanning", "ChannelFly" ]
                },
                "channelFlyMtbc" : {
                    "description" : "ChannelFly MTBC",
                    "type" : "integer",
                    "minimum" : 100,
                    "maximum" : 1440
                }
            }
        },
        "awsVenue" : {
            "type" : "string"
        },
        "backgroundScanning24" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "frequencyInSec" : {
                    "description" : "Frequency in second",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 65535
                }
            }
        },
        "backgroundScanning50" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "frequencyInSec" : {
                    "description" : "Frequency in second",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 65535
                }
            }
        },
        "bandBalancing" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "mode" : {
                    "description" : "Band Balancing Mode: BASIC-Withholds probe and authentication responses at connetcion time in heavily loaded band to balance clients to the other band, PROACTIVE-Uses BASIC functionality and actively rebalances clients via 802.11v BTM, STRICT-Uses PROACTIVE functionality and forcefully rebalances clients via 802.11v BTM",
                    "type" : "string",
                    "enum" : [ "BASIC", "PROACTIVE", "STRICT" ]
                },
                "wifi24Percentage" : {
                    "description" : "Percentage of client load on 2.4GHz radio band",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 100
                }
            }
        },
        "loadBalancingMethod" : {
            "type" : "string",
            "enum" : [ "BASED_ON_CLIENT_COUNT", "BASED_ON_CAPACITY", "OFF" ]
        },
        "bonjourFencingPolicy" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "bonjourFencingPolicyEnabled" : {
            "type" : "boolean"
        },
        "channelEvaluationInterval" : {
            "maximum" : 3600,
            "minimum" : 60,
            "type" : "integer"
        },
        "channelModeEnabled" : {
            "type" : "boolean"
        },
        "clientAdmissionControl24" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "maxRadioLoadPercent" : {
                    "description" : "Maximum radio load percentage.",
                    "type" : "integer",
                    "minimum" : 50,
                    "maximum" : 100
                },
                "minClientCount" : {
                    "description" : "Minimum client count number.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 100
                },
                "minClientThroughputMbps" : {
                    "description" : "Minimum client throughput in Mbps.",
                    "type" : "number",
                    "minimum" : 0,
                    "maximum" : 100
                }
            }
        },
        "clientAdmissionControl50" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "maxRadioLoadPercent" : {
                    "description" : "Maximum radio load percentage.",
                    "type" : "integer",
                    "minimum" : 50,
                    "maximum" : 100
                },
                "minClientCount" : {
                    "description" : "Minimum client count number.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 100
                },
                "minClientThroughputMbps" : {
                    "description" : "Minimum client throughput in Mbps.",
                    "type" : "number",
                    "minimum" : 0,
                    "maximum" : 100
                }
            }
        },
        "clientLoadBalancing24" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "adjacentRadioThreshold" : {
                    "description" : "Adjacent radio threshold",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 100
                }
            }
        },
        "clientLoadBalancing50" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "adjacentRadioThreshold" : {
                    "description" : "Adjacent radio threshold",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 100
                }
            }
        },
        "countryCode" : {
            "type" : "string"
        },
        "description" : {
            "type" : [ "string", "null" ],
            "maxLength" : 64
        },
        "dfsChannelEnabled" : {
            "type" : "boolean"
        },
        "cbandChannelEnabled" : {
            "type" : "boolean"
        },
        "cbandChannelLicenseEnabled" : {
            "type" : "boolean"
        },
        "channel144Enabled" : {
            "type" : "boolean"
        },
        "dhcpSiteConfig" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "siteEnabled" : {
                    "description" : "DHCP Service Enabling Status",
                    "type" : "boolean"
                },
                "dwpdEnabled" : {
                    "description" : "DHCP Service Dynamic WAN Port Detection",
                    "type" : "boolean"
                },
                "manualSelect" : {
                    "description" : "DHCP Service AP Selection Mode. This value is effective when the siteMode is EnableOnMultipleAPs.",
                    "type" : "boolean"
                },
                "siteMode" : {
                    "description" : "DHCP Service mode",
                    "type" : "string",
                    "enum" : [ "EnableOnEachAPs", "EnableOnMultipleAPs", "EnableOnHierarchicalAPs" ]
                },
                "eth0ProfileId" : {
                    "type" : "integer"
                },
                "eth1ProfileId" : {
                    "type" : "integer"
                },
                "siteAps" : {
                    "type" : "array",
                    "items" : {
                        "type" : "object",
                        "description" : "DHCP Site selected APs. The content is effective when the siteMode is EnableOnMultipleAPs.",
                        "additionalProperties" : false,
                        "properties" : {
                            "apMac" : {
                                "type" : "string"
                            },
                            "apName" : {
                                "type" : "string"
                            },
                            "apStatus" : {
                                "type" : "string",
                                "enum" : [ "Online", "Offline", "Flagged" ]
                            },
                            "apServerEnabled" : {
                                "type" : "boolean"
                            },
                            "apServerPrimary" : {
                                "type" : "boolean"
                            },
                            "apServerIp" : {
                                "type" : [ "string", "null" ]
                            },
                            "apGatewayIp" : {
                                "type" : "string"
                            },
                            "apServerType" : {
                                "type" : "string"
                            }
                        }
                    }
                },
                "siteProfileIds" : {
                    "type" : "array",
                    "items" : {
                        "type" : "string"
                    }
                }
            }
        },
        "domainId" : {
            "type" : "string"
        },
        "dosBarringCheckPeriod" : {
            "type" : "integer"
        },
        "dosBarringEnable" : {
            "type" : "integer"
        },
        "dosBarringPeriod" : {
            "type" : "integer"
        },
        "dosBarringThreshold" : {
            "type" : "integer"
        },
        "ipsecProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "ipv6TrafficFilterEnabled" : {
            "type" : "integer"
        },
        "latitude" : {
            "type" : "number"
        },
        "location" : {
            "type" : "string"
        },
        "locationAdditionalInfo" : {
            "type" : "string",
            "pattern" : "^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
        },
        "locationBasedService" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "login" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "apLoginName" : {
                    "description" : "User name of the AP administrator",
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : "^((?!\$\()[!-_a-~]){1,64}$"
                },
                "apLoginPassword" : {
                    "description" : "Password of the AP administrator",
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : ".*(?=.{8,})(?=.*[a-zA-Z])(?=.*[0-9])(?=.*[_`~!@#$%^&*\(\)\[\]\{\}|;:'\",.\<>\/?=+-]).*"
                }
            },
            "required" : [ "apLoginName", "apLoginPassword" ]
        },
        "longitude" : {
            "type" : "number"
        },
        "mesh" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "ssid" : {
                    "description" : "SSID of the mesh network",
                    "type" : "string"
                },
                "passphrase" : {
                    "description" : "Passphrase for the mesh network",
                    "type" : "string"
                },
                "meshRadioIdx" : {
                    "description" : "Mesh radio index",
                    "type" : "string",
                    "enum" : [ "Radio24G", "Radio5G" ]
                },
                "zeroTouchStatus" : {
                    "type" : "boolean"
                }
            }
        },
        "name" : {
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 32,
            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$"
        },
        "nodeAffinityProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "rogue" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "reportType" : {
                    "description" : "Report type",
                    "type" : "string",
                    "enum" : [ "All", "Malicious" ]
                },
                "maliciousTypes" : {
                    "description" : "Malicious type when reportType is Malicious",
                    "type" : [ "array", "null" ],
                    "items" : {
                        "type" : "string",
                        "enum" : [ "SSIDSpoofing", "SameNetwork", "MACSpoofing" ]
                    }
                },
                "protectionEnabled" : {
                    "description" : "Protection enabled",
                    "type" : "boolean"
                }
            }
        },
        "smartMonitor" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "intervalInSec" : {
                    "description" : "Interval in seconds. This is required if smartMonitor is enabled",
                    "type" : "integer",
                    "minimum" : 5,
                    "maximum" : 60
                },
                "retryThreshold" : {
                    "description" : "Retry threshold. This is required if smartMonitor is enabled",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 10
                }
            }
        },
        "syslog" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "flowLevel" : {
                    "description" : "Flow Level of the syslog",
                    "type" : "string",
                    "enum" : [ "GENERAL_LOGS", "CLIENT_FLOW", "ALL" ]
                },
                "address" : {
                    "description" : "Address of the syslog server.",
                    "type" : "string"
                },
                "port" : {
                    "description" : "Port number of the syslog server",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 65535
                },
                "protocol" : {
                    "description" : "Protocol of the syslog server",
                    "type" : "string",
                    "enum" : [ "IPPROTO_TCP", "IPPROTO_UDP" ]
                },
                "secondaryAddress" : {
                    "description" : "Secondary Server Address of the syslog server",
                    "type" : "string"
                },
                "secondaryPort" : {
                    "description" : "Secondary Server Port of the syslog server",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 65535
                },
                "secondaryProtocol" : {
                    "description" : "Secondary Server Protocol of the syslog server",
                    "type" : "string",
                    "enum" : [ "IPPROTO_TCP", "IPPROTO_UDP" ]
                },
                "facility" : {
                    "description" : "Facility of the syslog server",
                    "type" : "string",
                    "enum" : [ "Keep_Original", "Local0", "Local1", "Local2", "Local3", "Local4", "Local5", "Local6", "Local7" ]
                },
                "priority" : {
                    "description" : "Priority of the log messages",
                    "type" : "string",
                    "enum" : [ "Emergency", "Alert", "Critical", "Error", "Warning", "Notice", "Info", "All" ]
                }
            }
        },
        "timezone" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "systemTimezone" : {
                    "description" : "System defined time zone, please refer to the “Overview > Time Zone” list",
                    "type" : "string"
                },
                "customizedTimezone" : {
                    "description" : "User defined time zone",
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "abbreviation" : {
                            "description" : "Time zone abbreviation",
                            "type" : "string",
                            "pattern" : "^[a-zA-Z]{3,4}$"
                        },
                        "gmtOffset" : {
                            "description" : "GMT offset",
                            "type" : "integer",
                            "minimum" : -11,
                            "maximum" : 14
                        },
                        "gmtOffsetMinute" : {
                            "description" : "GMT offset minute",
                            "type" : "integer",
                            "minimum" : 0,
                            "maximum" : 59
                        },
                        "start" : {
                            "description" : "Daylight saving time start",
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "month" : {
                                    "description" : "Month when daylight saving time begins",
                                    "type" : "integer",
                                    "enum" : [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ]
                                },
                                "week" : {
                                    "description" : "Week of the month (1 for the first week, 2 for the second week, and so on)",
                                    "type" : "integer",
                                    "enum" : [ 1, 2, 3, 4, 5 ]
                                },
                                "day" : {
                                    "description" : "Day of the week (0 for Sunday, 1 for Monday, 2 for Tuesday, and so on)",
                                    "type" : "integer",
                                    "enum" : [ 0, 1, 2, 3, 4, 5, 6 ]
                                },
                                "hour" : {
                                    "description" : "Hour of the day",
                                    "type" : "integer",
                                    "minimum" : 0,
                                    "maximum" : 23
                                }
                            },
                            "required" : [ "month", "week", "day", "hour" ]
                        },
                        "end" : {
                            "description" : "Daylight saving time end",
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "month" : {
                                    "description" : "Month when daylight saving time begins",
                                    "type" : "integer",
                                    "enum" : [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ]
                                },
                                "week" : {
                                    "description" : "Week of the month (1 for the first week, 2 for the second week, and so on)",
                                    "type" : "integer",
                                    "enum" : [ 1, 2, 3, 4, 5 ]
                                },
                                "day" : {
                                    "description" : "Day of the week (0 for Sunday, 1 for Monday, 2 for Tuesday, and so on)",
                                    "type" : "integer",
                                    "enum" : [ 0, 1, 2, 3, 4, 5, 6 ]
                                },
                                "hour" : {
                                    "description" : "Hour of the day",
                                    "type" : "integer",
                                    "minimum" : 0,
                                    "maximum" : 23
                                }
                            },
                            "required" : [ "month", "week", "day", "hour" ]
                        }
                    },
                    "required" : [ "abbreviation", "gmtOffset", "gmtOffsetMinute" ]
                }
            }
        },
        "tunnelProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "aaaAffinityEnabled" : {
            "type" : "boolean"
        },
        "tunnelType" : {
            "description" : "Tunnel type configuration of the zone. No_Tunneled is for IPv6 mode",
            "type" : "string",
            "enum" : [ "No_Tunneled", "RuckusGRE", "SoftGRE", "SoftGREIpsec" ]
        },
        "venueProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "vlanOverlappingEnabled" : {
            "type" : "boolean"
        },
        "wifi24" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "autoCellSizing" : {
                    "description" : "Auto Cell Sizing",
                    "type" : "boolean"
                },
                "txPower" : {
                    "description" : "Transmission power",
                    "type" : "string",
                    "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ]
                },
                "channelWidth" : {
                    "description" : "Channel width. Zero (0) means Auto.",
                    "type" : "integer",
                    "enum" : [ 0, 20, 40 ]
                },
                "channel" : {
                    "description" : "Channel number",
                    "type" : "integer"
                },
                "channelRange" : {
                    "description" : "Channel range options",
                    "type" : "array",
                    "items" : {
                        "type" : "integer"
                    }
                }
            }
        },
        "wifi50" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "autoCellSizing" : {
                    "description" : "Auto Cell Sizing",
                    "type" : "boolean"
                },
                "txPower" : {
                    "description" : "Transmission power",
                    "type" : "string",
                    "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ]
                },
                "channelWidth" : {
                    "description" : "Channel width. Zero (0) means Auto. 8080 means 80+80MHz",
                    "type" : "integer",
                    "enum" : [ 0, 20, 40, 80, 8080, 160 ]
                },
                "indoorChannel" : {
                    "description" : "Channel number for Indoor AP",
                    "type" : "integer"
                },
                "outdoorChannel" : {
                    "description" : "Channel number for Outdoor AP",
                    "type" : "integer"
                },
                "indoorSecondaryChannel" : {
                    "description" : "Secondary channel number for Indoor AP (channelWidth is 80+80MHz only)",
                    "type" : "integer"
                },
                "outdoorSecondaryChannel" : {
                    "description" : "Secondary channel number for outdoor AP (channelWidth is 80+80MHz only)",
                    "type" : "integer"
                },
                "indoorChannelRange" : {
                    "description" : "Channel range options for Indoor AP",
                    "type" : "array",
                    "items" : {
                        "type" : "integer"
                    }
                },
                "outdoorChannelRange" : {
                    "description" : "Channel range options for outdoor AP",
                    "type" : "array",
                    "items" : {
                        "type" : "integer"
                    }
                }
            }
        },
        "protectionMode24" : {
            "type" : "string",
            "enum" : [ "NONE", "CTS_ONLY", "RTS_CTS" ]
        },
        "zoneAffinityProfileId" : {
            "type" : "string"
        },
        "snmpAgent" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "apSnmpEnabled" : {
                    "description" : "Enable AP SNMP",
                    "type" : "boolean"
                },
                "snmpV2Agent" : {
                    "description" : "Community List of the SNMP V2 Agent.",
                    "type" : "array",
                    "items" : {
                        "type" : "object",
                        "additionalProperties" : false,
                        "properties" : {
                            "communityName" : {
                                "description" : "name of the SNMP Community.",
                                "type" : "string"
                            },
                            "readEnabled" : {
                                "description" : "read privilege of the SNMP Coummunity",
                                "type" : "boolean"
                            },
                            "writeEnabled" : {
                                "description" : "write privilege of the SNMP Coummunity",
                                "type" : "boolean"
                            },
                            "notificationEnabled" : {
                                "description" : "notification privilege of the SNMP Coummunity",
                                "type" : "boolean"
                            },
                            "notificationType" : {
                                "description" : "type of the notification privilege",
                                "type" : "string",
                                "enum" : [ "TRAP", "INFORM" ]
                            },
                            "notificationTarget" : {
                                "description" : "Trap List of the SNMP Coummunity",
                                "type" : "array",
                                "items" : {
                                    "type" : "object",
                                    "additionalProperties" : false,
                                    "properties" : {
                                        "address" : {
                                            "description" : "address of the SNMP Trap",
                                            "type" : "string"
                                        },
                                        "port" : {
                                            "description" : "port number of the SNMP Trap",
                                            "type" : "integer",
                                            "minimum" : 1,
                                            "maximum" : 65535
                                        }
                                    },
                                    "required" : [ "address", "port" ]
                                }
                            }
                        },
                        "required" : [ "communityName" ]
                    }
                },
                "snmpV3Agent" : {
                    "description" : "User List of the SNMP V3 Agent.",
                    "type" : "array",
                    "items" : {
                        "type" : "object",
                        "additionalProperties" : false,
                        "properties" : {
                            "userName" : {
                                "description" : "name of the SNMP User.",
                                "type" : "string"
                            },
                            "authProtocol" : {
                                "description" : "authProtocol of the SNMP User.",
                                "type" : "string",
                                "enum" : [ "NONE", "MD5", "SHA" ]
                            },
                            "authPassword" : {
                                "description" : "authPassword of the SNMP User.",
                                "type" : "string",
                                "minLength" : 8
                            },
                            "privProtocol" : {
                                "description" : "privProtocol of the SNMP User.",
                                "type" : "string",
                                "enum" : [ "NONE", "DES", "AES" ]
                            },
                            "privPassword" : {
                                "description" : "privPassword of the SNMP User.",
                                "type" : "string",
                                "minLength" : 8
                            },
                            "readEnabled" : {
                                "description" : "read privilege of the SNMP User",
                                "type" : "boolean"
                            },
                            "writeEnabled" : {
                                "description" : "write privilege of the SNMP User",
                                "type" : "boolean"
                            },
                            "notificationEnabled" : {
                                "description" : "notification privilege of the SNMP User",
                                "type" : "boolean"
                            },
                            "notificationType" : {
                                "description" : "type of the notification privilege",
                                "type" : "string",
                                "enum" : [ "TRAP", "INFORM" ]
                            },
                            "notificationTarget" : {
                                "description" : "Trap List of the SNMP User",
                                "type" : "array",
                                "items" : {
                                    "type" : "object",
                                    "additionalProperties" : false,
                                    "properties" : {
                                        "address" : {
                                            "description" : "address of the SNMP Trap",
                                            "type" : "string"
                                        },
                                        "port" : {
                                            "description" : "port number of the SNMP Trap",
                                            "type" : "integer",
                                            "minimum" : 1,
                                            "maximum" : 65535
                                        }
                                    },
                                    "required" : [ "address", "port" ]
                                }
                            }
                        },
                        "required" : [ "userName" ]
                    }
                }
            }
        },
        "recoverySsid" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "recoverySsidPskKey" : {
                    "description" : "recovery ssid password",
                    "type" : "string"
                },
                "recoverySsidEnabled" : {
                    "description" : "recovery ssid enable/disable",
                    "type" : "boolean"
                }
            }
        },
        "clusterRedundancyEnabled" : {
            "type" : "boolean"
        },
        "rogueApReportThreshold" : {
            "type" : "integer"
        },
        "rogueApAggressivenessMode" : {
            "type" : "integer"
        },
        "rogueApJammingDetection" : {
            "type" : "boolean"
        },
        "rogueApJammingThreshold" : {
            "type" : "integer"
        },
        "directedMulticastFromWiredClientEnabled" : {
            "type" : "boolean"
        },
        "directedMulticastFromWirelessClientEnabled" : {
            "type" : "boolean"
        },
        "directedMulticastFromNetworkEnabled" : {
            "type" : "boolean"
        },
        "healthCheckSitesEnabled" : {
            "description" : "Enabled Health Check Sites. ",
            "type" : "boolean"
        },
        "healthCheckSites" : {
            "description" : "Health Check Sites.",
            "type" : "array",
            "items" : {
                "type" : "string"
            }
        },
        "ruckusGreTunnelProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "softGreTunnelProflies" : {
            "type" : "array",
            "items" : {
                "type" : [ "object", "null" ],
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "type" : "string"
                    },
                    "name" : {
                        "type" : "string"
                    },
                    "aaaAffinityEnabled" : {
                        "type" : "boolean"
                    }
                }
            }
        },
        "ipsecProfiles" : {
            "type" : "array",
            "items" : {
                "type" : [ "object", "null" ],
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "type" : "string"
                    },
                    "name" : {
                        "type" : "string"
                    }
                }
            }
        },
        "sshTunnelEncryption" : {
            "type" : "string",
            "enum" : [ "AES128", "AES256" ]
        },
        "lteBandLockChannels" : {
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "simCardId" : {
                        "description" : "SIM card ID(Primary:0, Secondary:1)",
                        "type" : "integer"
                    },
                    "type" : {
                        "description" : "LTE chipset SKU type",
                        "type" : "string"
                    },
                    "channel4g" : {
                        "description" : "LTE 4G channels",
                        "type" : "string"
                    },
                    "channel3g" : {
                        "description" : "LTE 3G channels",
                        "type" : "string"
                    }
                }
            }
        },
        "apHccdEnabled" : {
            "type" : "boolean"
        },
        "apHccdPersist" : {
            "type" : "boolean"
        }
    },
    "type" : "object"
}
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
{
    "additionalProperties" : false,
    "properties" : {
        "altitude" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "altitudeUnit" : {
                    "description" : "altitude unit",
                    "type" : "string",
                    "enum" : [ "meters", "floor" ]
                },
                "altitudeValue" : {
                    "description" : "altitude value",
                    "type" : "integer"
                }
            }
        },
        "apMgmtVlan" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "mode" : {
                    "description" : "Vlan Mode of the zone",
                    "type" : "string",
                    "enum" : [ "KEEP", "USER_DEFINED" ]
                },
                "id" : {
                    "description" : "Vlan id of the zone",
                    "type" : "integer"
                }
            }
        },
        "apLatencyInterval" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "pingEnabled" : {
                    "description" : "AP ping latency enabled",
                    "type" : "boolean"
                }
            }
        },
        "apRebootTimeout" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "gatewayLossTimeoutInSec" : {
                    "description" : "Gateway loss timeout in second",
                    "type" : "integer",
                    "enum" : [ 0, 1800, 3600, 5400, 7200, 9000, 10800, 12600, 14400, 16200, 18000, 19800, 23400, 25200, 27000, 28800, 30600, 32400, 34200, 36000, 37800, 39600, 41400, 43200, 45000, 46800, 48600, 50400, 52200, 54000, 55800, 57600, 59400, 61200, 63000, 64800, 66600, 68400, 70200, 72000, 73800, 75600, 77400, 79200, 81000, 82800, 84600, 86400 ]
                },
                "serverLossTimeoutInSec" : {
                    "description" : "Server loss timeout in second",
                    "type" : "integer",
                    "enum" : [ 0, 7200, 14400, 21600, 28800, 36000, 43200, 50400, 57600, 64800, 72000, 79200, 86400 ]
                }
            }
        },
        "autoChannelSelection24" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "channelSelectMode" : {
                    "description" : "Channel Select Mode",
                    "type" : "string",
                    "enum" : [ "None", "BackgroundScanning", "ChannelFly" ]
                },
                "channelFlyMtbc" : {
                    "description" : "ChannelFly MTBC",
                    "type" : "integer",
                    "minimum" : 100,
                    "maximum" : 1440
                }
            }
        },
        "autoChannelSelection50" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "channelSelectMode" : {
                    "description" : "Channel Select Mode",
                    "type" : "string",
                    "enum" : [ "None", "BackgroundScanning", "ChannelFly" ]
                },
                "channelFlyMtbc" : {
                    "description" : "ChannelFly MTBC",
                    "type" : "integer",
                    "minimum" : 100,
                    "maximum" : 1440
                }
            }
        },
        "awsVenue" : {
            "type" : "string"
        },
        "backgroundScanning24" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "frequencyInSec" : {
                    "description" : "Frequency in second",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 65535
                }
            }
        },
        "backgroundScanning50" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "frequencyInSec" : {
                    "description" : "Frequency in second",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 65535
                }
            }
        },
        "bandBalancing" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "mode" : {
                    "description" : "Band Balancing Mode: BASIC-Withholds probe and authentication responses at connetcion time in heavily loaded band to balance clients to the other band, PROACTIVE-Uses BASIC functionality and actively rebalances clients via 802.11v BTM, STRICT-Uses PROACTIVE functionality and forcefully rebalances clients via 802.11v BTM",
                    "type" : "string",
                    "enum" : [ "BASIC", "PROACTIVE", "STRICT" ]
                },
                "wifi24Percentage" : {
                    "description" : "Percentage of client load on 2.4GHz radio band",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 100
                }
            }
        },
        "loadBalancingMethod" : {
            "type" : "string",
            "enum" : [ "BASED_ON_CLIENT_COUNT", "BASED_ON_CAPACITY", "OFF" ]
        },
        "bonjourFencingPolicy" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "bonjourFencingPolicyEnabled" : {
            "type" : "boolean"
        },
        "channelEvaluationInterval" : {
            "maximum" : 3600,
            "minimum" : 60,
            "type" : "integer"
        },
        "channelModeEnabled" : {
            "type" : "boolean"
        },
        "clientAdmissionControl24" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "maxRadioLoadPercent" : {
                    "description" : "Maximum radio load percentage.",
                    "type" : "integer",
                    "minimum" : 50,
                    "maximum" : 100
                },
                "minClientCount" : {
                    "description" : "Minimum client count number.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 100
                },
                "minClientThroughputMbps" : {
                    "description" : "Minimum client throughput in Mbps.",
                    "type" : "number",
                    "minimum" : 0,
                    "maximum" : 100
                }
            }
        },
        "clientAdmissionControl50" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "maxRadioLoadPercent" : {
                    "description" : "Maximum radio load percentage.",
                    "type" : "integer",
                    "minimum" : 50,
                    "maximum" : 100
                },
                "minClientCount" : {
                    "description" : "Minimum client count number.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 100
                },
                "minClientThroughputMbps" : {
                    "description" : "Minimum client throughput in Mbps.",
                    "type" : "number",
                    "minimum" : 0,
                    "maximum" : 100
                }
            }
        },
        "clientLoadBalancing24" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "adjacentRadioThreshold" : {
                    "description" : "Adjacent radio threshold",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 100
                }
            }
        },
        "clientLoadBalancing50" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "adjacentRadioThreshold" : {
                    "description" : "Adjacent radio threshold",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 100
                }
            }
        },
        "countryCode" : {
            "type" : "string"
        },
        "description" : {
            "type" : [ "string", "null" ],
            "maxLength" : 64
        },
        "dfsChannelEnabled" : {
            "type" : "boolean"
        },
        "cbandChannelEnabled" : {
            "type" : "boolean"
        },
        "cbandChannelLicenseEnabled" : {
            "type" : "boolean"
        },
        "channel144Enabled" : {
            "type" : "boolean"
        },
        "dhcpSiteConfig" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "siteEnabled" : {
                    "description" : "DHCP Service Enabling Status",
                    "type" : "boolean"
                },
                "dwpdEnabled" : {
                    "description" : "DHCP Service Dynamic WAN Port Detection",
                    "type" : "boolean"
                },
                "manualSelect" : {
                    "description" : "DHCP Service AP Selection Mode. This value is effective when the siteMode is EnableOnMultipleAPs.",
                    "type" : "boolean"
                },
                "siteMode" : {
                    "description" : "DHCP Service mode",
                    "type" : "string",
                    "enum" : [ "EnableOnEachAPs", "EnableOnMultipleAPs", "EnableOnHierarchicalAPs" ]
                },
                "eth0ProfileId" : {
                    "type" : "integer"
                },
                "eth1ProfileId" : {
                    "type" : "integer"
                },
                "siteAps" : {
                    "type" : "array",
                    "items" : {
                        "type" : "object",
                        "description" : "DHCP Site selected APs. The content is effective when the siteMode is EnableOnMultipleAPs.",
                        "additionalProperties" : false,
                        "properties" : {
                            "apMac" : {
                                "type" : "string"
                            },
                            "apName" : {
                                "type" : "string"
                            },
                            "apStatus" : {
                                "type" : "string",
                                "enum" : [ "Online", "Offline", "Flagged" ]
                            },
                            "apServerEnabled" : {
                                "type" : "boolean"
                            },
                            "apServerPrimary" : {
                                "type" : "boolean"
                            },
                            "apServerIp" : {
                                "type" : [ "string", "null" ]
                            },
                            "apGatewayIp" : {
                                "type" : "string"
                            },
                            "apServerType" : {
                                "type" : "string"
                            }
                        }
                    }
                },
                "siteProfileIds" : {
                    "type" : "array",
                    "items" : {
                        "type" : "string"
                    }
                }
            }
        },
        "domainId" : {
            "type" : "string"
        },
        "dosBarringCheckPeriod" : {
            "type" : "integer"
        },
        "dosBarringEnable" : {
            "type" : "integer"
        },
        "dosBarringPeriod" : {
            "type" : "integer"
        },
        "dosBarringThreshold" : {
            "type" : "integer"
        },
        "ipsecProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "ipv6TrafficFilterEnabled" : {
            "type" : "integer"
        },
        "latitude" : {
            "type" : "number"
        },
        "location" : {
            "type" : "string"
        },
        "locationAdditionalInfo" : {
            "type" : "string",
            "pattern" : "^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
        },
        "locationBasedService" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "login" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "apLoginName" : {
                    "description" : "User name of the AP administrator",
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : "^((?!\$\()[!-_a-~]){1,64}$"
                },
                "apLoginPassword" : {
                    "description" : "Password of the AP administrator",
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : ".*(?=.{8,})(?=.*[a-zA-Z])(?=.*[0-9])(?=.*[_`~!@#$%^&*\(\)\[\]\{\}|;:'\",.\<>\/?=+-]).*"
                }
            },
            "required" : [ "apLoginName", "apLoginPassword" ]
        },
        "longitude" : {
            "type" : "number"
        },
        "mesh" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "ssid" : {
                    "description" : "SSID of the mesh network",
                    "type" : "string"
                },
                "passphrase" : {
                    "description" : "Passphrase for the mesh network",
                    "type" : "string"
                },
                "meshRadioIdx" : {
                    "description" : "Mesh radio index",
                    "type" : "string",
                    "enum" : [ "Radio24G", "Radio5G" ]
                },
                "zeroTouchStatus" : {
                    "type" : "boolean"
                }
            }
        },
        "name" : {
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 32,
            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$"
        },
        "nodeAffinityProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "rogue" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "reportType" : {
                    "description" : "Report type",
                    "type" : "string",
                    "enum" : [ "All", "Malicious" ]
                },
                "maliciousTypes" : {
                    "description" : "Malicious type when reportType is Malicious",
                    "type" : [ "array", "null" ],
                    "items" : {
                        "type" : "string",
                        "enum" : [ "SSIDSpoofing", "SameNetwork", "MACSpoofing" ]
                    }
                },
                "protectionEnabled" : {
                    "description" : "Protection enabled",
                    "type" : "boolean"
                }
            }
        },
        "smartMonitor" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "intervalInSec" : {
                    "description" : "Interval in seconds. This is required if smartMonitor is enabled",
                    "type" : "integer",
                    "minimum" : 5,
                    "maximum" : 60
                },
                "retryThreshold" : {
                    "description" : "Retry threshold. This is required if smartMonitor is enabled",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 10
                }
            }
        },
        "syslog" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "flowLevel" : {
                    "description" : "Flow Level of the syslog",
                    "type" : "string",
                    "enum" : [ "GENERAL_LOGS", "CLIENT_FLOW", "ALL" ]
                },
                "address" : {
                    "description" : "Address of the syslog server.",
                    "type" : "string"
                },
                "port" : {
                    "description" : "Port number of the syslog server",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 65535
                },
                "protocol" : {
                    "description" : "Protocol of the syslog server",
                    "type" : "string",
                    "enum" : [ "IPPROTO_TCP", "IPPROTO_UDP" ]
                },
                "secondaryAddress" : {
                    "description" : "Secondary Server Address of the syslog server",
                    "type" : "string"
                },
                "secondaryPort" : {
                    "description" : "Secondary Server Port of the syslog server",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 65535
                },
                "secondaryProtocol" : {
                    "description" : "Secondary Server Protocol of the syslog server",
                    "type" : "string",
                    "enum" : [ "IPPROTO_TCP", "IPPROTO_UDP" ]
                },
                "facility" : {
                    "description" : "Facility of the syslog server",
                    "type" : "string",
                    "enum" : [ "Keep_Original", "Local0", "Local1", "Local2", "Local3", "Local4", "Local5", "Local6", "Local7" ]
                },
                "priority" : {
                    "description" : "Priority of the log messages",
                    "type" : "string",
                    "enum" : [ "Emergency", "Alert", "Critical", "Error", "Warning", "Notice", "Info", "All" ]
                }
            }
        },
        "timezone" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "systemTimezone" : {
                    "description" : "System defined time zone, please refer to the “Overview > Time Zone” list",
                    "type" : "string"
                },
                "customizedTimezone" : {
                    "description" : "User defined time zone",
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "abbreviation" : {
                            "description" : "Time zone abbreviation",
                            "type" : "string",
                            "pattern" : "^[a-zA-Z]{3,4}$"
                        },
                        "gmtOffset" : {
                            "description" : "GMT offset",
                            "type" : "integer",
                            "minimum" : -11,
                            "maximum" : 14
                        },
                        "gmtOffsetMinute" : {
                            "description" : "GMT offset minute",
                            "type" : "integer",
                            "minimum" : 0,
                            "maximum" : 59
                        },
                        "start" : {
                            "description" : "Daylight saving time start",
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "month" : {
                                    "description" : "Month when daylight saving time begins",
                                    "type" : "integer",
                                    "enum" : [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ]
                                },
                                "week" : {
                                    "description" : "Week of the month (1 for the first week, 2 for the second week, and so on)",
                                    "type" : "integer",
                                    "enum" : [ 1, 2, 3, 4, 5 ]
                                },
                                "day" : {
                                    "description" : "Day of the week (0 for Sunday, 1 for Monday, 2 for Tuesday, and so on)",
                                    "type" : "integer",
                                    "enum" : [ 0, 1, 2, 3, 4, 5, 6 ]
                                },
                                "hour" : {
                                    "description" : "Hour of the day",
                                    "type" : "integer",
                                    "minimum" : 0,
                                    "maximum" : 23
                                }
                            },
                            "required" : [ "month", "week", "day", "hour" ]
                        },
                        "end" : {
                            "description" : "Daylight saving time end",
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "month" : {
                                    "description" : "Month when daylight saving time begins",
                                    "type" : "integer",
                                    "enum" : [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ]
                                },
                                "week" : {
                                    "description" : "Week of the month (1 for the first week, 2 for the second week, and so on)",
                                    "type" : "integer",
                                    "enum" : [ 1, 2, 3, 4, 5 ]
                                },
                                "day" : {
                                    "description" : "Day of the week (0 for Sunday, 1 for Monday, 2 for Tuesday, and so on)",
                                    "type" : "integer",
                                    "enum" : [ 0, 1, 2, 3, 4, 5, 6 ]
                                },
                                "hour" : {
                                    "description" : "Hour of the day",
                                    "type" : "integer",
                                    "minimum" : 0,
                                    "maximum" : 23
                                }
                            },
                            "required" : [ "month", "week", "day", "hour" ]
                        }
                    },
                    "required" : [ "abbreviation", "gmtOffset", "gmtOffsetMinute" ]
                }
            }
        },
        "tunnelProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "aaaAffinityEnabled" : {
            "type" : "boolean"
        },
        "tunnelType" : {
            "description" : "Tunnel type configuration of the zone. No_Tunneled is for IPv6 mode",
            "type" : "string",
            "enum" : [ "No_Tunneled", "RuckusGRE", "SoftGRE", "SoftGREIpsec" ]
        },
        "venueProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "vlanOverlappingEnabled" : {
            "type" : "boolean"
        },
        "wifi24" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "autoCellSizing" : {
                    "description" : "Auto Cell Sizing",
                    "type" : "boolean"
                },
                "txPower" : {
                    "description" : "Transmission power",
                    "type" : "string",
                    "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ]
                },
                "channelWidth" : {
                    "description" : "Channel width. Zero (0) means Auto.",
                    "type" : "integer",
                    "enum" : [ 0, 20, 40 ]
                },
                "channel" : {
                    "description" : "Channel number",
                    "type" : "integer"
                },
                "channelRange" : {
                    "description" : "Channel range options",
                    "type" : "array",
                    "items" : {
                        "type" : "integer"
                    }
                }
            }
        },
        "wifi50" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "autoCellSizing" : {
                    "description" : "Auto Cell Sizing",
                    "type" : "boolean"
                },
                "txPower" : {
                    "description" : "Transmission power",
                    "type" : "string",
                    "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ]
                },
                "channelWidth" : {
                    "description" : "Channel width. Zero (0) means Auto. 8080 means 80+80MHz",
                    "type" : "integer",
                    "enum" : [ 0, 20, 40, 80, 8080, 160 ]
                },
                "indoorChannel" : {
                    "description" : "Channel number for Indoor AP",
                    "type" : "integer"
                },
                "outdoorChannel" : {
                    "description" : "Channel number for Outdoor AP",
                    "type" : "integer"
                },
                "indoorSecondaryChannel" : {
                    "description" : "Secondary channel number for Indoor AP (channelWidth is 80+80MHz only)",
                    "type" : "integer"
                },
                "outdoorSecondaryChannel" : {
                    "description" : "Secondary channel number for outdoor AP (channelWidth is 80+80MHz only)",
                    "type" : "integer"
                },
                "indoorChannelRange" : {
                    "description" : "Channel range options for Indoor AP",
                    "type" : "array",
                    "items" : {
                        "type" : "integer"
                    }
                },
                "outdoorChannelRange" : {
                    "description" : "Channel range options for outdoor AP",
                    "type" : "array",
                    "items" : {
                        "type" : "integer"
                    }
                }
            }
        },
        "protectionMode24" : {
            "type" : "string",
            "enum" : [ "NONE", "CTS_ONLY", "RTS_CTS" ]
        },
        "zoneAffinityProfileId" : {
            "type" : "string"
        },
        "snmpAgent" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "apSnmpEnabled" : {
                    "description" : "Enable AP SNMP",
                    "type" : "boolean"
                },
                "snmpV2Agent" : {
                    "description" : "Community List of the SNMP V2 Agent.",
                    "type" : "array",
                    "items" : {
                        "type" : "object",
                        "additionalProperties" : false,
                        "properties" : {
                            "communityName" : {
                                "description" : "name of the SNMP Community.",
                                "type" : "string"
                            },
                            "readEnabled" : {
                                "description" : "read privilege of the SNMP Coummunity",
                                "type" : "boolean"
                            },
                            "writeEnabled" : {
                                "description" : "write privilege of the SNMP Coummunity",
                                "type" : "boolean"
                            },
                            "notificationEnabled" : {
                                "description" : "notification privilege of the SNMP Coummunity",
                                "type" : "boolean"
                            },
                            "notificationType" : {
                                "description" : "type of the notification privilege",
                                "type" : "string",
                                "enum" : [ "TRAP", "INFORM" ]
                            },
                            "notificationTarget" : {
                                "description" : "Trap List of the SNMP Coummunity",
                                "type" : "array",
                                "items" : {
                                    "type" : "object",
                                    "additionalProperties" : false,
                                    "properties" : {
                                        "address" : {
                                            "description" : "address of the SNMP Trap",
                                            "type" : "string"
                                        },
                                        "port" : {
                                            "description" : "port number of the SNMP Trap",
                                            "type" : "integer",
                                            "minimum" : 1,
                                            "maximum" : 65535
                                        }
                                    },
                                    "required" : [ "address", "port" ]
                                }
                            }
                        },
                        "required" : [ "communityName" ]
                    }
                },
                "snmpV3Agent" : {
                    "description" : "User List of the SNMP V3 Agent.",
                    "type" : "array",
                    "items" : {
                        "type" : "object",
                        "additionalProperties" : false,
                        "properties" : {
                            "userName" : {
                                "description" : "name of the SNMP User.",
                                "type" : "string"
                            },
                            "authProtocol" : {
                                "description" : "authProtocol of the SNMP User.",
                                "type" : "string",
                                "enum" : [ "NONE", "MD5", "SHA" ]
                            },
                            "authPassword" : {
                                "description" : "authPassword of the SNMP User.",
                                "type" : "string",
                                "minLength" : 8
                            },
                            "privProtocol" : {
                                "description" : "privProtocol of the SNMP User.",
                                "type" : "string",
                                "enum" : [ "NONE", "DES", "AES" ]
                            },
                            "privPassword" : {
                                "description" : "privPassword of the SNMP User.",
                                "type" : "string",
                                "minLength" : 8
                            },
                            "readEnabled" : {
                                "description" : "read privilege of the SNMP User",
                                "type" : "boolean"
                            },
                            "writeEnabled" : {
                                "description" : "write privilege of the SNMP User",
                                "type" : "boolean"
                            },
                            "notificationEnabled" : {
                                "description" : "notification privilege of the SNMP User",
                                "type" : "boolean"
                            },
                            "notificationType" : {
                                "description" : "type of the notification privilege",
                                "type" : "string",
                                "enum" : [ "TRAP", "INFORM" ]
                            },
                            "notificationTarget" : {
                                "description" : "Trap List of the SNMP User",
                                "type" : "array",
                                "items" : {
                                    "type" : "object",
                                    "additionalProperties" : false,
                                    "properties" : {
                                        "address" : {
                                            "description" : "address of the SNMP Trap",
                                            "type" : "string"
                                        },
                                        "port" : {
                                            "description" : "port number of the SNMP Trap",
                                            "type" : "integer",
                                            "minimum" : 1,
                                            "maximum" : 65535
                                        }
                                    },
                                    "required" : [ "address", "port" ]
                                }
                            }
                        },
                        "required" : [ "userName" ]
                    }
                }
            }
        },
        "recoverySsid" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "recoverySsidPskKey" : {
                    "description" : "recovery ssid password",
                    "type" : "string"
                },
                "recoverySsidEnabled" : {
                    "description" : "recovery ssid enable/disable",
                    "type" : "boolean"
                }
            }
        },
        "clusterRedundancyEnabled" : {
            "type" : "boolean"
        },
        "rogueApReportThreshold" : {
            "type" : "integer"
        },
        "rogueApAggressivenessMode" : {
            "type" : "integer"
        },
        "rogueApJammingDetection" : {
            "type" : "boolean"
        },
        "rogueApJammingThreshold" : {
            "type" : "integer"
        },
        "directedMulticastFromWiredClientEnabled" : {
            "type" : "boolean"
        },
        "directedMulticastFromWirelessClientEnabled" : {
            "type" : "boolean"
        },
        "directedMulticastFromNetworkEnabled" : {
            "type" : "boolean"
        },
        "healthCheckSitesEnabled" : {
            "description" : "Enabled Health Check Sites. ",
            "type" : "boolean"
        },
        "healthCheckSites" : {
            "description" : "Health Check Sites.",
            "type" : "array",
            "items" : {
                "type" : "string"
            }
        },
        "ruckusGreTunnelProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "softGreTunnelProflies" : {
            "type" : "array",
            "items" : {
                "type" : [ "object", "null" ],
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "type" : "string"
                    },
                    "name" : {
                        "type" : "string"
                    },
                    "aaaAffinityEnabled" : {
                        "type" : "boolean"
                    }
                }
            }
        },
        "ipsecProfiles" : {
            "type" : "array",
            "items" : {
                "type" : [ "object", "null" ],
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "type" : "string"
                    },
                    "name" : {
                        "type" : "string"
                    }
                }
            }
        },
        "sshTunnelEncryption" : {
            "type" : "string",
            "enum" : [ "AES128", "AES256" ]
        },
        "lteBandLockChannels" : {
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "simCardId" : {
                        "description" : "SIM card ID(Primary:0, Secondary:1)",
                        "type" : "integer"
                    },
                    "type" : {
                        "description" : "LTE chipset SKU type",
                        "type" : "string"
                    },
                    "channel4g" : {
                        "description" : "LTE 4G channels",
                        "type" : "string"
                    },
                    "channel3g" : {
                        "description" : "LTE 3G channels",
                        "type" : "string"
                    }
                }
            }
        },
        "apHccdEnabled" : {
            "type" : "boolean"
        },
        "apHccdPersist" : {
            "type" : "boolean"
        }
    },
    "type" : "object"
}
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
{
    "additionalProperties" : false,
    "properties" : {
        "altitude" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "altitudeUnit" : {
                    "description" : "altitude unit",
                    "type" : "string",
                    "enum" : [ "meters", "floor" ]
                },
                "altitudeValue" : {
                    "description" : "altitude value",
                    "type" : "integer"
                }
            }
        },
        "apMgmtVlan" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "mode" : {
                    "description" : "Vlan Mode of the zone",
                    "type" : "string",
                    "enum" : [ "KEEP", "USER_DEFINED" ]
                },
                "id" : {
                    "description" : "Vlan id of the zone",
                    "type" : "integer"
                }
            }
        },
        "apLatencyInterval" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "pingEnabled" : {
                    "description" : "AP ping latency enabled",
                    "type" : "boolean"
                }
            }
        },
        "apRebootTimeout" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "gatewayLossTimeoutInSec" : {
                    "description" : "Gateway loss timeout in second",
                    "type" : "integer",
                    "enum" : [ 0, 1800, 3600, 5400, 7200, 9000, 10800, 12600, 14400, 16200, 18000, 19800, 23400, 25200, 27000, 28800, 30600, 32400, 34200, 36000, 37800, 39600, 41400, 43200, 45000, 46800, 48600, 50400, 52200, 54000, 55800, 57600, 59400, 61200, 63000, 64800, 66600, 68400, 70200, 72000, 73800, 75600, 77400, 79200, 81000, 82800, 84600, 86400 ]
                },
                "serverLossTimeoutInSec" : {
                    "description" : "Server loss timeout in second",
                    "type" : "integer",
                    "enum" : [ 0, 7200, 14400, 21600, 28800, 36000, 43200, 50400, 57600, 64800, 72000, 79200, 86400 ]
                }
            }
        },
        "autoChannelSelection24" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "channelSelectMode" : {
                    "description" : "Channel Select Mode",
                    "type" : "string",
                    "enum" : [ "None", "BackgroundScanning", "ChannelFly" ]
                },
                "channelFlyMtbc" : {
                    "description" : "ChannelFly MTBC",
                    "type" : "integer",
                    "minimum" : 100,
                    "maximum" : 1440
                }
            }
        },
        "autoChannelSelection50" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "channelSelectMode" : {
                    "description" : "Channel Select Mode",
                    "type" : "string",
                    "enum" : [ "None", "BackgroundScanning", "ChannelFly" ]
                },
                "channelFlyMtbc" : {
                    "description" : "ChannelFly MTBC",
                    "type" : "integer",
                    "minimum" : 100,
                    "maximum" : 1440
                }
            }
        },
        "awsVenue" : {
            "type" : "string"
        },
        "backgroundScanning24" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "frequencyInSec" : {
                    "description" : "Frequency in second",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 65535
                }
            }
        },
        "backgroundScanning50" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "frequencyInSec" : {
                    "description" : "Frequency in second",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 65535
                }
            }
        },
        "bandBalancing" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "mode" : {
                    "description" : "Band Balancing Mode: BASIC-Withholds probe and authentication responses at connetcion time in heavily loaded band to balance clients to the other band, PROACTIVE-Uses BASIC functionality and actively rebalances clients via 802.11v BTM, STRICT-Uses PROACTIVE functionality and forcefully rebalances clients via 802.11v BTM",
                    "type" : "string",
                    "enum" : [ "BASIC", "PROACTIVE", "STRICT" ]
                },
                "wifi24Percentage" : {
                    "description" : "Percentage of client load on 2.4GHz radio band",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 100
                }
            }
        },
        "loadBalancingMethod" : {
            "type" : "string",
            "enum" : [ "BASED_ON_CLIENT_COUNT", "BASED_ON_CAPACITY", "OFF" ]
        },
        "bonjourFencingPolicy" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "bonjourFencingPolicyEnabled" : {
            "type" : "boolean"
        },
        "channelEvaluationInterval" : {
            "maximum" : 3600,
            "minimum" : 60,
            "type" : "integer"
        },
        "channelModeEnabled" : {
            "type" : "boolean"
        },
        "clientAdmissionControl24" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "maxRadioLoadPercent" : {
                    "description" : "Maximum radio load percentage.",
                    "type" : "integer",
                    "minimum" : 50,
                    "maximum" : 100
                },
                "minClientCount" : {
                    "description" : "Minimum client count number.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 100
                },
                "minClientThroughputMbps" : {
                    "description" : "Minimum client throughput in Mbps.",
                    "type" : "number",
                    "minimum" : 0,
                    "maximum" : 100
                }
            }
        },
        "clientAdmissionControl50" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "maxRadioLoadPercent" : {
                    "description" : "Maximum radio load percentage.",
                    "type" : "integer",
                    "minimum" : 50,
                    "maximum" : 100
                },
                "minClientCount" : {
                    "description" : "Minimum client count number.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 100
                },
                "minClientThroughputMbps" : {
                    "description" : "Minimum client throughput in Mbps.",
                    "type" : "number",
                    "minimum" : 0,
                    "maximum" : 100
                }
            }
        },
        "clientLoadBalancing24" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "adjacentRadioThreshold" : {
                    "description" : "Adjacent radio threshold",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 100
                }
            }
        },
        "clientLoadBalancing50" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "adjacentRadioThreshold" : {
                    "description" : "Adjacent radio threshold",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 100
                }
            }
        },
        "countryCode" : {
            "type" : "string"
        },
        "description" : {
            "type" : [ "string", "null" ],
            "maxLength" : 64
        },
        "dfsChannelEnabled" : {
            "type" : "boolean"
        },
        "cbandChannelEnabled" : {
            "type" : "boolean"
        },
        "cbandChannelLicenseEnabled" : {
            "type" : "boolean"
        },
        "channel144Enabled" : {
            "type" : "boolean"
        },
        "dhcpSiteConfig" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "siteEnabled" : {
                    "description" : "DHCP Service Enabling Status",
                    "type" : "boolean"
                },
                "dwpdEnabled" : {
                    "description" : "DHCP Service Dynamic WAN Port Detection",
                    "type" : "boolean"
                },
                "manualSelect" : {
                    "description" : "DHCP Service AP Selection Mode. This value is effective when the siteMode is EnableOnMultipleAPs.",
                    "type" : "boolean"
                },
                "siteMode" : {
                    "description" : "DHCP Service mode",
                    "type" : "string",
                    "enum" : [ "EnableOnEachAPs", "EnableOnMultipleAPs", "EnableOnHierarchicalAPs" ]
                },
                "eth0ProfileId" : {
                    "type" : "integer"
                },
                "eth1ProfileId" : {
                    "type" : "integer"
                },
                "siteAps" : {
                    "type" : "array",
                    "items" : {
                        "type" : "object",
                        "description" : "DHCP Site selected APs. The content is effective when the siteMode is EnableOnMultipleAPs.",
                        "additionalProperties" : false,
                        "properties" : {
                            "apMac" : {
                                "type" : "string"
                            },
                            "apName" : {
                                "type" : "string"
                            },
                            "apStatus" : {
                                "type" : "string",
                                "enum" : [ "Online", "Offline", "Flagged" ]
                            },
                            "apServerEnabled" : {
                                "type" : "boolean"
                            },
                            "apServerPrimary" : {
                                "type" : "boolean"
                            },
                            "apServerIp" : {
                                "type" : [ "string", "null" ]
                            },
                            "apGatewayIp" : {
                                "type" : "string"
                            },
                            "apServerType" : {
                                "type" : "string"
                            }
                        }
                    }
                },
                "siteProfileIds" : {
                    "type" : "array",
                    "items" : {
                        "type" : "string"
                    }
                }
            }
        },
        "domainId" : {
            "type" : "string"
        },
        "dosBarringCheckPeriod" : {
            "type" : "integer"
        },
        "dosBarringEnable" : {
            "type" : "integer"
        },
        "dosBarringPeriod" : {
            "type" : "integer"
        },
        "dosBarringThreshold" : {
            "type" : "integer"
        },
        "ipsecProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "ipv6TrafficFilterEnabled" : {
            "type" : "integer"
        },
        "latitude" : {
            "type" : "number"
        },
        "location" : {
            "type" : "string"
        },
        "locationAdditionalInfo" : {
            "type" : "string",
            "pattern" : "^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
        },
        "locationBasedService" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "login" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "apLoginName" : {
                    "description" : "User name of the AP administrator",
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : "^((?!\$\()[!-_a-~]){1,64}$"
                },
                "apLoginPassword" : {
                    "description" : "Password of the AP administrator",
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : ".*(?=.{8,})(?=.*[a-zA-Z])(?=.*[0-9])(?=.*[_`~!@#$%^&*\(\)\[\]\{\}|;:'\",.\<>\/?=+-]).*"
                }
            },
            "required" : [ "apLoginName", "apLoginPassword" ]
        },
        "longitude" : {
            "type" : "number"
        },
        "mesh" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "ssid" : {
                    "description" : "SSID of the mesh network",
                    "type" : "string"
                },
                "passphrase" : {
                    "description" : "Passphrase for the mesh network",
                    "type" : "string"
                },
                "meshRadioIdx" : {
                    "description" : "Mesh radio index",
                    "type" : "string",
                    "enum" : [ "Radio24G", "Radio5G" ]
                },
                "zeroTouchStatus" : {
                    "type" : "boolean"
                }
            }
        },
        "name" : {
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 32,
            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$"
        },
        "nodeAffinityProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "rogue" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "reportType" : {
                    "description" : "Report type",
                    "type" : "string",
                    "enum" : [ "All", "Malicious" ]
                },
                "maliciousTypes" : {
                    "description" : "Malicious type when reportType is Malicious",
                    "type" : [ "array", "null" ],
                    "items" : {
                        "type" : "string",
                        "enum" : [ "SSIDSpoofing", "SameNetwork", "MACSpoofing" ]
                    }
                },
                "protectionEnabled" : {
                    "description" : "Protection enabled",
                    "type" : "boolean"
                }
            }
        },
        "smartMonitor" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "intervalInSec" : {
                    "description" : "Interval in seconds. This is required if smartMonitor is enabled",
                    "type" : "integer",
                    "minimum" : 5,
                    "maximum" : 60
                },
                "retryThreshold" : {
                    "description" : "Retry threshold. This is required if smartMonitor is enabled",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 10
                }
            }
        },
        "syslog" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "flowLevel" : {
                    "description" : "Flow Level of the syslog",
                    "type" : "string",
                    "enum" : [ "GENERAL_LOGS", "CLIENT_FLOW", "ALL" ]
                },
                "address" : {
                    "description" : "Address of the syslog server.",
                    "type" : "string"
                },
                "port" : {
                    "description" : "Port number of the syslog server",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 65535
                },
                "protocol" : {
                    "description" : "Protocol of the syslog server",
                    "type" : "string",
                    "enum" : [ "IPPROTO_TCP", "IPPROTO_UDP" ]
                },
                "secondaryAddress" : {
                    "description" : "Secondary Server Address of the syslog server",
                    "type" : "string"
                },
                "secondaryPort" : {
                    "description" : "Secondary Server Port of the syslog server",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 65535
                },
                "secondaryProtocol" : {
                    "description" : "Secondary Server Protocol of the syslog server",
                    "type" : "string",
                    "enum" : [ "IPPROTO_TCP", "IPPROTO_UDP" ]
                },
                "facility" : {
                    "description" : "Facility of the syslog server",
                    "type" : "string",
                    "enum" : [ "Keep_Original", "Local0", "Local1", "Local2", "Local3", "Local4", "Local5", "Local6", "Local7" ]
                },
                "priority" : {
                    "description" : "Priority of the log messages",
                    "type" : "string",
                    "enum" : [ "Emergency", "Alert", "Critical", "Error", "Warning", "Notice", "Info", "All" ]
                }
            }
        },
        "timezone" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "systemTimezone" : {
                    "description" : "System defined time zone, please refer to the “Overview > Time Zone” list",
                    "type" : "string"
                },
                "customizedTimezone" : {
                    "description" : "User defined time zone",
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "abbreviation" : {
                            "description" : "Time zone abbreviation",
                            "type" : "string",
                            "pattern" : "^[a-zA-Z]{3,4}$"
                        },
                        "gmtOffset" : {
                            "description" : "GMT offset",
                            "type" : "integer",
                            "minimum" : -11,
                            "maximum" : 14
                        },
                        "gmtOffsetMinute" : {
                            "description" : "GMT offset minute",
                            "type" : "integer",
                            "minimum" : 0,
                            "maximum" : 59
                        },
                        "start" : {
                            "description" : "Daylight saving time start",
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "month" : {
                                    "description" : "Month when daylight saving time begins",
                                    "type" : "integer",
                                    "enum" : [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ]
                                },
                                "week" : {
                                    "description" : "Week of the month (1 for the first week, 2 for the second week, and so on)",
                                    "type" : "integer",
                                    "enum" : [ 1, 2, 3, 4, 5 ]
                                },
                                "day" : {
                                    "description" : "Day of the week (0 for Sunday, 1 for Monday, 2 for Tuesday, and so on)",
                                    "type" : "integer",
                                    "enum" : [ 0, 1, 2, 3, 4, 5, 6 ]
                                },
                                "hour" : {
                                    "description" : "Hour of the day",
                                    "type" : "integer",
                                    "minimum" : 0,
                                    "maximum" : 23
                                }
                            },
                            "required" : [ "month", "week", "day", "hour" ]
                        },
                        "end" : {
                            "description" : "Daylight saving time end",
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "month" : {
                                    "description" : "Month when daylight saving time begins",
                                    "type" : "integer",
                                    "enum" : [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ]
                                },
                                "week" : {
                                    "description" : "Week of the month (1 for the first week, 2 for the second week, and so on)",
                                    "type" : "integer",
                                    "enum" : [ 1, 2, 3, 4, 5 ]
                                },
                                "day" : {
                                    "description" : "Day of the week (0 for Sunday, 1 for Monday, 2 for Tuesday, and so on)",
                                    "type" : "integer",
                                    "enum" : [ 0, 1, 2, 3, 4, 5, 6 ]
                                },
                                "hour" : {
                                    "description" : "Hour of the day",
                                    "type" : "integer",
                                    "minimum" : 0,
                                    "maximum" : 23
                                }
                            },
                            "required" : [ "month", "week", "day", "hour" ]
                        }
                    },
                    "required" : [ "abbreviation", "gmtOffset", "gmtOffsetMinute" ]
                }
            }
        },
        "tunnelProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "aaaAffinityEnabled" : {
            "type" : "boolean"
        },
        "tunnelType" : {
            "description" : "Tunnel type configuration of the zone. No_Tunneled is for IPv6 mode",
            "type" : "string",
            "enum" : [ "No_Tunneled", "RuckusGRE", "SoftGRE", "SoftGREIpsec" ]
        },
        "venueProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "vlanOverlappingEnabled" : {
            "type" : "boolean"
        },
        "wifi24" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "autoCellSizing" : {
                    "description" : "Auto Cell Sizing",
                    "type" : "boolean"
                },
                "txPower" : {
                    "description" : "Transmission power",
                    "type" : "string",
                    "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ]
                },
                "channelWidth" : {
                    "description" : "Channel width. Zero (0) means Auto.",
                    "type" : "integer",
                    "enum" : [ 0, 20, 40 ]
                },
                "channel" : {
                    "description" : "Channel number",
                    "type" : "integer"
                },
                "channelRange" : {
                    "description" : "Channel range options",
                    "type" : "array",
                    "items" : {
                        "type" : "integer"
                    }
                }
            }
        },
        "wifi50" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "autoCellSizing" : {
                    "description" : "Auto Cell Sizing",
                    "type" : "boolean"
                },
                "txPower" : {
                    "description" : "Transmission power",
                    "type" : "string",
                    "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ]
                },
                "channelWidth" : {
                    "description" : "Channel width. Zero (0) means Auto. 8080 means 80+80MHz",
                    "type" : "integer",
                    "enum" : [ 0, 20, 40, 80, 8080, 160 ]
                },
                "indoorChannel" : {
                    "description" : "Channel number for Indoor AP",
                    "type" : "integer"
                },
                "outdoorChannel" : {
                    "description" : "Channel number for Outdoor AP",
                    "type" : "integer"
                },
                "indoorSecondaryChannel" : {
                    "description" : "Secondary channel number for Indoor AP (channelWidth is 80+80MHz only)",
                    "type" : "integer"
                },
                "outdoorSecondaryChannel" : {
                    "description" : "Secondary channel number for outdoor AP (channelWidth is 80+80MHz only)",
                    "type" : "integer"
                },
                "indoorChannelRange" : {
                    "description" : "Channel range options for Indoor AP",
                    "type" : "array",
                    "items" : {
                        "type" : "integer"
                    }
                },
                "outdoorChannelRange" : {
                    "description" : "Channel range options for outdoor AP",
                    "type" : "array",
                    "items" : {
                        "type" : "integer"
                    }
                }
            }
        },
        "protectionMode24" : {
            "type" : "string",
            "enum" : [ "NONE", "CTS_ONLY", "RTS_CTS" ]
        },
        "zoneAffinityProfileId" : {
            "type" : "string"
        },
        "snmpAgent" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "apSnmpEnabled" : {
                    "description" : "Enable AP SNMP",
                    "type" : "boolean"
                },
                "snmpV2Agent" : {
                    "description" : "Community List of the SNMP V2 Agent.",
                    "type" : "array",
                    "items" : {
                        "type" : "object",
                        "additionalProperties" : false,
                        "properties" : {
                            "communityName" : {
                                "description" : "name of the SNMP Community.",
                                "type" : "string"
                            },
                            "readEnabled" : {
                                "description" : "read privilege of the SNMP Coummunity",
                                "type" : "boolean"
                            },
                            "writeEnabled" : {
                                "description" : "write privilege of the SNMP Coummunity",
                                "type" : "boolean"
                            },
                            "notificationEnabled" : {
                                "description" : "notification privilege of the SNMP Coummunity",
                                "type" : "boolean"
                            },
                            "notificationType" : {
                                "description" : "type of the notification privilege",
                                "type" : "string",
                                "enum" : [ "TRAP", "INFORM" ]
                            },
                            "notificationTarget" : {
                                "description" : "Trap List of the SNMP Coummunity",
                                "type" : "array",
                                "items" : {
                                    "type" : "object",
                                    "additionalProperties" : false,
                                    "properties" : {
                                        "address" : {
                                            "description" : "address of the SNMP Trap",
                                            "type" : "string"
                                        },
                                        "port" : {
                                            "description" : "port number of the SNMP Trap",
                                            "type" : "integer",
                                            "minimum" : 1,
                                            "maximum" : 65535
                                        }
                                    },
                                    "required" : [ "address", "port" ]
                                }
                            }
                        },
                        "required" : [ "communityName" ]
                    }
                },
                "snmpV3Agent" : {
                    "description" : "User List of the SNMP V3 Agent.",
                    "type" : "array",
                    "items" : {
                        "type" : "object",
                        "additionalProperties" : false,
                        "properties" : {
                            "userName" : {
                                "description" : "name of the SNMP User.",
                                "type" : "string"
                            },
                            "authProtocol" : {
                                "description" : "authProtocol of the SNMP User.",
                                "type" : "string",
                                "enum" : [ "NONE", "MD5", "SHA" ]
                            },
                            "authPassword" : {
                                "description" : "authPassword of the SNMP User.",
                                "type" : "string",
                                "minLength" : 8
                            },
                            "privProtocol" : {
                                "description" : "privProtocol of the SNMP User.",
                                "type" : "string",
                                "enum" : [ "NONE", "DES", "AES" ]
                            },
                            "privPassword" : {
                                "description" : "privPassword of the SNMP User.",
                                "type" : "string",
                                "minLength" : 8
                            },
                            "readEnabled" : {
                                "description" : "read privilege of the SNMP User",
                                "type" : "boolean"
                            },
                            "writeEnabled" : {
                                "description" : "write privilege of the SNMP User",
                                "type" : "boolean"
                            },
                            "notificationEnabled" : {
                                "description" : "notification privilege of the SNMP User",
                                "type" : "boolean"
                            },
                            "notificationType" : {
                                "description" : "type of the notification privilege",
                                "type" : "string",
                                "enum" : [ "TRAP", "INFORM" ]
                            },
                            "notificationTarget" : {
                                "description" : "Trap List of the SNMP User",
                                "type" : "array",
                                "items" : {
                                    "type" : "object",
                                    "additionalProperties" : false,
                                    "properties" : {
                                        "address" : {
                                            "description" : "address of the SNMP Trap",
                                            "type" : "string"
                                        },
                                        "port" : {
                                            "description" : "port number of the SNMP Trap",
                                            "type" : "integer",
                                            "minimum" : 1,
                                            "maximum" : 65535
                                        }
                                    },
                                    "required" : [ "address", "port" ]
                                }
                            }
                        },
                        "required" : [ "userName" ]
                    }
                }
            }
        },
        "recoverySsid" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "recoverySsidPskKey" : {
                    "description" : "recovery ssid password",
                    "type" : "string"
                },
                "recoverySsidEnabled" : {
                    "description" : "recovery ssid enable/disable",
                    "type" : "boolean"
                }
            }
        },
        "clusterRedundancyEnabled" : {
            "type" : "boolean"
        },
        "rogueApReportThreshold" : {
            "type" : "integer"
        },
        "rogueApAggressivenessMode" : {
            "type" : "integer"
        },
        "rogueApJammingDetection" : {
            "type" : "boolean"
        },
        "rogueApJammingThreshold" : {
            "type" : "integer"
        },
        "directedMulticastFromWiredClientEnabled" : {
            "type" : "boolean"
        },
        "directedMulticastFromWirelessClientEnabled" : {
            "type" : "boolean"
        },
        "directedMulticastFromNetworkEnabled" : {
            "type" : "boolean"
        },
        "healthCheckSitesEnabled" : {
            "description" : "Enabled Health Check Sites. ",
            "type" : "boolean"
        },
        "healthCheckSites" : {
            "description" : "Health Check Sites.",
            "type" : "array",
            "items" : {
                "type" : "string"
            }
        },
        "ruckusGreTunnelProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "softGreTunnelProflies" : {
            "type" : "array",
            "items" : {
                "type" : [ "object", "null" ],
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "type" : "string"
                    },
                    "name" : {
                        "type" : "string"
                    },
                    "aaaAffinityEnabled" : {
                        "type" : "boolean"
                    }
                }
            }
        },
        "ipsecProfiles" : {
            "type" : "array",
            "items" : {
                "type" : [ "object", "null" ],
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "type" : "string"
                    },
                    "name" : {
                        "type" : "string"
                    }
                }
            }
        },
        "sshTunnelEncryption" : {
            "type" : "string",
            "enum" : [ "AES128", "AES256" ]
        },
        "lteBandLockChannels" : {
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "simCardId" : {
                        "description" : "SIM card ID(Primary:0, Secondary:1)",
                        "type" : "integer"
                    },
                    "type" : {
                        "description" : "LTE chipset SKU type",
                        "type" : "string"
                    },
                    "channel4g" : {
                        "description" : "LTE 4G channels",
                        "type" : "string"
                    },
                    "channel3g" : {
                        "description" : "LTE 3G channels",
                        "type" : "string"
                    }
                }
            }
        },
        "apHccdEnabled" : {
            "type" : "boolean"
        },
        "apHccdPersist" : {
            "type" : "boolean"
        }
    },
    "type" : "object"
}
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" : {
            "type" : "string"
        },
        "zoneAffinityProfileId" : {
            "description" : "Zone affinity profile of the zone",
            "type" : "string"
        },
        "enforcePriorityZoneAffinityEnable" : {
            "description" : "Enforce the priority of zone affinity",
            "type" : "boolean"
        },
        "name" : {
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 32,
            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$"
        },
        "description" : {
            "type" : [ "string", "null" ],
            "maxLength" : 64
        },
        "version" : {
            "type" : "string",
            "pattern" : "^\d+\.\d+\.\d+\.\d+\.\d+$"
        },
        "countryCode" : {
            "type" : "string"
        },
        "login" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "apLoginName" : {
                    "description" : "User name of the AP administrator",
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : "^((?!\$\()[!-_a-~]){1,64}$"
                },
                "apLoginPassword" : {
                    "description" : "Password of the AP administrator",
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : ".*(?=.{8,})(?=.*[a-zA-Z])(?=.*[0-9])(?=.*[_`~!@#$%^&*\(\)\[\]\{\}|;:'\",.\<>\/?=+-]).*"
                }
            },
            "required" : [ "apLoginName", "apLoginPassword" ]
        },
        "timezone" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "systemTimezone" : {
                    "description" : "System defined time zone, please refer to the “Overview > Time Zone” list",
                    "type" : "string"
                },
                "customizedTimezone" : {
                    "description" : "User defined time zone",
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "abbreviation" : {
                            "description" : "Time zone abbreviation",
                            "type" : "string",
                            "pattern" : "^[a-zA-Z]{3,4}$"
                        },
                        "gmtOffset" : {
                            "description" : "GMT offset",
                            "type" : "integer",
                            "minimum" : -11,
                            "maximum" : 14
                        },
                        "gmtOffsetMinute" : {
                            "description" : "GMT offset minute",
                            "type" : "integer",
                            "minimum" : 0,
                            "maximum" : 59
                        },
                        "start" : {
                            "description" : "Daylight saving time start",
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "month" : {
                                    "description" : "Month when daylight saving time begins",
                                    "type" : "integer",
                                    "enum" : [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ]
                                },
                                "week" : {
                                    "description" : "Week of the month (1 for the first week, 2 for the second week, and so on)",
                                    "type" : "integer",
                                    "enum" : [ 1, 2, 3, 4, 5 ]
                                },
                                "day" : {
                                    "description" : "Day of the week (0 for Sunday, 1 for Monday, 2 for Tuesday, and so on)",
                                    "type" : "integer",
                                    "enum" : [ 0, 1, 2, 3, 4, 5, 6 ]
                                },
                                "hour" : {
                                    "description" : "Hour of the day",
                                    "type" : "integer",
                                    "minimum" : 0,
                                    "maximum" : 23
                                }
                            },
                            "required" : [ "month", "week", "day", "hour" ]
                        },
                        "end" : {
                            "description" : "Daylight saving time end",
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "month" : {
                                    "description" : "Month when daylight saving time begins",
                                    "type" : "integer",
                                    "enum" : [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ]
                                },
                                "week" : {
                                    "description" : "Week of the month (1 for the first week, 2 for the second week, and so on)",
                                    "type" : "integer",
                                    "enum" : [ 1, 2, 3, 4, 5 ]
                                },
                                "day" : {
                                    "description" : "Day of the week (0 for Sunday, 1 for Monday, 2 for Tuesday, and so on)",
                                    "type" : "integer",
                                    "enum" : [ 0, 1, 2, 3, 4, 5, 6 ]
                                },
                                "hour" : {
                                    "description" : "Hour of the day",
                                    "type" : "integer",
                                    "minimum" : 0,
                                    "maximum" : 23
                                }
                            },
                            "required" : [ "month", "week", "day", "hour" ]
                        }
                    },
                    "required" : [ "abbreviation", "gmtOffset", "gmtOffsetMinute" ]
                }
            }
        },
        "mesh" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "ssid" : {
                    "description" : "SSID of the mesh network",
                    "type" : "string"
                },
                "passphrase" : {
                    "description" : "Passphrase for the mesh network",
                    "type" : "string"
                },
                "meshRadioIdx" : {
                    "description" : "Mesh radio index",
                    "type" : "string",
                    "enum" : [ "Radio24G", "Radio5G" ],
                    "default" : "Radio5G"
                },
                "zeroTouchStatus" : {
                    "type" : "boolean"
                }
            }
        },
        "dfsChannelEnabled" : {
            "type" : "boolean",
            "default" : false
        },
        "cbandChannelEnabled" : {
            "type" : "boolean",
            "default" : false
        },
        "cbandChannelLicenseEnabled" : {
            "type" : "boolean",
            "default" : false
        },
        "channel144Enabled" : {
            "type" : "boolean",
            "default" : false
        },
        "wifi24" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "autoCellSizing" : {
                    "description" : "Auto Cell Sizing",
                    "type" : "boolean"
                },
                "txPower" : {
                    "description" : "Transmission power",
                    "type" : "string",
                    "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
                    "default" : "Full"
                },
                "channelWidth" : {
                    "description" : "Channel width. Zero (0) means Auto.",
                    "type" : "integer",
                    "enum" : [ 0, 20, 40 ],
                    "default" : 0
                },
                "channel" : {
                    "description" : "Channel number",
                    "type" : "integer"
                },
                "channelRange" : {
                    "description" : "Channel range options",
                    "type" : "array",
                    "items" : {
                        "type" : "integer"
                    }
                }
            }
        },
        "wifi50" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "autoCellSizing" : {
                    "description" : "Auto Cell Sizing",
                    "type" : "boolean"
                },
                "txPower" : {
                    "description" : "Transmission power",
                    "type" : "string",
                    "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
                    "default" : "Full"
                },
                "channelWidth" : {
                    "description" : "Channel width. Zero (0) means Auto. 8080 means 80+80MHz",
                    "type" : "integer",
                    "enum" : [ 0, 20, 40, 80, 8080, 160 ],
                    "default" : 0
                },
                "indoorChannel" : {
                    "description" : "Channel number for Indoor AP",
                    "type" : "integer"
                },
                "outdoorChannel" : {
                    "description" : "Channel number for Outdoor AP",
                    "type" : "integer"
                },
                "indoorSecondaryChannel" : {
                    "description" : "Secondary channel number for Indoor AP (channelWidth is 80+80MHz only)",
                    "type" : "integer"
                },
                "outdoorSecondaryChannel" : {
                    "description" : "Secondary channel number for outdoor AP (channelWidth is 80+80MHz only)",
                    "type" : "integer"
                },
                "indoorChannelRange" : {
                    "description" : "Channel range options for Indoor AP",
                    "type" : "array",
                    "items" : {
                        "type" : "integer"
                    }
                },
                "outdoorChannelRange" : {
                    "description" : "Channel range options for outdoor AP",
                    "type" : "array",
                    "items" : {
                        "type" : "integer"
                    }
                }
            }
        },
        "protectionMode24" : {
            "type" : "string",
            "enum" : [ "NONE", "CTS_ONLY", "RTS_CTS" ],
            "default" : "RTS_CTS"
        },
        "syslog" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "flowLevel" : {
                    "description" : "Flow Level of the syslog",
                    "type" : "string",
                    "enum" : [ "GENERAL_LOGS", "CLIENT_FLOW", "ALL" ],
                    "default" : "GENERAL_LOGS"
                },
                "address" : {
                    "description" : "Address of the syslog server.",
                    "type" : "string"
                },
                "port" : {
                    "description" : "Port number of the syslog server",
                    "type" : "integer",
                    "default" : 514,
                    "minimum" : 1,
                    "maximum" : 65535
                },
                "protocol" : {
                    "description" : "Protocol of the syslog server",
                    "type" : "string",
                    "enum" : [ "IPPROTO_TCP", "IPPROTO_UDP" ],
                    "default" : "IPPROTO_TCP"
                },
                "secondaryAddress" : {
                    "description" : "Secondary Server Address of the syslog server",
                    "type" : "string"
                },
                "secondaryPort" : {
                    "description" : "Secondary Server Port of the syslog server",
                    "type" : "integer",
                    "default" : 514,
                    "minimum" : 1,
                    "maximum" : 65535
                },
                "secondaryProtocol" : {
                    "description" : "Secondary Server Protocol of the syslog server",
                    "type" : "string",
                    "enum" : [ "IPPROTO_TCP", "IPPROTO_UDP" ],
                    "default" : "IPPROTO_TCP"
                },
                "facility" : {
                    "description" : "Facility of the syslog server",
                    "type" : "string",
                    "enum" : [ "Keep_Original", "Local0", "Local1", "Local2", "Local3", "Local4", "Local5", "Local6", "Local7" ],
                    "default" : "Keep_Original"
                },
                "priority" : {
                    "description" : "Priority of the log messages",
                    "type" : "string",
                    "enum" : [ "Emergency", "Alert", "Critical", "Error", "Warning", "Notice", "Info", "All" ],
                    "default" : "Error"
                }
            }
        },
        "smartMonitor" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "intervalInSec" : {
                    "description" : "Interval in seconds. This is required if smartMonitor is enabled",
                    "type" : "integer",
                    "default" : 10,
                    "minimum" : 5,
                    "maximum" : 60
                },
                "retryThreshold" : {
                    "description" : "Retry threshold. This is required if smartMonitor is enabled",
                    "type" : "integer",
                    "default" : 3,
                    "minimum" : 1,
                    "maximum" : 10
                }
            }
        },
        "clientAdmissionControl24" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "maxRadioLoadPercent" : {
                    "description" : "Maximum radio load percentage.",
                    "type" : "integer",
                    "default" : 75,
                    "minimum" : 50,
                    "maximum" : 100
                },
                "minClientCount" : {
                    "description" : "Minimum client count number.",
                    "type" : "integer",
                    "default" : 10,
                    "minimum" : 0,
                    "maximum" : 100
                },
                "minClientThroughputMbps" : {
                    "description" : "Minimum client throughput in Mbps.",
                    "type" : "number",
                    "default" : 0,
                    "minimum" : 0,
                    "maximum" : 100
                }
            }
        },
        "clientAdmissionControl50" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "maxRadioLoadPercent" : {
                    "description" : "Maximum radio load percentage.",
                    "type" : "integer",
                    "default" : 75,
                    "minimum" : 50,
                    "maximum" : 100
                },
                "minClientCount" : {
                    "description" : "Minimum client count number.",
                    "type" : "integer",
                    "default" : 10,
                    "minimum" : 0,
                    "maximum" : 100
                },
                "minClientThroughputMbps" : {
                    "description" : "Minimum client throughput in Mbps.",
                    "type" : "number",
                    "default" : 0,
                    "minimum" : 0,
                    "maximum" : 100
                }
            }
        },
        "channelModeEnabled" : {
            "type" : "boolean",
            "default" : false
        },
        "tunnelType" : {
            "description" : "Tunnel type configuration of the zone. No_Tunneled is for IPv6 mode",
            "type" : "string",
            "enum" : [ "No_Tunneled", "RuckusGRE", "SoftGRE", "SoftGREIpsec" ],
            "default" : "RuckusGRE"
        },
        "tunnelProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "backgroundScanning24" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "frequencyInSec" : {
                    "description" : "Frequency in second",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 65535,
                    "default" : 20
                }
            }
        },
        "backgroundScanning50" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "frequencyInSec" : {
                    "description" : "Frequency in second",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 65535,
                    "default" : 20
                }
            }
        },
        "clientLoadBalancing24" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "adjacentRadioThreshold" : {
                    "description" : "Adjacent radio threshold",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 100
                }
            }
        },
        "clientLoadBalancing50" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "adjacentRadioThreshold" : {
                    "description" : "Adjacent radio threshold",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 100
                }
            }
        },
        "bandBalancing" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "mode" : {
                    "description" : "Band Balancing Mode: BASIC-Withholds probe and authentication responses at connetcion time in heavily loaded band to balance clients to the other band, PROACTIVE-Uses BASIC functionality and actively rebalances clients via 802.11v BTM, STRICT-Uses PROACTIVE functionality and forcefully rebalances clients via 802.11v BTM",
                    "type" : "string",
                    "enum" : [ "BASIC", "PROACTIVE", "STRICT" ],
                    "default" : "BASIC"
                },
                "wifi24Percentage" : {
                    "description" : "Percentage of client load on 2.4GHz radio band",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 100,
                    "default" : 25
                }
            }
        },
        "loadBalancingMethod" : {
            "type" : "string",
            "enum" : [ "BASED_ON_CLIENT_COUNT", "BASED_ON_CAPACITY", "OFF" ],
            "default" : "BASED_ON_CLIENT_COUNT"
        },
        "rogue" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "reportType" : {
                    "description" : "Report type",
                    "type" : "string",
                    "enum" : [ "All", "Malicious" ]
                },
                "maliciousTypes" : {
                    "description" : "Malicious type when reportType is Malicious",
                    "type" : [ "array", "null" ],
                    "items" : {
                        "type" : "string",
                        "enum" : [ "SSIDSpoofing", "SameNetwork", "MACSpoofing" ]
                    }
                },
                "protectionEnabled" : {
                    "description" : "Protection enabled",
                    "type" : "boolean"
                }
            }
        },
        "dosBarringEnable" : {
            "type" : "integer"
        },
        "dosBarringPeriod" : {
            "type" : "integer",
            "default" : 60
        },
        "dosBarringThreshold" : {
            "type" : "integer",
            "default" : 5
        },
        "dosBarringCheckPeriod" : {
            "type" : "integer",
            "default" : 30
        },
        "locationBasedService" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "apRebootTimeout" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "gatewayLossTimeoutInSec" : {
                    "description" : "Gateway loss timeout in second",
                    "type" : "integer",
                    "enum" : [ 0, 1800, 3600, 5400, 7200, 9000, 10800, 12600, 14400, 16200, 18000, 19800, 23400, 25200, 27000, 28800, 30600, 32400, 34200, 36000, 37800, 39600, 41400, 43200, 45000, 46800, 48600, 50400, 52200, 54000, 55800, 57600, 59400, 61200, 63000, 64800, 66600, 68400, 70200, 72000, 73800, 75600, 77400, 79200, 81000, 82800, 84600, 86400 ],
                    "default" : 1800
                },
                "serverLossTimeoutInSec" : {
                    "description" : "Server loss timeout in second",
                    "type" : "integer",
                    "enum" : [ 0, 7200, 14400, 21600, 28800, 36000, 43200, 50400, 57600, 64800, 72000, 79200, 86400 ],
                    "default" : 7200
                }
            }
        },
        "location" : {
            "type" : "string"
        },
        "locationAdditionalInfo" : {
            "type" : "string",
            "pattern" : "^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
        },
        "altitude" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "altitudeUnit" : {
                    "description" : "altitude unit",
                    "type" : "string",
                    "enum" : [ "meters", "floor" ],
                    "default" : "meters"
                },
                "altitudeValue" : {
                    "description" : "altitude value",
                    "type" : "integer"
                }
            }
        },
        "latitude" : {
            "type" : "number"
        },
        "longitude" : {
            "type" : "number"
        },
        "vlanOverlappingEnabled" : {
            "type" : "boolean"
        },
        "nodeAffinityProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "venueProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "autoChannelSelection24" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "channelSelectMode" : {
                    "description" : "Channel Select Mode",
                    "type" : "string",
                    "enum" : [ "None", "BackgroundScanning", "ChannelFly" ],
                    "default" : "BackgroundScanning"
                },
                "channelFlyMtbc" : {
                    "description" : "ChannelFly MTBC",
                    "type" : "integer",
                    "default" : 480,
                    "minimum" : 100,
                    "maximum" : 1440
                }
            }
        },
        "autoChannelSelection50" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "channelSelectMode" : {
                    "description" : "Channel Select Mode",
                    "type" : "string",
                    "enum" : [ "None", "BackgroundScanning", "ChannelFly" ],
                    "default" : "BackgroundScanning"
                },
                "channelFlyMtbc" : {
                    "description" : "ChannelFly MTBC",
                    "type" : "integer",
                    "default" : 480,
                    "minimum" : 100,
                    "maximum" : 1440
                }
            }
        },
        "channelEvaluationInterval" : {
            "type" : "integer",
            "default" : 600,
            "minimum" : 60,
            "maximum" : 3600
        },
        "apMgmtVlan" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "mode" : {
                    "description" : "Vlan Mode of the zone",
                    "type" : "string",
                    "enum" : [ "KEEP", "USER_DEFINED" ],
                    "default" : "KEEP"
                },
                "id" : {
                    "description" : "Vlan id of the zone",
                    "type" : "integer",
                    "default" : "1"
                }
            }
        },
        "apLatencyInterval" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "pingEnabled" : {
                    "description" : "AP ping latency enabled",
                    "type" : "boolean",
                    "default" : true
                }
            }
        },
        "ipsecProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "ipv6TrafficFilterEnabled" : {
            "type" : "integer"
        },
        "bonjourFencingPolicyEnabled" : {
            "type" : "boolean"
        },
        "bonjourFencingPolicy" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "dhcpSiteConfig" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "siteEnabled" : {
                    "description" : "DHCP Service Enabling Status",
                    "type" : "boolean"
                },
                "dwpdEnabled" : {
                    "description" : "DHCP Service Dynamic WAN Port Detection",
                    "type" : "boolean"
                },
                "manualSelect" : {
                    "description" : "DHCP Service AP Selection Mode. This value is effective when the siteMode is EnableOnMultipleAPs.",
                    "type" : "boolean"
                },
                "siteMode" : {
                    "description" : "DHCP Service mode",
                    "type" : "string",
                    "enum" : [ "EnableOnEachAPs", "EnableOnMultipleAPs", "EnableOnHierarchicalAPs" ]
                },
                "eth0ProfileId" : {
                    "type" : "integer"
                },
                "eth1ProfileId" : {
                    "type" : "integer"
                },
                "siteAps" : {
                    "type" : "array",
                    "items" : {
                        "type" : "object",
                        "description" : "DHCP Site selected APs. The content is effective when the siteMode is EnableOnMultipleAPs.",
                        "additionalProperties" : false,
                        "properties" : {
                            "apMac" : {
                                "type" : "string"
                            },
                            "apName" : {
                                "type" : "string"
                            },
                            "apStatus" : {
                                "type" : "string",
                                "enum" : [ "Online", "Offline", "Flagged" ]
                            },
                            "apServerEnabled" : {
                                "type" : "boolean"
                            },
                            "apServerPrimary" : {
                                "type" : "boolean"
                            },
                            "apServerIp" : {
                                "type" : [ "string", "null" ]
                            },
                            "apGatewayIp" : {
                                "type" : "string"
                            },
                            "apServerType" : {
                                "type" : "string"
                            }
                        }
                    }
                },
                "siteProfileIds" : {
                    "type" : "array",
                    "items" : {
                        "type" : "string"
                    }
                }
            }
        },
        "snmpAgent" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "apSnmpEnabled" : {
                    "description" : "Enable AP SNMP",
                    "type" : "boolean"
                },
                "snmpV2Agent" : {
                    "description" : "Community List of the SNMP V2 Agent.",
                    "type" : "array",
                    "items" : {
                        "type" : "object",
                        "additionalProperties" : false,
                        "properties" : {
                            "communityName" : {
                                "description" : "name of the SNMP Community.",
                                "type" : "string"
                            },
                            "readEnabled" : {
                                "description" : "read privilege of the SNMP Coummunity",
                                "type" : "boolean"
                            },
                            "writeEnabled" : {
                                "description" : "write privilege of the SNMP Coummunity",
                                "type" : "boolean"
                            },
                            "notificationEnabled" : {
                                "description" : "notification privilege of the SNMP Coummunity",
                                "type" : "boolean"
                            },
                            "notificationType" : {
                                "description" : "type of the notification privilege",
                                "type" : "string",
                                "enum" : [ "TRAP", "INFORM" ]
                            },
                            "notificationTarget" : {
                                "description" : "Trap List of the SNMP Coummunity",
                                "type" : "array",
                                "items" : {
                                    "type" : "object",
                                    "additionalProperties" : false,
                                    "properties" : {
                                        "address" : {
                                            "description" : "address of the SNMP Trap",
                                            "type" : "string"
                                        },
                                        "port" : {
                                            "description" : "port number of the SNMP Trap",
                                            "type" : "integer",
                                            "minimum" : 1,
                                            "maximum" : 65535
                                        }
                                    },
                                    "required" : [ "address", "port" ]
                                }
                            }
                        },
                        "required" : [ "communityName" ]
                    }
                },
                "snmpV3Agent" : {
                    "description" : "User List of the SNMP V3 Agent.",
                    "type" : "array",
                    "items" : {
                        "type" : "object",
                        "additionalProperties" : false,
                        "properties" : {
                            "userName" : {
                                "description" : "name of the SNMP User.",
                                "type" : "string"
                            },
                            "authProtocol" : {
                                "description" : "authProtocol of the SNMP User.",
                                "type" : "string",
                                "enum" : [ "NONE", "MD5", "SHA" ]
                            },
                            "authPassword" : {
                                "description" : "authPassword of the SNMP User.",
                                "type" : "string",
                                "minLength" : 8
                            },
                            "privProtocol" : {
                                "description" : "privProtocol of the SNMP User.",
                                "type" : "string",
                                "enum" : [ "NONE", "DES", "AES" ]
                            },
                            "privPassword" : {
                                "description" : "privPassword of the SNMP User.",
                                "type" : "string",
                                "minLength" : 8
                            },
                            "readEnabled" : {
                                "description" : "read privilege of the SNMP User",
                                "type" : "boolean"
                            },
                            "writeEnabled" : {
                                "description" : "write privilege of the SNMP User",
                                "type" : "boolean"
                            },
                            "notificationEnabled" : {
                                "description" : "notification privilege of the SNMP User",
                                "type" : "boolean"
                            },
                            "notificationType" : {
                                "description" : "type of the notification privilege",
                                "type" : "string",
                                "enum" : [ "TRAP", "INFORM" ]
                            },
                            "notificationTarget" : {
                                "description" : "Trap List of the SNMP User",
                                "type" : "array",
                                "items" : {
                                    "type" : "object",
                                    "additionalProperties" : false,
                                    "properties" : {
                                        "address" : {
                                            "description" : "address of the SNMP Trap",
                                            "type" : "string"
                                        },
                                        "port" : {
                                            "description" : "port number of the SNMP Trap",
                                            "type" : "integer",
                                            "minimum" : 1,
                                            "maximum" : 65535
                                        }
                                    },
                                    "required" : [ "address", "port" ]
                                }
                            }
                        },
                        "required" : [ "userName" ]
                    }
                }
            }
        },
        "recoverySsid" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "recoverySsidPskKey" : {
                    "description" : "recovery ssid password",
                    "type" : "string"
                },
                "recoverySsidEnabled" : {
                    "description" : "recovery ssid enable/disable",
                    "type" : "boolean"
                }
            }
        },
        "clusterRedundancyEnabled" : {
            "type" : "boolean",
            "default" : false
        },
        "rogueApReportThreshold" : {
            "type" : "integer"
        },
        "rogueApAggressivenessMode" : {
            "type" : "integer"
        },
        "rogueApJammingDetection" : {
            "type" : "boolean",
            "default" : false
        },
        "rogueApJammingThreshold" : {
            "type" : "integer"
        },
        "directedMulticastFromWiredClientEnabled" : {
            "type" : "boolean",
            "default" : true
        },
        "directedMulticastFromWirelessClientEnabled" : {
            "type" : "boolean",
            "default" : true
        },
        "directedMulticastFromNetworkEnabled" : {
            "type" : "boolean",
            "default" : true
        },
        "healthCheckSitesEnabled" : {
            "description" : "Enabled Health Check Sites. ",
            "type" : "boolean",
            "default" : false
        },
        "healthCheckSites" : {
            "description" : "Health Check Sites.",
            "type" : "array",
            "items" : {
                "type" : "string"
            }
        },
        "ruckusGreTunnelProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "softGreTunnelProflies" : {
            "type" : "array",
            "items" : {
                "type" : [ "object", "null" ],
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "type" : "string"
                    },
                    "name" : {
                        "type" : "string"
                    },
                    "aaaAffinityEnabled" : {
                        "type" : "boolean"
                    }
                }
            }
        },
        "ipsecProfiles" : {
            "type" : "array",
            "items" : {
                "type" : [ "object", "null" ],
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "type" : "string"
                    },
                    "name" : {
                        "type" : "string"
                    }
                }
            }
        },
        "sshTunnelEncryption" : {
            "type" : "string",
            "enum" : [ "AES128", "AES256" ],
            "default" : "AES128"
        },
        "lteBandLockChannels" : {
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "simCardId" : {
                        "description" : "SIM card ID(Primary:0, Secondary:1)",
                        "type" : "integer"
                    },
                    "type" : {
                        "description" : "LTE chipset SKU type",
                        "type" : "string"
                    },
                    "channel4g" : {
                        "description" : "LTE 4G channels",
                        "type" : "string"
                    },
                    "channel3g" : {
                        "description" : "LTE 3G channels",
                        "type" : "string"
                    }
                }
            }
        },
        "apHccdEnabled" : {
            "type" : "boolean",
            "default" : false
        },
        "apHccdPersist" : {
            "type" : "boolean",
            "default" : true
        }
    },
    "required" : [ "name", "login" ]
}
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" : {
            "type" : "string"
        },
        "zoneAffinityProfileId" : {
            "description" : "Zone affinity profile of the zone",
            "type" : "string"
        },
        "enforcePriorityZoneAffinityEnable" : {
            "description" : "Enforce the priority of zone affinity",
            "type" : "boolean"
        },
        "name" : {
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 32,
            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$"
        },
        "description" : {
            "type" : [ "string", "null" ],
            "maxLength" : 64
        },
        "version" : {
            "type" : "string",
            "pattern" : "^\d+\.\d+\.\d+\.\d+\.\d+$"
        },
        "countryCode" : {
            "type" : "string"
        },
        "login" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "apLoginName" : {
                    "description" : "User name of the AP administrator",
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : "^((?!\$\()[!-_a-~]){1,64}$"
                },
                "apLoginPassword" : {
                    "description" : "Password of the AP administrator",
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : ".*(?=.{8,})(?=.*[a-zA-Z])(?=.*[0-9])(?=.*[_`~!@#$%^&*\(\)\[\]\{\}|;:'\",.\<>\/?=+-]).*"
                }
            },
            "required" : [ "apLoginName", "apLoginPassword" ]
        },
        "timezone" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "systemTimezone" : {
                    "description" : "System defined time zone, please refer to the “Overview > Time Zone” list",
                    "type" : "string"
                },
                "customizedTimezone" : {
                    "description" : "User defined time zone",
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "abbreviation" : {
                            "description" : "Time zone abbreviation",
                            "type" : "string",
                            "pattern" : "^[a-zA-Z]{3,4}$"
                        },
                        "gmtOffset" : {
                            "description" : "GMT offset",
                            "type" : "integer",
                            "minimum" : -11,
                            "maximum" : 14
                        },
                        "gmtOffsetMinute" : {
                            "description" : "GMT offset minute",
                            "type" : "integer",
                            "minimum" : 0,
                            "maximum" : 59
                        },
                        "start" : {
                            "description" : "Daylight saving time start",
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "month" : {
                                    "description" : "Month when daylight saving time begins",
                                    "type" : "integer",
                                    "enum" : [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ]
                                },
                                "week" : {
                                    "description" : "Week of the month (1 for the first week, 2 for the second week, and so on)",
                                    "type" : "integer",
                                    "enum" : [ 1, 2, 3, 4, 5 ]
                                },
                                "day" : {
                                    "description" : "Day of the week (0 for Sunday, 1 for Monday, 2 for Tuesday, and so on)",
                                    "type" : "integer",
                                    "enum" : [ 0, 1, 2, 3, 4, 5, 6 ]
                                },
                                "hour" : {
                                    "description" : "Hour of the day",
                                    "type" : "integer",
                                    "minimum" : 0,
                                    "maximum" : 23
                                }
                            },
                            "required" : [ "month", "week", "day", "hour" ]
                        },
                        "end" : {
                            "description" : "Daylight saving time end",
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "month" : {
                                    "description" : "Month when daylight saving time begins",
                                    "type" : "integer",
                                    "enum" : [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ]
                                },
                                "week" : {
                                    "description" : "Week of the month (1 for the first week, 2 for the second week, and so on)",
                                    "type" : "integer",
                                    "enum" : [ 1, 2, 3, 4, 5 ]
                                },
                                "day" : {
                                    "description" : "Day of the week (0 for Sunday, 1 for Monday, 2 for Tuesday, and so on)",
                                    "type" : "integer",
                                    "enum" : [ 0, 1, 2, 3, 4, 5, 6 ]
                                },
                                "hour" : {
                                    "description" : "Hour of the day",
                                    "type" : "integer",
                                    "minimum" : 0,
                                    "maximum" : 23
                                }
                            },
                            "required" : [ "month", "week", "day", "hour" ]
                        }
                    },
                    "required" : [ "abbreviation", "gmtOffset", "gmtOffsetMinute" ]
                }
            }
        },
        "mesh" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "ssid" : {
                    "description" : "SSID of the mesh network",
                    "type" : "string"
                },
                "passphrase" : {
                    "description" : "Passphrase for the mesh network",
                    "type" : "string"
                },
                "meshRadioIdx" : {
                    "description" : "Mesh radio index",
                    "type" : "string",
                    "enum" : [ "Radio24G", "Radio5G" ],
                    "default" : "Radio5G"
                },
                "zeroTouchStatus" : {
                    "type" : "boolean"
                }
            }
        },
        "dfsChannelEnabled" : {
            "type" : "boolean",
            "default" : false
        },
        "cbandChannelEnabled" : {
            "type" : "boolean",
            "default" : false
        },
        "cbandChannelLicenseEnabled" : {
            "type" : "boolean",
            "default" : false
        },
        "channel144Enabled" : {
            "type" : "boolean",
            "default" : false
        },
        "wifi24" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "autoCellSizing" : {
                    "description" : "Auto Cell Sizing",
                    "type" : "boolean"
                },
                "txPower" : {
                    "description" : "Transmission power",
                    "type" : "string",
                    "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
                    "default" : "Full"
                },
                "channelWidth" : {
                    "description" : "Channel width. Zero (0) means Auto.",
                    "type" : "integer",
                    "enum" : [ 0, 20, 40 ],
                    "default" : 0
                },
                "channel" : {
                    "description" : "Channel number",
                    "type" : "integer"
                },
                "channelRange" : {
                    "description" : "Channel range options",
                    "type" : "array",
                    "items" : {
                        "type" : "integer"
                    }
                }
            }
        },
        "wifi50" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "autoCellSizing" : {
                    "description" : "Auto Cell Sizing",
                    "type" : "boolean"
                },
                "txPower" : {
                    "description" : "Transmission power",
                    "type" : "string",
                    "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
                    "default" : "Full"
                },
                "channelWidth" : {
                    "description" : "Channel width. Zero (0) means Auto. 8080 means 80+80MHz",
                    "type" : "integer",
                    "enum" : [ 0, 20, 40, 80, 8080, 160 ],
                    "default" : 0
                },
                "indoorChannel" : {
                    "description" : "Channel number for Indoor AP",
                    "type" : "integer"
                },
                "outdoorChannel" : {
                    "description" : "Channel number for Outdoor AP",
                    "type" : "integer"
                },
                "indoorSecondaryChannel" : {
                    "description" : "Secondary channel number for Indoor AP (channelWidth is 80+80MHz only)",
                    "type" : "integer"
                },
                "outdoorSecondaryChannel" : {
                    "description" : "Secondary channel number for outdoor AP (channelWidth is 80+80MHz only)",
                    "type" : "integer"
                },
                "indoorChannelRange" : {
                    "description" : "Channel range options for Indoor AP",
                    "type" : "array",
                    "items" : {
                        "type" : "integer"
                    }
                },
                "outdoorChannelRange" : {
                    "description" : "Channel range options for outdoor AP",
                    "type" : "array",
                    "items" : {
                        "type" : "integer"
                    }
                }
            }
        },
        "protectionMode24" : {
            "type" : "string",
            "enum" : [ "NONE", "CTS_ONLY", "RTS_CTS" ],
            "default" : "RTS_CTS"
        },
        "syslog" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "flowLevel" : {
                    "description" : "Flow Level of the syslog",
                    "type" : "string",
                    "enum" : [ "GENERAL_LOGS", "CLIENT_FLOW", "ALL" ],
                    "default" : "GENERAL_LOGS"
                },
                "address" : {
                    "description" : "Address of the syslog server.",
                    "type" : "string"
                },
                "port" : {
                    "description" : "Port number of the syslog server",
                    "type" : "integer",
                    "default" : 514,
                    "minimum" : 1,
                    "maximum" : 65535
                },
                "protocol" : {
                    "description" : "Protocol of the syslog server",
                    "type" : "string",
                    "enum" : [ "IPPROTO_TCP", "IPPROTO_UDP" ],
                    "default" : "IPPROTO_TCP"
                },
                "secondaryAddress" : {
                    "description" : "Secondary Server Address of the syslog server",
                    "type" : "string"
                },
                "secondaryPort" : {
                    "description" : "Secondary Server Port of the syslog server",
                    "type" : "integer",
                    "default" : 514,
                    "minimum" : 1,
                    "maximum" : 65535
                },
                "secondaryProtocol" : {
                    "description" : "Secondary Server Protocol of the syslog server",
                    "type" : "string",
                    "enum" : [ "IPPROTO_TCP", "IPPROTO_UDP" ],
                    "default" : "IPPROTO_TCP"
                },
                "facility" : {
                    "description" : "Facility of the syslog server",
                    "type" : "string",
                    "enum" : [ "Keep_Original", "Local0", "Local1", "Local2", "Local3", "Local4", "Local5", "Local6", "Local7" ],
                    "default" : "Keep_Original"
                },
                "priority" : {
                    "description" : "Priority of the log messages",
                    "type" : "string",
                    "enum" : [ "Emergency", "Alert", "Critical", "Error", "Warning", "Notice", "Info", "All" ],
                    "default" : "Error"
                }
            }
        },
        "smartMonitor" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "intervalInSec" : {
                    "description" : "Interval in seconds. This is required if smartMonitor is enabled",
                    "type" : "integer",
                    "default" : 10,
                    "minimum" : 5,
                    "maximum" : 60
                },
                "retryThreshold" : {
                    "description" : "Retry threshold. This is required if smartMonitor is enabled",
                    "type" : "integer",
                    "default" : 3,
                    "minimum" : 1,
                    "maximum" : 10
                }
            }
        },
        "clientAdmissionControl24" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "maxRadioLoadPercent" : {
                    "description" : "Maximum radio load percentage.",
                    "type" : "integer",
                    "default" : 75,
                    "minimum" : 50,
                    "maximum" : 100
                },
                "minClientCount" : {
                    "description" : "Minimum client count number.",
                    "type" : "integer",
                    "default" : 10,
                    "minimum" : 0,
                    "maximum" : 100
                },
                "minClientThroughputMbps" : {
                    "description" : "Minimum client throughput in Mbps.",
                    "type" : "number",
                    "default" : 0,
                    "minimum" : 0,
                    "maximum" : 100
                }
            }
        },
        "clientAdmissionControl50" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "maxRadioLoadPercent" : {
                    "description" : "Maximum radio load percentage.",
                    "type" : "integer",
                    "default" : 75,
                    "minimum" : 50,
                    "maximum" : 100
                },
                "minClientCount" : {
                    "description" : "Minimum client count number.",
                    "type" : "integer",
                    "default" : 10,
                    "minimum" : 0,
                    "maximum" : 100
                },
                "minClientThroughputMbps" : {
                    "description" : "Minimum client throughput in Mbps.",
                    "type" : "number",
                    "default" : 0,
                    "minimum" : 0,
                    "maximum" : 100
                }
            }
        },
        "channelModeEnabled" : {
            "type" : "boolean",
            "default" : false
        },
        "tunnelType" : {
            "description" : "Tunnel type configuration of the zone. No_Tunneled is for IPv6 mode",
            "type" : "string",
            "enum" : [ "No_Tunneled", "RuckusGRE", "SoftGRE", "SoftGREIpsec" ],
            "default" : "RuckusGRE"
        },
        "tunnelProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "backgroundScanning24" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "frequencyInSec" : {
                    "description" : "Frequency in second",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 65535,
                    "default" : 20
                }
            }
        },
        "backgroundScanning50" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "frequencyInSec" : {
                    "description" : "Frequency in second",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 65535,
                    "default" : 20
                }
            }
        },
        "clientLoadBalancing24" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "adjacentRadioThreshold" : {
                    "description" : "Adjacent radio threshold",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 100
                }
            }
        },
        "clientLoadBalancing50" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "adjacentRadioThreshold" : {
                    "description" : "Adjacent radio threshold",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 100
                }
            }
        },
        "bandBalancing" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "mode" : {
                    "description" : "Band Balancing Mode: BASIC-Withholds probe and authentication responses at connetcion time in heavily loaded band to balance clients to the other band, PROACTIVE-Uses BASIC functionality and actively rebalances clients via 802.11v BTM, STRICT-Uses PROACTIVE functionality and forcefully rebalances clients via 802.11v BTM",
                    "type" : "string",
                    "enum" : [ "BASIC", "PROACTIVE", "STRICT" ],
                    "default" : "BASIC"
                },
                "wifi24Percentage" : {
                    "description" : "Percentage of client load on 2.4GHz radio band",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 100,
                    "default" : 25
                }
            }
        },
        "loadBalancingMethod" : {
            "type" : "string",
            "enum" : [ "BASED_ON_CLIENT_COUNT", "BASED_ON_CAPACITY", "OFF" ],
            "default" : "BASED_ON_CLIENT_COUNT"
        },
        "rogue" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "reportType" : {
                    "description" : "Report type",
                    "type" : "string",
                    "enum" : [ "All", "Malicious" ]
                },
                "maliciousTypes" : {
                    "description" : "Malicious type when reportType is Malicious",
                    "type" : [ "array", "null" ],
                    "items" : {
                        "type" : "string",
                        "enum" : [ "SSIDSpoofing", "SameNetwork", "MACSpoofing" ]
                    }
                },
                "protectionEnabled" : {
                    "description" : "Protection enabled",
                    "type" : "boolean"
                }
            }
        },
        "dosBarringEnable" : {
            "type" : "integer"
        },
        "dosBarringPeriod" : {
            "type" : "integer",
            "default" : 60
        },
        "dosBarringThreshold" : {
            "type" : "integer",
            "default" : 5
        },
        "dosBarringCheckPeriod" : {
            "type" : "integer",
            "default" : 30
        },
        "locationBasedService" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "apRebootTimeout" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "gatewayLossTimeoutInSec" : {
                    "description" : "Gateway loss timeout in second",
                    "type" : "integer",
                    "enum" : [ 0, 1800, 3600, 5400, 7200, 9000, 10800, 12600, 14400, 16200, 18000, 19800, 23400, 25200, 27000, 28800, 30600, 32400, 34200, 36000, 37800, 39600, 41400, 43200, 45000, 46800, 48600, 50400, 52200, 54000, 55800, 57600, 59400, 61200, 63000, 64800, 66600, 68400, 70200, 72000, 73800, 75600, 77400, 79200, 81000, 82800, 84600, 86400 ],
                    "default" : 1800
                },
                "serverLossTimeoutInSec" : {
                    "description" : "Server loss timeout in second",
                    "type" : "integer",
                    "enum" : [ 0, 7200, 14400, 21600, 28800, 36000, 43200, 50400, 57600, 64800, 72000, 79200, 86400 ],
                    "default" : 7200
                }
            }
        },
        "location" : {
            "type" : "string"
        },
        "locationAdditionalInfo" : {
            "type" : "string",
            "pattern" : "^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
        },
        "altitude" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "altitudeUnit" : {
                    "description" : "altitude unit",
                    "type" : "string",
                    "enum" : [ "meters", "floor" ],
                    "default" : "meters"
                },
                "altitudeValue" : {
                    "description" : "altitude value",
                    "type" : "integer"
                }
            }
        },
        "latitude" : {
            "type" : "number"
        },
        "longitude" : {
            "type" : "number"
        },
        "vlanOverlappingEnabled" : {
            "type" : "boolean"
        },
        "nodeAffinityProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "venueProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "autoChannelSelection24" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "channelSelectMode" : {
                    "description" : "Channel Select Mode",
                    "type" : "string",
                    "enum" : [ "None", "BackgroundScanning", "ChannelFly" ],
                    "default" : "BackgroundScanning"
                },
                "channelFlyMtbc" : {
                    "description" : "ChannelFly MTBC",
                    "type" : "integer",
                    "default" : 480,
                    "minimum" : 100,
                    "maximum" : 1440
                }
            }
        },
        "autoChannelSelection50" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "channelSelectMode" : {
                    "description" : "Channel Select Mode",
                    "type" : "string",
                    "enum" : [ "None", "BackgroundScanning", "ChannelFly" ],
                    "default" : "BackgroundScanning"
                },
                "channelFlyMtbc" : {
                    "description" : "ChannelFly MTBC",
                    "type" : "integer",
                    "default" : 480,
                    "minimum" : 100,
                    "maximum" : 1440
                }
            }
        },
        "channelEvaluationInterval" : {
            "type" : "integer",
            "default" : 600,
            "minimum" : 60,
            "maximum" : 3600
        },
        "apMgmtVlan" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "mode" : {
                    "description" : "Vlan Mode of the zone",
                    "type" : "string",
                    "enum" : [ "KEEP", "USER_DEFINED" ],
                    "default" : "KEEP"
                },
                "id" : {
                    "description" : "Vlan id of the zone",
                    "type" : "integer",
                    "default" : "1"
                }
            }
        },
        "apLatencyInterval" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "pingEnabled" : {
                    "description" : "AP ping latency enabled",
                    "type" : "boolean",
                    "default" : true
                }
            }
        },
        "ipsecProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "ipv6TrafficFilterEnabled" : {
            "type" : "integer"
        },
        "bonjourFencingPolicyEnabled" : {
            "type" : "boolean"
        },
        "bonjourFencingPolicy" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "dhcpSiteConfig" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "siteEnabled" : {
                    "description" : "DHCP Service Enabling Status",
                    "type" : "boolean"
                },
                "dwpdEnabled" : {
                    "description" : "DHCP Service Dynamic WAN Port Detection",
                    "type" : "boolean"
                },
                "manualSelect" : {
                    "description" : "DHCP Service AP Selection Mode. This value is effective when the siteMode is EnableOnMultipleAPs.",
                    "type" : "boolean"
                },
                "siteMode" : {
                    "description" : "DHCP Service mode",
                    "type" : "string",
                    "enum" : [ "EnableOnEachAPs", "EnableOnMultipleAPs", "EnableOnHierarchicalAPs" ]
                },
                "eth0ProfileId" : {
                    "type" : "integer"
                },
                "eth1ProfileId" : {
                    "type" : "integer"
                },
                "siteAps" : {
                    "type" : "array",
                    "items" : {
                        "type" : "object",
                        "description" : "DHCP Site selected APs. The content is effective when the siteMode is EnableOnMultipleAPs.",
                        "additionalProperties" : false,
                        "properties" : {
                            "apMac" : {
                                "type" : "string"
                            },
                            "apName" : {
                                "type" : "string"
                            },
                            "apStatus" : {
                                "type" : "string",
                                "enum" : [ "Online", "Offline", "Flagged" ]
                            },
                            "apServerEnabled" : {
                                "type" : "boolean"
                            },
                            "apServerPrimary" : {
                                "type" : "boolean"
                            },
                            "apServerIp" : {
                                "type" : [ "string", "null" ]
                            },
                            "apGatewayIp" : {
                                "type" : "string"
                            },
                            "apServerType" : {
                                "type" : "string"
                            }
                        }
                    }
                },
                "siteProfileIds" : {
                    "type" : "array",
                    "items" : {
                        "type" : "string"
                    }
                }
            }
        },
        "snmpAgent" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "apSnmpEnabled" : {
                    "description" : "Enable AP SNMP",
                    "type" : "boolean"
                },
                "snmpV2Agent" : {
                    "description" : "Community List of the SNMP V2 Agent.",
                    "type" : "array",
                    "items" : {
                        "type" : "object",
                        "additionalProperties" : false,
                        "properties" : {
                            "communityName" : {
                                "description" : "name of the SNMP Community.",
                                "type" : "string"
                            },
                            "readEnabled" : {
                                "description" : "read privilege of the SNMP Coummunity",
                                "type" : "boolean"
                            },
                            "writeEnabled" : {
                                "description" : "write privilege of the SNMP Coummunity",
                                "type" : "boolean"
                            },
                            "notificationEnabled" : {
                                "description" : "notification privilege of the SNMP Coummunity",
                                "type" : "boolean"
                            },
                            "notificationType" : {
                                "description" : "type of the notification privilege",
                                "type" : "string",
                                "enum" : [ "TRAP", "INFORM" ]
                            },
                            "notificationTarget" : {
                                "description" : "Trap List of the SNMP Coummunity",
                                "type" : "array",
                                "items" : {
                                    "type" : "object",
                                    "additionalProperties" : false,
                                    "properties" : {
                                        "address" : {
                                            "description" : "address of the SNMP Trap",
                                            "type" : "string"
                                        },
                                        "port" : {
                                            "description" : "port number of the SNMP Trap",
                                            "type" : "integer",
                                            "minimum" : 1,
                                            "maximum" : 65535
                                        }
                                    },
                                    "required" : [ "address", "port" ]
                                }
                            }
                        },
                        "required" : [ "communityName" ]
                    }
                },
                "snmpV3Agent" : {
                    "description" : "User List of the SNMP V3 Agent.",
                    "type" : "array",
                    "items" : {
                        "type" : "object",
                        "additionalProperties" : false,
                        "properties" : {
                            "userName" : {
                                "description" : "name of the SNMP User.",
                                "type" : "string"
                            },
                            "authProtocol" : {
                                "description" : "authProtocol of the SNMP User.",
                                "type" : "string",
                                "enum" : [ "NONE", "MD5", "SHA" ]
                            },
                            "authPassword" : {
                                "description" : "authPassword of the SNMP User.",
                                "type" : "string",
                                "minLength" : 8
                            },
                            "privProtocol" : {
                                "description" : "privProtocol of the SNMP User.",
                                "type" : "string",
                                "enum" : [ "NONE", "DES", "AES" ]
                            },
                            "privPassword" : {
                                "description" : "privPassword of the SNMP User.",
                                "type" : "string",
                                "minLength" : 8
                            },
                            "readEnabled" : {
                                "description" : "read privilege of the SNMP User",
                                "type" : "boolean"
                            },
                            "writeEnabled" : {
                                "description" : "write privilege of the SNMP User",
                                "type" : "boolean"
                            },
                            "notificationEnabled" : {
                                "description" : "notification privilege of the SNMP User",
                                "type" : "boolean"
                            },
                            "notificationType" : {
                                "description" : "type of the notification privilege",
                                "type" : "string",
                                "enum" : [ "TRAP", "INFORM" ]
                            },
                            "notificationTarget" : {
                                "description" : "Trap List of the SNMP User",
                                "type" : "array",
                                "items" : {
                                    "type" : "object",
                                    "additionalProperties" : false,
                                    "properties" : {
                                        "address" : {
                                            "description" : "address of the SNMP Trap",
                                            "type" : "string"
                                        },
                                        "port" : {
                                            "description" : "port number of the SNMP Trap",
                                            "type" : "integer",
                                            "minimum" : 1,
                                            "maximum" : 65535
                                        }
                                    },
                                    "required" : [ "address", "port" ]
                                }
                            }
                        },
                        "required" : [ "userName" ]
                    }
                }
            }
        },
        "recoverySsid" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "recoverySsidPskKey" : {
                    "description" : "recovery ssid password",
                    "type" : "string"
                },
                "recoverySsidEnabled" : {
                    "description" : "recovery ssid enable/disable",
                    "type" : "boolean"
                }
            }
        },
        "clusterRedundancyEnabled" : {
            "type" : "boolean",
            "default" : false
        },
        "rogueApReportThreshold" : {
            "type" : "integer"
        },
        "rogueApAggressivenessMode" : {
            "type" : "integer"
        },
        "rogueApJammingDetection" : {
            "type" : "boolean",
            "default" : false
        },
        "rogueApJammingThreshold" : {
            "type" : "integer"
        },
        "directedMulticastFromWiredClientEnabled" : {
            "type" : "boolean",
            "default" : true
        },
        "directedMulticastFromWirelessClientEnabled" : {
            "type" : "boolean",
            "default" : true
        },
        "directedMulticastFromNetworkEnabled" : {
            "type" : "boolean",
            "default" : true
        },
        "healthCheckSitesEnabled" : {
            "description" : "Enabled Health Check Sites. ",
            "type" : "boolean",
            "default" : false
        },
        "healthCheckSites" : {
            "description" : "Health Check Sites.",
            "type" : "array",
            "items" : {
                "type" : "string"
            }
        },
        "ruckusGreTunnelProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "softGreTunnelProflies" : {
            "type" : "array",
            "items" : {
                "type" : [ "object", "null" ],
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "type" : "string"
                    },
                    "name" : {
                        "type" : "string"
                    },
                    "aaaAffinityEnabled" : {
                        "type" : "boolean"
                    }
                }
            }
        },
        "ipsecProfiles" : {
            "type" : "array",
            "items" : {
                "type" : [ "object", "null" ],
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "type" : "string"
                    },
                    "name" : {
                        "type" : "string"
                    }
                }
            }
        },
        "sshTunnelEncryption" : {
            "type" : "string",
            "enum" : [ "AES128", "AES256" ],
            "default" : "AES128"
        },
        "lteBandLockChannels" : {
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "simCardId" : {
                        "description" : "SIM card ID(Primary:0, Secondary:1)",
                        "type" : "integer"
                    },
                    "type" : {
                        "description" : "LTE chipset SKU type",
                        "type" : "string"
                    },
                    "channel4g" : {
                        "description" : "LTE 4G channels",
                        "type" : "string"
                    },
                    "channel3g" : {
                        "description" : "LTE 3G channels",
                        "type" : "string"
                    }
                }
            }
        },
        "apHccdEnabled" : {
            "type" : "boolean",
            "default" : false
        },
        "apHccdPersist" : {
            "type" : "boolean",
            "default" : true
        }
    },
    "required" : [ "name", "login" ]
}
Response  201
HideShow
Body
{
  "id": "zoneUUID"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Modify entire zone

PUT/v8_1/rkszones/{id}

Use this API command to modify entire information of a zone.

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
{
    "additionalProperties" : false,
    "properties" : {
        "altitude" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "altitudeUnit" : {
                    "description" : "altitude unit",
                    "type" : "string",
                    "enum" : [ "meters", "floor" ]
                },
                "altitudeValue" : {
                    "description" : "altitude value",
                    "type" : "integer"
                }
            }
        },
        "apMgmtVlan" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "mode" : {
                    "description" : "Vlan Mode of the zone",
                    "type" : "string",
                    "enum" : [ "KEEP", "USER_DEFINED" ]
                },
                "id" : {
                    "description" : "Vlan id of the zone",
                    "type" : "integer"
                }
            }
        },
        "apLatencyInterval" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "pingEnabled" : {
                    "description" : "AP ping latency enabled",
                    "type" : "boolean"
                }
            }
        },
        "apRebootTimeout" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "gatewayLossTimeoutInSec" : {
                    "description" : "Gateway loss timeout in second",
                    "type" : "integer",
                    "enum" : [ 0, 1800, 3600, 5400, 7200, 9000, 10800, 12600, 14400, 16200, 18000, 19800, 23400, 25200, 27000, 28800, 30600, 32400, 34200, 36000, 37800, 39600, 41400, 43200, 45000, 46800, 48600, 50400, 52200, 54000, 55800, 57600, 59400, 61200, 63000, 64800, 66600, 68400, 70200, 72000, 73800, 75600, 77400, 79200, 81000, 82800, 84600, 86400 ]
                },
                "serverLossTimeoutInSec" : {
                    "description" : "Server loss timeout in second",
                    "type" : "integer",
                    "enum" : [ 0, 7200, 14400, 21600, 28800, 36000, 43200, 50400, 57600, 64800, 72000, 79200, 86400 ]
                }
            }
        },
        "autoChannelSelection24" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "channelSelectMode" : {
                    "description" : "Channel Select Mode",
                    "type" : "string",
                    "enum" : [ "None", "BackgroundScanning", "ChannelFly" ]
                },
                "channelFlyMtbc" : {
                    "description" : "ChannelFly MTBC",
                    "type" : "integer",
                    "minimum" : 100,
                    "maximum" : 1440
                }
            }
        },
        "autoChannelSelection50" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "channelSelectMode" : {
                    "description" : "Channel Select Mode",
                    "type" : "string",
                    "enum" : [ "None", "BackgroundScanning", "ChannelFly" ]
                },
                "channelFlyMtbc" : {
                    "description" : "ChannelFly MTBC",
                    "type" : "integer",
                    "minimum" : 100,
                    "maximum" : 1440
                }
            }
        },
        "awsVenue" : {
            "type" : "string"
        },
        "backgroundScanning24" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "frequencyInSec" : {
                    "description" : "Frequency in second",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 65535
                }
            }
        },
        "backgroundScanning50" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "frequencyInSec" : {
                    "description" : "Frequency in second",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 65535
                }
            }
        },
        "bandBalancing" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "mode" : {
                    "description" : "Band Balancing Mode: BASIC-Withholds probe and authentication responses at connetcion time in heavily loaded band to balance clients to the other band, PROACTIVE-Uses BASIC functionality and actively rebalances clients via 802.11v BTM, STRICT-Uses PROACTIVE functionality and forcefully rebalances clients via 802.11v BTM",
                    "type" : "string",
                    "enum" : [ "BASIC", "PROACTIVE", "STRICT" ]
                },
                "wifi24Percentage" : {
                    "description" : "Percentage of client load on 2.4GHz radio band",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 100
                }
            }
        },
        "loadBalancingMethod" : {
            "type" : "string",
            "enum" : [ "BASED_ON_CLIENT_COUNT", "BASED_ON_CAPACITY", "OFF" ]
        },
        "bonjourFencingPolicy" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "bonjourFencingPolicyEnabled" : {
            "type" : "boolean"
        },
        "channelEvaluationInterval" : {
            "maximum" : 3600,
            "minimum" : 60,
            "type" : "integer"
        },
        "channelModeEnabled" : {
            "type" : "boolean"
        },
        "clientAdmissionControl24" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "maxRadioLoadPercent" : {
                    "description" : "Maximum radio load percentage.",
                    "type" : "integer",
                    "minimum" : 50,
                    "maximum" : 100
                },
                "minClientCount" : {
                    "description" : "Minimum client count number.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 100
                },
                "minClientThroughputMbps" : {
                    "description" : "Minimum client throughput in Mbps.",
                    "type" : "number",
                    "minimum" : 0,
                    "maximum" : 100
                }
            }
        },
        "clientAdmissionControl50" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "maxRadioLoadPercent" : {
                    "description" : "Maximum radio load percentage.",
                    "type" : "integer",
                    "minimum" : 50,
                    "maximum" : 100
                },
                "minClientCount" : {
                    "description" : "Minimum client count number.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 100
                },
                "minClientThroughputMbps" : {
                    "description" : "Minimum client throughput in Mbps.",
                    "type" : "number",
                    "minimum" : 0,
                    "maximum" : 100
                }
            }
        },
        "clientLoadBalancing24" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "adjacentRadioThreshold" : {
                    "description" : "Adjacent radio threshold",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 100
                }
            }
        },
        "clientLoadBalancing50" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "adjacentRadioThreshold" : {
                    "description" : "Adjacent radio threshold",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 100
                }
            }
        },
        "countryCode" : {
            "type" : "string"
        },
        "description" : {
            "type" : [ "string", "null" ],
            "maxLength" : 64
        },
        "dfsChannelEnabled" : {
            "type" : "boolean"
        },
        "cbandChannelEnabled" : {
            "type" : "boolean"
        },
        "cbandChannelLicenseEnabled" : {
            "type" : "boolean"
        },
        "channel144Enabled" : {
            "type" : "boolean"
        },
        "dhcpSiteConfig" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "siteEnabled" : {
                    "description" : "DHCP Service Enabling Status",
                    "type" : "boolean"
                },
                "dwpdEnabled" : {
                    "description" : "DHCP Service Dynamic WAN Port Detection",
                    "type" : "boolean"
                },
                "manualSelect" : {
                    "description" : "DHCP Service AP Selection Mode. This value is effective when the siteMode is EnableOnMultipleAPs.",
                    "type" : "boolean"
                },
                "siteMode" : {
                    "description" : "DHCP Service mode",
                    "type" : "string",
                    "enum" : [ "EnableOnEachAPs", "EnableOnMultipleAPs", "EnableOnHierarchicalAPs" ]
                },
                "eth0ProfileId" : {
                    "type" : "integer"
                },
                "eth1ProfileId" : {
                    "type" : "integer"
                },
                "siteAps" : {
                    "type" : "array",
                    "items" : {
                        "type" : "object",
                        "description" : "DHCP Site selected APs. The content is effective when the siteMode is EnableOnMultipleAPs.",
                        "additionalProperties" : false,
                        "properties" : {
                            "apMac" : {
                                "type" : "string"
                            },
                            "apName" : {
                                "type" : "string"
                            },
                            "apStatus" : {
                                "type" : "string",
                                "enum" : [ "Online", "Offline", "Flagged" ]
                            },
                            "apServerEnabled" : {
                                "type" : "boolean"
                            },
                            "apServerPrimary" : {
                                "type" : "boolean"
                            },
                            "apServerIp" : {
                                "type" : [ "string", "null" ]
                            },
                            "apGatewayIp" : {
                                "type" : "string"
                            },
                            "apServerType" : {
                                "type" : "string"
                            }
                        }
                    }
                },
                "siteProfileIds" : {
                    "type" : "array",
                    "items" : {
                        "type" : "string"
                    }
                }
            }
        },
        "domainId" : {
            "type" : "string"
        },
        "dosBarringCheckPeriod" : {
            "type" : "integer"
        },
        "dosBarringEnable" : {
            "type" : "integer"
        },
        "dosBarringPeriod" : {
            "type" : "integer"
        },
        "dosBarringThreshold" : {
            "type" : "integer"
        },
        "ipsecProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "ipv6TrafficFilterEnabled" : {
            "type" : "integer"
        },
        "latitude" : {
            "type" : "number"
        },
        "location" : {
            "type" : "string"
        },
        "locationAdditionalInfo" : {
            "type" : "string",
            "pattern" : "^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
        },
        "locationBasedService" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "login" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "apLoginName" : {
                    "description" : "User name of the AP administrator",
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : "^((?!\$\()[!-_a-~]){1,64}$"
                },
                "apLoginPassword" : {
                    "description" : "Password of the AP administrator",
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : ".*(?=.{8,})(?=.*[a-zA-Z])(?=.*[0-9])(?=.*[_`~!@#$%^&*\(\)\[\]\{\}|;:'\",.\<>\/?=+-]).*"
                }
            },
            "required" : [ "apLoginName", "apLoginPassword" ]
        },
        "longitude" : {
            "type" : "number"
        },
        "mesh" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "ssid" : {
                    "description" : "SSID of the mesh network",
                    "type" : "string"
                },
                "passphrase" : {
                    "description" : "Passphrase for the mesh network",
                    "type" : "string"
                },
                "meshRadioIdx" : {
                    "description" : "Mesh radio index",
                    "type" : "string",
                    "enum" : [ "Radio24G", "Radio5G" ]
                },
                "zeroTouchStatus" : {
                    "type" : "boolean"
                }
            }
        },
        "name" : {
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 32,
            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$"
        },
        "nodeAffinityProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "rogue" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "reportType" : {
                    "description" : "Report type",
                    "type" : "string",
                    "enum" : [ "All", "Malicious" ]
                },
                "maliciousTypes" : {
                    "description" : "Malicious type when reportType is Malicious",
                    "type" : [ "array", "null" ],
                    "items" : {
                        "type" : "string",
                        "enum" : [ "SSIDSpoofing", "SameNetwork", "MACSpoofing" ]
                    }
                },
                "protectionEnabled" : {
                    "description" : "Protection enabled",
                    "type" : "boolean"
                }
            }
        },
        "smartMonitor" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "intervalInSec" : {
                    "description" : "Interval in seconds. This is required if smartMonitor is enabled",
                    "type" : "integer",
                    "minimum" : 5,
                    "maximum" : 60
                },
                "retryThreshold" : {
                    "description" : "Retry threshold. This is required if smartMonitor is enabled",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 10
                }
            }
        },
        "syslog" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "flowLevel" : {
                    "description" : "Flow Level of the syslog",
                    "type" : "string",
                    "enum" : [ "GENERAL_LOGS", "CLIENT_FLOW", "ALL" ]
                },
                "address" : {
                    "description" : "Address of the syslog server.",
                    "type" : "string"
                },
                "port" : {
                    "description" : "Port number of the syslog server",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 65535
                },
                "protocol" : {
                    "description" : "Protocol of the syslog server",
                    "type" : "string",
                    "enum" : [ "IPPROTO_TCP", "IPPROTO_UDP" ]
                },
                "secondaryAddress" : {
                    "description" : "Secondary Server Address of the syslog server",
                    "type" : "string"
                },
                "secondaryPort" : {
                    "description" : "Secondary Server Port of the syslog server",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 65535
                },
                "secondaryProtocol" : {
                    "description" : "Secondary Server Protocol of the syslog server",
                    "type" : "string",
                    "enum" : [ "IPPROTO_TCP", "IPPROTO_UDP" ]
                },
                "facility" : {
                    "description" : "Facility of the syslog server",
                    "type" : "string",
                    "enum" : [ "Keep_Original", "Local0", "Local1", "Local2", "Local3", "Local4", "Local5", "Local6", "Local7" ]
                },
                "priority" : {
                    "description" : "Priority of the log messages",
                    "type" : "string",
                    "enum" : [ "Emergency", "Alert", "Critical", "Error", "Warning", "Notice", "Info", "All" ]
                }
            }
        },
        "timezone" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "systemTimezone" : {
                    "description" : "System defined time zone, please refer to the “Overview > Time Zone” list",
                    "type" : "string"
                },
                "customizedTimezone" : {
                    "description" : "User defined time zone",
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "abbreviation" : {
                            "description" : "Time zone abbreviation",
                            "type" : "string",
                            "pattern" : "^[a-zA-Z]{3,4}$"
                        },
                        "gmtOffset" : {
                            "description" : "GMT offset",
                            "type" : "integer",
                            "minimum" : -11,
                            "maximum" : 14
                        },
                        "gmtOffsetMinute" : {
                            "description" : "GMT offset minute",
                            "type" : "integer",
                            "minimum" : 0,
                            "maximum" : 59
                        },
                        "start" : {
                            "description" : "Daylight saving time start",
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "month" : {
                                    "description" : "Month when daylight saving time begins",
                                    "type" : "integer",
                                    "enum" : [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ]
                                },
                                "week" : {
                                    "description" : "Week of the month (1 for the first week, 2 for the second week, and so on)",
                                    "type" : "integer",
                                    "enum" : [ 1, 2, 3, 4, 5 ]
                                },
                                "day" : {
                                    "description" : "Day of the week (0 for Sunday, 1 for Monday, 2 for Tuesday, and so on)",
                                    "type" : "integer",
                                    "enum" : [ 0, 1, 2, 3, 4, 5, 6 ]
                                },
                                "hour" : {
                                    "description" : "Hour of the day",
                                    "type" : "integer",
                                    "minimum" : 0,
                                    "maximum" : 23
                                }
                            },
                            "required" : [ "month", "week", "day", "hour" ]
                        },
                        "end" : {
                            "description" : "Daylight saving time end",
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "month" : {
                                    "description" : "Month when daylight saving time begins",
                                    "type" : "integer",
                                    "enum" : [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ]
                                },
                                "week" : {
                                    "description" : "Week of the month (1 for the first week, 2 for the second week, and so on)",
                                    "type" : "integer",
                                    "enum" : [ 1, 2, 3, 4, 5 ]
                                },
                                "day" : {
                                    "description" : "Day of the week (0 for Sunday, 1 for Monday, 2 for Tuesday, and so on)",
                                    "type" : "integer",
                                    "enum" : [ 0, 1, 2, 3, 4, 5, 6 ]
                                },
                                "hour" : {
                                    "description" : "Hour of the day",
                                    "type" : "integer",
                                    "minimum" : 0,
                                    "maximum" : 23
                                }
                            },
                            "required" : [ "month", "week", "day", "hour" ]
                        }
                    },
                    "required" : [ "abbreviation", "gmtOffset", "gmtOffsetMinute" ]
                }
            }
        },
        "tunnelProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "aaaAffinityEnabled" : {
            "type" : "boolean"
        },
        "tunnelType" : {
            "description" : "Tunnel type configuration of the zone. No_Tunneled is for IPv6 mode",
            "type" : "string",
            "enum" : [ "No_Tunneled", "RuckusGRE", "SoftGRE", "SoftGREIpsec" ]
        },
        "venueProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "vlanOverlappingEnabled" : {
            "type" : "boolean"
        },
        "wifi24" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "autoCellSizing" : {
                    "description" : "Auto Cell Sizing",
                    "type" : "boolean"
                },
                "txPower" : {
                    "description" : "Transmission power",
                    "type" : "string",
                    "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ]
                },
                "channelWidth" : {
                    "description" : "Channel width. Zero (0) means Auto.",
                    "type" : "integer",
                    "enum" : [ 0, 20, 40 ]
                },
                "channel" : {
                    "description" : "Channel number",
                    "type" : "integer"
                },
                "channelRange" : {
                    "description" : "Channel range options",
                    "type" : "array",
                    "items" : {
                        "type" : "integer"
                    }
                }
            }
        },
        "wifi50" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "autoCellSizing" : {
                    "description" : "Auto Cell Sizing",
                    "type" : "boolean"
                },
                "txPower" : {
                    "description" : "Transmission power",
                    "type" : "string",
                    "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ]
                },
                "channelWidth" : {
                    "description" : "Channel width. Zero (0) means Auto. 8080 means 80+80MHz",
                    "type" : "integer",
                    "enum" : [ 0, 20, 40, 80, 8080, 160 ]
                },
                "indoorChannel" : {
                    "description" : "Channel number for Indoor AP",
                    "type" : "integer"
                },
                "outdoorChannel" : {
                    "description" : "Channel number for Outdoor AP",
                    "type" : "integer"
                },
                "indoorSecondaryChannel" : {
                    "description" : "Secondary channel number for Indoor AP (channelWidth is 80+80MHz only)",
                    "type" : "integer"
                },
                "outdoorSecondaryChannel" : {
                    "description" : "Secondary channel number for outdoor AP (channelWidth is 80+80MHz only)",
                    "type" : "integer"
                },
                "indoorChannelRange" : {
                    "description" : "Channel range options for Indoor AP",
                    "type" : "array",
                    "items" : {
                        "type" : "integer"
                    }
                },
                "outdoorChannelRange" : {
                    "description" : "Channel range options for outdoor AP",
                    "type" : "array",
                    "items" : {
                        "type" : "integer"
                    }
                }
            }
        },
        "protectionMode24" : {
            "type" : "string",
            "enum" : [ "NONE", "CTS_ONLY", "RTS_CTS" ]
        },
        "zoneAffinityProfileId" : {
            "type" : "string"
        },
        "snmpAgent" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "apSnmpEnabled" : {
                    "description" : "Enable AP SNMP",
                    "type" : "boolean"
                },
                "snmpV2Agent" : {
                    "description" : "Community List of the SNMP V2 Agent.",
                    "type" : "array",
                    "items" : {
                        "type" : "object",
                        "additionalProperties" : false,
                        "properties" : {
                            "communityName" : {
                                "description" : "name of the SNMP Community.",
                                "type" : "string"
                            },
                            "readEnabled" : {
                                "description" : "read privilege of the SNMP Coummunity",
                                "type" : "boolean"
                            },
                            "writeEnabled" : {
                                "description" : "write privilege of the SNMP Coummunity",
                                "type" : "boolean"
                            },
                            "notificationEnabled" : {
                                "description" : "notification privilege of the SNMP Coummunity",
                                "type" : "boolean"
                            },
                            "notificationType" : {
                                "description" : "type of the notification privilege",
                                "type" : "string",
                                "enum" : [ "TRAP", "INFORM" ]
                            },
                            "notificationTarget" : {
                                "description" : "Trap List of the SNMP Coummunity",
                                "type" : "array",
                                "items" : {
                                    "type" : "object",
                                    "additionalProperties" : false,
                                    "properties" : {
                                        "address" : {
                                            "description" : "address of the SNMP Trap",
                                            "type" : "string"
                                        },
                                        "port" : {
                                            "description" : "port number of the SNMP Trap",
                                            "type" : "integer",
                                            "minimum" : 1,
                                            "maximum" : 65535
                                        }
                                    },
                                    "required" : [ "address", "port" ]
                                }
                            }
                        },
                        "required" : [ "communityName" ]
                    }
                },
                "snmpV3Agent" : {
                    "description" : "User List of the SNMP V3 Agent.",
                    "type" : "array",
                    "items" : {
                        "type" : "object",
                        "additionalProperties" : false,
                        "properties" : {
                            "userName" : {
                                "description" : "name of the SNMP User.",
                                "type" : "string"
                            },
                            "authProtocol" : {
                                "description" : "authProtocol of the SNMP User.",
                                "type" : "string",
                                "enum" : [ "NONE", "MD5", "SHA" ]
                            },
                            "authPassword" : {
                                "description" : "authPassword of the SNMP User.",
                                "type" : "string",
                                "minLength" : 8
                            },
                            "privProtocol" : {
                                "description" : "privProtocol of the SNMP User.",
                                "type" : "string",
                                "enum" : [ "NONE", "DES", "AES" ]
                            },
                            "privPassword" : {
                                "description" : "privPassword of the SNMP User.",
                                "type" : "string",
                                "minLength" : 8
                            },
                            "readEnabled" : {
                                "description" : "read privilege of the SNMP User",
                                "type" : "boolean"
                            },
                            "writeEnabled" : {
                                "description" : "write privilege of the SNMP User",
                                "type" : "boolean"
                            },
                            "notificationEnabled" : {
                                "description" : "notification privilege of the SNMP User",
                                "type" : "boolean"
                            },
                            "notificationType" : {
                                "description" : "type of the notification privilege",
                                "type" : "string",
                                "enum" : [ "TRAP", "INFORM" ]
                            },
                            "notificationTarget" : {
                                "description" : "Trap List of the SNMP User",
                                "type" : "array",
                                "items" : {
                                    "type" : "object",
                                    "additionalProperties" : false,
                                    "properties" : {
                                        "address" : {
                                            "description" : "address of the SNMP Trap",
                                            "type" : "string"
                                        },
                                        "port" : {
                                            "description" : "port number of the SNMP Trap",
                                            "type" : "integer",
                                            "minimum" : 1,
                                            "maximum" : 65535
                                        }
                                    },
                                    "required" : [ "address", "port" ]
                                }
                            }
                        },
                        "required" : [ "userName" ]
                    }
                }
            }
        },
        "recoverySsid" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "recoverySsidPskKey" : {
                    "description" : "recovery ssid password",
                    "type" : "string"
                },
                "recoverySsidEnabled" : {
                    "description" : "recovery ssid enable/disable",
                    "type" : "boolean"
                }
            }
        },
        "clusterRedundancyEnabled" : {
            "type" : "boolean"
        },
        "rogueApReportThreshold" : {
            "type" : "integer"
        },
        "rogueApAggressivenessMode" : {
            "type" : "integer"
        },
        "rogueApJammingDetection" : {
            "type" : "boolean"
        },
        "rogueApJammingThreshold" : {
            "type" : "integer"
        },
        "directedMulticastFromWiredClientEnabled" : {
            "type" : "boolean"
        },
        "directedMulticastFromWirelessClientEnabled" : {
            "type" : "boolean"
        },
        "directedMulticastFromNetworkEnabled" : {
            "type" : "boolean"
        },
        "healthCheckSitesEnabled" : {
            "description" : "Enabled Health Check Sites. ",
            "type" : "boolean"
        },
        "healthCheckSites" : {
            "description" : "Health Check Sites.",
            "type" : "array",
            "items" : {
                "type" : "string"
            }
        },
        "ruckusGreTunnelProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "softGreTunnelProflies" : {
            "type" : "array",
            "items" : {
                "type" : [ "object", "null" ],
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "type" : "string"
                    },
                    "name" : {
                        "type" : "string"
                    },
                    "aaaAffinityEnabled" : {
                        "type" : "boolean"
                    }
                }
            }
        },
        "ipsecProfiles" : {
            "type" : "array",
            "items" : {
                "type" : [ "object", "null" ],
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "type" : "string"
                    },
                    "name" : {
                        "type" : "string"
                    }
                }
            }
        },
        "sshTunnelEncryption" : {
            "type" : "string",
            "enum" : [ "AES128", "AES256" ]
        },
        "lteBandLockChannels" : {
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "simCardId" : {
                        "description" : "SIM card ID(Primary:0, Secondary:1)",
                        "type" : "integer"
                    },
                    "type" : {
                        "description" : "LTE chipset SKU type",
                        "type" : "string"
                    },
                    "channel4g" : {
                        "description" : "LTE 4G channels",
                        "type" : "string"
                    },
                    "channel3g" : {
                        "description" : "LTE 3G channels",
                        "type" : "string"
                    }
                }
            }
        },
        "apHccdEnabled" : {
            "type" : "boolean"
        },
        "apHccdPersist" : {
            "type" : "boolean"
        }
    },
    "type" : "object"
}
Response  204

Retrieve Mesh Configuration

GET/v8_1/rkszones/{id}/mesh

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

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

Delete IPsec Profiles

DELETE/v8_1/rkszones/{id}/softGreTunnelProflies

Use this API command to Delete IPsec profiles.

Response  204

Delete IPsec Profiles

DELETE/v8_1/rkszones/{id}/ipsecProfiles

Use this API command to Delete IPsec profiles.

Response  204

Retrieve AP Model

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

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

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

Modify AP Model

PUT/v8_1/rkszones/{zoneId}/apmodel/{model}

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

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

Retrieve AP Model Common Attribute

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

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

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

Retrieve AP Firmware List

GET/v8_1/rkszones/{zoneId}/apFirmware

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

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

Change AP Firmware

PUT/v8_1/rkszones/{zoneId}/apFirmware

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

Request
HideShow
Body
{
  "firmwareVersion": "3.4.0.101.25"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "firmwareVersion": {
      "description": "new version of the AP firmare",
      "type": "string"
    }
  }
}
Response  204

Get Available GRE Tunnel Profiles.

GET/v8_1/rkszones/{zoneId}/availableTunnelProfiles

Get available GRE tunnel profiles of this Zone.

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

Get available IPSec Tunnel Profiles.

GET/v8_1/rkszones/{zoneId}/availableIpsecProfiles

Get available IPSec tunnel profiles of this Zone.

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

Retrieve

GET/v8_1/rkszones/{id}

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

Response  200
HideShow
Body
{
  "id": "ad5ffab1-b3ed-4b36-b054-bc723a977dbb",
  "domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
  "name": "public-api-zone-ipv6",
  "description": null,
  "countryCode": "US",
  "version": "3.1.0.0.55",
  "timezone": {
    "systemTimezone": "UTC",
    "customizedTimezone": null
  },
  "ipMode": "IPV6",
  "login": {
    "apLoginName": "admin",
    "apLoginPassword": "admin!234"
  },
  "mesh": {
    "ssid": "meshSSID",
    "passphrase": "passphrase"
  },
  "dfsChannelEnabled": false,
  "cbandChannelEnabled": false,
  "cbandChannelLicenseEnabled": false,
  "channel144Enabled": false,
  "wifi24": {
    "txPower": "Full",
    "channelWidth": 20,
    "channel": 0,
    "channelRange": [
      1,
      2,
      3,
      4,
      5,
      6,
      7,
      8,
      9,
      10,
      11
    ],
    "availableChannelRange": [
      1,
      2,
      3,
      4,
      5,
      6,
      7,
      8,
      9,
      10,
      11
    ]
  },
  "wifi50": {
    "txPower": "-1dB",
    "channelWidth": 40,
    "indoorChannel": 0,
    "outdoorChannel": 0,
    "indoorChannelRange": [
      36,
      40,
      44,
      48,
      149,
      153,
      157,
      161
    ],
    "outdoorChannelRange": [
      149,
      153,
      157,
      161
    ],
    "availableIndoorChannelRange": [
      36,
      40,
      44,
      48,
      149,
      153,
      157,
      161
    ],
    "availableOutdoorChannelRange": [
      149,
      153,
      157,
      161
    ]
  },
  "protectionMode24": "CTS_ONLY",
  "syslog": null,
  "smartMonitor": null,
  "clientAdmissionControl24": null,
  "clientAdmissionControl50": null,
  "channelModeEnabled": false,
  "tunnelType": "No_Tunneled",
  "tunnelProfile": null,
  "backgroundScanning24": null,
  "backgroundScanning50": null,
  "clientLoadBalancing24": null,
  "clientLoadBalancing50": null,
  "bandBalancing": null,
  "loadBalancingMethod": null,
  "rogue": null,
  "dosBarringEnable": 0,
  "dosBarringPeriod": 60,
  "dosBarringThreshold": 5,
  "dosBarringCheckPeriod": 30,
  "locationBasedService": null,
  "apRebootTimeout": {
    "gatewayLossTimeoutInSec": 1800,
    "serverLossTimeoutInSec": 7200
  },
  "location": null,
  "locationAdditionalInfo": null,
  "latitude": null,
  "longitude": null,
  "vlanOverlappingEnabled": false,
  "nodeAffinityProfile": null,
  "venueProfile": null,
  "autoChannelSelection24": {
    "channelSelectMode": "ChannelFly",
    "channelFlyMtbc": 480
  },
  "autoChannelSelection50": {
    "channelSelectMode": "BackgroundScanning",
    "channelFlyMtbc": 480
  },
  "channelEvaluationInterval": 777,
  "apMgmtVlan": {
    "id": 1,
    "mode": "KEEP"
  },
  "ipsecProfile": {
    "id": "ipsecProfileId",
    "name": "ipsecProfileName"
  },
  "bonjourFencingPolicyEnabled": true,
  "bonjourFencingPolicy": {
    "id": "bonjourFencingPolicyId",
    "name": "bonjourFencingPolicyName"
  },
  "recoverySsid": {
    "recoverySsidEnabled": true
  },
  "dhcpSiteConfig": {
    "zoneName": "zoneK",
    "siteEnabled": true,
    "dwpdEnabled": false,
    "manualSelect": true,
    "siteMode": "EnableOnMultipleAPs",
    "siteAps": [
      {
        "apMac": "38:FF:36:00:0E:10",
        "apServerEnabled": true,
        "apServerPrimary": true
      },
      {
        "apMac": "58:FF:36:00:0E:20",
        "apServerEnabled": true,
        "apServerPrimary": true
      }
    ],
    "siteProfileIds": [
      "75e26590-547f-11e6-9ca7-5a095364c13c",
      "869bb532-547f-11e6-9ca7-5a095364c13c"
    ]
  },
  "snmpAgent": {
    "apSnmpEnabled": true,
    "snmpV2Agent": [
      {
        "communityName": "v2Agent",
        "notificationEnabled": true,
        "readEnabled": true,
        "writeEnabled": true,
        "notificationType": "TRAP",
        "notificationTarget": [
          {
            "address": "172.19.16.20",
            "port": 161
          }
        ]
      }
    ],
    "snmpV3Agent": [
      {
        "userName": "v3Agent",
        "authProtocol": "MD5",
        "authPassword": "admin!234",
        "privProtocol": "DES",
        "privPassword": "admin!234",
        "notificationEnabled": true,
        "readEnabled": true,
        "writeEnabled": true,
        "notificationType": "TRAP",
        "notificationTarget": [
          {
            "address": "172.19.16.20",
            "port": 161
          }
        ]
      }
    ]
  },
  "rogueApReportThreshold": 40,
  "rogueApAggressivenessMode": 2,
  "rogueApJammingDetection": true,
  "rogueApJammingThreshold": 40,
  "directedMulticastFromWiredClientEnabled": true,
  "directedMulticastFromWirelessClientEnabled": true,
  "directedMulticastFromNetworkEnabled": false,
  "healthCheckSitesEnabled": true,
  "healthCheckSites": [
    "www.google.com",
    "www.live.com:443",
    "www.github.com:443",
    "source.codeaurora.org:443",
    "www.wikipedia.com"
  ],
  "ruckusGreTunnelProfile": {
    "id": "f5b92938-aa4e-4d02-90ea-273799ff689b",
    "name": "Default Tunnel Profile"
  },
  "softGreTunnelProflies": [
    {
      "id": "5a2e41b0-df53-11e7-98e1-08002748d78e",
      "name": "softGre1",
      "aaaAffinityEnabled": true
    },
    {
      "id": "7803e411-df53-11e7-98e1-08002748d78e",
      "name": "softGre2",
      "aaaAffinityEnabled": true
    }
  ],
  "ipsecProfiles": [
    {
      "id": "3fd9aa91-df65-11e7-98e1-08002748d78e",
      "name": "ipsec1"
    }
  ],
  "ipsecTunnelMode": "SOFT_GRE",
  "sshTunnelEncryption": "AES128",
  "apHccdEnabled": true,
  "apHccdPersist": true
}
Schema
{
    "additionalProperties" : false,
    "properties" : {
        "altitude" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "altitudeUnit" : {
                    "description" : "altitude unit",
                    "type" : "string",
                    "enum" : [ "meters", "floor" ],
                    "default" : "meters"
                },
                "altitudeValue" : {
                    "description" : "altitude value",
                    "type" : "integer"
                }
            }
        },
        "apMgmtVlan" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "mode" : {
                    "description" : "Vlan Mode of the zone",
                    "type" : "string",
                    "enum" : [ "KEEP", "USER_DEFINED" ],
                    "default" : "KEEP"
                },
                "id" : {
                    "description" : "Vlan id of the zone",
                    "type" : "integer",
                    "default" : "1"
                }
            }
        },
        "apLatencyInterval" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "pingEnabled" : {
                    "description" : "AP ping latency enabled",
                    "type" : "boolean",
                    "default" : true
                }
            }
        },
        "apRebootTimeout" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "gatewayLossTimeoutInSec" : {
                    "description" : "Gateway loss timeout in second",
                    "type" : "integer",
                    "enum" : [ 0, 1800, 3600, 5400, 7200, 9000, 10800, 12600, 14400, 16200, 18000, 19800, 23400, 25200, 27000, 28800, 30600, 32400, 34200, 36000, 37800, 39600, 41400, 43200, 45000, 46800, 48600, 50400, 52200, 54000, 55800, 57600, 59400, 61200, 63000, 64800, 66600, 68400, 70200, 72000, 73800, 75600, 77400, 79200, 81000, 82800, 84600, 86400 ],
                    "default" : 1800
                },
                "serverLossTimeoutInSec" : {
                    "description" : "Server loss timeout in second",
                    "type" : "integer",
                    "enum" : [ 0, 7200, 14400, 21600, 28800, 36000, 43200, 50400, 57600, 64800, 72000, 79200, 86400 ],
                    "default" : 7200
                }
            }
        },
        "autoChannelSelection24" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "channelSelectMode" : {
                    "description" : "Channel Select Mode",
                    "type" : "string",
                    "enum" : [ "None", "BackgroundScanning", "ChannelFly" ],
                    "default" : "BackgroundScanning"
                },
                "channelFlyMtbc" : {
                    "description" : "ChannelFly MTBC",
                    "type" : "integer",
                    "default" : 480,
                    "minimum" : 100,
                    "maximum" : 1440
                }
            }
        },
        "autoChannelSelection50" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "channelSelectMode" : {
                    "description" : "Channel Select Mode",
                    "type" : "string",
                    "enum" : [ "None", "BackgroundScanning", "ChannelFly" ],
                    "default" : "BackgroundScanning"
                },
                "channelFlyMtbc" : {
                    "description" : "ChannelFly MTBC",
                    "type" : "integer",
                    "default" : 480,
                    "minimum" : 100,
                    "maximum" : 1440
                }
            }
        },
        "awsVenue" : {
            "type" : "string"
        },
        "backgroundScanning24" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "frequencyInSec" : {
                    "description" : "Frequency in second",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 65535,
                    "default" : 20
                }
            }
        },
        "backgroundScanning50" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "frequencyInSec" : {
                    "description" : "Frequency in second",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 65535,
                    "default" : 20
                }
            }
        },
        "bandBalancing" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "mode" : {
                    "description" : "Band Balancing Mode: BASIC-Withholds probe and authentication responses at connetcion time in heavily loaded band to balance clients to the other band, PROACTIVE-Uses BASIC functionality and actively rebalances clients via 802.11v BTM, STRICT-Uses PROACTIVE functionality and forcefully rebalances clients via 802.11v BTM",
                    "type" : "string",
                    "enum" : [ "BASIC", "PROACTIVE", "STRICT" ],
                    "default" : "BASIC"
                },
                "wifi24Percentage" : {
                    "description" : "Percentage of client load on 2.4GHz radio band",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 100,
                    "default" : 25
                }
            }
        },
        "loadBalancingMethod" : {
            "type" : "string",
            "enum" : [ "BASED_ON_CLIENT_COUNT", "BASED_ON_CAPACITY", "OFF" ],
            "default" : "BASED_ON_CLIENT_COUNT"
        },
        "bonjourFencingPolicy" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "bonjourFencingPolicyEnabled" : {
            "type" : "boolean"
        },
        "channelEvaluationInterval" : {
            "default" : 600,
            "maximum" : 3600,
            "minimum" : 60,
            "type" : "integer"
        },
        "channelModeEnabled" : {
            "type" : "boolean"
        },
        "clientAdmissionControl24" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "maxRadioLoadPercent" : {
                    "description" : "Maximum radio load percentage.",
                    "type" : "integer",
                    "default" : 75,
                    "minimum" : 50,
                    "maximum" : 100
                },
                "minClientCount" : {
                    "description" : "Minimum client count number.",
                    "type" : "integer",
                    "default" : 10,
                    "minimum" : 0,
                    "maximum" : 100
                },
                "minClientThroughputMbps" : {
                    "description" : "Minimum client throughput in Mbps.",
                    "type" : "number",
                    "default" : 0,
                    "minimum" : 0,
                    "maximum" : 100
                }
            }
        },
        "clientAdmissionControl50" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "maxRadioLoadPercent" : {
                    "description" : "Maximum radio load percentage.",
                    "type" : "integer",
                    "default" : 75,
                    "minimum" : 50,
                    "maximum" : 100
                },
                "minClientCount" : {
                    "description" : "Minimum client count number.",
                    "type" : "integer",
                    "default" : 10,
                    "minimum" : 0,
                    "maximum" : 100
                },
                "minClientThroughputMbps" : {
                    "description" : "Minimum client throughput in Mbps.",
                    "type" : "number",
                    "default" : 0,
                    "minimum" : 0,
                    "maximum" : 100
                }
            }
        },
        "clientLoadBalancing24" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "adjacentRadioThreshold" : {
                    "description" : "Adjacent radio threshold",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 100
                }
            }
        },
        "clientLoadBalancing50" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "adjacentRadioThreshold" : {
                    "description" : "Adjacent radio threshold",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 100
                }
            }
        },
        "countryCode" : {
            "type" : "string"
        },
        "description" : {
            "type" : [ "string", "null" ],
            "maxLength" : 64
        },
        "dfsChannelEnabled" : {
            "type" : "boolean"
        },
        "cbandChannelEnabled" : {
            "type" : "boolean"
        },
        "cbandChannelLicenseEnabled" : {
            "type" : "boolean"
        },
        "channel144Enabled" : {
            "type" : "boolean"
        },
        "dhcpSiteConfig" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "siteEnabled" : {
                    "description" : "DHCP Service Enabling Status",
                    "type" : "boolean"
                },
                "dwpdEnabled" : {
                    "description" : "DHCP Service Dynamic WAN Port Detection",
                    "type" : "boolean"
                },
                "manualSelect" : {
                    "description" : "DHCP Service AP Selection Mode. This value is effective when the siteMode is EnableOnMultipleAPs.",
                    "type" : "boolean"
                },
                "siteMode" : {
                    "description" : "DHCP Service mode",
                    "type" : "string",
                    "enum" : [ "EnableOnEachAPs", "EnableOnMultipleAPs", "EnableOnHierarchicalAPs" ]
                },
                "eth0ProfileId" : {
                    "type" : "integer"
                },
                "eth1ProfileId" : {
                    "type" : "integer"
                },
                "siteAps" : {
                    "type" : "array",
                    "items" : {
                        "type" : "object",
                        "description" : "DHCP Site selected APs. The content is effective when the siteMode is EnableOnMultipleAPs.",
                        "additionalProperties" : false,
                        "properties" : {
                            "apMac" : {
                                "type" : "string"
                            },
                            "apName" : {
                                "type" : "string"
                            },
                            "apStatus" : {
                                "type" : "string",
                                "enum" : [ "Online", "Offline", "Flagged" ]
                            },
                            "apServerEnabled" : {
                                "type" : "boolean"
                            },
                            "apServerPrimary" : {
                                "type" : "boolean"
                            },
                            "apServerIp" : {
                                "type" : [ "string", "null" ]
                            },
                            "apGatewayIp" : {
                                "type" : "string"
                            },
                            "apServerType" : {
                                "type" : "string"
                            }
                        }
                    }
                },
                "siteProfileIds" : {
                    "type" : "array",
                    "items" : {
                        "type" : "string"
                    }
                }
            }
        },
        "domainId" : {
            "type" : "string"
        },
        "dosBarringCheckPeriod" : {
            "type" : "integer"
        },
        "dosBarringEnable" : {
            "type" : "integer"
        },
        "dosBarringPeriod" : {
            "type" : "integer"
        },
        "dosBarringThreshold" : {
            "type" : "integer"
        },
        "id" : {
            "type" : "string"
        },
        "ipMode" : {
            "type" : "string",
            "enum" : [ "IPV4", "IPV6", "IPV4_IPV6" ]
        },
        "ipsecProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "ipv6TrafficFilterEnabled" : {
            "type" : "integer"
        },
        "latitude" : {
            "type" : "number"
        },
        "location" : {
            "type" : "string"
        },
        "locationAdditionalInfo" : {
            "type" : "string",
            "pattern" : "^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
        },
        "locationBasedService" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "login" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "apLoginName" : {
                    "description" : "User name of the AP administrator",
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : "^((?!\$\()[!-_a-~]){1,64}$"
                },
                "apLoginPassword" : {
                    "description" : "Password of the AP administrator",
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : ".*(?=.{8,})(?=.*[a-zA-Z])(?=.*[0-9])(?=.*[_`~!@#$%^&*\(\)\[\]\{\}|;:'\",.\<>\/?=+-]).*"
                }
            },
            "required" : [ "apLoginName", "apLoginPassword" ]
        },
        "longitude" : {
            "type" : "number"
        },
        "mesh" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "ssid" : {
                    "description" : "SSID of the mesh network",
                    "type" : "string"
                },
                "passphrase" : {
                    "description" : "Passphrase for the mesh network",
                    "type" : "string"
                },
                "meshRadioIdx" : {
                    "description" : "Mesh radio index",
                    "type" : "string",
                    "enum" : [ "Radio24G", "Radio5G" ],
                    "default" : "Radio5G"
                },
                "zeroTouchStatus" : {
                    "type" : "boolean"
                }
            }
        },
        "name" : {
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 32,
            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$"
        },
        "nodeAffinityProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "rogue" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "reportType" : {
                    "description" : "Report type",
                    "type" : "string",
                    "enum" : [ "All", "Malicious" ]
                },
                "maliciousTypes" : {
                    "description" : "Malicious type when reportType is Malicious",
                    "type" : [ "array", "null" ],
                    "items" : {
                        "type" : "string",
                        "enum" : [ "SSIDSpoofing", "SameNetwork", "MACSpoofing" ]
                    }
                },
                "protectionEnabled" : {
                    "description" : "Protection enabled",
                    "type" : "boolean"
                }
            }
        },
        "smartMonitor" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "intervalInSec" : {
                    "description" : "Interval in seconds. This is required if smartMonitor is enabled",
                    "type" : "integer",
                    "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
                }
            }
        },
        "syslog" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "flowLevel" : {
                    "description" : "Flow Level of the syslog",
                    "type" : "string",
                    "enum" : [ "GENERAL_LOGS", "CLIENT_FLOW", "ALL" ],
                    "default" : "GENERAL_LOGS"
                },
                "address" : {
                    "description" : "Address of the syslog server.",
                    "type" : "string"
                },
                "port" : {
                    "description" : "Port number of the syslog server",
                    "type" : "integer",
                    "default" : 514,
                    "minimum" : 1,
                    "maximum" : 65535
                },
                "protocol" : {
                    "description" : "Protocol of the syslog server",
                    "type" : "string",
                    "enum" : [ "IPPROTO_TCP", "IPPROTO_UDP" ],
                    "default" : "IPPROTO_TCP"
                },
                "secondaryAddress" : {
                    "description" : "Secondary Server Address of the syslog server",
                    "type" : "string"
                },
                "secondaryPort" : {
                    "description" : "Secondary Server Port of the syslog server",
                    "type" : "integer",
                    "default" : 514,
                    "minimum" : 1,
                    "maximum" : 65535
                },
                "secondaryProtocol" : {
                    "description" : "Secondary Server Protocol of the syslog server",
                    "type" : "string",
                    "enum" : [ "IPPROTO_TCP", "IPPROTO_UDP" ],
                    "default" : "IPPROTO_TCP"
                },
                "facility" : {
                    "description" : "Facility of the syslog server",
                    "type" : "string",
                    "enum" : [ "Keep_Original", "Local0", "Local1", "Local2", "Local3", "Local4", "Local5", "Local6", "Local7" ],
                    "default" : "Keep_Original"
                },
                "priority" : {
                    "description" : "Priority of the log messages",
                    "type" : "string",
                    "enum" : [ "Emergency", "Alert", "Critical", "Error", "Warning", "Notice", "Info", "All" ],
                    "default" : "Error"
                }
            }
        },
        "timezone" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "systemTimezone" : {
                    "description" : "System defined time zone, please refer to the “Overview > Time Zone” list",
                    "type" : "string"
                },
                "customizedTimezone" : {
                    "description" : "User defined time zone",
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "abbreviation" : {
                            "description" : "Time zone abbreviation",
                            "type" : "string",
                            "pattern" : "^[a-zA-Z]{3,4}$"
                        },
                        "gmtOffset" : {
                            "description" : "GMT offset",
                            "type" : "integer",
                            "minimum" : -11,
                            "maximum" : 14
                        },
                        "gmtOffsetMinute" : {
                            "description" : "GMT offset minute",
                            "type" : "integer",
                            "minimum" : 0,
                            "maximum" : 59
                        },
                        "start" : {
                            "description" : "Daylight saving time start",
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "month" : {
                                    "description" : "Month when daylight saving time begins",
                                    "type" : "integer",
                                    "enum" : [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ]
                                },
                                "week" : {
                                    "description" : "Week of the month (1 for the first week, 2 for the second week, and so on)",
                                    "type" : "integer",
                                    "enum" : [ 1, 2, 3, 4, 5 ]
                                },
                                "day" : {
                                    "description" : "Day of the week (0 for Sunday, 1 for Monday, 2 for Tuesday, and so on)",
                                    "type" : "integer",
                                    "enum" : [ 0, 1, 2, 3, 4, 5, 6 ]
                                },
                                "hour" : {
                                    "description" : "Hour of the day",
                                    "type" : "integer",
                                    "minimum" : 0,
                                    "maximum" : 23
                                }
                            },
                            "required" : [ "month", "week", "day", "hour" ]
                        },
                        "end" : {
                            "description" : "Daylight saving time end",
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "month" : {
                                    "description" : "Month when daylight saving time begins",
                                    "type" : "integer",
                                    "enum" : [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ]
                                },
                                "week" : {
                                    "description" : "Week of the month (1 for the first week, 2 for the second week, and so on)",
                                    "type" : "integer",
                                    "enum" : [ 1, 2, 3, 4, 5 ]
                                },
                                "day" : {
                                    "description" : "Day of the week (0 for Sunday, 1 for Monday, 2 for Tuesday, and so on)",
                                    "type" : "integer",
                                    "enum" : [ 0, 1, 2, 3, 4, 5, 6 ]
                                },
                                "hour" : {
                                    "description" : "Hour of the day",
                                    "type" : "integer",
                                    "minimum" : 0,
                                    "maximum" : 23
                                }
                            },
                            "required" : [ "month", "week", "day", "hour" ]
                        }
                    },
                    "required" : [ "abbreviation", "gmtOffset", "gmtOffsetMinute" ]
                }
            }
        },
        "tunnelProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "aaaAffinityEnabled" : {
            "type" : "boolean"
        },
        "tunnelType" : {
            "description" : "Tunnel type configuration of the zone. No_Tunneled is for IPv6 mode",
            "type" : "string",
            "enum" : [ "No_Tunneled", "RuckusGRE", "SoftGRE", "SoftGREIpsec" ],
            "default" : "RuckusGRE"
        },
        "venueProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "version" : {
            "type" : "string",
            "pattern" : "^\d+\.\d+\.\d+\.\d+\.\d+$"
        },
        "vlanOverlappingEnabled" : {
            "type" : "boolean"
        },
        "wifi24" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "autoCellSizing" : {
                    "description" : "Auto Cell Sizing",
                    "type" : "boolean"
                },
                "txPower" : {
                    "description" : "Transmission power",
                    "type" : "string",
                    "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
                    "default" : "Full"
                },
                "channelWidth" : {
                    "description" : "Channel width. Zero (0) means Auto.",
                    "type" : "integer",
                    "enum" : [ 0, 20, 40 ]
                },
                "channel" : {
                    "description" : "Channel number",
                    "type" : "integer"
                },
                "channelRange" : {
                    "description" : "Channel range options",
                    "type" : "array",
                    "items" : {
                        "type" : "integer"
                    }
                },
                "availableChannelRange" : {
                    "description" : "Available channel range options",
                    "type" : "array",
                    "items" : {
                        "type" : "integer"
                    }
                }
            }
        },
        "wifi50" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "autoCellSizing" : {
                    "description" : "Auto Cell Sizing",
                    "type" : "boolean"
                },
                "txPower" : {
                    "description" : "Transmission power",
                    "type" : "string",
                    "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
                    "default" : "Full"
                },
                "channelWidth" : {
                    "description" : "Channel width. Zero (0) means Auto. 8080 means 80+80MHz",
                    "type" : "integer",
                    "enum" : [ 0, 20, 40, 80, 8080, 160 ]
                },
                "indoorChannel" : {
                    "description" : "Channel number for Indoor AP",
                    "type" : "integer"
                },
                "outdoorChannel" : {
                    "description" : "Channel number for Outdoor AP",
                    "type" : "integer"
                },
                "indoorSecondaryChannel" : {
                    "description" : "Secondary channel number for Indoor AP (channelWidth is 80+80MHz only)",
                    "type" : "integer"
                },
                "outdoorSecondaryChannel" : {
                    "description" : "Secondary channel number for outdoor AP (channelWidth is 80+80MHz only)",
                    "type" : "integer"
                },
                "indoorChannelRange" : {
                    "description" : "Channel range options for Indoor AP",
                    "type" : "array",
                    "items" : {
                        "type" : "integer"
                    }
                },
                "outdoorChannelRange" : {
                    "description" : "Channel range options for outdoor AP",
                    "type" : "array",
                    "items" : {
                        "type" : "integer"
                    }
                },
                "availableIndoorChannelRange" : {
                    "description" : "Available channel range options",
                    "type" : "array",
                    "items" : {
                        "type" : "integer"
                    }
                },
                "availableOutdoorChannelRange" : {
                    "description" : "Available channel range options",
                    "type" : "array",
                    "items" : {
                        "type" : "integer"
                    }
                }
            }
        },
        "protectionMode24" : {
            "type" : "string",
            "enum" : [ "NONE", "CTS_ONLY", "RTS_CTS" ],
            "default" : "RTS_CTS"
        },
        "zoneAffinityProfileId" : {
            "type" : "string"
        },
        "snmpAgent" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "apSnmpEnabled" : {
                    "description" : "Enable AP SNMP",
                    "type" : "boolean"
                },
                "snmpV2Agent" : {
                    "description" : "Community List of the SNMP V2 Agent.",
                    "type" : "array",
                    "items" : {
                        "type" : "object",
                        "additionalProperties" : false,
                        "properties" : {
                            "communityName" : {
                                "description" : "name of the SNMP Community.",
                                "type" : "string"
                            },
                            "readEnabled" : {
                                "description" : "read privilege of the SNMP Coummunity",
                                "type" : "boolean"
                            },
                            "writeEnabled" : {
                                "description" : "write privilege of the SNMP Coummunity",
                                "type" : "boolean"
                            },
                            "notificationEnabled" : {
                                "description" : "notification privilege of the SNMP Coummunity",
                                "type" : "boolean"
                            },
                            "notificationType" : {
                                "description" : "type of the notification privilege",
                                "type" : "string",
                                "enum" : [ "TRAP", "INFORM" ]
                            },
                            "notificationTarget" : {
                                "description" : "Trap List of the SNMP Coummunity",
                                "type" : "array",
                                "items" : {
                                    "type" : "object",
                                    "additionalProperties" : false,
                                    "properties" : {
                                        "address" : {
                                            "description" : "address of the SNMP Trap",
                                            "type" : "string"
                                        },
                                        "port" : {
                                            "description" : "port number of the SNMP Trap",
                                            "type" : "integer",
                                            "minimum" : 1,
                                            "maximum" : 65535
                                        }
                                    },
                                    "required" : [ "address", "port" ]
                                }
                            }
                        },
                        "required" : [ "communityName" ]
                    }
                },
                "snmpV3Agent" : {
                    "description" : "User List of the SNMP V3 Agent.",
                    "type" : "array",
                    "items" : {
                        "type" : "object",
                        "additionalProperties" : false,
                        "properties" : {
                            "userName" : {
                                "description" : "name of the SNMP User.",
                                "type" : "string"
                            },
                            "authProtocol" : {
                                "description" : "authProtocol of the SNMP User.",
                                "type" : "string",
                                "enum" : [ "NONE", "MD5", "SHA" ]
                            },
                            "authPassword" : {
                                "description" : "authPassword of the SNMP User.",
                                "type" : "string",
                                "minLength" : 8
                            },
                            "privProtocol" : {
                                "description" : "privProtocol of the SNMP User.",
                                "type" : "string",
                                "enum" : [ "NONE", "DES", "AES" ]
                            },
                            "privPassword" : {
                                "description" : "privPassword of the SNMP User.",
                                "type" : "string",
                                "minLength" : 8
                            },
                            "readEnabled" : {
                                "description" : "read privilege of the SNMP User",
                                "type" : "boolean"
                            },
                            "writeEnabled" : {
                                "description" : "write privilege of the SNMP User",
                                "type" : "boolean"
                            },
                            "notificationEnabled" : {
                                "description" : "notification privilege of the SNMP User",
                                "type" : "boolean"
                            },
                            "notificationType" : {
                                "description" : "type of the notification privilege",
                                "type" : "string",
                                "enum" : [ "TRAP", "INFORM" ]
                            },
                            "notificationTarget" : {
                                "description" : "Trap List of the SNMP User",
                                "type" : "array",
                                "items" : {
                                    "type" : "object",
                                    "additionalProperties" : false,
                                    "properties" : {
                                        "address" : {
                                            "description" : "address of the SNMP Trap",
                                            "type" : "string"
                                        },
                                        "port" : {
                                            "description" : "port number of the SNMP Trap",
                                            "type" : "integer",
                                            "minimum" : 1,
                                            "maximum" : 65535
                                        }
                                    },
                                    "required" : [ "address", "port" ]
                                }
                            }
                        },
                        "required" : [ "userName" ]
                    }
                }
            }
        },
        "recoverySsid" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "recoverySsidPskKey" : {
                    "description" : "recovery ssid password",
                    "type" : "string"
                },
                "recoverySsidEnabled" : {
                    "description" : "recovery ssid enable/disable",
                    "type" : "boolean"
                }
            }
        },
        "clusterRedundancyEnabled" : {
            "type" : "boolean"
        },
        "rogueApReportThreshold" : {
            "type" : "integer"
        },
        "rogueApAggressivenessMode" : {
            "type" : "integer"
        },
        "rogueApJammingDetection" : {
            "type" : "boolean"
        },
        "rogueApJammingThreshold" : {
            "type" : "integer"
        },
        "directedMulticastFromWiredClientEnabled" : {
            "type" : "boolean"
        },
        "directedMulticastFromWirelessClientEnabled" : {
            "type" : "boolean"
        },
        "directedMulticastFromNetworkEnabled" : {
            "type" : "boolean"
        },
        "healthCheckSitesEnabled" : {
            "description" : "Enabled Health Check Sites. ",
            "type" : "boolean",
            "default" : false
        },
        "healthCheckSites" : {
            "description" : "Health Check Sites.",
            "type" : "array",
            "items" : {
                "type" : "string"
            }
        },
        "ruckusGreTunnelProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "softGreTunnelProflies" : {
            "type" : "array",
            "items" : {
                "type" : [ "object", "null" ],
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "type" : "string"
                    },
                    "name" : {
                        "type" : "string"
                    },
                    "aaaAffinityEnabled" : {
                        "type" : "boolean"
                    }
                }
            }
        },
        "ipsecProfiles" : {
            "type" : "array",
            "items" : {
                "type" : [ "object", "null" ],
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "type" : "string"
                    },
                    "name" : {
                        "type" : "string"
                    }
                }
            }
        },
        "sshTunnelEncryption" : {
            "type" : "string",
            "enum" : [ "AES128", "AES256" ]
        },
        "lteBandLockChannels" : {
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "simCardId" : {
                        "description" : "SIM card ID(Primary:0, Secondary:1)",
                        "type" : "integer"
                    },
                    "type" : {
                        "description" : "LTE chipset SKU type",
                        "type" : "string"
                    },
                    "channel4g" : {
                        "description" : "LTE 4G channels",
                        "type" : "string"
                    },
                    "channel3g" : {
                        "description" : "LTE 3G channels",
                        "type" : "string"
                    }
                }
            }
        },
        "apHccdEnabled" : {
            "type" : "boolean",
            "default" : false
        },
        "apHccdPersist" : {
            "type" : "boolean",
            "default" : true
        }
    },
    "type" : "object"
}

Modify Mesh Configuration

PATCH/v8_1/rkszones/{id}/mesh

Use this API command to enable mesh networking or update the mesh configuration.

Request
HideShow
Body
{
  "ssid": "meshSSID",
  "passphrase": "passphrase"
}
Schema
{
  "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"
    }
  }
}
Response  204

Modify

PATCH/v8_1/rkszones/{id}

Use this API command to modify the basic information of a zone.

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
{
    "additionalProperties" : false,
    "properties" : {
        "altitude" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "altitudeUnit" : {
                    "description" : "altitude unit",
                    "type" : "string",
                    "enum" : [ "meters", "floor" ]
                },
                "altitudeValue" : {
                    "description" : "altitude value",
                    "type" : "integer"
                }
            }
        },
        "apMgmtVlan" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "mode" : {
                    "description" : "Vlan Mode of the zone",
                    "type" : "string",
                    "enum" : [ "KEEP", "USER_DEFINED" ]
                },
                "id" : {
                    "description" : "Vlan id of the zone",
                    "type" : "integer"
                }
            }
        },
        "apLatencyInterval" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "pingEnabled" : {
                    "description" : "AP ping latency enabled",
                    "type" : "boolean"
                }
            }
        },
        "apRebootTimeout" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "gatewayLossTimeoutInSec" : {
                    "description" : "Gateway loss timeout in second",
                    "type" : "integer",
                    "enum" : [ 0, 1800, 3600, 5400, 7200, 9000, 10800, 12600, 14400, 16200, 18000, 19800, 23400, 25200, 27000, 28800, 30600, 32400, 34200, 36000, 37800, 39600, 41400, 43200, 45000, 46800, 48600, 50400, 52200, 54000, 55800, 57600, 59400, 61200, 63000, 64800, 66600, 68400, 70200, 72000, 73800, 75600, 77400, 79200, 81000, 82800, 84600, 86400 ]
                },
                "serverLossTimeoutInSec" : {
                    "description" : "Server loss timeout in second",
                    "type" : "integer",
                    "enum" : [ 0, 7200, 14400, 21600, 28800, 36000, 43200, 50400, 57600, 64800, 72000, 79200, 86400 ]
                }
            }
        },
        "autoChannelSelection24" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "channelSelectMode" : {
                    "description" : "Channel Select Mode",
                    "type" : "string",
                    "enum" : [ "None", "BackgroundScanning", "ChannelFly" ]
                },
                "channelFlyMtbc" : {
                    "description" : "ChannelFly MTBC",
                    "type" : "integer",
                    "minimum" : 100,
                    "maximum" : 1440
                }
            }
        },
        "autoChannelSelection50" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "channelSelectMode" : {
                    "description" : "Channel Select Mode",
                    "type" : "string",
                    "enum" : [ "None", "BackgroundScanning", "ChannelFly" ]
                },
                "channelFlyMtbc" : {
                    "description" : "ChannelFly MTBC",
                    "type" : "integer",
                    "minimum" : 100,
                    "maximum" : 1440
                }
            }
        },
        "awsVenue" : {
            "type" : "string"
        },
        "backgroundScanning24" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "frequencyInSec" : {
                    "description" : "Frequency in second",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 65535
                }
            }
        },
        "backgroundScanning50" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "frequencyInSec" : {
                    "description" : "Frequency in second",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 65535
                }
            }
        },
        "bandBalancing" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "mode" : {
                    "description" : "Band Balancing Mode: BASIC-Withholds probe and authentication responses at connetcion time in heavily loaded band to balance clients to the other band, PROACTIVE-Uses BASIC functionality and actively rebalances clients via 802.11v BTM, STRICT-Uses PROACTIVE functionality and forcefully rebalances clients via 802.11v BTM",
                    "type" : "string",
                    "enum" : [ "BASIC", "PROACTIVE", "STRICT" ]
                },
                "wifi24Percentage" : {
                    "description" : "Percentage of client load on 2.4GHz radio band",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 100
                }
            }
        },
        "loadBalancingMethod" : {
            "type" : "string",
            "enum" : [ "BASED_ON_CLIENT_COUNT", "BASED_ON_CAPACITY", "OFF" ]
        },
        "bonjourFencingPolicy" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "bonjourFencingPolicyEnabled" : {
            "type" : "boolean"
        },
        "channelEvaluationInterval" : {
            "maximum" : 3600,
            "minimum" : 60,
            "type" : "integer"
        },
        "channelModeEnabled" : {
            "type" : "boolean"
        },
        "clientAdmissionControl24" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "maxRadioLoadPercent" : {
                    "description" : "Maximum radio load percentage.",
                    "type" : "integer",
                    "minimum" : 50,
                    "maximum" : 100
                },
                "minClientCount" : {
                    "description" : "Minimum client count number.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 100
                },
                "minClientThroughputMbps" : {
                    "description" : "Minimum client throughput in Mbps.",
                    "type" : "number",
                    "minimum" : 0,
                    "maximum" : 100
                }
            }
        },
        "clientAdmissionControl50" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "maxRadioLoadPercent" : {
                    "description" : "Maximum radio load percentage.",
                    "type" : "integer",
                    "minimum" : 50,
                    "maximum" : 100
                },
                "minClientCount" : {
                    "description" : "Minimum client count number.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 100
                },
                "minClientThroughputMbps" : {
                    "description" : "Minimum client throughput in Mbps.",
                    "type" : "number",
                    "minimum" : 0,
                    "maximum" : 100
                }
            }
        },
        "clientLoadBalancing24" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "adjacentRadioThreshold" : {
                    "description" : "Adjacent radio threshold",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 100
                }
            }
        },
        "clientLoadBalancing50" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "adjacentRadioThreshold" : {
                    "description" : "Adjacent radio threshold",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 100
                }
            }
        },
        "countryCode" : {
            "type" : "string"
        },
        "description" : {
            "type" : [ "string", "null" ],
            "maxLength" : 64
        },
        "dfsChannelEnabled" : {
            "type" : "boolean"
        },
        "cbandChannelEnabled" : {
            "type" : "boolean"
        },
        "cbandChannelLicenseEnabled" : {
            "type" : "boolean"
        },
        "channel144Enabled" : {
            "type" : "boolean"
        },
        "dhcpSiteConfig" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "siteEnabled" : {
                    "description" : "DHCP Service Enabling Status",
                    "type" : "boolean"
                },
                "dwpdEnabled" : {
                    "description" : "DHCP Service Dynamic WAN Port Detection",
                    "type" : "boolean"
                },
                "manualSelect" : {
                    "description" : "DHCP Service AP Selection Mode. This value is effective when the siteMode is EnableOnMultipleAPs.",
                    "type" : "boolean"
                },
                "siteMode" : {
                    "description" : "DHCP Service mode",
                    "type" : "string",
                    "enum" : [ "EnableOnEachAPs", "EnableOnMultipleAPs", "EnableOnHierarchicalAPs" ]
                },
                "eth0ProfileId" : {
                    "type" : "integer"
                },
                "eth1ProfileId" : {
                    "type" : "integer"
                },
                "siteAps" : {
                    "type" : "array",
                    "items" : {
                        "type" : "object",
                        "description" : "DHCP Site selected APs. The content is effective when the siteMode is EnableOnMultipleAPs.",
                        "additionalProperties" : false,
                        "properties" : {
                            "apMac" : {
                                "type" : "string"
                            },
                            "apName" : {
                                "type" : "string"
                            },
                            "apStatus" : {
                                "type" : "string",
                                "enum" : [ "Online", "Offline", "Flagged" ]
                            },
                            "apServerEnabled" : {
                                "type" : "boolean"
                            },
                            "apServerPrimary" : {
                                "type" : "boolean"
                            },
                            "apServerIp" : {
                                "type" : [ "string", "null" ]
                            },
                            "apGatewayIp" : {
                                "type" : "string"
                            },
                            "apServerType" : {
                                "type" : "string"
                            }
                        }
                    }
                },
                "siteProfileIds" : {
                    "type" : "array",
                    "items" : {
                        "type" : "string"
                    }
                }
            }
        },
        "domainId" : {
            "type" : "string"
        },
        "dosBarringCheckPeriod" : {
            "type" : "integer"
        },
        "dosBarringEnable" : {
            "type" : "integer"
        },
        "dosBarringPeriod" : {
            "type" : "integer"
        },
        "dosBarringThreshold" : {
            "type" : "integer"
        },
        "ipsecProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "ipv6TrafficFilterEnabled" : {
            "type" : "integer"
        },
        "latitude" : {
            "type" : "number"
        },
        "location" : {
            "type" : "string"
        },
        "locationAdditionalInfo" : {
            "type" : "string",
            "pattern" : "^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
        },
        "locationBasedService" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "login" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "apLoginName" : {
                    "description" : "User name of the AP administrator",
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : "^((?!\$\()[!-_a-~]){1,64}$"
                },
                "apLoginPassword" : {
                    "description" : "Password of the AP administrator",
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : ".*(?=.{8,})(?=.*[a-zA-Z])(?=.*[0-9])(?=.*[_`~!@#$%^&*\(\)\[\]\{\}|;:'\",.\<>\/?=+-]).*"
                }
            },
            "required" : [ "apLoginName", "apLoginPassword" ]
        },
        "longitude" : {
            "type" : "number"
        },
        "mesh" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "ssid" : {
                    "description" : "SSID of the mesh network",
                    "type" : "string"
                },
                "passphrase" : {
                    "description" : "Passphrase for the mesh network",
                    "type" : "string"
                },
                "meshRadioIdx" : {
                    "description" : "Mesh radio index",
                    "type" : "string",
                    "enum" : [ "Radio24G", "Radio5G" ]
                },
                "zeroTouchStatus" : {
                    "type" : "boolean"
                }
            }
        },
        "name" : {
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 32,
            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$"
        },
        "nodeAffinityProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "rogue" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "reportType" : {
                    "description" : "Report type",
                    "type" : "string",
                    "enum" : [ "All", "Malicious" ]
                },
                "maliciousTypes" : {
                    "description" : "Malicious type when reportType is Malicious",
                    "type" : [ "array", "null" ],
                    "items" : {
                        "type" : "string",
                        "enum" : [ "SSIDSpoofing", "SameNetwork", "MACSpoofing" ]
                    }
                },
                "protectionEnabled" : {
                    "description" : "Protection enabled",
                    "type" : "boolean"
                }
            }
        },
        "smartMonitor" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "intervalInSec" : {
                    "description" : "Interval in seconds. This is required if smartMonitor is enabled",
                    "type" : "integer",
                    "minimum" : 5,
                    "maximum" : 60
                },
                "retryThreshold" : {
                    "description" : "Retry threshold. This is required if smartMonitor is enabled",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 10
                }
            }
        },
        "syslog" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "flowLevel" : {
                    "description" : "Flow Level of the syslog",
                    "type" : "string",
                    "enum" : [ "GENERAL_LOGS", "CLIENT_FLOW", "ALL" ]
                },
                "address" : {
                    "description" : "Address of the syslog server.",
                    "type" : "string"
                },
                "port" : {
                    "description" : "Port number of the syslog server",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 65535
                },
                "protocol" : {
                    "description" : "Protocol of the syslog server",
                    "type" : "string",
                    "enum" : [ "IPPROTO_TCP", "IPPROTO_UDP" ]
                },
                "secondaryAddress" : {
                    "description" : "Secondary Server Address of the syslog server",
                    "type" : "string"
                },
                "secondaryPort" : {
                    "description" : "Secondary Server Port of the syslog server",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 65535
                },
                "secondaryProtocol" : {
                    "description" : "Secondary Server Protocol of the syslog server",
                    "type" : "string",
                    "enum" : [ "IPPROTO_TCP", "IPPROTO_UDP" ]
                },
                "facility" : {
                    "description" : "Facility of the syslog server",
                    "type" : "string",
                    "enum" : [ "Keep_Original", "Local0", "Local1", "Local2", "Local3", "Local4", "Local5", "Local6", "Local7" ]
                },
                "priority" : {
                    "description" : "Priority of the log messages",
                    "type" : "string",
                    "enum" : [ "Emergency", "Alert", "Critical", "Error", "Warning", "Notice", "Info", "All" ]
                }
            }
        },
        "timezone" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "systemTimezone" : {
                    "description" : "System defined time zone, please refer to the “Overview > Time Zone” list",
                    "type" : "string"
                },
                "customizedTimezone" : {
                    "description" : "User defined time zone",
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "abbreviation" : {
                            "description" : "Time zone abbreviation",
                            "type" : "string",
                            "pattern" : "^[a-zA-Z]{3,4}$"
                        },
                        "gmtOffset" : {
                            "description" : "GMT offset",
                            "type" : "integer",
                            "minimum" : -11,
                            "maximum" : 14
                        },
                        "gmtOffsetMinute" : {
                            "description" : "GMT offset minute",
                            "type" : "integer",
                            "minimum" : 0,
                            "maximum" : 59
                        },
                        "start" : {
                            "description" : "Daylight saving time start",
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "month" : {
                                    "description" : "Month when daylight saving time begins",
                                    "type" : "integer",
                                    "enum" : [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ]
                                },
                                "week" : {
                                    "description" : "Week of the month (1 for the first week, 2 for the second week, and so on)",
                                    "type" : "integer",
                                    "enum" : [ 1, 2, 3, 4, 5 ]
                                },
                                "day" : {
                                    "description" : "Day of the week (0 for Sunday, 1 for Monday, 2 for Tuesday, and so on)",
                                    "type" : "integer",
                                    "enum" : [ 0, 1, 2, 3, 4, 5, 6 ]
                                },
                                "hour" : {
                                    "description" : "Hour of the day",
                                    "type" : "integer",
                                    "minimum" : 0,
                                    "maximum" : 23
                                }
                            },
                            "required" : [ "month", "week", "day", "hour" ]
                        },
                        "end" : {
                            "description" : "Daylight saving time end",
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "month" : {
                                    "description" : "Month when daylight saving time begins",
                                    "type" : "integer",
                                    "enum" : [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ]
                                },
                                "week" : {
                                    "description" : "Week of the month (1 for the first week, 2 for the second week, and so on)",
                                    "type" : "integer",
                                    "enum" : [ 1, 2, 3, 4, 5 ]
                                },
                                "day" : {
                                    "description" : "Day of the week (0 for Sunday, 1 for Monday, 2 for Tuesday, and so on)",
                                    "type" : "integer",
                                    "enum" : [ 0, 1, 2, 3, 4, 5, 6 ]
                                },
                                "hour" : {
                                    "description" : "Hour of the day",
                                    "type" : "integer",
                                    "minimum" : 0,
                                    "maximum" : 23
                                }
                            },
                            "required" : [ "month", "week", "day", "hour" ]
                        }
                    },
                    "required" : [ "abbreviation", "gmtOffset", "gmtOffsetMinute" ]
                }
            }
        },
        "tunnelProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "aaaAffinityEnabled" : {
            "type" : "boolean"
        },
        "tunnelType" : {
            "description" : "Tunnel type configuration of the zone. No_Tunneled is for IPv6 mode",
            "type" : "string",
            "enum" : [ "No_Tunneled", "RuckusGRE", "SoftGRE", "SoftGREIpsec" ]
        },
        "venueProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "vlanOverlappingEnabled" : {
            "type" : "boolean"
        },
        "wifi24" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "autoCellSizing" : {
                    "description" : "Auto Cell Sizing",
                    "type" : "boolean"
                },
                "txPower" : {
                    "description" : "Transmission power",
                    "type" : "string",
                    "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ]
                },
                "channelWidth" : {
                    "description" : "Channel width. Zero (0) means Auto.",
                    "type" : "integer",
                    "enum" : [ 0, 20, 40 ]
                },
                "channel" : {
                    "description" : "Channel number",
                    "type" : "integer"
                },
                "channelRange" : {
                    "description" : "Channel range options",
                    "type" : "array",
                    "items" : {
                        "type" : "integer"
                    }
                }
            }
        },
        "wifi50" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "autoCellSizing" : {
                    "description" : "Auto Cell Sizing",
                    "type" : "boolean"
                },
                "txPower" : {
                    "description" : "Transmission power",
                    "type" : "string",
                    "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ]
                },
                "channelWidth" : {
                    "description" : "Channel width. Zero (0) means Auto. 8080 means 80+80MHz",
                    "type" : "integer",
                    "enum" : [ 0, 20, 40, 80, 8080, 160 ]
                },
                "indoorChannel" : {
                    "description" : "Channel number for Indoor AP",
                    "type" : "integer"
                },
                "outdoorChannel" : {
                    "description" : "Channel number for Outdoor AP",
                    "type" : "integer"
                },
                "indoorSecondaryChannel" : {
                    "description" : "Secondary channel number for Indoor AP (channelWidth is 80+80MHz only)",
                    "type" : "integer"
                },
                "outdoorSecondaryChannel" : {
                    "description" : "Secondary channel number for outdoor AP (channelWidth is 80+80MHz only)",
                    "type" : "integer"
                },
                "indoorChannelRange" : {
                    "description" : "Channel range options for Indoor AP",
                    "type" : "array",
                    "items" : {
                        "type" : "integer"
                    }
                },
                "outdoorChannelRange" : {
                    "description" : "Channel range options for outdoor AP",
                    "type" : "array",
                    "items" : {
                        "type" : "integer"
                    }
                }
            }
        },
        "protectionMode24" : {
            "type" : "string",
            "enum" : [ "NONE", "CTS_ONLY", "RTS_CTS" ]
        },
        "zoneAffinityProfileId" : {
            "type" : "string"
        },
        "snmpAgent" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "apSnmpEnabled" : {
                    "description" : "Enable AP SNMP",
                    "type" : "boolean"
                },
                "snmpV2Agent" : {
                    "description" : "Community List of the SNMP V2 Agent.",
                    "type" : "array",
                    "items" : {
                        "type" : "object",
                        "additionalProperties" : false,
                        "properties" : {
                            "communityName" : {
                                "description" : "name of the SNMP Community.",
                                "type" : "string"
                            },
                            "readEnabled" : {
                                "description" : "read privilege of the SNMP Coummunity",
                                "type" : "boolean"
                            },
                            "writeEnabled" : {
                                "description" : "write privilege of the SNMP Coummunity",
                                "type" : "boolean"
                            },
                            "notificationEnabled" : {
                                "description" : "notification privilege of the SNMP Coummunity",
                                "type" : "boolean"
                            },
                            "notificationType" : {
                                "description" : "type of the notification privilege",
                                "type" : "string",
                                "enum" : [ "TRAP", "INFORM" ]
                            },
                            "notificationTarget" : {
                                "description" : "Trap List of the SNMP Coummunity",
                                "type" : "array",
                                "items" : {
                                    "type" : "object",
                                    "additionalProperties" : false,
                                    "properties" : {
                                        "address" : {
                                            "description" : "address of the SNMP Trap",
                                            "type" : "string"
                                        },
                                        "port" : {
                                            "description" : "port number of the SNMP Trap",
                                            "type" : "integer",
                                            "minimum" : 1,
                                            "maximum" : 65535
                                        }
                                    },
                                    "required" : [ "address", "port" ]
                                }
                            }
                        },
                        "required" : [ "communityName" ]
                    }
                },
                "snmpV3Agent" : {
                    "description" : "User List of the SNMP V3 Agent.",
                    "type" : "array",
                    "items" : {
                        "type" : "object",
                        "additionalProperties" : false,
                        "properties" : {
                            "userName" : {
                                "description" : "name of the SNMP User.",
                                "type" : "string"
                            },
                            "authProtocol" : {
                                "description" : "authProtocol of the SNMP User.",
                                "type" : "string",
                                "enum" : [ "NONE", "MD5", "SHA" ]
                            },
                            "authPassword" : {
                                "description" : "authPassword of the SNMP User.",
                                "type" : "string",
                                "minLength" : 8
                            },
                            "privProtocol" : {
                                "description" : "privProtocol of the SNMP User.",
                                "type" : "string",
                                "enum" : [ "NONE", "DES", "AES" ]
                            },
                            "privPassword" : {
                                "description" : "privPassword of the SNMP User.",
                                "type" : "string",
                                "minLength" : 8
                            },
                            "readEnabled" : {
                                "description" : "read privilege of the SNMP User",
                                "type" : "boolean"
                            },
                            "writeEnabled" : {
                                "description" : "write privilege of the SNMP User",
                                "type" : "boolean"
                            },
                            "notificationEnabled" : {
                                "description" : "notification privilege of the SNMP User",
                                "type" : "boolean"
                            },
                            "notificationType" : {
                                "description" : "type of the notification privilege",
                                "type" : "string",
                                "enum" : [ "TRAP", "INFORM" ]
                            },
                            "notificationTarget" : {
                                "description" : "Trap List of the SNMP User",
                                "type" : "array",
                                "items" : {
                                    "type" : "object",
                                    "additionalProperties" : false,
                                    "properties" : {
                                        "address" : {
                                            "description" : "address of the SNMP Trap",
                                            "type" : "string"
                                        },
                                        "port" : {
                                            "description" : "port number of the SNMP Trap",
                                            "type" : "integer",
                                            "minimum" : 1,
                                            "maximum" : 65535
                                        }
                                    },
                                    "required" : [ "address", "port" ]
                                }
                            }
                        },
                        "required" : [ "userName" ]
                    }
                }
            }
        },
        "recoverySsid" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "recoverySsidPskKey" : {
                    "description" : "recovery ssid password",
                    "type" : "string"
                },
                "recoverySsidEnabled" : {
                    "description" : "recovery ssid enable/disable",
                    "type" : "boolean"
                }
            }
        },
        "clusterRedundancyEnabled" : {
            "type" : "boolean"
        },
        "rogueApReportThreshold" : {
            "type" : "integer"
        },
        "rogueApAggressivenessMode" : {
            "type" : "integer"
        },
        "rogueApJammingDetection" : {
            "type" : "boolean"
        },
        "rogueApJammingThreshold" : {
            "type" : "integer"
        },
        "directedMulticastFromWiredClientEnabled" : {
            "type" : "boolean"
        },
        "directedMulticastFromWirelessClientEnabled" : {
            "type" : "boolean"
        },
        "directedMulticastFromNetworkEnabled" : {
            "type" : "boolean"
        },
        "healthCheckSitesEnabled" : {
            "description" : "Enabled Health Check Sites. ",
            "type" : "boolean"
        },
        "healthCheckSites" : {
            "description" : "Health Check Sites.",
            "type" : "array",
            "items" : {
                "type" : "string"
            }
        },
        "ruckusGreTunnelProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "softGreTunnelProflies" : {
            "type" : "array",
            "items" : {
                "type" : [ "object", "null" ],
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "type" : "string"
                    },
                    "name" : {
                        "type" : "string"
                    },
                    "aaaAffinityEnabled" : {
                        "type" : "boolean"
                    }
                }
            }
        },
        "ipsecProfiles" : {
            "type" : "array",
            "items" : {
                "type" : [ "object", "null" ],
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "type" : "string"
                    },
                    "name" : {
                        "type" : "string"
                    }
                }
            }
        },
        "sshTunnelEncryption" : {
            "type" : "string",
            "enum" : [ "AES128", "AES256" ]
        },
        "lteBandLockChannels" : {
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "simCardId" : {
                        "description" : "SIM card ID(Primary:0, Secondary:1)",
                        "type" : "integer"
                    },
                    "type" : {
                        "description" : "LTE chipset SKU type",
                        "type" : "string"
                    },
                    "channel4g" : {
                        "description" : "LTE 4G channels",
                        "type" : "string"
                    },
                    "channel3g" : {
                        "description" : "LTE 3G channels",
                        "type" : "string"
                    }
                }
            }
        },
        "apHccdEnabled" : {
            "type" : "boolean"
        },
        "apHccdPersist" : {
            "type" : "boolean"
        }
    },
    "type" : "object"
}
Response  204

Modify Time Zone

PATCH/v8_1/rkszones/{id}/timezone

Use this API command to modify the time zone of a zone.

Request
HideShow
Body
‧ Sample : systemTimezone sample1
{
    "systemTimezone" : "America/Whitehorse"
}
‧ Sample : systemTimezone sample2
{
    "systemTimezone" : "PRC"
}
‧ Sample : customizedTimezone sample
{
    "customizedTimezone" : {
        "abbreviation" : "ABC",
        "gmtOffset" : 4,
        "gmtOffsetMinute" : 10
    }
}
Schema
{
    "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" ]
        }
    }
}
Response  204

Modify AP Logon

PATCH/v8_1/rkszones/{id}/login

Use this API command to modify the AP logon information for APs that belong to a zone.

Request
HideShow
Body
{
  "apLoginName": "admin",
  "apLoginPassword": "admin!234"
}
Schema
{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "apLoginName" : {
            "description" : "User name of the AP administrator",
            "type" : "string",
            "maxLength" : 64,
            "pattern" : "^((?!\$\()[!-_a-~]){1,64}$"
        },
        "apLoginPassword" : {
            "description" : "Password of the AP administrator",
            "type" : "string",
            "maxLength" : 64,
            "pattern" : ".*(?=.{8,})(?=.*[a-zA-Z])(?=.*[0-9])(?=.*[_`~!@#$%^&*\(\)\[\]\{\}|;:'\",.\<>\/?=+-]).*"
        }
    },
    "required" : [ "apLoginName", "apLoginPassword" ]
}
Response  204

Modify Radio 2.4G

PATCH/v8_1/rkszones/{id}/wifi24

Use this API command to modify the 2.4GHz radio configuration for APs that belong to a zone.

Request
HideShow
Body
{
  "txPower": "Full",
  "channelWidth": 20,
  "channel": 0,
  "channelRange": [
    1,
    2,
    3,
    4,
    5,
    6,
    7,
    8,
    9,
    10,
    11
  ]
}
Schema
{
  "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"
      }
    }
  }
}
Response  204

Modify Radio 5G

PATCH/v8_1/rkszones/{id}/wifi50

Use this API command to modify the 5GHz radio configuration for APs that belong to a zone.

Request
HideShow
Body
{
  "txPower": "-1dB",
  "channelWidth": 40,
  "indoorChannel": 0,
  "outdoorChannel": 0,
  "indoorChannelRange": [
    36,
    40,
    44,
    48,
    149,
    153,
    157,
    161
  ],
  "outdoorChannelRange": [
    149,
    153,
    157,
    161
  ]
}
Schema
{
  "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"
      }
    }
  }
}
Response  204

Modify Syslog

PATCH/v8_1/rkszones/{id}/syslog

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

Request
HideShow
Body
{
  "address": "1.1.1.1",
  "port": 514,
  "facility": "Local0",
  "priority": "Error"
}
Schema
{
  "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"
      ]
    }
  }
}
Response  204

Modify Smart Monitor

PATCH/v8_1/rkszones/{id}/smartMonitor

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

Request
HideShow
Body
{
  "intervalInSec": 10,
  "retryThreshold": 3
}
Schema
{
  "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
    }
  }
}
Response  204

Modify Client Admission Control 2.4G

PATCH/v8_1/rkszones/{id}/clientAdmissionControl24

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

Request
HideShow
Body
{
  "maxRadioLoadPercent": 70,
  "minClientCount": 10,
  "minClientThroughputMbps": 10
}
Schema
{
  "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
    }
  }
}
Response  204

Modify Client Admission Control 5G

PATCH/v8_1/rkszones/{id}/clientAdmissionControl50

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

Request
HideShow
Body
{
  "maxRadioLoadPercent": 70,
  "minClientCount": 10,
  "minClientThroughputMbps": 10
}
Schema
{
  "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
    }
  }
}
Response  204

Modify tunnel profile

PATCH/v8_1/rkszones/{id}/tunnelProfile

Use this API command to change tunnel profile of Zone.

Request
HideShow
Body
{
  "id": "f5b92938-aa4e-4d02-90ea-273799ff689b",
  "name": "Default Tunnel Profile"
}
Schema
{
  "type": [
    "object",
    "null"
  ],
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    }
  }
}
Response  204

Modify Background Scanning 2.4G

PATCH/v8_1/rkszones/{id}/backgroundScanning24

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

Request
HideShow
Body
{
  "frequencyInSec": 20
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "frequencyInSec": {
      "description": "Frequency in second",
      "type": "integer",
      "minimum": 1,
      "maximum": 65535
    }
  }
}
Response  204

Modify Background Scanning 5G

PATCH/v8_1/rkszones/{id}/backgroundScanning50

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

Request
HideShow
Body
{
  "frequencyInSec": 20
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "frequencyInSec": {
      "description": "Frequency in second",
      "type": "integer",
      "minimum": 1,
      "maximum": 65535
    }
  }
}
Response  204

Modify Client Load Balancing 2.4G

PATCH/v8_1/rkszones/{id}/clientLoadBalancing24

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

Request
HideShow
Body
{
  "adjacentRadioThreshold": 12
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "adjacentRadioThreshold": {
      "description": "Adjacent radio threshold",
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    }
  }
}
Response  204

Modify Client Load Balancing 5G

PATCH/v8_1/rkszones/{id}/clientLoadBalancing50

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

Request
HideShow
Body
{
  "adjacentRadioThreshold": 12
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "adjacentRadioThreshold": {
      "description": "Adjacent radio threshold",
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    }
  }
}
Response  204

Modify Band Balancing

PATCH/v8_1/rkszones/{id}/bandBalancing

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

Request
HideShow
Body
{
  "wifi24Percentage": 10
}
Schema
{
  "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
    }
  }
}
Response  204

Modify AP Reboot Timeout

PATCH/v8_1/rkszones/{id}/apRebootTimeout

Use this API command to modify AP reboot timeout for APs that belong to a zone.

Request
HideShow
Body
{
  "gatewayLossTimeoutInSec": 1800,
  "serverLossTimeoutInSec": 7200
}
Schema
{
  "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
      ]
    }
  }
}
Response  204

Modify Node Affinity Profile

PATCH/v8_1/rkszones/{id}/nodeAffinityProfile

Use this API command to modify node affinity profile for APs that belong to a zone.

Request
HideShow
Body
null
Schema
{
  "type": [
    "object",
    "null"
  ],
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    }
  }
}
Response  204

Modify Hotspot2.0 Venue Profile

PATCH/v8_1/rkszones/{id}/venueProfile

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

Request
HideShow
Body
null
Schema
{
  "type": [
    "object",
    "null"
  ],
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    }
  }
}
Response  204

Modify Rogue

PATCH/v8_1/rkszones/{id}/rogue

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

Request
HideShow
Body
{
  "reportType": "All",
  "maliciousTypes": null,
  "protectionEnabled": true
}
Schema
{
  "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"
    }
  }
}
Response  204

Modify Location Based Service

PATCH/v8_1/rkszones/{id}/locationBasedService

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

Request
HideShow
Body
null
Schema
{
  "type": [
    "object",
    "null"
  ],
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    }
  }
}
Response  204

Modify Radio 2.4G Auto ChannelSelectMode

PATCH/v8_1/rkszones/{id}/autoChannelSelection24

Modify Radio 2.4G Auto ChannelSelectMode and ChannelFly MTBC of a zone.

Request
HideShow
Body
{
  "channelSelectMode": "ChannelFly",
  "channelFlyMtbc": 480
}
Schema
{
  "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
    }
  }
}
Response  204

Modify Radio 5G Auto ChannelSelectMode

PATCH/v8_1/rkszones/{id}/autoChannelSelection50

Modify Radio 5G Auto ChannelSelectMode and ChannelFly MTBC of a zone.

Request
HideShow
Body
{
  "channelSelectMode": "BackgroundScanning",
  "channelFlyMtbc": 480
}
Schema
{
  "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
    }
  }
}
Response  204

Modify IPsec Profile

PATCH/v8_1/rkszones/{id}/ipsecProfile

Modify IPsec Profile of a zone.

Request
HideShow
Body
{
  "id": "ipsecProfileId",
  "name": "ipsecProfileName"
}
Schema
{
  "type": [
    "object",
    "null"
  ],
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    }
  }
}
Response  204

Modify AP Management Vlan

PATCH/v8_1/rkszones/{id}/apMgmtVlan

Modify AP Management Vlan of a zone.

Request
HideShow
Body
{
  "id": 1,
  "mode": "KEEP"
}
Schema
{
  "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"
    }
  }
}
Response  204

Modify Altitude

PATCH/v8_1/rkszones/{id}/altitude

Use this API command to modify the altitude configuration of zone.

Request
HideShow
Body
{
  "altitudeUnit": "meters",
  "altitudeValue": 1
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "altitudeUnit": {
      "description": "altitude unit",
      "type": "string",
      "enum": [
        "meters",
        "floor"
      ]
    },
    "altitudeValue": {
      "description": "altitude value",
      "type": "integer"
    }
  }
}
Response  204

Modify AP SNMP Options

PATCH/v8_1/rkszones/{id}/snmpAgent

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

Request
HideShow
Body
{
  "apSnmpEnabled": true,
  "snmpV2Agent": [
    {
      "communityName": "v2Agent",
      "notificationEnabled": true,
      "readEnabled": true,
      "writeEnabled": true,
      "notificationType": "TRAP",
      "notificationTarget": [
        {
          "address": "172.19.16.20",
          "port": 161
        }
      ]
    }
  ],
  "snmpV3Agent": [
    {
      "userName": "v3Agent",
      "authProtocol": "MD5",
      "authPassword": "admin!234",
      "privProtocol": "DES",
      "privPassword": "admin!234",
      "notificationEnabled": true,
      "readEnabled": true,
      "writeEnabled": true,
      "notificationType": "TRAP",
      "notificationTarget": [
        {
          "address": "172.19.16.20",
          "port": 161
        }
      ]
    }
  ]
}
Schema
{
  "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"
        ]
      }
    }
  }
}
Response  204

Modify zone recovery SSID

PATCH/v8_1/rkszones/{id}/recoverySsid

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

Request
HideShow
Body
{
  "recoverySsidEnabled": true
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "recoverySsidPskKey": {
      "description": "recovery ssid password",
      "type": "string"
    },
    "recoverySsidEnabled": {
      "description": "recovery ssid enable/disable",
      "type": "boolean"
    }
  }
}
Response  204

Modify DHCP/NAT service configuration

PATCH/v8_1/rkszones/{id}/dhcpSiteConfig

Use this API command to modify DHCP/NAT service configuration of Zone.

Request
HideShow
Body
‧ Sample : DHCP Site Configuration when DHCP Service mode is EnableOnEachAPs
{
    "siteEnabled" : true,
    "siteMode" : "EnableOnEachAPs",
    "siteProfileIds" : [ "75e26590-547f-11e6-9ca7-5a095364c13c", "869bb532-547f-11e6-9ca7-5a095364c13c" ]
}
‧ Sample : DHCP Site Configuration when DHCP Service mode is EnableOnMultipleAPs
{
    "siteEnabled" : true,
    "manualSelect" : true,
    "siteMode" : "EnableOnMultipleAPs",
    "siteAps" : [ {
        "apMac" : "38:FF:36:00:0E:10",
        "apServerEnabled" : true,
        "apServerPrimary" : true
    }, {
        "apMac" : "58:FF:36:00:0E:20",
        "apServerEnabled" : true,
        "apServerPrimary" : false
    } ],
    "siteProfileIds" : [ "75e26590-547f-11e6-9ca7-5a095364c13c", "869bb532-547f-11e6-9ca7-5a095364c13c" ]
}
‧ Sample : DHCP Site Configuration when DHCP Service mode is EnableOnHierarchicalAPs
{
    "siteEnabled" : true,
    "manualSelect" : true,
    "dwpdEnabled" : false,
    "eth0ProfileId" : 0,
    "eth1ProfileId" : 2,
    "siteMode" : "EnableOnHierarchicalAPs",
    "siteAps" : [ {
        "apMac" : "38:FF:36:00:0E:10",
        "apServerEnabled" : true,
        "apServerPrimary" : true
    }, {
        "apMac" : "58:FF:36:00:0E:20",
        "apServerEnabled" : true,
        "apServerPrimary" : false
    } ],
    "siteProfileIds" : [ "75e26590-547f-11e6-9ca7-5a095364c13c", "869bb532-547f-11e6-9ca7-5a095364c13c" ]
}
Schema
{
    "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"
            }
        }
    }
}
Response  204

Modify Bonjour Fencing Policy configuration

PATCH/v8_1/rkszones/{id}/bonjourFencingPolicy

Use this API command to modify Bonjour Fencing Policy configuration of Zone.

Request
HideShow
Body
null
Schema
{
  "type": [
    "object",
    "null"
  ],
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    }
  }
}
Response  204

Delete

DELETE/v8_1/rkszones/{id}

Use this API command to delete a zone.

Response  204

Create Zone

POST/v8_1/rkszones

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

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" : {
            "type" : "string"
        },
        "zoneAffinityProfileId" : {
            "description" : "Zone affinity profile of the zone",
            "type" : "string"
        },
        "enforcePriorityZoneAffinityEnable" : {
            "description" : "Enforce the priority of zone affinity",
            "type" : "boolean"
        },
        "name" : {
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 32,
            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$"
        },
        "description" : {
            "type" : [ "string", "null" ],
            "maxLength" : 64
        },
        "version" : {
            "type" : "string",
            "pattern" : "^\d+\.\d+\.\d+\.\d+\.\d+$"
        },
        "countryCode" : {
            "type" : "string"
        },
        "login" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "apLoginName" : {
                    "description" : "User name of the AP administrator",
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : "^((?!\$\()[!-_a-~]){1,64}$"
                },
                "apLoginPassword" : {
                    "description" : "Password of the AP administrator",
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : ".*(?=.{8,})(?=.*[a-zA-Z])(?=.*[0-9])(?=.*[_`~!@#$%^&*\(\)\[\]\{\}|;:'\",.\<>\/?=+-]).*"
                }
            },
            "required" : [ "apLoginName", "apLoginPassword" ]
        },
        "timezone" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "systemTimezone" : {
                    "description" : "System defined time zone, please refer to the “Overview > Time Zone” list",
                    "type" : "string"
                },
                "customizedTimezone" : {
                    "description" : "User defined time zone",
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "abbreviation" : {
                            "description" : "Time zone abbreviation",
                            "type" : "string",
                            "pattern" : "^[a-zA-Z]{3,4}$"
                        },
                        "gmtOffset" : {
                            "description" : "GMT offset",
                            "type" : "integer",
                            "minimum" : -11,
                            "maximum" : 14
                        },
                        "gmtOffsetMinute" : {
                            "description" : "GMT offset minute",
                            "type" : "integer",
                            "minimum" : 0,
                            "maximum" : 59
                        },
                        "start" : {
                            "description" : "Daylight saving time start",
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "month" : {
                                    "description" : "Month when daylight saving time begins",
                                    "type" : "integer",
                                    "enum" : [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ]
                                },
                                "week" : {
                                    "description" : "Week of the month (1 for the first week, 2 for the second week, and so on)",
                                    "type" : "integer",
                                    "enum" : [ 1, 2, 3, 4, 5 ]
                                },
                                "day" : {
                                    "description" : "Day of the week (0 for Sunday, 1 for Monday, 2 for Tuesday, and so on)",
                                    "type" : "integer",
                                    "enum" : [ 0, 1, 2, 3, 4, 5, 6 ]
                                },
                                "hour" : {
                                    "description" : "Hour of the day",
                                    "type" : "integer",
                                    "minimum" : 0,
                                    "maximum" : 23
                                }
                            },
                            "required" : [ "month", "week", "day", "hour" ]
                        },
                        "end" : {
                            "description" : "Daylight saving time end",
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "month" : {
                                    "description" : "Month when daylight saving time begins",
                                    "type" : "integer",
                                    "enum" : [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ]
                                },
                                "week" : {
                                    "description" : "Week of the month (1 for the first week, 2 for the second week, and so on)",
                                    "type" : "integer",
                                    "enum" : [ 1, 2, 3, 4, 5 ]
                                },
                                "day" : {
                                    "description" : "Day of the week (0 for Sunday, 1 for Monday, 2 for Tuesday, and so on)",
                                    "type" : "integer",
                                    "enum" : [ 0, 1, 2, 3, 4, 5, 6 ]
                                },
                                "hour" : {
                                    "description" : "Hour of the day",
                                    "type" : "integer",
                                    "minimum" : 0,
                                    "maximum" : 23
                                }
                            },
                            "required" : [ "month", "week", "day", "hour" ]
                        }
                    },
                    "required" : [ "abbreviation", "gmtOffset", "gmtOffsetMinute" ]
                }
            }
        },
        "mesh" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "ssid" : {
                    "description" : "SSID of the mesh network",
                    "type" : "string"
                },
                "passphrase" : {
                    "description" : "Passphrase for the mesh network",
                    "type" : "string"
                },
                "meshRadioIdx" : {
                    "description" : "Mesh radio index",
                    "type" : "string",
                    "enum" : [ "Radio24G", "Radio5G" ],
                    "default" : "Radio5G"
                },
                "zeroTouchStatus" : {
                    "type" : "boolean"
                }
            }
        },
        "dfsChannelEnabled" : {
            "type" : "boolean",
            "default" : false
        },
        "cbandChannelEnabled" : {
            "type" : "boolean",
            "default" : false
        },
        "cbandChannelLicenseEnabled" : {
            "type" : "boolean",
            "default" : false
        },
        "channel144Enabled" : {
            "type" : "boolean",
            "default" : false
        },
        "wifi24" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "autoCellSizing" : {
                    "description" : "Auto Cell Sizing",
                    "type" : "boolean"
                },
                "txPower" : {
                    "description" : "Transmission power",
                    "type" : "string",
                    "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
                    "default" : "Full"
                },
                "channelWidth" : {
                    "description" : "Channel width. Zero (0) means Auto.",
                    "type" : "integer",
                    "enum" : [ 0, 20, 40 ],
                    "default" : 0
                },
                "channel" : {
                    "description" : "Channel number",
                    "type" : "integer"
                },
                "channelRange" : {
                    "description" : "Channel range options",
                    "type" : "array",
                    "items" : {
                        "type" : "integer"
                    }
                }
            }
        },
        "wifi50" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "autoCellSizing" : {
                    "description" : "Auto Cell Sizing",
                    "type" : "boolean"
                },
                "txPower" : {
                    "description" : "Transmission power",
                    "type" : "string",
                    "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
                    "default" : "Full"
                },
                "channelWidth" : {
                    "description" : "Channel width. Zero (0) means Auto. 8080 means 80+80MHz",
                    "type" : "integer",
                    "enum" : [ 0, 20, 40, 80, 8080, 160 ],
                    "default" : 0
                },
                "indoorChannel" : {
                    "description" : "Channel number for Indoor AP",
                    "type" : "integer"
                },
                "outdoorChannel" : {
                    "description" : "Channel number for Outdoor AP",
                    "type" : "integer"
                },
                "indoorSecondaryChannel" : {
                    "description" : "Secondary channel number for Indoor AP (channelWidth is 80+80MHz only)",
                    "type" : "integer"
                },
                "outdoorSecondaryChannel" : {
                    "description" : "Secondary channel number for outdoor AP (channelWidth is 80+80MHz only)",
                    "type" : "integer"
                },
                "indoorChannelRange" : {
                    "description" : "Channel range options for Indoor AP",
                    "type" : "array",
                    "items" : {
                        "type" : "integer"
                    }
                },
                "outdoorChannelRange" : {
                    "description" : "Channel range options for outdoor AP",
                    "type" : "array",
                    "items" : {
                        "type" : "integer"
                    }
                }
            }
        },
        "protectionMode24" : {
            "type" : "string",
            "enum" : [ "NONE", "CTS_ONLY", "RTS_CTS" ],
            "default" : "RTS_CTS"
        },
        "syslog" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "flowLevel" : {
                    "description" : "Flow Level of the syslog",
                    "type" : "string",
                    "enum" : [ "GENERAL_LOGS", "CLIENT_FLOW", "ALL" ],
                    "default" : "GENERAL_LOGS"
                },
                "address" : {
                    "description" : "Address of the syslog server.",
                    "type" : "string"
                },
                "port" : {
                    "description" : "Port number of the syslog server",
                    "type" : "integer",
                    "default" : 514,
                    "minimum" : 1,
                    "maximum" : 65535
                },
                "protocol" : {
                    "description" : "Protocol of the syslog server",
                    "type" : "string",
                    "enum" : [ "IPPROTO_TCP", "IPPROTO_UDP" ],
                    "default" : "IPPROTO_TCP"
                },
                "secondaryAddress" : {
                    "description" : "Secondary Server Address of the syslog server",
                    "type" : "string"
                },
                "secondaryPort" : {
                    "description" : "Secondary Server Port of the syslog server",
                    "type" : "integer",
                    "default" : 514,
                    "minimum" : 1,
                    "maximum" : 65535
                },
                "secondaryProtocol" : {
                    "description" : "Secondary Server Protocol of the syslog server",
                    "type" : "string",
                    "enum" : [ "IPPROTO_TCP", "IPPROTO_UDP" ],
                    "default" : "IPPROTO_TCP"
                },
                "facility" : {
                    "description" : "Facility of the syslog server",
                    "type" : "string",
                    "enum" : [ "Keep_Original", "Local0", "Local1", "Local2", "Local3", "Local4", "Local5", "Local6", "Local7" ],
                    "default" : "Keep_Original"
                },
                "priority" : {
                    "description" : "Priority of the log messages",
                    "type" : "string",
                    "enum" : [ "Emergency", "Alert", "Critical", "Error", "Warning", "Notice", "Info", "All" ],
                    "default" : "Error"
                }
            }
        },
        "smartMonitor" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "intervalInSec" : {
                    "description" : "Interval in seconds. This is required if smartMonitor is enabled",
                    "type" : "integer",
                    "default" : 10,
                    "minimum" : 5,
                    "maximum" : 60
                },
                "retryThreshold" : {
                    "description" : "Retry threshold. This is required if smartMonitor is enabled",
                    "type" : "integer",
                    "default" : 3,
                    "minimum" : 1,
                    "maximum" : 10
                }
            }
        },
        "clientAdmissionControl24" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "maxRadioLoadPercent" : {
                    "description" : "Maximum radio load percentage.",
                    "type" : "integer",
                    "default" : 75,
                    "minimum" : 50,
                    "maximum" : 100
                },
                "minClientCount" : {
                    "description" : "Minimum client count number.",
                    "type" : "integer",
                    "default" : 10,
                    "minimum" : 0,
                    "maximum" : 100
                },
                "minClientThroughputMbps" : {
                    "description" : "Minimum client throughput in Mbps.",
                    "type" : "number",
                    "default" : 0,
                    "minimum" : 0,
                    "maximum" : 100
                }
            }
        },
        "clientAdmissionControl50" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "maxRadioLoadPercent" : {
                    "description" : "Maximum radio load percentage.",
                    "type" : "integer",
                    "default" : 75,
                    "minimum" : 50,
                    "maximum" : 100
                },
                "minClientCount" : {
                    "description" : "Minimum client count number.",
                    "type" : "integer",
                    "default" : 10,
                    "minimum" : 0,
                    "maximum" : 100
                },
                "minClientThroughputMbps" : {
                    "description" : "Minimum client throughput in Mbps.",
                    "type" : "number",
                    "default" : 0,
                    "minimum" : 0,
                    "maximum" : 100
                }
            }
        },
        "channelModeEnabled" : {
            "type" : "boolean",
            "default" : false
        },
        "tunnelType" : {
            "description" : "Tunnel type configuration of the zone. No_Tunneled is for IPv6 mode",
            "type" : "string",
            "enum" : [ "No_Tunneled", "RuckusGRE", "SoftGRE", "SoftGREIpsec" ],
            "default" : "RuckusGRE"
        },
        "tunnelProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "backgroundScanning24" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "frequencyInSec" : {
                    "description" : "Frequency in second",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 65535,
                    "default" : 20
                }
            }
        },
        "backgroundScanning50" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "frequencyInSec" : {
                    "description" : "Frequency in second",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 65535,
                    "default" : 20
                }
            }
        },
        "clientLoadBalancing24" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "adjacentRadioThreshold" : {
                    "description" : "Adjacent radio threshold",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 100
                }
            }
        },
        "clientLoadBalancing50" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "adjacentRadioThreshold" : {
                    "description" : "Adjacent radio threshold",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 100
                }
            }
        },
        "bandBalancing" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "mode" : {
                    "description" : "Band Balancing Mode: BASIC-Withholds probe and authentication responses at connetcion time in heavily loaded band to balance clients to the other band, PROACTIVE-Uses BASIC functionality and actively rebalances clients via 802.11v BTM, STRICT-Uses PROACTIVE functionality and forcefully rebalances clients via 802.11v BTM",
                    "type" : "string",
                    "enum" : [ "BASIC", "PROACTIVE", "STRICT" ],
                    "default" : "BASIC"
                },
                "wifi24Percentage" : {
                    "description" : "Percentage of client load on 2.4GHz radio band",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 100,
                    "default" : 25
                }
            }
        },
        "loadBalancingMethod" : {
            "type" : "string",
            "enum" : [ "BASED_ON_CLIENT_COUNT", "BASED_ON_CAPACITY", "OFF" ],
            "default" : "BASED_ON_CLIENT_COUNT"
        },
        "rogue" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "reportType" : {
                    "description" : "Report type",
                    "type" : "string",
                    "enum" : [ "All", "Malicious" ]
                },
                "maliciousTypes" : {
                    "description" : "Malicious type when reportType is Malicious",
                    "type" : [ "array", "null" ],
                    "items" : {
                        "type" : "string",
                        "enum" : [ "SSIDSpoofing", "SameNetwork", "MACSpoofing" ]
                    }
                },
                "protectionEnabled" : {
                    "description" : "Protection enabled",
                    "type" : "boolean"
                }
            }
        },
        "dosBarringEnable" : {
            "type" : "integer"
        },
        "dosBarringPeriod" : {
            "type" : "integer",
            "default" : 60
        },
        "dosBarringThreshold" : {
            "type" : "integer",
            "default" : 5
        },
        "dosBarringCheckPeriod" : {
            "type" : "integer",
            "default" : 30
        },
        "locationBasedService" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "apRebootTimeout" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "gatewayLossTimeoutInSec" : {
                    "description" : "Gateway loss timeout in second",
                    "type" : "integer",
                    "enum" : [ 0, 1800, 3600, 5400, 7200, 9000, 10800, 12600, 14400, 16200, 18000, 19800, 23400, 25200, 27000, 28800, 30600, 32400, 34200, 36000, 37800, 39600, 41400, 43200, 45000, 46800, 48600, 50400, 52200, 54000, 55800, 57600, 59400, 61200, 63000, 64800, 66600, 68400, 70200, 72000, 73800, 75600, 77400, 79200, 81000, 82800, 84600, 86400 ],
                    "default" : 1800
                },
                "serverLossTimeoutInSec" : {
                    "description" : "Server loss timeout in second",
                    "type" : "integer",
                    "enum" : [ 0, 7200, 14400, 21600, 28800, 36000, 43200, 50400, 57600, 64800, 72000, 79200, 86400 ],
                    "default" : 7200
                }
            }
        },
        "location" : {
            "type" : "string"
        },
        "locationAdditionalInfo" : {
            "type" : "string",
            "pattern" : "^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
        },
        "altitude" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "altitudeUnit" : {
                    "description" : "altitude unit",
                    "type" : "string",
                    "enum" : [ "meters", "floor" ],
                    "default" : "meters"
                },
                "altitudeValue" : {
                    "description" : "altitude value",
                    "type" : "integer"
                }
            }
        },
        "latitude" : {
            "type" : "number"
        },
        "longitude" : {
            "type" : "number"
        },
        "vlanOverlappingEnabled" : {
            "type" : "boolean"
        },
        "nodeAffinityProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "venueProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "autoChannelSelection24" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "channelSelectMode" : {
                    "description" : "Channel Select Mode",
                    "type" : "string",
                    "enum" : [ "None", "BackgroundScanning", "ChannelFly" ],
                    "default" : "BackgroundScanning"
                },
                "channelFlyMtbc" : {
                    "description" : "ChannelFly MTBC",
                    "type" : "integer",
                    "default" : 480,
                    "minimum" : 100,
                    "maximum" : 1440
                }
            }
        },
        "autoChannelSelection50" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "channelSelectMode" : {
                    "description" : "Channel Select Mode",
                    "type" : "string",
                    "enum" : [ "None", "BackgroundScanning", "ChannelFly" ],
                    "default" : "BackgroundScanning"
                },
                "channelFlyMtbc" : {
                    "description" : "ChannelFly MTBC",
                    "type" : "integer",
                    "default" : 480,
                    "minimum" : 100,
                    "maximum" : 1440
                }
            }
        },
        "channelEvaluationInterval" : {
            "type" : "integer",
            "default" : 600,
            "minimum" : 60,
            "maximum" : 3600
        },
        "apMgmtVlan" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "mode" : {
                    "description" : "Vlan Mode of the zone",
                    "type" : "string",
                    "enum" : [ "KEEP", "USER_DEFINED" ],
                    "default" : "KEEP"
                },
                "id" : {
                    "description" : "Vlan id of the zone",
                    "type" : "integer",
                    "default" : "1"
                }
            }
        },
        "apLatencyInterval" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "pingEnabled" : {
                    "description" : "AP ping latency enabled",
                    "type" : "boolean",
                    "default" : true
                }
            }
        },
        "ipsecProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "ipv6TrafficFilterEnabled" : {
            "type" : "integer"
        },
        "bonjourFencingPolicyEnabled" : {
            "type" : "boolean"
        },
        "bonjourFencingPolicy" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "dhcpSiteConfig" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "siteEnabled" : {
                    "description" : "DHCP Service Enabling Status",
                    "type" : "boolean"
                },
                "dwpdEnabled" : {
                    "description" : "DHCP Service Dynamic WAN Port Detection",
                    "type" : "boolean"
                },
                "manualSelect" : {
                    "description" : "DHCP Service AP Selection Mode. This value is effective when the siteMode is EnableOnMultipleAPs.",
                    "type" : "boolean"
                },
                "siteMode" : {
                    "description" : "DHCP Service mode",
                    "type" : "string",
                    "enum" : [ "EnableOnEachAPs", "EnableOnMultipleAPs", "EnableOnHierarchicalAPs" ]
                },
                "eth0ProfileId" : {
                    "type" : "integer"
                },
                "eth1ProfileId" : {
                    "type" : "integer"
                },
                "siteAps" : {
                    "type" : "array",
                    "items" : {
                        "type" : "object",
                        "description" : "DHCP Site selected APs. The content is effective when the siteMode is EnableOnMultipleAPs.",
                        "additionalProperties" : false,
                        "properties" : {
                            "apMac" : {
                                "type" : "string"
                            },
                            "apName" : {
                                "type" : "string"
                            },
                            "apStatus" : {
                                "type" : "string",
                                "enum" : [ "Online", "Offline", "Flagged" ]
                            },
                            "apServerEnabled" : {
                                "type" : "boolean"
                            },
                            "apServerPrimary" : {
                                "type" : "boolean"
                            },
                            "apServerIp" : {
                                "type" : [ "string", "null" ]
                            },
                            "apGatewayIp" : {
                                "type" : "string"
                            },
                            "apServerType" : {
                                "type" : "string"
                            }
                        }
                    }
                },
                "siteProfileIds" : {
                    "type" : "array",
                    "items" : {
                        "type" : "string"
                    }
                }
            }
        },
        "snmpAgent" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "apSnmpEnabled" : {
                    "description" : "Enable AP SNMP",
                    "type" : "boolean"
                },
                "snmpV2Agent" : {
                    "description" : "Community List of the SNMP V2 Agent.",
                    "type" : "array",
                    "items" : {
                        "type" : "object",
                        "additionalProperties" : false,
                        "properties" : {
                            "communityName" : {
                                "description" : "name of the SNMP Community.",
                                "type" : "string"
                            },
                            "readEnabled" : {
                                "description" : "read privilege of the SNMP Coummunity",
                                "type" : "boolean"
                            },
                            "writeEnabled" : {
                                "description" : "write privilege of the SNMP Coummunity",
                                "type" : "boolean"
                            },
                            "notificationEnabled" : {
                                "description" : "notification privilege of the SNMP Coummunity",
                                "type" : "boolean"
                            },
                            "notificationType" : {
                                "description" : "type of the notification privilege",
                                "type" : "string",
                                "enum" : [ "TRAP", "INFORM" ]
                            },
                            "notificationTarget" : {
                                "description" : "Trap List of the SNMP Coummunity",
                                "type" : "array",
                                "items" : {
                                    "type" : "object",
                                    "additionalProperties" : false,
                                    "properties" : {
                                        "address" : {
                                            "description" : "address of the SNMP Trap",
                                            "type" : "string"
                                        },
                                        "port" : {
                                            "description" : "port number of the SNMP Trap",
                                            "type" : "integer",
                                            "minimum" : 1,
                                            "maximum" : 65535
                                        }
                                    },
                                    "required" : [ "address", "port" ]
                                }
                            }
                        },
                        "required" : [ "communityName" ]
                    }
                },
                "snmpV3Agent" : {
                    "description" : "User List of the SNMP V3 Agent.",
                    "type" : "array",
                    "items" : {
                        "type" : "object",
                        "additionalProperties" : false,
                        "properties" : {
                            "userName" : {
                                "description" : "name of the SNMP User.",
                                "type" : "string"
                            },
                            "authProtocol" : {
                                "description" : "authProtocol of the SNMP User.",
                                "type" : "string",
                                "enum" : [ "NONE", "MD5", "SHA" ]
                            },
                            "authPassword" : {
                                "description" : "authPassword of the SNMP User.",
                                "type" : "string",
                                "minLength" : 8
                            },
                            "privProtocol" : {
                                "description" : "privProtocol of the SNMP User.",
                                "type" : "string",
                                "enum" : [ "NONE", "DES", "AES" ]
                            },
                            "privPassword" : {
                                "description" : "privPassword of the SNMP User.",
                                "type" : "string",
                                "minLength" : 8
                            },
                            "readEnabled" : {
                                "description" : "read privilege of the SNMP User",
                                "type" : "boolean"
                            },
                            "writeEnabled" : {
                                "description" : "write privilege of the SNMP User",
                                "type" : "boolean"
                            },
                            "notificationEnabled" : {
                                "description" : "notification privilege of the SNMP User",
                                "type" : "boolean"
                            },
                            "notificationType" : {
                                "description" : "type of the notification privilege",
                                "type" : "string",
                                "enum" : [ "TRAP", "INFORM" ]
                            },
                            "notificationTarget" : {
                                "description" : "Trap List of the SNMP User",
                                "type" : "array",
                                "items" : {
                                    "type" : "object",
                                    "additionalProperties" : false,
                                    "properties" : {
                                        "address" : {
                                            "description" : "address of the SNMP Trap",
                                            "type" : "string"
                                        },
                                        "port" : {
                                            "description" : "port number of the SNMP Trap",
                                            "type" : "integer",
                                            "minimum" : 1,
                                            "maximum" : 65535
                                        }
                                    },
                                    "required" : [ "address", "port" ]
                                }
                            }
                        },
                        "required" : [ "userName" ]
                    }
                }
            }
        },
        "recoverySsid" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "recoverySsidPskKey" : {
                    "description" : "recovery ssid password",
                    "type" : "string"
                },
                "recoverySsidEnabled" : {
                    "description" : "recovery ssid enable/disable",
                    "type" : "boolean"
                }
            }
        },
        "clusterRedundancyEnabled" : {
            "type" : "boolean",
            "default" : false
        },
        "rogueApReportThreshold" : {
            "type" : "integer"
        },
        "rogueApAggressivenessMode" : {
            "type" : "integer"
        },
        "rogueApJammingDetection" : {
            "type" : "boolean",
            "default" : false
        },
        "rogueApJammingThreshold" : {
            "type" : "integer"
        },
        "directedMulticastFromWiredClientEnabled" : {
            "type" : "boolean",
            "default" : true
        },
        "directedMulticastFromWirelessClientEnabled" : {
            "type" : "boolean",
            "default" : true
        },
        "directedMulticastFromNetworkEnabled" : {
            "type" : "boolean",
            "default" : true
        },
        "healthCheckSitesEnabled" : {
            "description" : "Enabled Health Check Sites. ",
            "type" : "boolean",
            "default" : false
        },
        "healthCheckSites" : {
            "description" : "Health Check Sites.",
            "type" : "array",
            "items" : {
                "type" : "string"
            }
        },
        "ruckusGreTunnelProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "softGreTunnelProflies" : {
            "type" : "array",
            "items" : {
                "type" : [ "object", "null" ],
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "type" : "string"
                    },
                    "name" : {
                        "type" : "string"
                    },
                    "aaaAffinityEnabled" : {
                        "type" : "boolean"
                    }
                }
            }
        },
        "ipsecProfiles" : {
            "type" : "array",
            "items" : {
                "type" : [ "object", "null" ],
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "type" : "string"
                    },
                    "name" : {
                        "type" : "string"
                    }
                }
            }
        },
        "sshTunnelEncryption" : {
            "type" : "string",
            "enum" : [ "AES128", "AES256" ],
            "default" : "AES128"
        },
        "lteBandLockChannels" : {
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "simCardId" : {
                        "description" : "SIM card ID(Primary:0, Secondary:1)",
                        "type" : "integer"
                    },
                    "type" : {
                        "description" : "LTE chipset SKU type",
                        "type" : "string"
                    },
                    "channel4g" : {
                        "description" : "LTE 4G channels",
                        "type" : "string"
                    },
                    "channel3g" : {
                        "description" : "LTE 3G channels",
                        "type" : "string"
                    }
                }
            }
        },
        "apHccdEnabled" : {
            "type" : "boolean",
            "default" : false
        },
        "apHccdPersist" : {
            "type" : "boolean",
            "default" : true
        }
    },
    "required" : [ "name", "login" ]
}
Response  201
HideShow
Body
{
  "id": "zoneUUID"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

AP Group

Retrieve Default AP Group

GET/v8_1/rkszones/{zoneId}/apgroups/default

Use this API command to retrieve information about default AP group of zone.

Response  200
HideShow
Body
{
  "id": "apGroupUUID",
  "zoneId": "zoneUUID",
  "name": "apGroupName",
  "description": "apGroupDescription",
  "location": "test-ap1_modify",
  "locationAdditionalInfo": "add",
  "latitude": 34,
  "longitude": 45,
  "wifi24": {
    "txPower": "Full",
    "channelWidth": 20,
    "channel": 9,
    "channelRange": [
      1,
      2,
      3,
      4,
      9,
      10,
      11
    ],
    "availableChannelRange": [
      1,
      2,
      3,
      4,
      5,
      6,
      7,
      8,
      9,
      10,
      11
    ]
  },
  "wifi50": {
    "txPower": "Full",
    "channelWidth": 40,
    "indoorChannel": 0,
    "outdoorChannel": 157,
    "indoorChannelRange": [
      36,
      40,
      44,
      48
    ],
    "outdoorChannelRange": [
      149,
      153
    ],
    "availableIndoorChannelRange": [
      36,
      40,
      44,
      48,
      149,
      153,
      157,
      161
    ],
    "availableOutdoorChannelRange": [
      149,
      153,
      157,
      161
    ]
  },
  "protectionMode24": "CTS_ONLY",
  "wlanGroup24": {
    "id": "19b10850-7eaa-11e4-a584-08002716c79f",
    "name": "default"
  },
  "wlanGroup50": null,
  "locationBasedService": null,
  "clientAdmissionControl24": {
    "maxRadioLoadPercent": 70,
    "minClientCount": 30,
    "minClientThroughputMbps": 10,
    "enabled": true
  },
  "clientAdmissionControl50": null,
  "venueProfile": null,
  "members": [
    {
      "apMac": "00:11:22:33:44:55"
    },
    {
      "apMac": "11:22:33:44:55:66"
    }
  ],
  "autoChannelSelection24": {
    "channelSelectMode": "ChannelFly",
    "channelFlyMtbc": 480
  },
  "autoChannelSelection50": {
    "channelSelectMode": "BackgroundScanning",
    "channelFlyMtbc": 480
  },
  "channelEvaluationInterval": 777,
  "apMgmtVlan": {
    "id": 1,
    "mode": "KEEP"
  },
  "altitude": {
    "altitudeUnit": "meters",
    "altitudeValue": 1
  },
  "recoverySsid": {
    "recoverySsidEnabled": true
  },
  "rogueApReportThreshold": 30,
  "rogueApAggressivenessMode": 1,
  "rogueApJammingThreshold": 30,
  "directedMulticastFromWiredClientEnabled": true,
  "directedMulticastFromWirelessClientEnabled": true,
  "directedMulticastFromNetworkEnabled": false
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "Identifier of the AP group",
      "type": "string"
    },
    "zoneId": {
      "description": "Identifier of the zone to which the AP group belongs",
      "type": "string"
    },
    "name": {
      "description": "Name of the AP group",
      "type": "string"
    },
    "description": {
      "description": "Description of the AP group",
      "type": "string"
    },
    "location": {
      "description": "Location of the AP group.",
      "type": "string"
    },
    "locationAdditionalInfo": {
      "description": "Location additional info of the AP group.",
      "type": "string",
      "pattern": "^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
    },
    "altitude": {
      "description": "GPS Altitude",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "altitudeUnit": {
          "description": "altitude unit",
          "type": "string",
          "enum": [
            "meters",
            "floor"
          ],
          "default": "meters"
        },
        "altitudeValue": {
          "description": "altitude value",
          "type": "integer"
        }
      }
    },
    "latitude": {
      "description": "Latitude coordinate (in decimal format) of the AP group",
      "type": "number"
    },
    "longitude": {
      "description": "Longitude coordinate (in decimal format) of the AP group",
      "type": "number"
    },
    "wifi24": {
      "description": "AP 2.4GHz radio configuration of the AP group.",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "autoCellSizing": {
          "description": "Auto Cell Sizing",
          "type": "boolean"
        },
        "txPower": {
          "description": "Transmission power",
          "type": "string",
          "enum": [
            "Full",
            "-1dB",
            "-2dB",
            "-3dB(1/2)",
            "-4dB",
            "-5dB",
            "-6dB(1/4)",
            "-7dB",
            "-8dB",
            "-9dB(1/8)",
            "-10dB",
            "Min"
          ],
          "default": "Full"
        },
        "channelWidth": {
          "description": "Channel width. Zero (0) means Auto.",
          "type": "integer",
          "enum": [
            0,
            20,
            40
          ]
        },
        "channel": {
          "description": "Channel number",
          "type": "integer"
        },
        "channelRange": {
          "description": "Channel range options",
          "type": "array",
          "items": {
            "type": "integer"
          }
        },
        "availableChannelRange": {
          "description": "Available channel range options",
          "type": "array",
          "items": {
            "type": "integer"
          }
        }
      }
    },
    "wifi50": {
      "description": "AP 5GHz radio configuration of the AP group.",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "autoCellSizing": {
          "description": "Auto Cell Sizing",
          "type": "boolean"
        },
        "txPower": {
          "description": "Transmission power",
          "type": "string",
          "enum": [
            "Full",
            "-1dB",
            "-2dB",
            "-3dB(1/2)",
            "-4dB",
            "-5dB",
            "-6dB(1/4)",
            "-7dB",
            "-8dB",
            "-9dB(1/8)",
            "-10dB",
            "Min"
          ],
          "default": "Full"
        },
        "channelWidth": {
          "description": "Channel width. Zero (0) means Auto. 8080 means 80+80MHz",
          "type": "integer",
          "enum": [
            0,
            20,
            40,
            80,
            8080,
            160
          ]
        },
        "indoorChannel": {
          "description": "Channel number for Indoor AP",
          "type": "integer"
        },
        "outdoorChannel": {
          "description": "Channel number for Outdoor AP",
          "type": "integer"
        },
        "indoorSecondaryChannel": {
          "description": "Secondary channel number for Indoor AP (channelWidth is 80+80MHz only)",
          "type": "integer"
        },
        "outdoorSecondaryChannel": {
          "description": "Secondary channel number for outdoor AP (channelWidth is 80+80MHz only)",
          "type": "integer"
        },
        "indoorChannelRange": {
          "description": "Channel range options for Indoor AP",
          "type": "array",
          "items": {
            "type": "integer"
          }
        },
        "outdoorChannelRange": {
          "description": "Channel range options for outdoor AP",
          "type": "array",
          "items": {
            "type": "integer"
          }
        },
        "availableIndoorChannelRange": {
          "description": "Available channel range options",
          "type": "array",
          "items": {
            "type": "integer"
          }
        },
        "availableOutdoorChannelRange": {
          "description": "Available channel range options",
          "type": "array",
          "items": {
            "type": "integer"
          }
        }
      }
    },
    "protectionMode24": {
      "description": "AP 2.4GHz Protection mode configuration of the AP group.",
      "type": "string",
      "enum": [
        "NONE",
        "CTS_ONLY",
        "RTS_CTS"
      ],
      "default": "RTS_CTS"
    },
    "wlanGroup24": {
      "description": "WLAN group of radio 2.4G. This configuraiton will override the WLAN group of radio 2.4G at the zone level.",
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "wlanGroup50": {
      "description": "WLAN group of radio 5G. This configuration will override the WLAN group of radio 5G at the zone level.",
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "locationBasedService": {
      "description": "Location based service configuration of the AP group.",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "enabled": {
          "type": "boolean"
        },
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "clientAdmissionControl24": {
      "description": "WLAN group of 2.4GHz radio. This configuraiton will override the WLAN group of 2.4GHz radio at the zone level.",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "enabled": {
          "type": "boolean"
        },
        "maxRadioLoadPercent": {
          "description": "Maximum radio load percentage.",
          "type": "integer",
          "default": 75,
          "minimum": 50,
          "maximum": 100
        },
        "minClientCount": {
          "description": "Minimum client count number.",
          "type": "integer",
          "default": 10,
          "minimum": 0,
          "maximum": 100
        },
        "minClientThroughputMbps": {
          "description": "Minimum client throughput in Mbps.",
          "type": "number",
          "default": 0,
          "minimum": 0,
          "maximum": 100
        }
      }
    },
    "clientAdmissionControl50": {
      "description": "WLAN group of 5G radio. This configuration will override the WLAN group of 5G radio at the zone level.",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "enabled": {
          "type": "boolean"
        },
        "maxRadioLoadPercent": {
          "description": "Maximum radio load percentage.",
          "type": "integer",
          "default": 75,
          "minimum": 50,
          "maximum": 100
        },
        "minClientCount": {
          "description": "Minimum client count number.",
          "type": "integer",
          "default": 10,
          "minimum": 0,
          "maximum": 100
        },
        "minClientThroughputMbps": {
          "description": "Minimum client throughput in Mbps.",
          "type": "number",
          "default": 0,
          "minimum": 0,
          "maximum": 100
        }
      }
    },
    "venueProfile": {
      "description": "Venue profile configuration of the AP group.",
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "members": {
      "description": "Members of the AP group",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "apMac": {
            "description": "MAC address of member AP",
            "type": "string",
            "pattern": "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
          },
          "apSerial": {
            "description": "Serial number of member AP",
            "type": "string"
          }
        }
      }
    },
    "autoChannelSelection24": {
      "description": "client load balancing on Radio 2.4G, auto channel selection mode",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "channelSelectMode": {
          "description": "Channel Select Mode",
          "type": "string",
          "enum": [
            "None",
            "BackgroundScanning",
            "ChannelFly"
          ],
          "default": "BackgroundScanning"
        },
        "channelFlyMtbc": {
          "description": "ChannelFly MTBC",
          "type": "integer",
          "default": 480,
          "minimum": 100,
          "maximum": 1440
        }
      }
    },
    "autoChannelSelection50": {
      "description": "client load balancing on Radio 5G, auto channel selection mode",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "channelSelectMode": {
          "description": "Channel Select Mode",
          "type": "string",
          "enum": [
            "None",
            "BackgroundScanning",
            "ChannelFly"
          ],
          "default": "BackgroundScanning"
        },
        "channelFlyMtbc": {
          "description": "ChannelFly MTBC",
          "type": "integer",
          "default": 480,
          "minimum": 100,
          "maximum": 1440
        }
      }
    },
    "channelEvaluationInterval": {
      "description": "channel evaluation Interval of the ap group",
      "type": "integer",
      "default": 600,
      "minimum": 60,
      "maximum": 3600
    },
    "apMgmtVlan": {
      "description": "ap Management Vlan of the apgroup",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "mode": {
          "description": "Vlan Mode of the zone",
          "type": "string",
          "enum": [
            "KEEP",
            "USER_DEFINED"
          ],
          "default": "KEEP"
        },
        "id": {
          "description": "Vlan id of the zone",
          "type": "integer",
          "default": "1"
        }
      }
    },
    "awsVenue": {
      "description": "Venue code",
      "type": "string"
    },
    "recoverySsid": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "recoverySsidEnabled": {
          "description": "recovery ssid enable/disable",
          "type": "boolean"
        }
      }
    },
    "rogueApReportThreshold": {
      "description": "Rogue AP report will leave out all entries that have signal strength lower than this threshold.",
      "type": "integer"
    },
    "rogueApAggressivenessMode": {
      "description": "Adjust the frequency interval to de-authenticate rogue APs.",
      "type": "integer"
    },
    "rogueApJammingThreshold": {
      "type": "integer"
    },
    "directedMulticastFromWiredClientEnabled": {
      "type": "boolean"
    },
    "directedMulticastFromWirelessClientEnabled": {
      "type": "boolean"
    },
    "directedMulticastFromNetworkEnabled": {
      "type": "boolean"
    },
    "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"
          }
        }
      }
    }
  },
  "required": [
    "name"
  ]
}

Modify

PATCH/v8_1/rkszones/{zoneId}/apgroups/{id}

Use this API command to modify the basic information of an AP group.

Request
HideShow
Body
{
  "name": "apGroupNameModified",
  "description": "apGroupDescriptionModified",
  "location": "test-ap1_modify",
  "locationAdditionalInfo": "add",
  "latitude": 34,
  "longitude": 45,
  "wifi24": {
    "txPower": "Full",
    "channelWidth": 20,
    "channel": 10,
    "channelRange": [
      1,
      2,
      3,
      4,
      5,
      6,
      7,
      8,
      9,
      10,
      11
    ]
  },
  "wifi50": {
    "txPower": "Full",
    "channelWidth": 20,
    "indoorChannel": 36,
    "outdoorChannel": 149,
    "indoorChannelRange": [
      36,
      40,
      44,
      48,
      149,
      153,
      157,
      161
    ],
    "outdoorChannelRange": [
      149,
      153,
      157,
      161
    ]
  },
  "protectionMode24": "CTS_ONLY",
  "wlanGroup24": {
    "id": "19b10850-7eaa-11e4-a584-08002716c79f",
    "name": "default"
  },
  "wlanGroup50": {
    "id": "19b10850-7eaa-11e4-a584-08002716c79f",
    "name": "default"
  },
  "locationBasedService": {
    "id": "lbsServiceId",
    "name": "lbsServiceName"
  },
  "clientAdmissionControl24": {
    "maxRadioLoadPercent": 70,
    "minClientCount": 30,
    "minClientThroughputMbps": 10,
    "enabled": true
  },
  "clientAdmissionControl50": {
    "maxRadioLoadPercent": 70,
    "minClientCount": 30,
    "minClientThroughputMbps": 10,
    "enabled": true
  },
  "venueProfile": {
    "id": "venueProfileId",
    "name": "venueProfileName"
  },
  "autoChannelSelection24": {
    "channelSelectMode": "ChannelFly",
    "channelFlyMtbc": 480
  },
  "autoChannelSelection50": {
    "channelSelectMode": "BackgroundScanning",
    "channelFlyMtbc": 480
  },
  "channelEvaluationInterval": 777,
  "apMgmtVlan": {
    "id": 1,
    "mode": "KEEP"
  },
  "altitude": {
    "altitudeUnit": "meters",
    "altitudeValue": 1
  },
  "recoverySsid": {
    "recoverySsidEnabled": true
  },
  "rogueApReportThreshold": 30,
  "rogueApAggressivenessMode": 1,
  "rogueApJammingThreshold": 30,
  "directedMulticastFromWiredClientEnabled": true,
  "directedMulticastFromWirelessClientEnabled": true,
  "directedMulticastFromNetworkEnabled": false,
  "lteBandLockChannels": [
    {
      "simCardId": 0,
      "type": "EC25E",
      "channel4g": "B1,B3,B5",
      "channel3g": "B5"
    },
    {
      "simCardId": 1,
      "type": "EC25E",
      "channel4g": "",
      "channel3g": ""
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "description": "Name of the AP group",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "Description of the AP group",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "location": {
      "description": "Location of the AP group.",
      "type": "string"
    },
    "locationAdditionalInfo": {
      "description": "Location additional info of the AP group.",
      "type": "string",
      "pattern": "^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
    },
    "altitude": {
      "description": "GPS Altitude",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "altitudeUnit": {
          "description": "altitude unit",
          "type": "string",
          "enum": [
            "meters",
            "floor"
          ]
        },
        "altitudeValue": {
          "description": "altitude value",
          "type": "integer"
        }
      }
    },
    "latitude": {
      "description": "Latitude coordinate (in decimal format) of the AP group",
      "type": "number"
    },
    "longitude": {
      "description": "Longitude coordinate (in decimal format) of the AP group",
      "type": "number"
    },
    "wifi24": {
      "description": "AP 2.4GHz radio configuration of the AP group.",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "autoCellSizing": {
          "description": "Auto Cell Sizing",
          "type": "boolean"
        },
        "txPower": {
          "description": "Transmission power",
          "type": "string",
          "enum": [
            "Full",
            "-1dB",
            "-2dB",
            "-3dB(1/2)",
            "-4dB",
            "-5dB",
            "-6dB(1/4)",
            "-7dB",
            "-8dB",
            "-9dB(1/8)",
            "-10dB",
            "Min"
          ]
        },
        "channelWidth": {
          "description": "Channel width. Zero (0) means Auto.",
          "type": "integer",
          "enum": [
            0,
            20,
            40
          ]
        },
        "channel": {
          "description": "Channel number",
          "type": "integer"
        },
        "channelRange": {
          "description": "Channel range options",
          "type": "array",
          "items": {
            "type": "integer"
          }
        }
      }
    },
    "wifi50": {
      "description": "AP 5GHz radio configuration of the AP group.",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "autoCellSizing": {
          "description": "Auto Cell Sizing",
          "type": "boolean"
        },
        "txPower": {
          "description": "Transmission power",
          "type": "string",
          "enum": [
            "Full",
            "-1dB",
            "-2dB",
            "-3dB(1/2)",
            "-4dB",
            "-5dB",
            "-6dB(1/4)",
            "-7dB",
            "-8dB",
            "-9dB(1/8)",
            "-10dB",
            "Min"
          ]
        },
        "channelWidth": {
          "description": "Channel width. Zero (0) means Auto. 8080 means 80+80MHz",
          "type": "integer",
          "enum": [
            0,
            20,
            40,
            80,
            8080,
            160
          ]
        },
        "indoorChannel": {
          "description": "Channel number for Indoor AP",
          "type": "integer"
        },
        "outdoorChannel": {
          "description": "Channel number for Outdoor AP",
          "type": "integer"
        },
        "indoorSecondaryChannel": {
          "description": "Secondary channel number for Indoor AP (channelWidth is 80+80MHz only)",
          "type": "integer"
        },
        "outdoorSecondaryChannel": {
          "description": "Secondary channel number for outdoor AP (channelWidth is 80+80MHz only)",
          "type": "integer"
        },
        "indoorChannelRange": {
          "description": "Channel range options for Indoor AP",
          "type": "array",
          "items": {
            "type": "integer"
          }
        },
        "outdoorChannelRange": {
          "description": "Channel range options for outdoor AP",
          "type": "array",
          "items": {
            "type": "integer"
          }
        }
      }
    },
    "protectionMode24": {
      "description": "AP 2.4GHz Protection mode configuration of the AP group.",
      "type": "string",
      "enum": [
        "NONE",
        "CTS_ONLY",
        "RTS_CTS"
      ]
    },
    "wlanGroup24": {
      "description": "WLAN group of 2.4GHz radio. This configuraiton will override the WLAN group of 2.4GHz radio at the zone level.",
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "wlanGroup50": {
      "description": "WLAN group of 5G radio. This configuration will override the WLAN group of 5G radio at the zone level.",
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "locationBasedService": {
      "description": "Location based service configuration of the AP group.",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "enabled": {
          "type": "boolean"
        },
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "clientAdmissionControl24": {
      "description": "AP client admission control of 2.4GHz radio configuration of the AP group.",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "enabled": {
          "type": "boolean"
        },
        "maxRadioLoadPercent": {
          "description": "Maximum radio load percentage.",
          "type": "integer",
          "minimum": 50,
          "maximum": 100
        },
        "minClientCount": {
          "description": "Minimum client count number.",
          "type": "integer",
          "minimum": 0,
          "maximum": 100
        },
        "minClientThroughputMbps": {
          "description": "Minimum client throughput in Mbps.",
          "type": "number",
          "minimum": 0,
          "maximum": 100
        }
      }
    },
    "clientAdmissionControl50": {
      "description": "AP client admission control of 5GHz radio configuration of the AP group.",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "enabled": {
          "type": "boolean"
        },
        "maxRadioLoadPercent": {
          "description": "Maximum radio load percentage.",
          "type": "integer",
          "minimum": 50,
          "maximum": 100
        },
        "minClientCount": {
          "description": "Minimum client count number.",
          "type": "integer",
          "minimum": 0,
          "maximum": 100
        },
        "minClientThroughputMbps": {
          "description": "Minimum client throughput in Mbps.",
          "type": "number",
          "minimum": 0,
          "maximum": 100
        }
      }
    },
    "venueProfile": {
      "description": "Venue profile configuration of the AP group.",
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "autoChannelSelection24": {
      "description": "client load balancing on Radio 2.4G, auto channel selection mode",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "channelSelectMode": {
          "description": "Channel Select Mode",
          "type": "string",
          "enum": [
            "None",
            "BackgroundScanning",
            "ChannelFly"
          ]
        },
        "channelFlyMtbc": {
          "description": "ChannelFly MTBC",
          "type": "integer",
          "minimum": 100,
          "maximum": 1440
        }
      }
    },
    "autoChannelSelection50": {
      "description": "client load balancing on Radio 5G, auto channel selection mode",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "channelSelectMode": {
          "description": "Channel Select Mode",
          "type": "string",
          "enum": [
            "None",
            "BackgroundScanning",
            "ChannelFly"
          ]
        },
        "channelFlyMtbc": {
          "description": "ChannelFly MTBC",
          "type": "integer",
          "minimum": 100,
          "maximum": 1440
        }
      }
    },
    "channelEvaluationInterval": {
      "description": "channel evaluation Interval of the ap group",
      "type": "integer",
      "minimum": 60,
      "maximum": 3600
    },
    "apMgmtVlan": {
      "description": "ap Management Vlan of the apgroup",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "mode": {
          "description": "Vlan Mode of the zone",
          "type": "string",
          "enum": [
            "KEEP",
            "USER_DEFINED"
          ]
        },
        "id": {
          "description": "Vlan id of the zone",
          "type": "integer"
        }
      }
    },
    "awsVenue": {
      "description": "Venue code",
      "type": "string"
    },
    "recoverySsid": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "recoverySsidEnabled": {
          "description": "recovery ssid enable/disable",
          "type": "boolean"
        }
      }
    },
    "rogueApReportThreshold": {
      "description": "Rogue AP report will leave out all entries that have signal strength lower than this threshold.",
      "type": "integer"
    },
    "rogueApAggressivenessMode": {
      "description": "Adjust the frequency interval to de-authenticate rogue APs.",
      "type": "integer"
    },
    "rogueApJammingThreshold": {
      "type": "integer"
    },
    "directedMulticastFromWiredClientEnabled": {
      "description": "Directed multicast from wired client to network.",
      "type": "boolean"
    },
    "directedMulticastFromWirelessClientEnabled": {
      "description": "Directed multicast from wireless client to network.",
      "type": "boolean"
    },
    "directedMulticastFromNetworkEnabled": {
      "description": "Directed multicast from network to wired / wireless client.",
      "type": "boolean"
    },
    "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"
          }
        }
      }
    }
  }
}
Response  204

Modify Location Override

PATCH/v8_1/rkszones/{zoneId}/apgroups/{id}/location

Use this API command to modify the location override zone for APs that belong to an AP group.

Request
HideShow
Body
"test-ap1_modify"
Schema
{
  "description": "Location of the AP group.",
  "type": "string"
}
Response  204

Modify Location AdditionalInfo Override

PATCH/v8_1/rkszones/{zoneId}/apgroups/{id}/locationAdditionalInfo

Use this API command to modify the locationAdditionalInfo override zone for APs that belong to an AP group.

Request
HideShow
Body
"add"
Schema
{
  "description": "Location additional info of the AP group.",
  "type": "string",
  "pattern": "^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
}
Response  204

Modify Radio 2.4G Override

PATCH/v8_1/rkszones/{zoneId}/apgroups/{id}/wifi24

Use this API command to modify the 2.4GHz radio configuration override zone for APs that belong to an AP group.

Request
HideShow
Body
{
  "txPower": "Full",
  "channelWidth": 20,
  "channel": 10,
  "channelRange": [
    1,
    2,
    3,
    4,
    5,
    6,
    7,
    8,
    9,
    10,
    11
  ]
}
Schema
{
  "description": "AP 2.4GHz radio configuration of the AP group.",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "autoCellSizing": {
      "description": "Auto Cell Sizing",
      "type": "boolean"
    },
    "txPower": {
      "description": "Transmission power",
      "type": "string",
      "enum": [
        "Full",
        "-1dB",
        "-2dB",
        "-3dB(1/2)",
        "-4dB",
        "-5dB",
        "-6dB(1/4)",
        "-7dB",
        "-8dB",
        "-9dB(1/8)",
        "-10dB",
        "Min"
      ]
    },
    "channelWidth": {
      "description": "Channel width. Zero (0) means Auto.",
      "type": "integer",
      "enum": [
        0,
        20,
        40
      ]
    },
    "channel": {
      "description": "Channel number",
      "type": "integer"
    },
    "channelRange": {
      "description": "Channel range options",
      "type": "array",
      "items": {
        "type": "integer"
      }
    }
  }
}
Response  204

Modify Radio 5G Override

PATCH/v8_1/rkszones/{zoneId}/apgroups/{id}/wifi50

Use this API command to modify the 5GHz radio configuration override zone for APs that belong to an AP group.

Request
HideShow
Body
{
  "txPower": "Full",
  "channelWidth": 20,
  "indoorChannel": 36,
  "outdoorChannel": 149,
  "indoorChannelRange": [
    36,
    40,
    44,
    48,
    149,
    153,
    157,
    161
  ],
  "outdoorChannelRange": [
    149,
    153,
    157,
    161
  ]
}
Schema
{
  "description": "AP 5GHz radio configuration of the AP group.",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "autoCellSizing": {
      "description": "Auto Cell Sizing",
      "type": "boolean"
    },
    "txPower": {
      "description": "Transmission power",
      "type": "string",
      "enum": [
        "Full",
        "-1dB",
        "-2dB",
        "-3dB(1/2)",
        "-4dB",
        "-5dB",
        "-6dB(1/4)",
        "-7dB",
        "-8dB",
        "-9dB(1/8)",
        "-10dB",
        "Min"
      ]
    },
    "channelWidth": {
      "description": "Channel width. Zero (0) means Auto. 8080 means 80+80MHz",
      "type": "integer",
      "enum": [
        0,
        20,
        40,
        80,
        8080,
        160
      ]
    },
    "indoorChannel": {
      "description": "Channel number for Indoor AP",
      "type": "integer"
    },
    "outdoorChannel": {
      "description": "Channel number for Outdoor AP",
      "type": "integer"
    },
    "indoorSecondaryChannel": {
      "description": "Secondary channel number for Indoor AP (channelWidth is 80+80MHz only)",
      "type": "integer"
    },
    "outdoorSecondaryChannel": {
      "description": "Secondary channel number for outdoor AP (channelWidth is 80+80MHz only)",
      "type": "integer"
    },
    "indoorChannelRange": {
      "description": "Channel range options for Indoor AP",
      "type": "array",
      "items": {
        "type": "integer"
      }
    },
    "outdoorChannelRange": {
      "description": "Channel range options for outdoor AP",
      "type": "array",
      "items": {
        "type": "integer"
      }
    }
  }
}
Response  204

Modify WLAN group 2.4G Override

PATCH/v8_1/rkszones/{zoneId}/apgroups/{id}/wlanGroup24

Use this API command to modify the WLAN group on 2.4GHz radio override zone for APs that belong to an AP group.

Request
HideShow
Body
{
  "id": "19b10850-7eaa-11e4-a584-08002716c79f",
  "name": "default"
}
Schema
{
  "description": "WLAN group of 2.4GHz radio. This configuraiton will override the WLAN group of 2.4GHz radio at the zone level.",
  "type": [
    "object",
    "null"
  ],
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    }
  }
}
Response  204

Modify WLAN group 5G Override

PATCH/v8_1/rkszones/{zoneId}/apgroups/{id}/wlanGroup50

Use this API command to modify the WLAN group on 5GHz radio override zone for APs that belong to an AP group.

Request
HideShow
Body
{
  "id": "19b10850-7eaa-11e4-a584-08002716c79f",
  "name": "default"
}
Schema
{
  "description": "WLAN group of 5G radio. This configuration will override the WLAN group of 5G radio at the zone level.",
  "type": [
    "object",
    "null"
  ],
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    }
  }
}
Response  204

Modify Location Based Service Override

PATCH/v8_1/rkszones/{zoneId}/apgroups/{id}/locationBasedService

Use this API command to modify location based service override zone for APs that belong to an AP group.

Request
HideShow
Body
{
  "id": "lbsServiceId",
  "name": "lbsServiceName"
}
Schema
{
  "description": "Location based service configuration of the AP group.",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "enabled": {
      "type": "boolean"
    },
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    }
  }
}
Response  204

Modify Client Admission Control 2.4G Override

PATCH/v8_1/rkszones/{zoneId}/apgroups/{id}/clientAdmissionControl24

Use this API command to modify client admission control 2.4GHz radio configuration override zone for APs that belong to an AP group.

Request
HideShow
Body
{
  "maxRadioLoadPercent": 70,
  "minClientCount": 30,
  "minClientThroughputMbps": 10,
  "enabled": true
}
Schema
{
  "description": "AP client admission control of 2.4GHz radio configuration of the AP group.",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "enabled": {
      "type": "boolean"
    },
    "maxRadioLoadPercent": {
      "description": "Maximum radio load percentage.",
      "type": "integer",
      "minimum": 50,
      "maximum": 100
    },
    "minClientCount": {
      "description": "Minimum client count number.",
      "type": "integer",
      "minimum": 0,
      "maximum": 100
    },
    "minClientThroughputMbps": {
      "description": "Minimum client throughput in Mbps.",
      "type": "number",
      "minimum": 0,
      "maximum": 100
    }
  }
}
Response  204

Modify Client Admission Control 5G Override

PATCH/v8_1/rkszones/{zoneId}/apgroups/{id}/clientAdmissionControl50

Use this API command to modify client admission control 5GHz radio configuration override zone for APs that belong to an AP group.

Request
HideShow
Body
{
  "maxRadioLoadPercent": 70,
  "minClientCount": 30,
  "minClientThroughputMbps": 10,
  "enabled": true
}
Schema
{
  "description": "AP client admission control of 5GHz radio configuration of the AP group.",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "enabled": {
      "type": "boolean"
    },
    "maxRadioLoadPercent": {
      "description": "Maximum radio load percentage.",
      "type": "integer",
      "minimum": 50,
      "maximum": 100
    },
    "minClientCount": {
      "description": "Minimum client count number.",
      "type": "integer",
      "minimum": 0,
      "maximum": 100
    },
    "minClientThroughputMbps": {
      "description": "Minimum client throughput in Mbps.",
      "type": "number",
      "minimum": 0,
      "maximum": 100
    }
  }
}
Response  204

Modify Hotspot2.0 Venue Profile

PATCH/v8_1/rkszones/{zoneId}/apgroups/{id}/venueProfile

Use this API command to modify Hotspot 2.0 venue profile for APs that belong to an AP group.

Request
HideShow
Body
{
  "id": "venueProfileId",
  "name": "venueProfileName"
}
Schema
{
  "description": "Venue profile configuration of the AP group.",
  "type": [
    "object",
    "null"
  ],
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    }
  }
}
Response  204

Modify Radio 2.4G Auto ChannelSelectMode Override

PATCH/v8_1/rkszones/{zoneId}/apgroups/{id}/autoChannelSelection24

Override Radio 2.4G Auto ChannelSelectMode and ChannelFly MTBC of an AP group.

Request
HideShow
Body
{
  "channelSelectMode": "ChannelFly",
  "channelFlyMtbc": 480
}
Schema
{
  "description": "client load balancing on Radio 2.4G, auto channel selection mode",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "channelSelectMode": {
      "description": "Channel Select Mode",
      "type": "string",
      "enum": [
        "None",
        "BackgroundScanning",
        "ChannelFly"
      ]
    },
    "channelFlyMtbc": {
      "description": "ChannelFly MTBC",
      "type": "integer",
      "minimum": 100,
      "maximum": 1440
    }
  }
}
Response  204

Modify Radio 5G Auto ChannelSelectMode Override

PATCH/v8_1/rkszones/{zoneId}/apgroups/{id}/autoChannelSelection50

Override Radio 5G Auto ChannelSelectMode and ChannelFly MTBC of an AP group.

Request
HideShow
Body
{
  "channelSelectMode": "BackgroundScanning",
  "channelFlyMtbc": 480
}
Schema
{
  "description": "client load balancing on Radio 5G, auto channel selection mode",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "channelSelectMode": {
      "description": "Channel Select Mode",
      "type": "string",
      "enum": [
        "None",
        "BackgroundScanning",
        "ChannelFly"
      ]
    },
    "channelFlyMtbc": {
      "description": "ChannelFly MTBC",
      "type": "integer",
      "minimum": 100,
      "maximum": 1440
    }
  }
}
Response  204

Modify AP Management Vlan

PATCH/v8_1/rkszones/{zoneId}/apgroups/{id}/apMgmtVlan

Modify AP Management Vlan of an AP group.

Request
HideShow
Body
{
  "id": 1,
  "mode": "KEEP"
}
Schema
{
  "description": "ap Management Vlan of the apgroup",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "mode": {
      "description": "Vlan Mode of the zone",
      "type": "string",
      "enum": [
        "KEEP",
        "USER_DEFINED"
      ]
    },
    "id": {
      "description": "Vlan id of the zone",
      "type": "integer"
    }
  }
}
Response  204

Modify Altitude of ApGroup

PATCH/v8_1/rkszones/{zoneId}/apgroups/{id}/altitude

Use this API command to modify the altitude of AP group.

Request
HideShow
Body
{
  "altitudeUnit": "meters",
  "altitudeValue": 1
}
Schema
{
  "description": "GPS Altitude",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "altitudeUnit": {
      "description": "altitude unit",
      "type": "string",
      "enum": [
        "meters",
        "floor"
      ]
    },
    "altitudeValue": {
      "description": "altitude value",
      "type": "integer"
    }
  }
}
Response  204

Modify Recovery SSID Override

PATCH/v8_1/rkszones/{zoneId}/apgroups/{id}/recoverySsid

Use this API command to modify the Recovery SSID of an AP group.

Request
HideShow
Body
{
  "recoverySsidEnabled": true
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "recoverySsidEnabled": {
      "description": "recovery ssid enable/disable",
      "type": "boolean"
    }
  }
}
Response  204

Disable Location Override

DELETE/v8_1/rkszones/{zoneId}/apgroups/{id}/location

Use this API command to disable location override for APs that belong to an AP group.

Response  204

Disable Location AdditionalInfo Override

DELETE/v8_1/rkszones/{zoneId}/apgroups/{id}/locationAdditionalInfo

Use this API command to disable location additionalInfo override zone for APs that belong to an AP group.

Response  204

Disable Radio 2.4G Override

DELETE/v8_1/rkszones/{zoneId}/apgroups/{id}/wifi24

Use this API command to disable 2.4GHz radio configuration override zone for APs that belong to an AP group.

Response  204

Disable Radio 5G Override

DELETE/v8_1/rkszones/{zoneId}/apgroups/{id}/wifi50

Use this API command to disable 5GHz radio configuration override zone for APs that belong to an AP group.

Response  204

Disable WLAN group 2.4G Override

DELETE/v8_1/rkszones/{zoneId}/apgroups/{id}/wlanGroup24

Use this API command to disable WLAN group on 2.4GHz radio override zone for APs that belong to an AP group.

Response  204

Disable WLAN group 5G Override

DELETE/v8_1/rkszones/{zoneId}/apgroups/{id}/wlanGroup50

Use this API command to disable WLAN group on 5GHz radio override zone for APs that belong to an AP group.

Response  204

Disable Location Based Service Override

DELETE/v8_1/rkszones/{zoneId}/apgroups/{id}/locationBasedService

Use this API command to disable location based service override zone for APs that belong to an AP group.

Response  204

Disable Client Admission Control 2.4G Override

DELETE/v8_1/rkszones/{zoneId}/apgroups/{id}/clientAdmissionControl24

Use this API command to disable client admission control 2.4GHz radio configuration override zone for APs that belong to an AP group.

Response  204

Disable Client Admission Control 5G Override

DELETE/v8_1/rkszones/{zoneId}/apgroups/{id}/clientAdmissionControl50

Use this API command to disable client admission control 5GHz radio configuration override zone for APs that belong to an AP group.

Response  204

Clear Hotspot2.0 Venue Profile

DELETE/v8_1/rkszones/{zoneId}/apgroups/{id}/venueProfile

Use this API command to clear Hotspot 2.0 venue profile for APs that belong to an AP group.

Response  204

Disable Radio 2.4G Auto ChannelSelectMode Override

DELETE/v8_1/rkszones/{zoneId}/apgroups/{id}/autoChannelSelection24

Disable Radio 2.4G Auto ChannelSelectMode and ChannelFly MTBC Override of an AP group.

Response  204

Disable Radio 5G Auto ChannelSelectMode Override

DELETE/v8_1/rkszones/{zoneId}/apgroups/{id}/autoChannelSelection50

Disable Radio 5G Auto ChannelSelectMode and ChannelFly MTBC Override of an AP group.

Response  204

Disable Channel Evaluation Interval Override

DELETE/v8_1/rkszones/{zoneId}/apgroups/{id}/channelEvaluationInterval

Disable Channel Evaluation Interval Override of an AP group.

Response  204

Disable AP Management Vlan Override

DELETE/v8_1/rkszones/{zoneId}/apgroups/{id}/apMgmtVlan

Disable AP Management Vlan Override of an AP group.

Response  204

Disable Altitude of ApGroup

DELETE/v8_1/rkszones/{zoneId}/apgroups/{id}/altitude

Use this API command to clear the altitude of AP group.

Response  204

Create

POST/v8_1/rkszones/{zoneId}/apgroups

Use this API command to create new AP group within a zone.

Request
HideShow
Body
{
  "name": "apGroupName",
  "description": "apGroupDescription",
  "location": "Location",
  "locationAdditionalInfo": "Location_Additional_Info",
  "latitude": 37.411,
  "longitude": -122.0196,
  "altitude": {
    "altitudeUnit": "meters",
    "altitudeValue": 65
  },
  "wlanGroup24": {
    "id": "3b779e31-4469-11e8-823e-3e3d08a406ec",
    "name": "wg1"
  },
  "wlanGroup50": {
    "id": "4550acd1-4469-11e8-823e-3e3d08a406ec",
    "name": "wg2"
  },
  "wifi24": {
    "txPower": "-5dB",
    "channelWidth": 40,
    "channel": 5,
    "channelRange": [
      1,
      2,
      3,
      4,
      5,
      6
    ]
  },
  "wifi50": {
    "txPower": "-5dB",
    "channelWidth": 20,
    "indoorChannel": 36,
    "outdoorChannel": 157,
    "indoorChannelRange": [
      36,
      40,
      44,
      48,
      157,
      161
    ],
    "outdoorChannelRange": [
      157,
      161
    ]
  },
  "locationBasedService": {
    "id": "7bebe311-4471-11e8-823e-3e3d08a406ec",
    "name": "lbs01",
    "enabled": true
  },
  "clientAdmissionControl24": {
    "maxRadioLoadPercent": 75,
    "minClientCount": 10,
    "minClientThroughputMbps": 0,
    "enabled": true
  },
  "clientAdmissionControl50": {
    "maxRadioLoadPercent": 75,
    "minClientCount": 20,
    "minClientThroughputMbps": 0,
    "enabled": true
  },
  "protectionMode24": "RTS_CTS",
  "recoverySsid": {
    "recoverySsidEnabled": true
  },
  "rogueApReportThreshold": 30,
  "rogueApAggressivenessMode": 1,
  "rogueApJammingThreshold": 30,
  "directedMulticastFromWiredClientEnabled": true,
  "directedMulticastFromWirelessClientEnabled": true,
  "directedMulticastFromNetworkEnabled": true,
  "apMgmtVlan": {
    "id": 123,
    "mode": "USER_DEFINED"
  },
  "venueProfile": {
    "id": "631d8150-4484-11e8-8b35-3e3d08a406ec",
    "name": "venueProfile"
  },
  "channelEvaluationInterval": 777,
  "autoChannelSelection24": {
    "channelSelectMode": "BackgroundScanning",
    "channelFlyMtbc": 480
  },
  "autoChannelSelection50": {
    "channelSelectMode": "BackgroundScanning",
    "channelFlyMtbc": 480
  }
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "description": "Name of the AP group",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "Description of the AP group",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "location": {
      "description": "Location of the AP group.",
      "type": "string"
    },
    "locationAdditionalInfo": {
      "description": "Location additional info of the AP group.",
      "type": "string",
      "pattern": "^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
    },
    "altitude": {
      "description": "GPS Altitude",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "altitudeUnit": {
          "description": "altitude unit",
          "type": "string",
          "enum": [
            "meters",
            "floor"
          ],
          "default": "meters"
        },
        "altitudeValue": {
          "description": "altitude value",
          "type": "integer"
        }
      }
    },
    "latitude": {
      "description": "Latitude coordinate (in decimal format) of the AP group",
      "type": "number"
    },
    "longitude": {
      "description": "Longitude coordinate (in decimal format) of the AP group",
      "type": "number"
    },
    "wifi24": {
      "description": "AP 2.4GHz radio configuration of the AP group.",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "autoCellSizing": {
          "description": "Auto Cell Sizing",
          "type": "boolean"
        },
        "txPower": {
          "description": "Transmission power",
          "type": "string",
          "enum": [
            "Full",
            "-1dB",
            "-2dB",
            "-3dB(1/2)",
            "-4dB",
            "-5dB",
            "-6dB(1/4)",
            "-7dB",
            "-8dB",
            "-9dB(1/8)",
            "-10dB",
            "Min"
          ],
          "default": "Full"
        },
        "channelWidth": {
          "description": "Channel width. Zero (0) means Auto.",
          "type": "integer",
          "enum": [
            0,
            20,
            40
          ],
          "default": 0
        },
        "channel": {
          "description": "Channel number",
          "type": "integer"
        },
        "channelRange": {
          "description": "Channel range options",
          "type": "array",
          "items": {
            "type": "integer"
          }
        }
      }
    },
    "wifi50": {
      "description": "AP 5GHz radio configuration of the AP group.",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "autoCellSizing": {
          "description": "Auto Cell Sizing",
          "type": "boolean"
        },
        "txPower": {
          "description": "Transmission power",
          "type": "string",
          "enum": [
            "Full",
            "-1dB",
            "-2dB",
            "-3dB(1/2)",
            "-4dB",
            "-5dB",
            "-6dB(1/4)",
            "-7dB",
            "-8dB",
            "-9dB(1/8)",
            "-10dB",
            "Min"
          ],
          "default": "Full"
        },
        "channelWidth": {
          "description": "Channel width. Zero (0) means Auto. 8080 means 80+80MHz",
          "type": "integer",
          "enum": [
            0,
            20,
            40,
            80,
            8080,
            160
          ],
          "default": 0
        },
        "indoorChannel": {
          "description": "Channel number for Indoor AP",
          "type": "integer"
        },
        "outdoorChannel": {
          "description": "Channel number for Outdoor AP",
          "type": "integer"
        },
        "indoorSecondaryChannel": {
          "description": "Secondary channel number for Indoor AP (channelWidth is 80+80MHz only)",
          "type": "integer"
        },
        "outdoorSecondaryChannel": {
          "description": "Secondary channel number for outdoor AP (channelWidth is 80+80MHz only)",
          "type": "integer"
        },
        "indoorChannelRange": {
          "description": "Channel range options for Indoor AP",
          "type": "array",
          "items": {
            "type": "integer"
          }
        },
        "outdoorChannelRange": {
          "description": "Channel range options for outdoor AP",
          "type": "array",
          "items": {
            "type": "integer"
          }
        }
      }
    },
    "protectionMode24": {
      "description": "AP 2.4GHz Protection mode configuration of the AP group.",
      "type": "string",
      "enum": [
        "NONE",
        "CTS_ONLY",
        "RTS_CTS"
      ],
      "default": "RTS_CTS"
    },
    "wlanGroup24": {
      "description": "WLAN group of 2.4GHz radio. This configuraiton will override the WLAN group of 2.4GHz radio at the zone level.",
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "wlanGroup50": {
      "description": "WLAN group of 5G radio. This configuration will override the WLAN group of 5G radio at the zone level.",
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "locationBasedService": {
      "description": "Location based service configuration of the AP group.",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "enabled": {
          "type": "boolean"
        },
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "clientAdmissionControl24": {
      "description": "AP client admission control of 2.4GHz radio configuration of the AP group.",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "enabled": {
          "type": "boolean"
        },
        "maxRadioLoadPercent": {
          "description": "Maximum radio load percentage.",
          "type": "integer",
          "default": 75,
          "minimum": 50,
          "maximum": 100
        },
        "minClientCount": {
          "description": "Minimum client count number.",
          "type": "integer",
          "default": 10,
          "minimum": 0,
          "maximum": 100
        },
        "minClientThroughputMbps": {
          "description": "Minimum client throughput in Mbps.",
          "type": "number",
          "default": 0,
          "minimum": 0,
          "maximum": 100
        }
      }
    },
    "clientAdmissionControl50": {
      "description": "AP client admission control of 5GHz radio configuration of the AP group.",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "enabled": {
          "type": "boolean"
        },
        "maxRadioLoadPercent": {
          "description": "Maximum radio load percentage.",
          "type": "integer",
          "default": 75,
          "minimum": 50,
          "maximum": 100
        },
        "minClientCount": {
          "description": "Minimum client count number.",
          "type": "integer",
          "default": 10,
          "minimum": 0,
          "maximum": 100
        },
        "minClientThroughputMbps": {
          "description": "Minimum client throughput in Mbps.",
          "type": "number",
          "default": 0,
          "minimum": 0,
          "maximum": 100
        }
      }
    },
    "venueProfile": {
      "description": "Venue profile configuration of the AP group.",
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "autoChannelSelection24": {
      "description": "client load balancing on Radio 2.4G, auto channel selection mode",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "channelSelectMode": {
          "description": "Channel Select Mode",
          "type": "string",
          "enum": [
            "None",
            "BackgroundScanning",
            "ChannelFly"
          ],
          "default": "BackgroundScanning"
        },
        "channelFlyMtbc": {
          "description": "ChannelFly MTBC",
          "type": "integer",
          "default": 480,
          "minimum": 100,
          "maximum": 1440
        }
      }
    },
    "autoChannelSelection50": {
      "description": "client load balancing on Radio 5G, auto channel selection mode",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "channelSelectMode": {
          "description": "Channel Select Mode",
          "type": "string",
          "enum": [
            "None",
            "BackgroundScanning",
            "ChannelFly"
          ],
          "default": "BackgroundScanning"
        },
        "channelFlyMtbc": {
          "description": "ChannelFly MTBC",
          "type": "integer",
          "default": 480,
          "minimum": 100,
          "maximum": 1440
        }
      }
    },
    "channelEvaluationInterval": {
      "description": "channel evaluation Interval of the ap group",
      "type": "integer",
      "default": 600,
      "minimum": 60,
      "maximum": 3600
    },
    "apMgmtVlan": {
      "description": "ap Management Vlan of the apgroup",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "mode": {
          "description": "Vlan Mode of the zone",
          "type": "string",
          "enum": [
            "KEEP",
            "USER_DEFINED"
          ],
          "default": "KEEP"
        },
        "id": {
          "description": "Vlan id of the zone",
          "type": "integer",
          "default": "1"
        }
      }
    },
    "awsVenue": {
      "description": "Venue code",
      "type": "string"
    },
    "recoverySsid": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "recoverySsidEnabled": {
          "description": "recovery ssid enable/disable",
          "type": "boolean"
        }
      }
    },
    "rogueApReportThreshold": {
      "description": "Rogue AP report will leave out all entries that have signal strength lower than this threshold.",
      "type": "integer"
    },
    "rogueApAggressivenessMode": {
      "description": "Adjust the frequency interval to de-authenticate rogue APs.",
      "type": "integer"
    },
    "rogueApJammingThreshold": {
      "type": "integer"
    },
    "directedMulticastFromWiredClientEnabled": {
      "description": "Directed multicast from wired client to network.",
      "type": "boolean"
    },
    "directedMulticastFromWirelessClientEnabled": {
      "description": "Directed multicast from wireless client to network.",
      "type": "boolean"
    },
    "directedMulticastFromNetworkEnabled": {
      "description": "Directed multicast from network to wired / wireless client.",
      "type": "boolean"
    },
    "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"
          }
        }
      }
    }
  },
  "required": [
    "name"
  ]
}
Response  201
HideShow
Body
{
  "id": "apGroupUUID"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Delete

DELETE/v8_1/rkszones/{zoneId}/apgroups/{id}

Use this API command to delete an AP group.

Response  204

Retrieve List

GET/v8_1/rkszones/{zoneId}/apgroups

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

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

Response  200
HideShow
Body
{
  "totalCount": 2,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "id": "apGroupUUID",
      "name": "apGroupName"
    },
    {
      "id": "apGroupUUID2",
      "name": "apGroupName2"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "Identifier of the AP group",
            "type": "string"
          },
          "name": {
            "description": "Description of the AP group",
            "type": "string"
          }
        }
      }
    }
  }
}

Retrieve

GET/v8_1/rkszones/{zoneId}/apgroups/{id}

Use this API command to retrieve information about an AP group.

Response  200
HideShow
Body
{
  "id": "apGroupUUID",
  "zoneId": "zoneUUID",
  "name": "apGroupName",
  "description": "apGroupDescription",
  "location": "test-ap1_modify",
  "locationAdditionalInfo": "add",
  "latitude": 34,
  "longitude": 45,
  "wifi24": {
    "txPower": "Full",
    "channelWidth": 20,
    "channel": 9,
    "channelRange": [
      1,
      2,
      3,
      4,
      9,
      10,
      11
    ],
    "availableChannelRange": [
      1,
      2,
      3,
      4,
      5,
      6,
      7,
      8,
      9,
      10,
      11
    ]
  },
  "wifi50": {
    "txPower": "Full",
    "channelWidth": 40,
    "indoorChannel": 0,
    "outdoorChannel": 157,
    "indoorChannelRange": [
      36,
      40,
      44,
      48
    ],
    "outdoorChannelRange": [
      149,
      153
    ],
    "availableIndoorChannelRange": [
      36,
      40,
      44,
      48,
      149,
      153,
      157,
      161
    ],
    "availableOutdoorChannelRange": [
      149,
      153,
      157,
      161
    ]
  },
  "protectionMode24": "CTS_ONLY",
  "wlanGroup24": {
    "id": "19b10850-7eaa-11e4-a584-08002716c79f",
    "name": "default"
  },
  "wlanGroup50": null,
  "locationBasedService": null,
  "clientAdmissionControl24": {
    "maxRadioLoadPercent": 70,
    "minClientCount": 30,
    "minClientThroughputMbps": 10,
    "enabled": true
  },
  "clientAdmissionControl50": null,
  "venueProfile": null,
  "members": [
    {
      "apMac": "00:11:22:33:44:55"
    },
    {
      "apMac": "11:22:33:44:55:66"
    }
  ],
  "autoChannelSelection24": {
    "channelSelectMode": "ChannelFly",
    "channelFlyMtbc": 480
  },
  "autoChannelSelection50": {
    "channelSelectMode": "BackgroundScanning",
    "channelFlyMtbc": 480
  },
  "channelEvaluationInterval": 777,
  "apMgmtVlan": {
    "id": 1,
    "mode": "KEEP"
  },
  "altitude": {
    "altitudeUnit": "meters",
    "altitudeValue": 1
  },
  "recoverySsid": {
    "recoverySsidEnabled": true
  },
  "rogueApReportThreshold": 30,
  "rogueApAggressivenessMode": 1,
  "rogueApJammingThreshold": 30,
  "directedMulticastFromWiredClientEnabled": true,
  "directedMulticastFromWirelessClientEnabled": true,
  "directedMulticastFromNetworkEnabled": false
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "Identifier of the AP group",
      "type": "string"
    },
    "zoneId": {
      "description": "Identifier of the zone to which the AP group belongs",
      "type": "string"
    },
    "name": {
      "description": "Name of the AP group",
      "type": "string"
    },
    "description": {
      "description": "Description of the AP group",
      "type": "string"
    },
    "location": {
      "description": "Location of the AP group.",
      "type": "string"
    },
    "locationAdditionalInfo": {
      "description": "Location additional info of the AP group.",
      "type": "string",
      "pattern": "^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
    },
    "altitude": {
      "description": "GPS Altitude",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "altitudeUnit": {
          "description": "altitude unit",
          "type": "string",
          "enum": [
            "meters",
            "floor"
          ],
          "default": "meters"
        },
        "altitudeValue": {
          "description": "altitude value",
          "type": "integer"
        }
      }
    },
    "latitude": {
      "description": "Latitude coordinate (in decimal format) of the AP group",
      "type": "number"
    },
    "longitude": {
      "description": "Longitude coordinate (in decimal format) of the AP group",
      "type": "number"
    },
    "wifi24": {
      "description": "AP 2.4GHz radio configuration of the AP group.",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "autoCellSizing": {
          "description": "Auto Cell Sizing",
          "type": "boolean"
        },
        "txPower": {
          "description": "Transmission power",
          "type": "string",
          "enum": [
            "Full",
            "-1dB",
            "-2dB",
            "-3dB(1/2)",
            "-4dB",
            "-5dB",
            "-6dB(1/4)",
            "-7dB",
            "-8dB",
            "-9dB(1/8)",
            "-10dB",
            "Min"
          ],
          "default": "Full"
        },
        "channelWidth": {
          "description": "Channel width. Zero (0) means Auto.",
          "type": "integer",
          "enum": [
            0,
            20,
            40
          ]
        },
        "channel": {
          "description": "Channel number",
          "type": "integer"
        },
        "channelRange": {
          "description": "Channel range options",
          "type": "array",
          "items": {
            "type": "integer"
          }
        },
        "availableChannelRange": {
          "description": "Available channel range options",
          "type": "array",
          "items": {
            "type": "integer"
          }
        }
      }
    },
    "wifi50": {
      "description": "AP 5GHz radio configuration of the AP group.",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "autoCellSizing": {
          "description": "Auto Cell Sizing",
          "type": "boolean"
        },
        "txPower": {
          "description": "Transmission power",
          "type": "string",
          "enum": [
            "Full",
            "-1dB",
            "-2dB",
            "-3dB(1/2)",
            "-4dB",
            "-5dB",
            "-6dB(1/4)",
            "-7dB",
            "-8dB",
            "-9dB(1/8)",
            "-10dB",
            "Min"
          ],
          "default": "Full"
        },
        "channelWidth": {
          "description": "Channel width. Zero (0) means Auto. 8080 means 80+80MHz",
          "type": "integer",
          "enum": [
            0,
            20,
            40,
            80,
            8080,
            160
          ]
        },
        "indoorChannel": {
          "description": "Channel number for Indoor AP",
          "type": "integer"
        },
        "outdoorChannel": {
          "description": "Channel number for Outdoor AP",
          "type": "integer"
        },
        "indoorSecondaryChannel": {
          "description": "Secondary channel number for Indoor AP (channelWidth is 80+80MHz only)",
          "type": "integer"
        },
        "outdoorSecondaryChannel": {
          "description": "Secondary channel number for outdoor AP (channelWidth is 80+80MHz only)",
          "type": "integer"
        },
        "indoorChannelRange": {
          "description": "Channel range options for Indoor AP",
          "type": "array",
          "items": {
            "type": "integer"
          }
        },
        "outdoorChannelRange": {
          "description": "Channel range options for outdoor AP",
          "type": "array",
          "items": {
            "type": "integer"
          }
        },
        "availableIndoorChannelRange": {
          "description": "Available channel range options",
          "type": "array",
          "items": {
            "type": "integer"
          }
        },
        "availableOutdoorChannelRange": {
          "description": "Available channel range options",
          "type": "array",
          "items": {
            "type": "integer"
          }
        }
      }
    },
    "protectionMode24": {
      "description": "AP 2.4GHz Protection mode configuration of the AP group.",
      "type": "string",
      "enum": [
        "NONE",
        "CTS_ONLY",
        "RTS_CTS"
      ],
      "default": "RTS_CTS"
    },
    "wlanGroup24": {
      "description": "WLAN group of radio 2.4G. This configuraiton will override the WLAN group of radio 2.4G at the zone level.",
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "wlanGroup50": {
      "description": "WLAN group of radio 5G. This configuration will override the WLAN group of radio 5G at the zone level.",
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "locationBasedService": {
      "description": "Location based service configuration of the AP group.",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "enabled": {
          "type": "boolean"
        },
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "clientAdmissionControl24": {
      "description": "WLAN group of 2.4GHz radio. This configuraiton will override the WLAN group of 2.4GHz radio at the zone level.",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "enabled": {
          "type": "boolean"
        },
        "maxRadioLoadPercent": {
          "description": "Maximum radio load percentage.",
          "type": "integer",
          "default": 75,
          "minimum": 50,
          "maximum": 100
        },
        "minClientCount": {
          "description": "Minimum client count number.",
          "type": "integer",
          "default": 10,
          "minimum": 0,
          "maximum": 100
        },
        "minClientThroughputMbps": {
          "description": "Minimum client throughput in Mbps.",
          "type": "number",
          "default": 0,
          "minimum": 0,
          "maximum": 100
        }
      }
    },
    "clientAdmissionControl50": {
      "description": "WLAN group of 5G radio. This configuration will override the WLAN group of 5G radio at the zone level.",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "enabled": {
          "type": "boolean"
        },
        "maxRadioLoadPercent": {
          "description": "Maximum radio load percentage.",
          "type": "integer",
          "default": 75,
          "minimum": 50,
          "maximum": 100
        },
        "minClientCount": {
          "description": "Minimum client count number.",
          "type": "integer",
          "default": 10,
          "minimum": 0,
          "maximum": 100
        },
        "minClientThroughputMbps": {
          "description": "Minimum client throughput in Mbps.",
          "type": "number",
          "default": 0,
          "minimum": 0,
          "maximum": 100
        }
      }
    },
    "venueProfile": {
      "description": "Venue profile configuration of the AP group.",
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "members": {
      "description": "Members of the AP group",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "apMac": {
            "description": "MAC address of member AP",
            "type": "string",
            "pattern": "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
          },
          "apSerial": {
            "description": "Serial number of member AP",
            "type": "string"
          }
        }
      }
    },
    "autoChannelSelection24": {
      "description": "client load balancing on Radio 2.4G, auto channel selection mode",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "channelSelectMode": {
          "description": "Channel Select Mode",
          "type": "string",
          "enum": [
            "None",
            "BackgroundScanning",
            "ChannelFly"
          ],
          "default": "BackgroundScanning"
        },
        "channelFlyMtbc": {
          "description": "ChannelFly MTBC",
          "type": "integer",
          "default": 480,
          "minimum": 100,
          "maximum": 1440
        }
      }
    },
    "autoChannelSelection50": {
      "description": "client load balancing on Radio 5G, auto channel selection mode",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "channelSelectMode": {
          "description": "Channel Select Mode",
          "type": "string",
          "enum": [
            "None",
            "BackgroundScanning",
            "ChannelFly"
          ],
          "default": "BackgroundScanning"
        },
        "channelFlyMtbc": {
          "description": "ChannelFly MTBC",
          "type": "integer",
          "default": 480,
          "minimum": 100,
          "maximum": 1440
        }
      }
    },
    "channelEvaluationInterval": {
      "description": "channel evaluation Interval of the ap group",
      "type": "integer",
      "default": 600,
      "minimum": 60,
      "maximum": 3600
    },
    "apMgmtVlan": {
      "description": "ap Management Vlan of the apgroup",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "mode": {
          "description": "Vlan Mode of the zone",
          "type": "string",
          "enum": [
            "KEEP",
            "USER_DEFINED"
          ],
          "default": "KEEP"
        },
        "id": {
          "description": "Vlan id of the zone",
          "type": "integer",
          "default": "1"
        }
      }
    },
    "awsVenue": {
      "description": "Venue code",
      "type": "string"
    },
    "recoverySsid": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "recoverySsidEnabled": {
          "description": "recovery ssid enable/disable",
          "type": "boolean"
        }
      }
    },
    "rogueApReportThreshold": {
      "description": "Rogue AP report will leave out all entries that have signal strength lower than this threshold.",
      "type": "integer"
    },
    "rogueApAggressivenessMode": {
      "description": "Adjust the frequency interval to de-authenticate rogue APs.",
      "type": "integer"
    },
    "rogueApJammingThreshold": {
      "type": "integer"
    },
    "directedMulticastFromWiredClientEnabled": {
      "type": "boolean"
    },
    "directedMulticastFromWirelessClientEnabled": {
      "type": "boolean"
    },
    "directedMulticastFromNetworkEnabled": {
      "type": "boolean"
    },
    "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"
          }
        }
      }
    }
  },
  "required": [
    "name"
  ]
}

Add Member

POST/v8_1/rkszones/{zoneId}/apgroups/{id}/members/{apMac}

Use this API command to add a member AP to an AP group.

Response  201

Disable Radio 2.4G TxPower Override

DELETE/v8_1/rkszones/{zoneId}/apgroups/{id}/wifi24/txPower

Use this API command to disable 2.4GHz radio txPower override zone for APs that belong to an AP group.

Response  204

Disable Radio 5G TxPower Override

DELETE/v8_1/rkszones/{zoneId}/apgroups/{id}/wifi50/txPower

Use this API command to disable 5GHz radio txPower override zone for APs that belong to an AP group.

Response  204

Disable Radio 2.4G ChannelWidth Override

DELETE/v8_1/rkszones/{zoneId}/apgroups/{id}/wifi24/channelWidth

Use this API command to disable 2.4GHz radio channelWidth override zone for APs that belong to an AP group.

Response  204

Disable Radio 2.4G Channel Override

DELETE/v8_1/rkszones/{zoneId}/apgroups/{id}/wifi24/channel

Use this API command to disable 2.4GHz radio channel override zone for APs that belong to an AP group.

Response  204

Disable Radio 2.4G ChannelRange Override

DELETE/v8_1/rkszones/{zoneId}/apgroups/{id}/wifi24/channelRange

Use this API command to disable 2.4GHz radio channelRange override zone for APs that belong to an AP group.

Response  204

Disable Radio 5G ChannelWidth Override

DELETE/v8_1/rkszones/{zoneId}/apgroups/{id}/wifi50/channelWidth

Use this API command to disable 5GHz radio channelWidth override zone for APs that belong to an AP group.

Response  204

Disable Radio 5G IndoorChannel Override

DELETE/v8_1/rkszones/{zoneId}/apgroups/{id}/wifi50/indoorChannel

Use this API command to disable 5GHz radio indoorChannel override zone for APs that belong to an AP group.

Response  204

Disable Radio 5G OutdoorChannel Override

DELETE/v8_1/rkszones/{zoneId}/apgroups/{id}/wifi50/outdoorChannel

Use this API command to disable 5GHz radio outdoorChannel override zone for APs that belong to an AP group.

Response  204

Disable Radio 5G IndoorChannelRange Override

DELETE/v8_1/rkszones/{zoneId}/apgroups/{id}/wifi50/indoorChannelRange

Use this API command to disable 5GHz radio indoorChannelRange override zone for APs that belong to an AP group.

Response  204

Disable Radio 5G OutdoorChannelRange Override

DELETE/v8_1/rkszones/{zoneId}/apgroups/{id}/wifi50/outdoorChannelRange

Use this API command to disable 5GHz radio outdoorChannelRange override zone for APs that belong to an AP group.

Response  204

Disable 2.4GHz radio protection mode override.

DELETE/v8_1/rkszones/{zoneId}/apgroups/{id}/protectionMode24

Use this API command to disable 2.4GHz radio protection mode configuration override zone for APs that belong to an AP group.

Response  204

Disable Recovery SSID override.

DELETE/v8_1/rkszones/{zoneId}/apgroups/{id}/recoverySsid

Use this API command to disable Recovery SSID configuration override zone for APs that belong to an AP group.

Response  204

Disable Directed Multicast from wired client to Network

DELETE/v8_1/rkszones/{zoneId}/apgroups/{id}/directedMulticastFromWiredClientEnabled

Use this API command to disable Directed Multicast from wired client to Network configuration override zone for APs that belong to an AP group.

Response  204

Disable Directed Multicast from wireless client to Network

DELETE/v8_1/rkszones/{zoneId}/apgroups/{id}/directedMulticastFromWirelessClientEnabled

Use this API command to disable Directed Multicast from wireless client to Network configuration override zone for APs that belong to an AP group.

Response  204

Disable Directed Multicast from Network to wired/wireless client

DELETE/v8_1/rkszones/{zoneId}/apgroups/{id}/directedMulticastFromNetworkEnabled

Use this API command to disable Directed Multicast from Network to wired/wireless client configuration override zone for APs that belong to an AP group.

Response  204

Disable rogue AP report threshold override

DELETE/v8_1/rkszones/{zoneId}/apgroups/{id}/rogueApReportThreshold

Use this API command to disable rogue AP report threshold override zone for APs that belong to an AP group.

Response  204

Disable rogue AP aggressiveness mode override

DELETE/v8_1/rkszones/{zoneId}/apgroups/{id}/rogueApAggressivenessMode

Use this API command to disable rogue AP aggressiveness mode override zone for APs that belong to an AP group.

Response  204

Disable rogue AP jamming threshold override

DELETE/v8_1/rkszones/{zoneId}/apgroups/{id}/rogueApJammingThreshold

Use this API command to disable rogue AP jamming threshold override zone for APs that belong to an AP group.

Response  204

Disable LTE band lock channel override

DELETE/v8_1/rkszones/{zoneId}/apgroups/{id}/lteBandLockChannels

Use this API command to disable LTE band lock channel override zone for APs that belong to an AP group.

Response  204

Add Member List

POST/v8_1/rkszones/{zoneId}/apgroups/{id}/members

Add multiple members to an AP group.

Request
HideShow
Body
{
  "memberList": [
    {
      "apMac": "00:22:11:0C:BD:13"
    },
    {
      "apMac": "10:11:22:0C:0D:15"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "memberList": {
      "description": "List of apMac",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "apMac": {
            "description": "MAC address of member AP",
            "type": "string",
            "pattern": "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
          },
          "apSerial": {
            "description": "Serial number of member AP",
            "type": "string"
          }
        }
      }
    }
  }
}
Response  201

Remove Member

DELETE/v8_1/rkszones/{zoneId}/apgroups/{id}/members/{apMac}

Use this API command to remove a member AP from an AP group.

Response  204

Retrieve AP Model

GET/v8_1/rkszones/{zoneId}/apgroups/{id}/apmodel/{model}

Use this API command to retrieve AP model specific configuration override zone that belong to an AP group, NULL means the override setting is not checked inside an AP group.

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

Override AP Model

PUT/v8_1/rkszones/{zoneId}/apgroups/{id}/apmodel/{model}

Use this API command to modify AP model specific configuration override zone that belong to an AP group.

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

Disable Override AP Model

DELETE/v8_1/rkszones/{zoneId}/apgroups/{id}/apmodel/{model}

Use this API command to disable AP model specific configuration override zone that belong to an AP group.

Response  204

Access Point Configuration

Disable AP Management GPS Cooordinates

DELETE/v8_1/aps/{apMac}/gpsCoordinates

Disable AP Management GPS Cooordinates of an AP.

Response  204

Disable Mesh Options

DELETE/v8_1/aps/{apMac}/meshOptions

Use this API command to disable mesh options.

Response  204

Modify Specific

PUT/v8_1/aps/{apMac}/specific

Use this API command to modify specific configuration.

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

Disable Specific Override

DELETE/v8_1/aps/{apMac}/specific

Use this API command to disable specific configuration override from AP group or zone.

Response  204

Disable 2.4GHz radio protection mode override.

DELETE/v8_1/aps/{apMac}/protectionMode24

Use this API command to disable 2.4GHz radio protection mode configuration override.The AP will apply its group’s or zone’s configuration.

Response  204

Disable Recovery SSID override.

DELETE/v8_1/aps/{apMac}/recoverySsid

Use this API command to disable Recovery SSID configuration override.The AP will apply its group’s or zone’s configuration.

Response  204

Disable Directed Multicast from wired client override.

DELETE/v8_1/aps/{apMac}/directedMulticastFromWiredClientEnabled

Use this API command to disable Island SSID Broadcast enabled configuration override.The AP will apply its group’s or zone’s configuration.

Response  204

Disable Directed Multicast from wireless client override.

DELETE/v8_1/aps/{apMac}/directedMulticastFromWirelessClientEnabled

Use this API command to disable Island SSID Broadcast enabled configuration override.The AP will apply its group’s or zone’s configuration.

Response  204

Disable Directed Multicast from network to wired/wireless client override

DELETE/v8_1/aps/{apMac}/directedMulticastFromNetworkEnabled

Use this API command to disable Directed Multicast from network to wired/wireless client configuration override.The AP will apply its group’s or zone’s configuration.

Response  204

Disable rogue AP report threshold override

DELETE/v8_1/aps/{apMac}/rogueApReportThreshold

Use this API command to disable rogue AP report threshold override. The AP will apply its group’s or zone’s configuration.

Response  204

Disable rogue AP aggressiveness mode override

DELETE/v8_1/aps/{apMac}/rogueApAggressivenessMode

Use this API command to disable rogue AP aggressiveness mode override. The AP will apply its group’s or zone’s configuration.

Response  204

Disable rogue AP jamming threshold override

DELETE/v8_1/aps/{apMac}/rogueApJammingThreshold

Use this API command to disable rogue AP jamming threshold override. The AP will apply its group’s or zone’s configuration.

Response  204

Disable LTE band lock channel override

DELETE/v8_1/aps/{apMac}/lteBandLockChannels

Use this API command to disable LTE band lock channel override. The AP will apply its group’s or zone’s configuration.

Response  204

Download AP support log

GET/v8_1/aps/{apMac}/supportLog

Use this API command to download AP support log.

Response  200
HideShow
Headers
Content-Type: application/octet-stream

Upload AP Picture

POST/v8_1/aps/{apMac}/picture

Use this API command to upload a new AP picture.

Request
HideShow
Headers
Content-Type: multipart/form-data
Response  204

Modify Recovery SSID Override

PATCH/v8_1/aps/{apMac}/recoverySsid

Use this API command to modify the Recovery SSID of an AP.

Request
HideShow
Body
{
  "recoverySsidEnabled": true
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "recoverySsidEnabled": {
      "description": "recovery ssid enable/disable",
      "type": "boolean"
    }
  }
}
Response  204

Disable Login Override

DELETE/v8_1/aps/{apMac}/login

Use this API command to disable the AP-level logon override. The AP will apply its group’s or zone’s configuration.

Response  204

Disable Syslog Override

DELETE/v8_1/aps/{apMac}/syslog

Use this API command to disable the AP level syslog override. The access point will take its group’s or zone’s configuration.

Response  204

Disable Radio 2.4G Override

DELETE/v8_1/aps/{apMac}/wifi24

Use this API command to disable the AP level override of the 2.4GHz radio configuration. The access point will take its group’s configuration or zone’s configuration.

Response  204

Disable Radio 5G Override

DELETE/v8_1/aps/{apMac}/wifi50

Use this API command to disable the AP level override of 5GHz radio configuration. The access point will take its group’s or zone’s configuration.

Response  204

Disable WLAN Group 2.4G Override

DELETE/v8_1/aps/{apMac}/wlanGroup24

Use this API command to disable the AP level override of WLAN group configuration on 2.4GHz radio. The access point will take its group’s or zone’s configuration.

Response  204

Disable WLAN group 5G Override

DELETE/v8_1/aps/{apMac}/wlanGroup50

Use this API command to disable the AP level override of WLAN group on the 5GHz radio. The access point will take its group’s or zone’s configuration.

Response  204

Disable AP Channel Evaluation Interval

DELETE/v8_1/aps/{apMac}/channelEvaluationInterval

Disable AP lChannel Evaluation Interval. The access point will take its group’s configuration or zone’s configuration.

Response  204

Disable Radio 2.4G Auto channel selection

DELETE/v8_1/aps/{apMac}/autoChannelSelection24

Use this API command to disable the AP level override of auto channel selection on the 2.4GHz radio. The access point will take its group’s or zone’s configuration.

Response  204

Disable Radio 5G Auto channel selection

DELETE/v8_1/aps/{apMac}/autoChannelSelection50

Use this API command to disable the AP level override of auto channel selection on the 5GHz radio. The access point will take its group’s or zone’s configuration.

Response  204

Disable AP Management Vlan Override

DELETE/v8_1/aps/{apMac}/apMgmtVlan

Disable AP Management Vlan Override of an AP.

Response  204

Disable Altitude Override

DELETE/v8_1/aps/{apMac}/altitude

Use this API command to disable AP level override of altitude. The access point will take its group’s configuration or zone’s configuration.

Response  204

Retrieve AP Picture

GET/v8_1/aps/{apMac}/picture

Use this API command to retrieve the current AP picture.

Response  200
HideShow
Headers
Content-Type: application/octet-stream

Disable Location Override

DELETE/v8_1/aps/{apMac}/location

Use this API command to disable AP level override of location. The access point will take its group’s configuration or zone’s configuration.

Response  204

Disable Location AdditionalInfo Override

DELETE/v8_1/aps/{apMac}/locationAdditionalInfo

Use this API command to disable AP level override of location additionalInfo. The access point will take its group’s configuration or zone’s configuration.

Response  204

Disable Smart Monitor Override

DELETE/v8_1/aps/{apMac}/smartMonitor

Use this API command to disable AP level override of smart monitor. The access point will take its group’s configuration or zone’s configuration.

Response  204

Disable Bonjour Gateway Override

DELETE/v8_1/aps/{apMac}/bonjourGateway

Use this API command to disable AP level override of bonjour gateway. The access point will take its group’s configuration or zone’s configuration.

Response  204

Disable Client Admission Control 2.4G Override

DELETE/v8_1/aps/{apMac}/clientAdmissionControl24

Use this API command to disable AP level override of client admission control 2.4GHz radio configuration. The access point will take its group’s configuration or zone’s configuration.

Response  204

Disable Client Admission Control 5G Override

DELETE/v8_1/aps/{apMac}/clientAdmissionControl50

Use this API command to disable AP level override of client admission control 5GHz radio configuration. The access point will take its group’s configuration or zone’s configuration.

Response  204

Disable Venue Profile Override

DELETE/v8_1/aps/{apMac}/venueProfile

Use this API command to disable AP level override of venue profile. The access point will take its group’s configuration or zone’s configuration.

Response  204

Disable Radio 2.4G TxPower Override

DELETE/v8_1/aps/{apMac}/wifi24/txPower

Use this API command to disable the AP level override of the 2.4GHz radio txPower. The access point will take its group’s configuration or zone’s configuration.

Response  204

Disable Radio 5G TxPower Override

DELETE/v8_1/aps/{apMac}/wifi50/txPower

Use this API command to disable the AP level override of 5GHz radio txPower. The access point will take its group’s or zone’s configuration.

Response  204

Disable Radio 2.4G ChannelWidth Override

DELETE/v8_1/aps/{apMac}/wifi24/channelWidth

Use this API command to disable the AP level override of the 2.4GHz radio channelWidth. The access point will take its group’s configuration or zone’s configuration.

Response  204

Disable Radio 2.4G Channel Override

DELETE/v8_1/aps/{apMac}/wifi24/channel

Use this API command to disable the AP level override of the 2.4GHz radio channel. The access point will take its group’s configuration or zone’s configuration.

Response  204

Disable Radio 2.4G ChannelRange Override

DELETE/v8_1/aps/{apMac}/wifi24/channelRange

Use this API command to disable the AP level override of the 2.4GHz radio channelRange. The access point will take its group’s configuration or zone’s configuration.

Response  204

Disable Radio 5G ChannelWidth Override

DELETE/v8_1/aps/{apMac}/wifi50/channelWidth

Use this API command to disable the AP level override of 5GHz radio channelWidth. The access point will take its group’s or zone’s configuration.

Response  204

Disable Radio 5G Channel Override

DELETE/v8_1/aps/{apMac}/wifi50/channel

Use this API command to disable the AP level override of 5GHz radio channel. The access point will take its group’s or zone’s configuration.

Response  204

Disable Radio 5G ChannelRange Override

DELETE/v8_1/aps/{apMac}/wifi50/channelRange

Use this API command to disable the AP level override of 5GHz radio channelRange. The access point will take its group’s or zone’s configuration.

Response  204

Reboot

PUT/v8_1/aps/{apMac}/reboot

reboot an access point.

Response  204

AP Factory Reset

POST/v8_1/aps/{apMac}/factoryreset

ap set factory.

Response  200

Delete AP Picture

DELETE/v8_1/aps/{apMac}/picture

Use this API command to delete an AP picture.

Response  204

Retrieve List

GET/v8_1/aps

Use this API command to retrieve the list of APs that belong to a zone or 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

zoneId
string (optional) 

filter AP list by zone

domainId
string (optional) 

filter AP list by domain. Default: current logon domain

Response  200
HideShow
Body
{
  "totalCount": 2,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "mac": "00:11:22:33:44:55",
      "zoneId": "zoneUUID",
      "apGroupId": "apGroupUUID",
      "name": "apName",
      "lanPortSize": 2
    },
    {
      "mac": "11:22:33:44:55:66",
      "zoneId": "zoneUUID2",
      "apGroupId": "apGroupUUID2",
      "name": "apName2",
      "lanPortSize": 1
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "description": "Total AP count",
      "type": "integer"
    },
    "hasMore": {
      "description": "Indicates whether there are more APs after the list that is currently displayed",
      "type": "boolean"
    },
    "firstIndex": {
      "description": "Index of the first AP returned out of the complete AP list",
      "type": "integer"
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "mac": {
            "description": "MAC address of the AP",
            "type": "string",
            "pattern": "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
          },
          "zoneId": {
            "description": "Identifier of the zone to which the AP belongs",
            "type": "string"
          },
          "apGroupId": {
            "description": "Identifier of the AP group to which the AP belongs",
            "type": "string"
          },
          "name": {
            "description": "Name of the AP",
            "type": "string"
          },
          "serial": {
            "description": "Serial Number",
            "type": "string"
          }
        }
      }
    }
  }
}

Modify

PATCH/v8_1/aps/{apMac}

Use this API command to modify the basic information of an AP.

Request
HideShow
Body
{
  "zoneId": "zoneUUID",
  "apGroupId": "apGroupUUID",
  "serial": "00000096",
  "model": "ZF7343",
  "name": "apName",
  "gpsSource": "MANUAL",
  "latitude": 22.3,
  "longitude": 114,
  "location": "location",
  "locationAdditionalInfo": "locationAdditionalInfo",
  "description": "apDescription",
  "administrativeState": "Unlocked",
  "provisionChecklist": "provisionChecklist",
  "wlanService24Enabled": true,
  "wlanService50Enabled": false,
  "login": {
    "apLoginName": "apLoginName",
    "apLoginPassword": "test1@pwd"
  },
  "syslog": {
    "enabled": true,
    "address": "1.1.1.1",
    "port": 514,
    "facility": "Keep_Original",
    "priority": "Error",
    "flowLevel": "GENERAL_LOGS",
    "protocol": "IPPROTO_TCP"
  },
  "wifi24": {
    "txPower": "Full",
    "channelWidth": 20,
    "channel": 1,
    "channelRange": [
      1,
      2,
      3
    ]
  },
  "wifi50": {
    "txPower": "Full",
    "channelWidth": 20,
    "channel": 52,
    "channelRange": [
      52,
      56,
      60
    ]
  },
  "protectionMode24": "CTS_ONLY",
  "wlanGroup24": {
    "id": "wlanGroupUUID",
    "name": "wlanGroupName"
  },
  "wlanGroup50": {
    "id": "wlanGroupUUID",
    "name": "wlanGroupName"
  },
  "network": {
    "ipType": "Static",
    "ip": "1.1.1.1",
    "netmask": "255.255.255.0",
    "gateway": "1.1.1.0",
    "primaryDns": "8.8.8.8",
    "secondaryDns": "8.8.8.9"
  },
  "networkIpv6": {
    "ipType": "Static",
    "ip": "2001::55/32",
    "gateway": "2001::66",
    "primaryDns": "2001::77",
    "secondaryDns": "2001::88"
  },
  "smartMonitor": {
    "enabled": true,
    "intervalInSec": 10,
    "retryThreshold": 10
  },
  "bonjourGateway": {
    "id": "bonjourGatewayUUID",
    "name": "bonjourGatewayName"
  },
  "clientAdmissionControl24": {
    "maxRadioLoadPercent": 70,
    "minClientCount": 30,
    "minClientThroughputMbps": 10,
    "enabled": true
  },
  "clientAdmissionControl50": {
    "maxRadioLoadPercent": 70,
    "minClientCount": 30,
    "minClientThroughputMbps": 10,
    "enabled": true
  },
  "venueProfile": {
    "id": "venueProfileId",
    "name": "venueProfileName"
  },
  "autoChannelSelection24": {
    "channelSelectMode": "ChannelFly",
    "channelFlyMtbc": 480
  },
  "autoChannelSelection50": {
    "channelSelectMode": "BackgroundScanning",
    "channelFlyMtbc": 480
  },
  "channelEvaluationInterval": 777,
  "apMgmtVlan": {
    "id": 1,
    "mode": "KEEP"
  },
  "altitude": {
    "altitudeUnit": "meters",
    "altitudeValue": 1
  },
  "meshOptions": {
    "meshMode": "MESH_AP",
    "uplinkSelection": "MANUAL",
    "meshUplinkEntryList": [
      "6C:AA:B3:26:6C:30"
    ]
  },
  "recoverySsid": {
    "recoverySsidEnabled": true
  },
  "rogueApReportThreshold": 50,
  "rogueApAggressivenessMode": 2,
  "rogueApJammingThreshold": 50,
  "directedMulticastFromWiredClientEnabled": true,
  "directedMulticastFromWirelessClientEnabled": true,
  "directedMulticastFromNetworkEnabled": false,
  "userLocationInfo": {
    "areaCode": 886
  },
  "lteBandLockChannels": [
    {
      "simCardId": 0,
      "type": "EC25E",
      "channel4g": "B1,B3,B5",
      "channel3g": "B5"
    },
    {
      "simCardId": 1,
      "type": "EC25E",
      "channel4g": "",
      "channel3g": ""
    }
  ]
}
Schema
{
    "additionalProperties" : false,
    "properties" : {
        "administrativeState" : {
            "type" : "string",
            "enum" : [ "Locked", "Unlocked" ]
        },
        "altitude" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "altitudeUnit" : {
                    "description" : "altitude unit",
                    "type" : "string",
                    "enum" : [ "meters", "floor" ]
                },
                "altitudeValue" : {
                    "description" : "altitude value",
                    "type" : "integer"
                }
            }
        },
        "apGroupId" : {
            "type" : "string"
        },
        "apMgmtVlan" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "mode" : {
                    "description" : "Vlan Mode of the zone",
                    "type" : "string",
                    "enum" : [ "KEEP", "USER_DEFINED" ]
                },
                "id" : {
                    "description" : "Vlan id of the zone",
                    "type" : "integer"
                }
            }
        },
        "autoChannelSelection24" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "channelSelectMode" : {
                    "description" : "Channel Select Mode",
                    "type" : "string",
                    "enum" : [ "None", "BackgroundScanning", "ChannelFly" ]
                },
                "channelFlyMtbc" : {
                    "description" : "ChannelFly MTBC",
                    "type" : "integer",
                    "minimum" : 100,
                    "maximum" : 1440
                }
            }
        },
        "autoChannelSelection50" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "channelSelectMode" : {
                    "description" : "Channel Select Mode",
                    "type" : "string",
                    "enum" : [ "None", "BackgroundScanning", "ChannelFly" ]
                },
                "channelFlyMtbc" : {
                    "description" : "ChannelFly MTBC",
                    "type" : "integer",
                    "minimum" : 100,
                    "maximum" : 1440
                }
            }
        },
        "awsVenue" : {
            "type" : "string"
        },
        "bonjourGateway" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "channelEvaluationInterval" : {
            "maximum" : 3600,
            "minimum" : 60,
            "type" : "integer"
        },
        "clientAdmissionControl24" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "enabled" : {
                    "type" : "boolean"
                },
                "maxRadioLoadPercent" : {
                    "description" : "Maximum radio load percentage.",
                    "type" : "integer",
                    "minimum" : 50,
                    "maximum" : 100
                },
                "minClientCount" : {
                    "description" : "Minimum client count number.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 100
                },
                "minClientThroughputMbps" : {
                    "description" : "Minimum client throughput in Mbps.",
                    "type" : "number",
                    "minimum" : 0,
                    "maximum" : 100
                }
            }
        },
        "clientAdmissionControl50" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "enabled" : {
                    "type" : "boolean"
                },
                "maxRadioLoadPercent" : {
                    "description" : "Maximum radio load percentage.",
                    "type" : "integer",
                    "minimum" : 50,
                    "maximum" : 100
                },
                "minClientCount" : {
                    "description" : "Minimum client count number.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 100
                },
                "minClientThroughputMbps" : {
                    "description" : "Minimum client throughput in Mbps.",
                    "type" : "number",
                    "minimum" : 0,
                    "maximum" : 100
                }
            }
        },
        "description" : {
            "type" : [ "string", "null" ],
            "maxLength" : 64
        },
        "gpsSource" : {
            "description" : "GPS Source of the AP",
            "type" : "string",
            "enum" : [ "GPS", "MANUAL" ]
        },
        "latitude" : {
            "type" : "number"
        },
        "location" : {
            "type" : "string"
        },
        "locationAdditionalInfo" : {
            "type" : "string",
            "pattern" : "^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
        },
        "login" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "apLoginName" : {
                    "description" : "User name of the AP administrator",
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : "^((?!\$\()[!-_a-~]){1,64}$"
                },
                "apLoginPassword" : {
                    "description" : "Password of the AP administrator",
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : ".*(?=.{8,})(?=.*[a-zA-Z])(?=.*[0-9])(?=.*[_`~!@#$%^&*\(\)\[\]\{\}|;:'\",.\<>\/?=+-]).*"
                }
            },
            "required" : [ "apLoginName", "apLoginPassword" ]
        },
        "longitude" : {
            "type" : "number"
        },
        "meshOptions" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "meshMode" : {
                    "description" : "mesh mode",
                    "type" : "string",
                    "enum" : [ "AUTO", "ROOT_AP", "MESH_AP", "DISABLE" ]
                },
                "uplinkSelection" : {
                    "description" : "Uplink selection",
                    "type" : "string",
                    "enum" : [ "SMART", "MANUAL" ]
                },
                "meshUplinkEntryList" : {
                    "description" : "MAC address of the neighbor AP",
                    "type" : "array",
                    "items" : {
                        "type" : "string",
                        "pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
                    }
                }
            }
        },
        "model" : {
            "type" : "string"
        },
        "name" : {
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 64,
            "pattern" : "^[!-~]((?!\$\()[ -_a-~]){0,62}[!-~]$"
        },
        "network" : {
            "additionalProperties" : false,
            "properties" : {
                "gateway" : {
                    "type" : "string"
                },
                "ip" : {
                    "type" : "string"
                },
                "ipType" : {
                    "type" : "string",
                    "enum" : [ "Dynamic", "Keep", "Static" ]
                },
                "netmask" : {
                    "type" : "string",
                    "pattern" : "^$|(^(128|192|224|24[08]|25[245]).0.0.0$)|(^255.(0|128|192|224|24[08]|25[245]).0.0$)|(^255.255.(0|128|192|224|24[08]|25[245]).0$)|(^255.255.255.(0|128|192|224|24[08]|252|255)$)"
                },
                "primaryDns" : {
                    "type" : "string"
                },
                "secondaryDns" : {
                    "type" : "string"
                }
            },
            "type" : "object"
        },
        "networkIpv6" : {
            "additionalProperties" : false,
            "properties" : {
                "gateway" : {
                    "type" : "string"
                },
                "ip" : {
                    "type" : "string"
                },
                "ipType" : {
                    "type" : "string",
                    "enum" : [ "Dynamic", "Keep", "Static" ]
                },
                "primaryDns" : {
                    "type" : "string"
                },
                "secondaryDns" : {
                    "type" : "string"
                }
            },
            "type" : "object"
        },
        "provisionChecklist" : {
            "type" : "string"
        },
        "serial" : {
            "type" : "string"
        },
        "smartMonitor" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "enabled" : {
                    "type" : "boolean"
                },
                "intervalInSec" : {
                    "description" : "Interval in seconds. This is required if smartMonitor is enabled",
                    "type" : "integer",
                    "minimum" : 5,
                    "maximum" : 60
                },
                "retryThreshold" : {
                    "description" : "Retry threshold. This is required if smartMonitor is enabled",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 10
                }
            }
        },
        "syslog" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "enabled" : {
                    "description" : "Indicates whether syslog is enabled or disabled",
                    "type" : "boolean"
                },
                "address" : {
                    "description" : "Address of the syslog server. If syslog is enabled, this attribute is required.",
                    "type" : "string"
                },
                "port" : {
                    "description" : "Port number of the syslog server",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 65535
                },
                "facility" : {
                    "description" : "Facility of the syslog server",
                    "type" : "string",
                    "enum" : [ "Keep_Original", "Local0", "Local1", "Local2", "Local3", "Local4", "Local5", "Local6", "Local7" ]
                },
                "priority" : {
                    "description" : "Priority of the log messages",
                    "type" : "string",
                    "enum" : [ "Emergency", "Alert", "Critical", "Error", "Warning", "Notice", "Info", "All" ]
                },
                "flowLevel" : {
                    "description" : "Flow Level of the syslog",
                    "type" : "string",
                    "enum" : [ "GENERAL_LOGS", "CLIENT_FLOW", "ALL" ]
                },
                "protocol" : {
                    "description" : "Protocol of the syslog server",
                    "type" : "string",
                    "enum" : [ "IPPROTO_TCP", "IPPROTO_UDP" ]
                },
                "secondaryAddress" : {
                    "description" : "Secondary Server Address of the syslog server",
                    "type" : "string"
                },
                "secondaryPort" : {
                    "description" : "Secondary Server Port of the syslog server",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 65535
                },
                "secondaryProtocol" : {
                    "description" : "Secondary Server Protocol of the syslog server",
                    "type" : "string",
                    "enum" : [ "IPPROTO_TCP", "IPPROTO_UDP" ]
                }
            },
            "required" : [ "enabled" ]
        },
        "venueProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "wifi24" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "autoCellSizing" : {
                    "description" : "Auto Cell Sizing",
                    "type" : "boolean"
                },
                "txPower" : {
                    "description" : "Transmission power",
                    "type" : "string",
                    "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ]
                },
                "channelWidth" : {
                    "description" : "Channel width. Zero (0) means Auto.",
                    "type" : "integer",
                    "enum" : [ 0, 20, 40 ]
                },
                "channel" : {
                    "description" : "Channel number",
                    "type" : "integer"
                },
                "channelRange" : {
                    "description" : "Channel range options",
                    "type" : "array",
                    "items" : {
                        "type" : "integer"
                    }
                }
            }
        },
        "wifi50" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "autoCellSizing" : {
                    "description" : "Auto Cell Sizing",
                    "type" : "boolean"
                },
                "txPower" : {
                    "description" : "transmission power",
                    "type" : "string",
                    "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ]
                },
                "channelWidth" : {
                    "description" : "channel width, 0 mean Auto, 8080 means 80+80MHz",
                    "type" : "integer",
                    "enum" : [ 0, 20, 40, 80, 8080, 160 ]
                },
                "channel" : {
                    "description" : "channel number",
                    "type" : "integer"
                },
                "secondaryChannel" : {
                    "description" : "channel number (channelWidth is 80+80MHz only)",
                    "type" : "integer"
                },
                "channelRange" : {
                    "description" : "channel range options",
                    "type" : "array",
                    "items" : {
                        "type" : "integer"
                    }
                }
            }
        },
        "protectionMode24" : {
            "type" : "string",
            "enum" : [ "NONE", "CTS_ONLY", "RTS_CTS" ]
        },
        "wlanGroup24" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "description" : "Identifier of the WLAN group",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the WLAN group",
                    "type" : "string"
                }
            }
        },
        "wlanGroup50" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "description" : "Identifier of the WLAN group",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the WLAN group",
                    "type" : "string"
                }
            }
        },
        "wlanService24Enabled" : {
            "type" : "boolean"
        },
        "wlanService50Enabled" : {
            "type" : "boolean"
        },
        "zoneId" : {
            "type" : "string"
        },
        "recoverySsid" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "recoverySsidEnabled" : {
                    "description" : "recovery ssid enable/disable",
                    "type" : "boolean"
                }
            }
        },
        "lteBandLockChannels" : {
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "simCardId" : {
                        "description" : "SIM card ID(Primary:0, Secondary:1)",
                        "type" : "integer"
                    },
                    "type" : {
                        "description" : "LTE chipset SKU type",
                        "type" : "string"
                    },
                    "channel4g" : {
                        "description" : "LTE 4G channels",
                        "type" : "string"
                    },
                    "channel3g" : {
                        "description" : "LTE 3G channels",
                        "type" : "string"
                    }
                }
            }
        }
    },
    "type" : "object"
}
Response  204

Modify Login Override

PATCH/v8_1/aps/{apMac}/login

Use this API command to enable or modify the AP-level logon override settings.

Request
HideShow
Body
{
  "apLoginName": "apLoginName",
  "apLoginPassword": "test1@pwd"
}
Schema
{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "apLoginName" : {
            "description" : "User name of the AP administrator",
            "type" : "string",
            "maxLength" : 64,
            "pattern" : "^((?!\$\()[!-_a-~]){1,64}$"
        },
        "apLoginPassword" : {
            "description" : "Password of the AP administrator",
            "type" : "string",
            "maxLength" : 64,
            "pattern" : ".*(?=.{8,})(?=.*[a-zA-Z])(?=.*[0-9])(?=.*[_`~!@#$%^&*\(\)\[\]\{\}|;:'\",.\<>\/?=+-]).*"
        }
    },
    "required" : [ "apLoginName", "apLoginPassword" ]
}
Response  204

Modify Syslog Override

PATCH/v8_1/aps/{apMac}/syslog

Use this API command to enable or modify the AP-level syslog override settings.

Request
HideShow
Body
{
  "enabled": true,
  "address": "1.1.1.1",
  "port": 514,
  "facility": "Keep_Original",
  "priority": "Error",
  "flowLevel": "GENERAL_LOGS",
  "protocol": "IPPROTO_TCP"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "enabled": {
      "description": "Indicates whether syslog is enabled or disabled",
      "type": "boolean"
    },
    "address": {
      "description": "Address of the syslog server. If syslog is enabled, this attribute is required.",
      "type": "string"
    },
    "port": {
      "description": "Port number of the syslog server",
      "type": "integer",
      "minimum": 1,
      "maximum": 65535
    },
    "facility": {
      "description": "Facility of the syslog server",
      "type": "string",
      "enum": [
        "Keep_Original",
        "Local0",
        "Local1",
        "Local2",
        "Local3",
        "Local4",
        "Local5",
        "Local6",
        "Local7"
      ]
    },
    "priority": {
      "description": "Priority of the log messages",
      "type": "string",
      "enum": [
        "Emergency",
        "Alert",
        "Critical",
        "Error",
        "Warning",
        "Notice",
        "Info",
        "All"
      ]
    },
    "flowLevel": {
      "description": "Flow Level of the syslog",
      "type": "string",
      "enum": [
        "GENERAL_LOGS",
        "CLIENT_FLOW",
        "ALL"
      ]
    },
    "protocol": {
      "description": "Protocol of the syslog server",
      "type": "string",
      "enum": [
        "IPPROTO_TCP",
        "IPPROTO_UDP"
      ]
    },
    "secondaryAddress": {
      "description": "Secondary Server Address of the syslog server",
      "type": "string"
    },
    "secondaryPort": {
      "description": "Secondary Server Port of the syslog server",
      "type": "integer",
      "minimum": 1,
      "maximum": 65535
    },
    "secondaryProtocol": {
      "description": "Secondary Server Protocol of the syslog server",
      "type": "string",
      "enum": [
        "IPPROTO_TCP",
        "IPPROTO_UDP"
      ]
    }
  },
  "required": [
    "enabled"
  ]
}
Response  204

Modify Radio 2.4G Override

PATCH/v8_1/aps/{apMac}/wifi24

Use this API command to modify the AP level override of the 2.4GHz radio configuration.

Request
HideShow
Body
{
  "txPower": "Full",
  "channelWidth": 20,
  "channel": 1,
  "channelRange": [
    1,
    2,
    3
  ]
}
Schema
{
  "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"
      }
    }
  }
}
Response  204

Modify Radio 5G Override

PATCH/v8_1/aps/{apMac}/wifi50

Use this API command to Modify the AP level override of the 5GHz radio configuration.

Request
HideShow
Body
{
  "txPower": "Full",
  "channelWidth": 20,
  "channel": 52,
  "channelRange": [
    52,
    56,
    60
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "autoCellSizing": {
      "description": "Auto Cell Sizing",
      "type": "boolean"
    },
    "txPower": {
      "description": "transmission power",
      "type": "string",
      "enum": [
        "Full",
        "-1dB",
        "-2dB",
        "-3dB(1/2)",
        "-4dB",
        "-5dB",
        "-6dB(1/4)",
        "-7dB",
        "-8dB",
        "-9dB(1/8)",
        "-10dB",
        "Min"
      ]
    },
    "channelWidth": {
      "description": "channel width, 0 mean Auto, 8080 means 80+80MHz",
      "type": "integer",
      "enum": [
        0,
        20,
        40,
        80,
        8080,
        160
      ]
    },
    "channel": {
      "description": "channel number",
      "type": "integer"
    },
    "secondaryChannel": {
      "description": "channel number (channelWidth is 80+80MHz only)",
      "type": "integer"
    },
    "channelRange": {
      "description": "channel range options",
      "type": "array",
      "items": {
        "type": "integer"
      }
    }
  }
}
Response  204

Modify WLAN Group 2.4G Override

PATCH/v8_1/aps/{apMac}/wlanGroup24

Use this API command to enable or modify the AP level override of the WLAN group configuration on the 2.4GHz radio.

Request
HideShow
Body
{
  "id": "wlanGroupUUID",
  "name": "wlanGroupName"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "Identifier of the WLAN group",
      "type": "string"
    },
    "name": {
      "description": "Name of the WLAN group",
      "type": "string"
    }
  }
}
Response  204

Modify WLAN Group 5G Override

PATCH/v8_1/aps/{apMac}/wlanGroup50

Use this API command to enable or modify the AP level override of the WLAN group configuration on the 5GHz radio.

Request
HideShow
Body
{
  "id": "wlanGroupUUID",
  "name": "wlanGroupName"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "Identifier of the WLAN group",
      "type": "string"
    },
    "name": {
      "description": "Name of the WLAN group",
      "type": "string"
    }
  }
}
Response  204

Modify Network Settings Ipv4

PATCH/v8_1/aps/{apMac}/network

Use this API command to modify the network settings Ipv4 of an AP.

Request
HideShow
Body
{
  "ipType": "Static",
  "ip": "1.1.1.1",
  "netmask": "255.255.255.0",
  "gateway": "1.1.1.0",
  "primaryDns": "8.8.8.8",
  "secondaryDns": "8.8.8.9"
}
Schema
{
  "additionalProperties": false,
  "properties": {
    "gateway": {
      "type": "string"
    },
    "ip": {
      "type": "string"
    },
    "ipType": {
      "type": "string",
      "enum": [
        "Dynamic",
        "Keep",
        "Static"
      ]
    },
    "netmask": {
      "type": "string",
      "pattern": "^$|(^(128|192|224|24[08]|25[245]).0.0.0$)|(^255.(0|128|192|224|24[08]|25[245]).0.0$)|(^255.255.(0|128|192|224|24[08]|25[245]).0$)|(^255.255.255.(0|128|192|224|24[08]|252|255)$)"
    },
    "primaryDns": {
      "type": "string"
    },
    "secondaryDns": {
      "type": "string"
    }
  },
  "type": "object"
}
Response  204

Modify Network Settings Ipv6

PATCH/v8_1/aps/{apMac}/networkIpv6

Use this API command to modify the network settings Ipv6 of an AP.

Request
HideShow
Body
{
  "ipType": "Static",
  "ip": "2001::55/32",
  "gateway": "2001::66",
  "primaryDns": "2001::77",
  "secondaryDns": "2001::88"
}
Schema
{
  "additionalProperties": false,
  "properties": {
    "gateway": {
      "type": "string"
    },
    "ip": {
      "type": "string"
    },
    "ipType": {
      "type": "string",
      "enum": [
        "Dynamic",
        "Keep",
        "Static"
      ]
    },
    "primaryDns": {
      "type": "string"
    },
    "secondaryDns": {
      "type": "string"
    }
  },
  "type": "object"
}
Response  204

Modify Smart Monitor

PATCH/v8_1/aps/{apMac}/smartMonitor

Use this API command to modify smart monitor of an AP.

Request
HideShow
Body
{
  "enabled": true,
  "intervalInSec": 10,
  "retryThreshold": 10
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "enabled": {
      "type": "boolean"
    },
    "intervalInSec": {
      "description": "Interval in seconds. This is required if smartMonitor is enabled",
      "type": "integer",
      "minimum": 5,
      "maximum": 60
    },
    "retryThreshold": {
      "description": "Retry threshold. This is required if smartMonitor is enabled",
      "type": "integer",
      "minimum": 1,
      "maximum": 10
    }
  }
}
Response  204

Modify Bonjour Gateway

PATCH/v8_1/aps/{apMac}/bonjourGateway

Use this API command to modify bonjour gateway of an AP.

Request
HideShow
Body
{
  "id": "bonjourGatewayUUID",
  "name": "bonjourGatewayName"
}
Schema
{
  "type": [
    "object",
    "null"
  ],
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    }
  }
}
Response  204

Modify Client Admission Control 2.4G

PATCH/v8_1/aps/{apMac}/clientAdmissionControl24

Use this API command to modify client admission control 2.4GHz radio configuration of an AP.

Request
HideShow
Body
{
  "maxRadioLoadPercent": 70,
  "minClientCount": 30,
  "minClientThroughputMbps": 10,
  "enabled": true
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "enabled": {
      "type": "boolean"
    },
    "maxRadioLoadPercent": {
      "description": "Maximum radio load percentage.",
      "type": "integer",
      "minimum": 50,
      "maximum": 100
    },
    "minClientCount": {
      "description": "Minimum client count number.",
      "type": "integer",
      "minimum": 0,
      "maximum": 100
    },
    "minClientThroughputMbps": {
      "description": "Minimum client throughput in Mbps.",
      "type": "number",
      "minimum": 0,
      "maximum": 100
    }
  }
}
Response  204

Modify Client Admission Control 5G

PATCH/v8_1/aps/{apMac}/clientAdmissionControl50

Use this API command to modify client admission control 5GHz radio configuration of an AP.

Request
HideShow
Body
{
  "maxRadioLoadPercent": 70,
  "minClientCount": 30,
  "minClientThroughputMbps": 10,
  "enabled": true
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "enabled": {
      "type": "boolean"
    },
    "maxRadioLoadPercent": {
      "description": "Maximum radio load percentage.",
      "type": "integer",
      "minimum": 50,
      "maximum": 100
    },
    "minClientCount": {
      "description": "Minimum client count number.",
      "type": "integer",
      "minimum": 0,
      "maximum": 100
    },
    "minClientThroughputMbps": {
      "description": "Minimum client throughput in Mbps.",
      "type": "number",
      "minimum": 0,
      "maximum": 100
    }
  }
}
Response  204

Modify Venue Profile

PATCH/v8_1/aps/{apMac}/venueProfile

Use this API command to modify venue profile of an AP.

Request
HideShow
Body
{
  "id": "venueProfileId",
  "name": "venueProfileName"
}
Schema
{
  "type": [
    "object",
    "null"
  ],
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    }
  }
}
Response  204

Modify Radio 2.4G Auto ChannelSelectMode Override

PATCH/v8_1/aps/{apMac}/autoChannelSelection24

Override Radio 2.4G Auto ChannelSelectMode and ChannelFly MTBC of an AP.

Request
HideShow
Body
{
  "channelSelectMode": "ChannelFly",
  "channelFlyMtbc": 480
}
Schema
{
  "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
    }
  }
}
Response  204

Modify Radio 5G Auto ChannelSelectMode Override

PATCH/v8_1/aps/{apMac}/autoChannelSelection50

Override Radio 5G Auto ChannelSelectMode and ChannelFly MTBC of an AP.

Request
HideShow
Body
{
  "channelSelectMode": "BackgroundScanning",
  "channelFlyMtbc": 480
}
Schema
{
  "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
    }
  }
}
Response  204

Modify AP Management Vlan

PATCH/v8_1/aps/{apMac}/apMgmtVlan

Modify AP Management Vlan of an AP.

Request
HideShow
Body
{
  "id": 1,
  "mode": "KEEP"
}
Schema
{
  "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"
    }
  }
}
Response  204

Modify Altitude Override

PATCH/v8_1/aps/{apMac}/altitude

Use this API command to modify the altitude of an AP.

Request
HideShow
Body
{
  "altitudeUnit": "meters",
  "altitudeValue": 1
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "altitudeUnit": {
      "description": "altitude unit",
      "type": "string",
      "enum": [
        "meters",
        "floor"
      ]
    },
    "altitudeValue": {
      "description": "altitude value",
      "type": "integer"
    }
  }
}
Response  204

Modify Mesh Options

PATCH/v8_1/aps/{apMac}/meshOptions

Use this API command to modify mesh options of an AP.

Request
HideShow
Body
{
  "meshMode": "MESH_AP",
  "uplinkSelection": "MANUAL",
  "meshUplinkEntryList": [
    "6C:AA:B3:26:6C:30"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "meshMode": {
      "description": "mesh mode",
      "type": "string",
      "enum": [
        "AUTO",
        "ROOT_AP",
        "MESH_AP",
        "DISABLE"
      ]
    },
    "uplinkSelection": {
      "description": "Uplink selection",
      "type": "string",
      "enum": [
        "SMART",
        "MANUAL"
      ]
    },
    "meshUplinkEntryList": {
      "description": "MAC address of the neighbor AP",
      "type": "array",
      "items": {
        "type": "string",
        "pattern": "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
      }
    }
  }
}
Response  204

Delete

DELETE/v8_1/aps/{apMac}

Use this API command to delete an access point.

Response  204

Create

POST/v8_1/aps

Use this API command to create a new access point.

Request
HideShow
Body
{
  "mac": "00:11:22:33:44:55",
  "zoneId": "zoneUUID",
  "apGroupId": "apGroupUUID",
  "serial": "00000096",
  "model": "ZF7962",
  "name": "apName",
  "gpsSource": "MANUAL",
  "latitude": 22.3,
  "longitude": 114,
  "location": "shenzhen",
  "description": "apDescription",
  "administrativeState": "Unlocked",
  "provisionChecklist": "test"
}
Schema
{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "administrativeState" : {
            "default" : "Unlocked",
            "type" : "string",
            "enum" : [ "Locked", "Unlocked" ]
        },
        "apGroupId" : {
            "type" : "string"
        },
        "awsVenue" : {
            "type" : "string"
        },
        "description" : {
            "type" : [ "string", "null" ],
            "maxLength" : 64
        },
        "gpsSource" : {
            "description" : "GPS Source of the AP",
            "type" : "string",
            "enum" : [ "GPS", "MANUAL" ]
        },
        "latitude" : {
            "type" : "number"
        },
        "location" : {
            "type" : "string"
        },
        "longitude" : {
            "type" : "number"
        },
        "mac" : {
            "type" : "string",
            "pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
        },
        "model" : {
            "type" : "string"
        },
        "name" : {
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 64,
            "pattern" : "^[!-~]((?!\$\()[ -_a-~]){0,62}[!-~]$"
        },
        "provisionChecklist" : {
            "type" : "string"
        },
        "serial" : {
            "type" : "string"
        },
        "zoneId" : {
            "type" : "string"
        }
    },
    "required" : [ "serial", "zoneId" ]
}
Response  201

Modify AP Config

PUT/v8_1/aps/{apMac}

Use this API command to modify the basic information of an AP in one request.

Request
HideShow
Body
{
  "name": "ruckus-ap1",
  "serial": "1234567888",
  "zoneId": "854a96e8-8576-454e-aa73-1d914733e270",
  "model": "R710",
  "gpsSource": "MANUAL",
  "latitude": 26.1,
  "longitude": 31.1,
  "location": "TW",
  "userLocationInfo": {
    "areaCode": 258
  },
  "wlanService24Enabled": true,
  "wlanService50Enabled": true,
  "login": {
    "apLoginName": "Lance",
    "apLoginPassword": "admin!234"
  },
  "altitude": {
    "altitudeUnit": "floor",
    "altitudeValue": 4
  },
  "syslog": {
    "enabled": true,
    "address": "192.171.1.2",
    "port": 56869,
    "facility": "Keep_Original",
    "priority": "Error"
  },
  "wifi24": {
    "txPower": "Full",
    "channelWidth": 20,
    "channel": 15,
    "channelRange": [
      0,
      15,
      30
    ]
  },
  "wifi50": {
    "txPower": "Full",
    "channelWidth": 20,
    "channel": 15,
    "secondaryChannel": 200,
    "channelRange": [
      14,
      43,
      33
    ]
  },
  "wlanGroup24": {
    "id": "0f2f3190-3b90-11e7-83cd-0242fc22fe11",
    "name": "z2wlangroup1"
  },
  "wlanGroup50": {
    "id": "b0090501-3b90-11e7-83cd-0242fc22fe11",
    "name": "z2wlangroup50"
  },
  "network": {
    "ipType": "Static",
    "ip": "172.17.60.115",
    "netmask": "255.255.0.0",
    "gateway": "172.17.17.16",
    "primaryDns": "8.8.8.8",
    "secondaryDns": "8.8.4.4"
  },
  "networkIpv6": {
    "ipType": "Static",
    "ip": "2001::55/32",
    "gateway": "2001::66",
    "primaryDns": "2001::77",
    "secondaryDns": "2001::88"
  },
  "smartMonitor": {
    "enabled": true,
    "intervalInSec": 15,
    "retryThreshold": 8
  },
  "bonjourGateway": {
    "id": "0de53320-3b95-11e7-83cd-0242fc22fe11",
    "name": "bonjourGateway1"
  },
  "clientAdmissionControl24": {
    "enabled": true,
    "maxRadioLoadPercent": 85,
    "minClientCount": 17,
    "minClientThroughputMbps": 25
  },
  "clientAdmissionControl50": {
    "enabled": true,
    "maxRadioLoadPercent": 95,
    "minClientCount": 18,
    "minClientThroughputMbps": 15
  },
  "venueProfile": {
    "id": "defde091-3b97-11e7-83cd-0242fc22fe11",
    "name": "VenueProfile2.0"
  },
  "autoChannelSelection24": {
    "channelSelectMode": "None",
    "channelFlyMtbc": 500
  },
  "autoChannelSelection50": {
    "channelSelectMode": "None",
    "channelFlyMtbc": 500
  },
  "channelEvaluationInterval": 750,
  "apMgmtVlan": {
    "mode": "KEEP",
    "id": 15
  },
  "meshOptions": {
    "meshMode": "AUTO",
    "uplinkSelection": "SMART",
    "meshUplinkEntryList": [
      "AB:CD:00:00:00:CC"
    ]
  }
}
Schema
{
    "description" : "Modify AP Config with whole content",
    "additionalProperties" : false,
    "properties" : {
        "administrativeState" : {
            "type" : "string",
            "enum" : [ "Locked", "Unlocked" ]
        },
        "altitude" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "altitudeUnit" : {
                    "description" : "altitude unit",
                    "type" : "string",
                    "enum" : [ "meters", "floor" ]
                },
                "altitudeValue" : {
                    "description" : "altitude value",
                    "type" : "integer"
                }
            }
        },
        "apGroupId" : {
            "type" : "string"
        },
        "apMgmtVlan" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "mode" : {
                    "description" : "Vlan Mode of the zone",
                    "type" : "string",
                    "enum" : [ "KEEP", "USER_DEFINED" ]
                },
                "id" : {
                    "description" : "Vlan id of the zone",
                    "type" : "integer"
                }
            }
        },
        "autoChannelSelection24" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "channelSelectMode" : {
                    "description" : "Channel Select Mode",
                    "type" : "string",
                    "enum" : [ "None", "BackgroundScanning", "ChannelFly" ]
                },
                "channelFlyMtbc" : {
                    "description" : "ChannelFly MTBC",
                    "type" : "integer",
                    "minimum" : 100,
                    "maximum" : 1440
                }
            }
        },
        "autoChannelSelection50" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "channelSelectMode" : {
                    "description" : "Channel Select Mode",
                    "type" : "string",
                    "enum" : [ "None", "BackgroundScanning", "ChannelFly" ]
                },
                "channelFlyMtbc" : {
                    "description" : "ChannelFly MTBC",
                    "type" : "integer",
                    "minimum" : 100,
                    "maximum" : 1440
                }
            }
        },
        "awsVenue" : {
            "type" : "string"
        },
        "bonjourGateway" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "channelEvaluationInterval" : {
            "maximum" : 3600,
            "minimum" : 60,
            "type" : "integer"
        },
        "clientAdmissionControl24" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "enabled" : {
                    "type" : "boolean"
                },
                "maxRadioLoadPercent" : {
                    "description" : "Maximum radio load percentage.",
                    "type" : "integer",
                    "minimum" : 50,
                    "maximum" : 100
                },
                "minClientCount" : {
                    "description" : "Minimum client count number.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 100
                },
                "minClientThroughputMbps" : {
                    "description" : "Minimum client throughput in Mbps.",
                    "type" : "number",
                    "minimum" : 0,
                    "maximum" : 100
                }
            }
        },
        "clientAdmissionControl50" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "enabled" : {
                    "type" : "boolean"
                },
                "maxRadioLoadPercent" : {
                    "description" : "Maximum radio load percentage.",
                    "type" : "integer",
                    "minimum" : 50,
                    "maximum" : 100
                },
                "minClientCount" : {
                    "description" : "Minimum client count number.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 100
                },
                "minClientThroughputMbps" : {
                    "description" : "Minimum client throughput in Mbps.",
                    "type" : "number",
                    "minimum" : 0,
                    "maximum" : 100
                }
            }
        },
        "description" : {
            "type" : [ "string", "null" ],
            "maxLength" : 64
        },
        "gpsSource" : {
            "description" : "GPS Source of the AP",
            "type" : "string",
            "enum" : [ "GPS", "MANUAL" ]
        },
        "latitude" : {
            "type" : "number"
        },
        "location" : {
            "type" : "string"
        },
        "locationAdditionalInfo" : {
            "type" : "string",
            "pattern" : "^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
        },
        "login" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "apLoginName" : {
                    "description" : "User name of the AP administrator",
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : "^((?!\$\()[!-_a-~]){1,64}$"
                },
                "apLoginPassword" : {
                    "description" : "Password of the AP administrator",
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : ".*(?=.{8,})(?=.*[a-zA-Z])(?=.*[0-9])(?=.*[_`~!@#$%^&*\(\)\[\]\{\}|;:'\",.\<>\/?=+-]).*"
                }
            },
            "required" : [ "apLoginName", "apLoginPassword" ]
        },
        "longitude" : {
            "type" : "number"
        },
        "meshOptions" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "meshMode" : {
                    "description" : "mesh mode",
                    "type" : "string",
                    "enum" : [ "AUTO", "ROOT_AP", "MESH_AP", "DISABLE" ]
                },
                "uplinkSelection" : {
                    "description" : "Uplink selection",
                    "type" : "string",
                    "enum" : [ "SMART", "MANUAL" ]
                },
                "meshUplinkEntryList" : {
                    "description" : "MAC address of the neighbor AP",
                    "type" : "array",
                    "items" : {
                        "type" : "string",
                        "pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
                    }
                }
            }
        },
        "model" : {
            "type" : "string"
        },
        "name" : {
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 64,
            "pattern" : "^[!-~]((?!\$\()[ -_a-~]){0,62}[!-~]$"
        },
        "network" : {
            "additionalProperties" : false,
            "properties" : {
                "gateway" : {
                    "type" : "string"
                },
                "ip" : {
                    "type" : "string"
                },
                "ipType" : {
                    "type" : "string",
                    "enum" : [ "Dynamic", "Keep", "Static" ]
                },
                "netmask" : {
                    "type" : "string",
                    "pattern" : "^$|(^(128|192|224|24[08]|25[245]).0.0.0$)|(^255.(0|128|192|224|24[08]|25[245]).0.0$)|(^255.255.(0|128|192|224|24[08]|25[245]).0$)|(^255.255.255.(0|128|192|224|24[08]|252|255)$)"
                },
                "primaryDns" : {
                    "type" : "string"
                },
                "secondaryDns" : {
                    "type" : "string"
                }
            },
            "type" : "object"
        },
        "networkIpv6" : {
            "additionalProperties" : false,
            "properties" : {
                "gateway" : {
                    "type" : "string"
                },
                "ip" : {
                    "type" : "string"
                },
                "ipType" : {
                    "type" : "string",
                    "enum" : [ "Dynamic", "Keep", "Static" ]
                },
                "primaryDns" : {
                    "type" : "string"
                },
                "secondaryDns" : {
                    "type" : "string"
                }
            },
            "type" : "object"
        },
        "provisionChecklist" : {
            "type" : "string"
        },
        "serial" : {
            "type" : "string"
        },
        "smartMonitor" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "enabled" : {
                    "type" : "boolean"
                },
                "intervalInSec" : {
                    "description" : "Interval in seconds. This is required if smartMonitor is enabled",
                    "type" : "integer",
                    "minimum" : 5,
                    "maximum" : 60
                },
                "retryThreshold" : {
                    "description" : "Retry threshold. This is required if smartMonitor is enabled",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 10
                }
            }
        },
        "syslog" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "enabled" : {
                    "description" : "Indicates whether syslog is enabled or disabled",
                    "type" : "boolean"
                },
                "address" : {
                    "description" : "Address of the syslog server. If syslog is enabled, this attribute is required.",
                    "type" : "string"
                },
                "port" : {
                    "description" : "Port number of the syslog server",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 65535
                },
                "facility" : {
                    "description" : "Facility of the syslog server",
                    "type" : "string",
                    "enum" : [ "Keep_Original", "Local0", "Local1", "Local2", "Local3", "Local4", "Local5", "Local6", "Local7" ]
                },
                "priority" : {
                    "description" : "Priority of the log messages",
                    "type" : "string",
                    "enum" : [ "Emergency", "Alert", "Critical", "Error", "Warning", "Notice", "Info", "All" ]
                },
                "flowLevel" : {
                    "description" : "Flow Level of the syslog",
                    "type" : "string",
                    "enum" : [ "GENERAL_LOGS", "CLIENT_FLOW", "ALL" ]
                },
                "protocol" : {
                    "description" : "Protocol of the syslog server",
                    "type" : "string",
                    "enum" : [ "IPPROTO_TCP", "IPPROTO_UDP" ]
                },
                "secondaryAddress" : {
                    "description" : "Secondary Server Address of the syslog server",
                    "type" : "string"
                },
                "secondaryPort" : {
                    "description" : "Secondary Server Port of the syslog server",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 65535
                },
                "secondaryProtocol" : {
                    "description" : "Secondary Server Protocol of the syslog server",
                    "type" : "string",
                    "enum" : [ "IPPROTO_TCP", "IPPROTO_UDP" ]
                }
            },
            "required" : [ "enabled" ]
        },
        "venueProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "wifi24" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "autoCellSizing" : {
                    "description" : "Auto Cell Sizing",
                    "type" : "boolean"
                },
                "txPower" : {
                    "description" : "Transmission power",
                    "type" : "string",
                    "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ]
                },
                "channelWidth" : {
                    "description" : "Channel width. Zero (0) means Auto.",
                    "type" : "integer",
                    "enum" : [ 0, 20, 40 ]
                },
                "channel" : {
                    "description" : "Channel number",
                    "type" : "integer"
                },
                "channelRange" : {
                    "description" : "Channel range options",
                    "type" : "array",
                    "items" : {
                        "type" : "integer"
                    }
                }
            }
        },
        "wifi50" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "autoCellSizing" : {
                    "description" : "Auto Cell Sizing",
                    "type" : "boolean"
                },
                "txPower" : {
                    "description" : "transmission power",
                    "type" : "string",
                    "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ]
                },
                "channelWidth" : {
                    "description" : "channel width, 0 mean Auto, 8080 means 80+80MHz",
                    "type" : "integer",
                    "enum" : [ 0, 20, 40, 80, 8080, 160 ]
                },
                "channel" : {
                    "description" : "channel number",
                    "type" : "integer"
                },
                "secondaryChannel" : {
                    "description" : "channel number (channelWidth is 80+80MHz only)",
                    "type" : "integer"
                },
                "channelRange" : {
                    "description" : "channel range options",
                    "type" : "array",
                    "items" : {
                        "type" : "integer"
                    }
                }
            }
        },
        "protectionMode24" : {
            "type" : "string",
            "enum" : [ "NONE", "CTS_ONLY", "RTS_CTS" ]
        },
        "wlanGroup24" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "description" : "Identifier of the WLAN group",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the WLAN group",
                    "type" : "string"
                }
            }
        },
        "wlanGroup50" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "description" : "Identifier of the WLAN group",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the WLAN group",
                    "type" : "string"
                }
            }
        },
        "wlanService24Enabled" : {
            "type" : "boolean"
        },
        "wlanService50Enabled" : {
            "type" : "boolean"
        },
        "zoneId" : {
            "type" : "string"
        },
        "recoverySsid" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "recoverySsidEnabled" : {
                    "description" : "recovery ssid enable/disable",
                    "type" : "boolean"
                }
            }
        },
        "lteBandLockChannels" : {
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "simCardId" : {
                        "description" : "SIM card ID(Primary:0, Secondary:1)",
                        "type" : "integer"
                    },
                    "type" : {
                        "description" : "LTE chipset SKU type",
                        "type" : "string"
                    },
                    "channel4g" : {
                        "description" : "LTE 4G channels",
                        "type" : "string"
                    },
                    "channel3g" : {
                        "description" : "LTE 3G channels",
                        "type" : "string"
                    }
                }
            }
        }
    },
    "type" : "object"
}
Response  204

Retrieve

GET/v8_1/aps/{apMac}

Use this API command to retrieve the configuration of an AP.

Response  200
HideShow
Body
{
  "zoneId": "zoneUUID",
  "apGroupId": "apGroupUUID",
  "serial": "00000096",
  "model": "ZF7343",
  "name": "apName",
  "gpsSource": "MANUAL",
  "latitude": 22.3,
  "longitude": 114,
  "location": "location",
  "locationAdditionalInfo": "locationAdditionalInfo",
  "description": "apDescription",
  "administrativeState": "Unlocked",
  "provisionChecklist": "provisionChecklist",
  "login": {
    "apLoginName": "apLoginName",
    "apLoginPassword": "apLoginPassword"
  },
  "wifi24": {
    "txPower": "Full",
    "channelWidth": 20,
    "channel": 1,
    "channelRange": [
      1,
      2,
      3
    ],
    "availableChannelRange": [
      1,
      2,
      3,
      4,
      5,
      6,
      7,
      8,
      9,
      10,
      11
    ]
  },
  "wifi50": {
    "txPower": "Full",
    "channelWidth": 20,
    "channel": 52,
    "channelRange": [
      52,
      56,
      60
    ],
    "availableChannelRange": [
      36,
      40,
      44,
      48,
      52,
      56,
      60,
      64,
      100,
      104,
      108,
      112,
      116,
      132,
      136,
      149,
      153,
      157,
      161
    ]
  },
  "protectionMode24": "CTS_ONLY",
  "wlanGroup24": {
    "id": "wlanGroupUUID",
    "name": "wlanGroupName"
  },
  "wlanGroup50": {
    "id": "wlanGroupUUID",
    "name": "wlanGroupName"
  },
  "network": {
    "ipType": "Static",
    "ip": "1.1.1.1",
    "netmask": "255.255.255.0",
    "gateway": "1.1.1.0",
    "primaryDns": "8.8.8.8",
    "secondaryDns": "8.8.8.9"
  },
  "networkIpv6": {
    "ipType": "Static",
    "ip": "2001::55/32",
    "gateway": "2001::66",
    "primaryDns": "2001::77",
    "secondaryDns": "2001::88"
  },
  "smartMonitor": {
    "enabled": true,
    "intervalInSec": 10,
    "retryThreshold": 10
  },
  "bonjourGateway": {
    "id": "bonjourGatewayUUID",
    "name": "bonjourGatewayName"
  },
  "clientAdmissionControl24": {
    "maxRadioLoadPercent": 70,
    "minClientCount": 30,
    "minClientThroughputMbps": 10,
    "enabled": true
  },
  "clientAdmissionControl50": {
    "maxRadioLoadPercent": 70,
    "minClientCount": 30,
    "minClientThroughputMbps": 10,
    "enabled": true
  },
  "specific": {
    "ledStatusEnabled": false,
    "lacp": {
      "enabled": false
    },
    "lldp": {
      "enabled": true,
      "advertiseIntervalInSec": 100,
      "holdTimeInSec": 1000,
      "managementIPTLVEnabled": false
    },
    "ledMode": null,
    "internalHeaterEnabled": null,
    "poeOutPortEnabled": null,
    "usbPowerEnable": true,
    "poeModeSetting": "Auto",
    "poeTxChain": 2,
    "radioBand": null,
    "externalAntenna24": null,
    "externalAntenna50": null,
    "lanPorts": [
      {
        "portName": "LAN1",
        "enabled": true,
        "type": "Trunk",
        "vlanUntagId": 13,
        "members": "1-4094",
        "_8021X": {
          "type": "Disable",
          "authenticator": null,
          "supplicant": null
        }
      },
      {
        "portName": "LAN2",
        "enabled": true,
        "type": "Access",
        "vlanUntagId": 15,
        "members": "15",
        "_8021X": {
          "type": "MACBasedAuthenticator",
          "authenticator": {
            "authentication": {
              "id": "5f66275c-b1fd-4e25-a4db-b64115740fb9",
              "name": "zoneRadius"
            },
            "accounting": {
              "id": "b86db5e8-884b-4c90-9315-dcd72acaf743",
              "name": "zoneRadiusAcct"
            },
            "macAuthByPassEnabled": true
          },
          "supplicant": null
        }
      },
      {
        "portName": "LAN3",
        "enabled": true,
        "type": "Trunk",
        "vlanUntagId": 1,
        "members": "1-4094",
        "_8021X": {
          "type": "Supplicant",
          "authenticator": null,
          "supplicant": {
            "type": "Custom",
            "userName": "a",
            "password": "a"
          }
        }
      }
    ]
  },
  "autoChannelSelection24": {
    "channelSelectMode": "ChannelFly",
    "channelFlyMtbc": 480
  },
  "autoChannelSelection50": {
    "channelSelectMode": "BackgroundScanning",
    "channelFlyMtbc": 480
  },
  "channelEvaluationInterval": 777,
  "apMgmtVlan": {
    "id": 1,
    "mode": "KEEP"
  },
  "altitude": {
    "altitudeUnit": "meters",
    "altitudeValue": 1
  },
  "meshOptions": {
    "meshMode": "MESH_AP",
    "uplinkSelection": "MANUAL",
    "meshUplinkEntryList": [
      "6C:AA:B3:26:6C:30"
    ]
  },
  "recoverySsid": {
    "recoverySsidEnabled": true
  },
  "rogueApReportThreshold": 50,
  "rogueApAggressivenessMode": 2,
  "rogueApJammingThreshold": 50,
  "directedMulticastFromWiredClientEnabled": true,
  "directedMulticastFromWirelessClientEnabled": true,
  "directedMulticastFromNetworkEnabled": false
}
Schema
{
    "additionalProperties" : false,
    "properties" : {
        "administrativeState" : {
            "default" : "Unlocked",
            "type" : "string",
            "enum" : [ "Locked", "Unlocked" ]
        },
        "altitude" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "altitudeUnit" : {
                    "description" : "altitude unit",
                    "type" : "string",
                    "enum" : [ "meters", "floor" ],
                    "default" : "meters"
                },
                "altitudeValue" : {
                    "description" : "altitude value",
                    "type" : "integer"
                }
            }
        },
        "apGroupId" : {
            "type" : "string"
        },
        "apMgmtVlan" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "mode" : {
                    "description" : "Vlan Mode of the zone",
                    "type" : "string",
                    "enum" : [ "KEEP", "USER_DEFINED" ],
                    "default" : "KEEP"
                },
                "id" : {
                    "description" : "Vlan id of the zone",
                    "type" : "integer",
                    "default" : "1"
                }
            }
        },
        "autoChannelSelection24" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "channelSelectMode" : {
                    "description" : "Channel Select Mode",
                    "type" : "string",
                    "enum" : [ "None", "BackgroundScanning", "ChannelFly" ],
                    "default" : "BackgroundScanning"
                },
                "channelFlyMtbc" : {
                    "description" : "ChannelFly MTBC",
                    "type" : "integer",
                    "default" : 480,
                    "minimum" : 100,
                    "maximum" : 1440
                }
            }
        },
        "autoChannelSelection50" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "channelSelectMode" : {
                    "description" : "Channel Select Mode",
                    "type" : "string",
                    "enum" : [ "None", "BackgroundScanning", "ChannelFly" ],
                    "default" : "BackgroundScanning"
                },
                "channelFlyMtbc" : {
                    "description" : "ChannelFly MTBC",
                    "type" : "integer",
                    "default" : 480,
                    "minimum" : 100,
                    "maximum" : 1440
                }
            }
        },
        "awsVenue" : {
            "type" : "string"
        },
        "bonjourGateway" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "channelEvaluationInterval" : {
            "default" : 600,
            "maximum" : 3600,
            "minimum" : 60,
            "type" : "integer"
        },
        "clientAdmissionControl24" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "enabled" : {
                    "type" : "boolean"
                },
                "maxRadioLoadPercent" : {
                    "description" : "Maximum radio load percentage.",
                    "type" : "integer",
                    "default" : 75,
                    "minimum" : 50,
                    "maximum" : 100
                },
                "minClientCount" : {
                    "description" : "Minimum client count number.",
                    "type" : "integer",
                    "default" : 10,
                    "minimum" : 0,
                    "maximum" : 100
                },
                "minClientThroughputMbps" : {
                    "description" : "Minimum client throughput in Mbps.",
                    "type" : "number",
                    "default" : 0,
                    "minimum" : 0,
                    "maximum" : 100
                }
            }
        },
        "clientAdmissionControl50" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "enabled" : {
                    "type" : "boolean"
                },
                "maxRadioLoadPercent" : {
                    "description" : "Maximum radio load percentage.",
                    "type" : "integer",
                    "default" : 75,
                    "minimum" : 50,
                    "maximum" : 100
                },
                "minClientCount" : {
                    "description" : "Minimum client count number.",
                    "type" : "integer",
                    "default" : 10,
                    "minimum" : 0,
                    "maximum" : 100
                },
                "minClientThroughputMbps" : {
                    "description" : "Minimum client throughput in Mbps.",
                    "type" : "number",
                    "default" : 0,
                    "minimum" : 0,
                    "maximum" : 100
                }
            }
        },
        "description" : {
            "type" : [ "string", "null" ],
            "maxLength" : 64
        },
        "gpsSource" : {
            "description" : "GPS Source of the AP",
            "type" : "string",
            "enum" : [ "GPS", "MANUAL" ]
        },
        "latitude" : {
            "type" : "number"
        },
        "location" : {
            "type" : "string"
        },
        "locationAdditionalInfo" : {
            "type" : "string",
            "pattern" : "^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
        },
        "login" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "apLoginName" : {
                    "description" : "User name of the AP administrator",
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : "^((?!\$\()[!-_a-~]){1,64}$"
                },
                "apLoginPassword" : {
                    "description" : "Password of the AP administrator",
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : ".*(?=.{8,})(?=.*[a-zA-Z])(?=.*[0-9])(?=.*[_`~!@#$%^&*\(\)\[\]\{\}|;:'\",.\<>\/?=+-]).*"
                }
            },
            "required" : [ "apLoginName", "apLoginPassword" ]
        },
        "longitude" : {
            "type" : "number"
        },
        "mac" : {
            "type" : "string",
            "pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
        },
        "meshOptions" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "meshMode" : {
                    "description" : "mesh mode",
                    "type" : "string",
                    "enum" : [ "AUTO", "ROOT_AP", "MESH_AP", "DISABLE" ]
                },
                "uplinkSelection" : {
                    "description" : "Uplink selection",
                    "type" : "string",
                    "enum" : [ "SMART", "MANUAL" ]
                },
                "meshUplinkEntryList" : {
                    "description" : "MAC address of the neighbor AP",
                    "type" : "array",
                    "items" : {
                        "type" : "string",
                        "pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
                    }
                }
            }
        },
        "model" : {
            "type" : "string"
        },
        "name" : {
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 64,
            "pattern" : "^[!-~]((?!\$\()[ -_a-~]){0,62}[!-~]$"
        },
        "network" : {
            "additionalProperties" : false,
            "properties" : {
                "gateway" : {
                    "type" : "string"
                },
                "ip" : {
                    "type" : "string"
                },
                "ipType" : {
                    "type" : "string",
                    "enum" : [ "Dynamic", "Keep", "Static" ]
                },
                "netmask" : {
                    "type" : "string",
                    "pattern" : "^$|(^(128|192|224|24[08]|25[245]).0.0.0$)|(^255.(0|128|192|224|24[08]|25[245]).0.0$)|(^255.255.(0|128|192|224|24[08]|25[245]).0$)|(^255.255.255.(0|128|192|224|24[08]|252|255)$)"
                },
                "primaryDns" : {
                    "type" : "string"
                },
                "secondaryDns" : {
                    "type" : "string"
                }
            },
            "type" : "object"
        },
        "networkIpv6" : {
            "additionalProperties" : false,
            "properties" : {
                "gateway" : {
                    "type" : "string"
                },
                "ip" : {
                    "type" : "string"
                },
                "ipType" : {
                    "type" : "string",
                    "enum" : [ "Dynamic", "Keep", "Static" ]
                },
                "primaryDns" : {
                    "type" : "string"
                },
                "secondaryDns" : {
                    "type" : "string"
                }
            },
            "type" : "object"
        },
        "provisionChecklist" : {
            "type" : "string"
        },
        "serial" : {
            "type" : "string"
        },
        "smartMonitor" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "enabled" : {
                    "type" : "boolean"
                },
                "intervalInSec" : {
                    "description" : "Interval in seconds. This is required if smartMonitor is enabled",
                    "type" : "integer",
                    "default" : 10,
                    "minimum" : 5,
                    "maximum" : 60
                },
                "retryThreshold" : {
                    "description" : "Retry threshold. This is required if smartMonitor is enabled",
                    "type" : "integer",
                    "default" : 3,
                    "minimum" : 1,
                    "maximum" : 10
                }
            }
        },
        "specific" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "ledStatusEnabled" : {
                    "type" : [ "boolean", "null" ]
                },
                "lldp" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "enabled" : {
                            "type" : "boolean",
                            "default" : true
                        },
                        "advertiseIntervalInSec" : {
                            "type" : [ "integer", "null" ],
                            "minimum" : 1,
                            "maximum" : 300
                        },
                        "holdTimeInSec" : {
                            "type" : [ "integer", "null" ],
                            "minimum" : 60,
                            "maximum" : 1200
                        },
                        "managementIPTLVEnabled" : {
                            "type" : [ "boolean", "null" ]
                        }
                    },
                    "required" : [ "enabled" ]
                },
                "lacp" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "enabled" : {
                            "type" : "boolean",
                            "default" : false
                        }
                    }
                },
                "cellularSettings" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "mobileAPName" : {
                            "type" : [ "string", "null" ],
                            "maxLength" : 100,
                            "pattern" : "^([!-?A-~]([!-?A-~]){0,62}[!-?A-~]|[!-?A-~]{1,1})$"
                        },
                        "mobileAPName2" : {
                            "type" : [ "string", "null" ],
                            "maxLength" : 100,
                            "pattern" : "^([!-?A-~]([!-?A-~]){0,62}[!-?A-~]|[!-?A-~]{1,1})$"
                        },
                        "simCardUsage" : {
                            "type" : [ "integer", "null" ],
                            "minimum" : 0,
                            "maximum" : 2
                        },
                        "select3g4g" : {
                            "type" : "integer",
                            "minimum" : 0,
                            "maximum" : 2
                        },
                        "select3g4g2" : {
                            "type" : "integer",
                            "minimum" : 0,
                            "maximum" : 2
                        },
                        "dataRoaming" : {
                            "type" : [ "integer", "null" ],
                            "minimum" : 0,
                            "maximum" : 1
                        },
                        "dataRoaming2" : {
                            "type" : [ "integer", "null" ],
                            "minimum" : 0,
                            "maximum" : 1
                        },
                        "wanConnection" : {
                            "type" : "integer",
                            "minimum" : 0,
                            "maximum" : 3
                        },
                        "wanRecoveryTimer" : {
                            "type" : "integer",
                            "minimum" : 10,
                            "maximum" : 300
                        }
                    },
                    "required" : [ "select3g4g", "select3g4g2", "wanConnection", "wanRecoveryTimer" ]
                },
                "ledMode" : {
                    "type" : [ "string", "null" ],
                    "enum" : [ null, "CableModem", "AccessPoint", "CableModem_AccessPoint", "CableModem_AccessPoint_DEFAULT", "ActiveSurgeProtector", "ActiveSurgeProtector_ModemOnline_DEFAULT", "Off" ]
                },
                "internalHeaterEnabled" : {
                    "type" : [ "boolean", "null" ]
                },
                "poeOutPortEnabled" : {
                    "type" : [ "boolean", "null" ]
                },
                "usbPowerEnable" : {
                    "type" : [ "boolean", "null" ]
                },
                "poeModeSetting" : {
                    "type" : [ "string", "null" ],
                    "enum" : [ "Auto", "_802_3af", "_802_3at", "_802_3atPlus", null ]
                },
                "poeTxChain" : {
                    "description" : "Option to use 1, 2 or 4 Tx chains while AP power source is 802.3af PoE",
                    "default" : 2,
                    "type" : [ "integer", "null" ]
                },
                "radioBand" : {
                    "description" : "Band switch between 2.4GHz and 5GHz is provided in single radio AP ZF-7321, ZF-7321-U, and ZF-7441.",
                    "type" : [ "string", "null" ],
                    "enum" : [ null, "2.4GHz", "5GHz" ]
                },
                "externalAntenna24" : {
                    "type" : [ "object", "null" ],
                    "additionalProperties" : false,
                    "properties" : {
                        "enabled" : {
                            "type" : "boolean"
                        },
                        "dbi" : {
                            "type" : [ "integer", "null" ],
                            "minimum" : 0,
                            "maximum" : 90
                        },
                        "chainMask" : {
                            "type" : [ "string", "null" ],
                            "enum" : [ null, "Two", "Three" ]
                        }
                    },
                    "required" : [ "enabled" ]
                },
                "externalAntenna50" : {
                    "type" : [ "object", "null" ],
                    "additionalProperties" : false,
                    "properties" : {
                        "enabled" : {
                            "type" : "boolean"
                        },
                        "dbi" : {
                            "type" : [ "integer", "null" ],
                            "minimum" : 0,
                            "maximum" : 90
                        },
                        "chainMask" : {
                            "type" : [ "string", "null" ],
                            "enum" : [ null, "Two", "Three" ]
                        }
                    },
                    "required" : [ "enabled" ]
                },
                "lanPorts" : {
                    "type" : "array",
                    "items" : {
                        "type" : "object",
                        "additionalProperties" : false,
                        "properties" : {
                            "portName" : {
                                "type" : "string",
                                "enum" : [ "LAN1", "LAN2", "LAN3", "LAN4", "LAN5" ]
                            },
                            "enabled" : {
                                "type" : "boolean"
                            },
                            "overwriteVlanEnabled" : {
                                "type" : "boolean"
                            },
                            "vlanUntagId" : {
                                "type" : [ "integer", "null" ],
                                "minimum" : 0,
                                "maximum" : 4094
                            },
                            "members" : {
                                "type" : [ "string", "null" ]
                            },
                            "ethPortProfile" : {
                                "type" : [ "object", "null" ],
                                "additionalProperties" : false,
                                "properties" : {
                                    "id" : {
                                        "type" : "string"
                                    },
                                    "name" : {
                                        "type" : "string"
                                    }
                                }
                            }
                        },
                        "required" : [ "portName", "enabled" ]
                    }
                }
            }
        },
        "syslog" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "enabled" : {
                    "description" : "Indicates whether syslog is enabled or disabled",
                    "type" : "boolean"
                },
                "address" : {
                    "description" : "Address of the syslog server. If syslog is enabled, this attribute is required.",
                    "type" : "string"
                },
                "port" : {
                    "description" : "Port number of the syslog server",
                    "type" : "integer",
                    "default" : "514",
                    "minimum" : 1,
                    "maximum" : 65535
                },
                "facility" : {
                    "description" : "Facility of the syslog server",
                    "type" : "string",
                    "enum" : [ "Keep_Original", "Local0", "Local1", "Local2", "Local3", "Local4", "Local5", "Local6", "Local7" ],
                    "default" : "Keep_Original"
                },
                "priority" : {
                    "description" : "Priority of the log messages",
                    "type" : "string",
                    "enum" : [ "Emergency", "Alert", "Critical", "Error", "Warning", "Notice", "Info", "All" ],
                    "default" : "Error"
                },
                "flowLevel" : {
                    "description" : "Flow Level of the syslog",
                    "type" : "string",
                    "enum" : [ "GENERAL_LOGS", "CLIENT_FLOW", "ALL" ],
                    "default" : "GENERAL_LOGS"
                },
                "protocol" : {
                    "description" : "Protocol of the syslog server",
                    "type" : "string",
                    "enum" : [ "IPPROTO_TCP", "IPPROTO_UDP" ],
                    "default" : "IPPROTO_TCP"
                },
                "secondaryAddress" : {
                    "description" : "Secondary Server Address of the syslog server",
                    "type" : "string"
                },
                "secondaryPort" : {
                    "description" : "Secondary Server Port of the syslog server",
                    "type" : "integer",
                    "default" : "514",
                    "minimum" : 1,
                    "maximum" : 65535
                },
                "secondaryProtocol" : {
                    "description" : "Secondary Server Protocol of the syslog server",
                    "type" : "string",
                    "enum" : [ "IPPROTO_TCP", "IPPROTO_UDP" ],
                    "default" : "IPPROTO_TCP"
                }
            },
            "required" : [ "enabled" ]
        },
        "venueProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "wifi24" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "autoCellSizing" : {
                    "description" : "Auto Cell Sizing",
                    "type" : "boolean"
                },
                "txPower" : {
                    "description" : "Transmission power",
                    "type" : "string",
                    "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
                    "default" : "Full"
                },
                "channelWidth" : {
                    "description" : "Channel width. Zero (0) means Auto.",
                    "type" : "integer",
                    "enum" : [ 0, 20, 40 ]
                },
                "channel" : {
                    "description" : "Channel number",
                    "type" : "integer"
                },
                "channelRange" : {
                    "description" : "Channel range options",
                    "type" : "array",
                    "items" : {
                        "type" : "integer"
                    }
                },
                "availableChannelRange" : {
                    "description" : "Available channel range options",
                    "type" : "array",
                    "items" : {
                        "type" : "integer"
                    }
                }
            }
        },
        "wifi50" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "autoCellSizing" : {
                    "description" : "Auto Cell Sizing",
                    "type" : "boolean"
                },
                "txPower" : {
                    "description" : "transmission power",
                    "type" : "string",
                    "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
                    "default" : "Full"
                },
                "channelWidth" : {
                    "description" : "channel width, 0 mean Auto, 8080 means 80+80MHz",
                    "type" : "integer",
                    "enum" : [ 0, 20, 40, 80, 8080, 160 ]
                },
                "channel" : {
                    "description" : "channel number",
                    "type" : "integer"
                },
                "secondaryChannel" : {
                    "description" : "channel number (channelWidth is 80+80MHz only)",
                    "type" : "integer"
                },
                "channelRange" : {
                    "description" : "channel range options",
                    "type" : "array",
                    "items" : {
                        "type" : "integer"
                    }
                }
            }
        },
        "protectionMode24" : {
            "type" : "string",
            "enum" : [ "NONE", "CTS_ONLY", "RTS_CTS" ],
            "default" : "RTS_CTS"
        },
        "wlanGroup24" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "description" : "Identifier of the WLAN group",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the WLAN group",
                    "type" : "string"
                }
            }
        },
        "wlanGroup50" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "description" : "Identifier of the WLAN group",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the WLAN group",
                    "type" : "string"
                }
            }
        },
        "wlanService24Enabled" : {
            "type" : "boolean"
        },
        "wlanService50Enabled" : {
            "type" : "boolean"
        },
        "zoneId" : {
            "type" : "string"
        },
        "recoverySsid" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "recoverySsidEnabled" : {
                    "description" : "recovery ssid enable/disable",
                    "type" : "boolean"
                }
            }
        },
        "lteBandLockChannels" : {
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "simCardId" : {
                        "description" : "SIM card ID(Primary:0, Secondary:1)",
                        "type" : "integer"
                    },
                    "type" : {
                        "description" : "LTE chipset SKU type",
                        "type" : "string"
                    },
                    "channel4g" : {
                        "description" : "LTE 4G channels",
                        "type" : "string"
                    },
                    "channel3g" : {
                        "description" : "LTE 3G channels",
                        "type" : "string"
                    }
                }
            }
        }
    },
    "type" : "object"
}

Query Zero Touch Unapproved AP list

GET/v8_1/mesh/zeroTouch

Use this API command to retrieve a list of unapproved AP.

Response  200
HideShow
Body
{
  "rawDataTotalCount": 100,
  "totalCount": 10,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "apMac": "AB:CD:00:00:00:0D",
      "meshRole": "eMesh AP",
      "apName": "AP014",
      "apModel": "R500",
      "ipAddress": "192.168.0.162",
      "externalIPAddress": "10.10.10.33:3000",
      "channel": null,
      "uplinkRssi": 77,
      "downlinkRssi": null,
      "hasDownLink": false,
      "clientCount": 0,
      "hops": 0
    }
  ],
  "extra": null
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "rawDataTotalCount": {
      "description": "MeshNodeInfos count.",
      "type": "integer"
    },
    "totalCount": {
      "description": "MeshNodeInfos count in this response.",
      "type": "integer"
    },
    "extra": {
      "description": "Any additional response data.",
      "type": "object"
    },
    "hasMore": {
      "description": "Indicator of whether there are more MeshNodeInfo after the current displayed list",
      "type": "boolean"
    },
    "firstIndex": {
      "description": "Index of the first MeshNodeInfo returned out of the complete Rogue AP list",
      "type": "integer"
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "apMac": {
            "description": "The MAC of the mesh AP",
            "type": "string"
          },
          "meshRole": {
            "description": "The Role of the mesh AP",
            "type": "string"
          },
          "apName": {
            "description": "The name of the mesh AP",
            "type": "string"
          },
          "apModel": {
            "description": "The model of the mesh AP",
            "type": "string"
          },
          "ipAddress": {
            "description": "The IP of the mesh AP",
            "type": "integer"
          },
          "externalIPAddress": {
            "description": "The external IP of the mesh AP",
            "type": "string"
          },
          "channel": {
            "description": "The channel of the mesh AP",
            "type": "string"
          },
          "uplinkRssi": {
            "description": "The uplinkRssi of the mesh AP",
            "type": "integer"
          },
          "downlinkRssi": {
            "description": "The downlinkRssi of the mesh AP",
            "type": "integer"
          },
          "hasDownLink": {
            "description": "The hasDownLink of the mesh AP",
            "type": "boolean"
          },
          "clientCount": {
            "description": "The count of clients of the mesh AP",
            "type": "integer"
          },
          "hops": {
            "description": "The hop count of this mesh AP",
            "type": "integer"
          },
          "helperZoneInfo": {
            "type": "array",
            "items": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "helperAPZoneId": {
                  "type": "string"
                },
                "helperAPZoneName": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}

Update Zero Touch Unapproved AP

PUT/v8_1/mesh/zeroTouch

Use this API command to approve/reject unapproved AP. Recommend to deploy 20 island APs to join per batch at the same time.

Request
HideShow
Body
{
  "apMac": "AB:CD:00:00:00:0D",
  "status": "Accept",
  "helperZoneId": "fce48fb7-8b89-49f6-8ce5-f52aecfc81ff",
  "serialNumber": "0089"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "apMac": {
      "type": "string"
    },
    "status": {
      "type": "string",
      "enum": [
        "Accept",
        "Reject"
      ]
    },
    "helperZoneId": {
      "type": "string"
    },
    "serialNumber": {
      "type": "string"
    }
  }
}
Response  200

Access Point Operational

Retrieve Operational Information

GET/v8_1/aps/{apMac}/operational/summary

Use this API command to retrieve the operational information of an AP.

Response  200
HideShow
Body
{
  "mac": "00:11:22:33:44:55",
  "zoneId": "zoneUUID",
  "apGroupId": "apGroupUUID",
  "serial": "00000096",
  "model": "ZF7962",
  "name": "apName",
  "version": "3.0.0.385",
  "description": "apDescription",
  "countryCode": "US",
  "latitude": 22.3,
  "longitude": 114,
  "altitude": {
    "altitudeUnit": "meters",
    "altitudeValue": 33
  },
  "location": "location",
  "locationAdditionalInfo": "locationAdditionalInfo",
  "cpId": "controlPlaneUUID",
  "dpId": "dataPlaneUUID",
  "wifi24Channel": "2",
  "wifi50Channel": "6",
  "meshRole": "Map",
  "meshHop": 2,
  "ipType": "Static",
  "ip": "1.1.1.1",
  "ipv6Type": null,
  "ipv6": null,
  "externalIp": "172.18.11.11",
  "externalPort": 675,
  "configState": "newConfig",
  "connectionState": "Connected",
  "registrationState": "Approved",
  "administrativeState": "Unlocked",
  "provisionMethod": "Discovered",
  "provisionStage": "Waiting for Registration",
  "isCriticalAP": true,
  "approvedTime": 111111,
  "lastSeenTime": 111111,
  "uptime": 111111,
  "clientCount": 2
}
Schema
{
    "additionalProperties" : false,
    "properties" : {
        "administrativeState" : {
            "type" : "string",
            "enum" : [ "Locked", "Unlocked" ]
        },
        "apGroupId" : {
            "type" : "string"
        },
        "approvedTime" : {
            "type" : "integer"
        },
        "clientCount" : {
            "type" : "integer"
        },
        "configState" : {
            "type" : "string",
            "enum" : [ "completed", "configApplied", "configFailed", "fwApplied", "fwDownloaded", "fwFailed", "newConfig" ]
        },
        "connectionState" : {
            "type" : "string"
        },
        "countryCode" : {
            "type" : "string"
        },
        "cpId" : {
            "type" : "string"
        },
        "description" : {
            "type" : [ "string", "null" ],
            "maxLength" : 64
        },
        "dpId" : {
            "type" : "string"
        },
        "externalIp" : {
            "type" : "string"
        },
        "externalPort" : {
            "type" : "integer"
        },
        "ip" : {
            "type" : "string"
        },
        "ipType" : {
            "type" : "string",
            "enum" : [ "Dynamic", "Keep", "Static" ]
        },
        "isCriticalAP" : {
            "type" : "boolean"
        },
        "lastSeenTime" : {
            "type" : "integer"
        },
        "latitude" : {
            "type" : "number"
        },
        "location" : {
            "type" : "string"
        },
        "locationAdditionalInfo" : {
            "type" : "string",
            "pattern" : "^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
        },
        "longitude" : {
            "type" : "number"
        },
        "mac" : {
            "type" : "string",
            "pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
        },
        "managementVlan" : {
            "type" : "integer"
        },
        "meshHop" : {
            "type" : "integer"
        },
        "meshRole" : {
            "type" : "string",
            "enum" : [ "Disabled", "Down", "Map", "Root", "Undefined", "eMap" ]
        },
        "model" : {
            "type" : "string"
        },
        "name" : {
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 64,
            "pattern" : "^[!-~]((?!\$\()[ -_a-~]){0,62}[!-~]$"
        },
        "provisionMethod" : {
            "type" : "string",
            "enum" : [ "Discovered", "Preprovision", "Swap" ]
        },
        "provisionStage" : {
            "type" : "string"
        },
        "registrationState" : {
            "type" : "string"
        },
        "serial" : {
            "type" : "string"
        },
        "uptime" : {
            "type" : "integer"
        },
        "version" : {
            "type" : "string",
            "pattern" : "^\d+\.\d+\.\d+\.\d+\.\d+$"
        },
        "wifi24Channel" : {
            "type" : "string"
        },
        "wifi50Channel" : {
            "type" : "string"
        },
        "zoneId" : {
            "type" : "string"
        }
    },
    "type" : "object"
}

Switchover AP

POST/v8_1/aps/switchoverCluster

Use this API command to switchover AP to another cluster

Request
HideShow
Body
{
  "ipOrFqdn": "172.18.11.11",
  "apMacList": [
    "01:02:03:11:12:A3",
    "01:02:03:11:13:29",
    "01:02:03:11:13:AF",
    "01:02:03:11:14:35",
    "01:02:03:11:14:BB"
  ],
  "deleteRecord": false
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "ipOrFqdn": {
      "description": "IP or FQDN address of destination cluster, Notice: Once this value been set, clusterName will be ignored.",
      "type": "string"
    },
    "clusterName": {
      "description": "Name of destination cluster, Notice: Once user has set ipOrFqdn, this value will be ignored.",
      "type": "string"
    },
    "apMacList": {
      "type": "array",
      "description": "AP MAC address list",
      "items": {
        "type": "string",
        "pattern": "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
      }
    },
    "zoneIdList": {
      "description": "Zone ID list for which APs attached to will be switchovered.",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "deleteRecord": {
      "description": "Flag to delete AP record after switchover cluster. Default value is false.",
      "type": "boolean"
    }
  }
}
Response  204

Retrieve Event Summary

GET/v8_0/aps/{apMac}/operational/eventSummary

Use this API command to retrieve the event summary of an AP.

Deprecated : this URI will be deprecated after Version: v8_0, and no longer be supported. For the alternative URI, please refer to the “RETRIEVE EVENT SUMMARY” section of the category “Event and Alarm”.

Response  200
HideShow
Body
{
  "criticalCount": 4,
  "majorCount": 2,
  "minorCount": 5,
  "warningCount": 5,
  "informationalCount": 2,
  "debugCount": 5
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "criticalCount": {
      "description": "Critical event count",
      "type": "integer"
    },
    "majorCount": {
      "description": "Major event count",
      "type": "integer"
    },
    "minorCount": {
      "description": "Minor event count",
      "type": "integer"
    },
    "warningCount": {
      "description": "Warning event count",
      "type": "integer"
    },
    "informationalCount": {
      "description": "Informational event count",
      "type": "integer"
    },
    "debugCount": {
      "description": "Debug event count",
      "type": "integer"
    }
  }
}

Retrieve Alarm Summary

GET/v8_0/aps/{apMac}/operational/alarmSummary

Use this API command to retrieve the alarm summary of an AP.

Deprecated : this URI will be deprecated after Version: v8_0, and no longer be supported. For the alternative URI, please refer to the “RETRIEVE ALARM SUMMARY” section of the category “Event and Alarm”.

Response  200
HideShow
Body
{
  "criticalCount": 3,
  "majorCount": 3,
  "minorCount": 4,
  "warningCount": 0
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "criticalCount": {
      "description": "Critical alarm count",
      "type": "integer"
    },
    "majorCount": {
      "description": "Major alarm count",
      "type": "integer"
    },
    "minorCount": {
      "description": "Minor alarm count",
      "type": "integer"
    },
    "warningCount": {
      "description": "Warning alarm count",
      "type": "integer"
    }
  }
}

Retrieve Mesh Neighbor AP List

GET/v8_1/aps/{apMac}/operational/neighbor

Use this API command to retrieve a list of neighbor access points on mesh AP.

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

Response  200
HideShow
Body
{
  "totalCount": 1,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "mac": "8C:0C:90:2B:8B:90",
      "model": "ZF7372",
      "name": "RuckusAP",
      "version": "3.1.0.0.157",
      "ip": "10.2.6.239",
      "externalIp": "10.2.6.239",
      "externalPort": "58788",
      "connectionState": "Connect",
      "channel": "40 (11a/n)",
      "signal": "119%",
      "zoneName": "neilMeshZone"
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "description": "Total mesh neighbor APs count",
      "type": "integer"
    },
    "hasMore": {
      "description": "Indicator of whether there are more Mesh Neighbor APs after the current displayed list",
      "type": "boolean"
    },
    "firstIndex": {
      "description": "Index of the first Mesh Neighbor AP returned out of the complete Mesh Neighbor AP list",
      "type": "integer"
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "mac": {
            "description": "MAC address of the mesh neighbor AP",
            "type": "string",
            "pattern": "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
          },
          "name": {
            "description": "Name of the mesh neighbor AP",
            "type": "string"
          },
          "zoneName": {
            "description": "Name of the zone which the mesh neighbor AP belongs to",
            "type": "string"
          },
          "ip": {
            "description": "IP address of the mesh neighbor AP",
            "type": "string"
          },
          "externalIp": {
            "description": "External IP of the mesh neighbor AP",
            "type": "string"
          },
          "externalPort": {
            "description": "External port of the mesh neighbor AP",
            "type": "string"
          },
          "model": {
            "description": "Model of the mesh neighbor AP",
            "type": "string"
          },
          "version": {
            "description": "Firmware version of the mesh neighbor AP",
            "type": "string"
          },
          "channel": {
            "description": "Channel of the mesh neighbor AP",
            "type": "string"
          },
          "signal": {
            "description": "Signal of the mesh neighbor AP",
            "type": "string"
          },
          "connectionState": {
            "description": "Connection state of the mesh neighbor AP",
            "type": "string"
          }
        }
      }
    }
  }
}

Retrieve Alarm List

GET/v8_0/aps/{apMac}/operational/alarms

Use this API command to retrieve the list of alarms on an AP.

Deprecated : this URI will be deprecated after Version: v8_0, and no longer be supported. For the alternative URI, please refer to the “RETRIEVE ALARM LIST” section of the category “Event and Alarm”.

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

severity
string (optional) 

filter by severity

category
string (optional) 

filter by category

code
number (optional) 

filter by alarm code

startTime
string (optional) 

filter by trigger time later than startTime (milliseconds in UTC time)

endTime
string (optional) 

filter by trigger time earlier than endTime (milliseconds in UTC time)

status
string (optional) 

filter by alarm status

Response  200
HideShow
Body
{
  "totalCount": 2,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "id": "538324f5-f085-4567-ae3f-6b40244d38d6",
      "time": 1408715298000,
      "code": 302,
      "category": "AP Communication",
      "type": "AP rebooted by system",
      "severity": "Major",
      "description": "AP [abcpeng@24:C9:A1:1D:55:A0] rebooted because of [application, wsgclient, reboot due to switch radio band].",
      "status": "Outstanding",
      "clearedTime": null,
      "acknowledgedTime": null
    },
    {
      "id": "5cc35da9-4d3c-4c9a-97e0-303d9b2b1776",
      "time": 1408715248732,
      "code": 307,
      "category": "AP Communication",
      "type": "AP heartbeat lost",
      "severity": "Informational",
      "description": "AP [abcpeng@24:C9:A1:1D:55:A0] heartbeat lost.",
      "status": "Cleared",
      "clearedTime": 1408715299243,
      "acknowledgedTime": null
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "description": "Total alarm count",
      "type": "integer"
    },
    "hasMore": {
      "description": "Indicates whether there are more alarms after the currently displayed list",
      "type": "boolean"
    },
    "firstIndex": {
      "description": "Index of the first alarm returned from the complete alarm list",
      "type": "integer"
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "Identifier of the alarm",
            "type": "string",
            "pattern": "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
          },
          "time": {
            "description": "Time of the alarm",
            "type": "string"
          },
          "code": {
            "description": "Alarm code",
            "type": "string"
          },
          "category": {
            "description": "Alarm category",
            "type": "string"
          },
          "type": {
            "description": "Alarm type",
            "type": "string"
          },
          "severity": {
            "description": "Alarm severity",
            "type": "string",
            "enum": [
              "Critical",
              "Major",
              "Minor",
              "Warning",
              "Informational"
            ]
          },
          "description": {
            "description": "Alarm description",
            "type": "string"
          },
          "status": {
            "description": "Alarm status",
            "type": "string",
            "enum": [
              "Outstanding",
              "Acknowledged",
              "Cleared"
            ]
          },
          "clearedTime": {
            "description": "Time that alarm was cleared",
            "type": "integer"
          },
          "acknowledgedTime": {
            "description": "Time the alarm was acknowledged",
            "type": "integer"
          }
        }
      }
    }
  }
}

Retrieve Event List

GET/v8_0/aps/{apMac}/operational/events

Use this API command to retrieve the list of events from an AP.

Deprecated : this URI will be deprecated after Version: v8_0, and no longer be supported. For the alternative URI, please refer to the “RETRIEVE EVENT LIST” section of the category “Event and Alarm”.

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

severity
string (optional) 

filter by severity

category
string (optional) 

filter by category

code
number (optional) 

filter by event code

startTime
string (optional) 

filter by trigger time later than startTime (milliseconds in UTC time)

endTime
string (optional) 

filter by trigger time earlier than endTime (milliseconds in UTC time)

Response  200
HideShow
Body
{
  "totalCount": 2,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "id": "7a06627a-f739-4aac-b2a1-5fc6d7bb2767",
      "time": 1408648612000,
      "code": 110,
      "category": "AP Communication",
      "type": "AP configuration updated",
      "severity": "Informational",
      "description": "AP [abcpeng@24:C9:A1:1D:55:A0] updated to configuration [af8d97a0-2967-11e4-91cf-000c29b1347d]."
    },
    {
      "id": "8c5796c1-746c-460b-81f0-f97b8ab2b74f",
      "time": 1408648603000,
      "code": 109,
      "category": "AP Communication",
      "type": "Updating AP configuration...",
      "severity": "Informational",
      "description": "AP [abcpeng@24:C9:A1:1D:55:A0] is being updated to new configuration ID [af8d97a0-2967-11e4-91cf-000c29b1347d]."
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "description": "Total event count",
      "type": "integer"
    },
    "hasMore": {
      "description": "Indicates whether there are more events after the currently displayed list",
      "type": "boolean"
    },
    "firstIndex": {
      "description": "Index of the first event returned from the complete event list",
      "type": "integer"
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "Identifier of the event",
            "type": "string",
            "pattern": "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
          },
          "time": {
            "description": "Time of the event",
            "type": "string"
          },
          "code": {
            "description": "Event code",
            "type": "string"
          },
          "category": {
            "description": "Event category",
            "type": "string"
          },
          "type": {
            "description": "Event type",
            "type": "string"
          },
          "severity": {
            "description": "Event severity",
            "type": "string",
            "enum": [
              "Critical",
              "Major",
              "Minor",
              "Warning",
              "Informational",
              "Debug"
            ]
          },
          "description": {
            "description": "Event description",
            "type": "string"
          }
        }
      }
    }
  }
}

AP packet capture download

POST/v8_1/aps/{apMac}/apPacketCapture/download

Use this API to download AP packet capture file

Response  200
HideShow
Headers
Content-Type: application/octet-stream

AP packet capture startStreaming

POST/v8_1/aps/{apMac}/apPacketCapture/startStreaming

Use this API to start AP packet streaming

Request
HideShow
Body
{
  "captureInterface": "RADIO50",
  "hostIp": "192.168.1.1",
  "includedMac": "1A:2B:3C:4D:5E:6F",
  "includedFrameTypes": [
    "CONTROL",
    "DATA"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "captureInterface": {
      "type": "string",
      "enum": [
        "RADIO24",
        "RADIO50",
        "ETH0",
        "ETH1",
        "ETH2",
        "ETH3",
        "ETH4",
        "ETH5",
        "ETH6",
        "ETH7"
      ],
      "description": "Capture interface"
    },
    "hostIp": {
      "type": "string",
      "description": "Wireshark host IP"
    },
    "includedMac": {
      "type": "string",
      "description": "MAC filter"
    },
    "includedFrameTypes": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "CONTROL",
          "DATA",
          "MANAGEMENT"
        ]
      },
      "description": "Frame type filter"
    }
  },
  "required": [
    "captureInterface"
  ]
}
Response  200
HideShow
Body
{
  "apMac": "A1:B2:C3:D4:E5:F6",
  "captureInterface": "ETH0",
  "hostIp": "192.168.1.1",
  "includedMac": "1A:2B:3C:4D:5E:6F",
  "includedFrameTypes": [
    "MANAGEMENT"
  ],
  "captureMode": "STREAMING",
  "captureState": "Streaming"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "apMac": {
      "type": "string",
      "description": "AP MAC address"
    },
    "captureInterface": {
      "type": "string",
      "enum": [
        "RADIO24",
        "RADIO50",
        "ETH0",
        "ETH1",
        "ETH2",
        "ETH3",
        "ETH4",
        "ETH5",
        "ETH6",
        "ETH7"
      ],
      "description": "Capture interface"
    },
    "hostIp": {
      "type": "string",
      "description": "Wireshark host IP"
    },
    "includedMac": {
      "type": "string",
      "description": "MAC filter"
    },
    "includedFrameTypes": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "CONTROL",
          "DATA",
          "MANAGEMENT"
        ]
      },
      "description": "Frame type filter"
    },
    "captureMode": {
      "type": "string",
      "enum": [
        "STREAMING",
        "FILE_CAPTURE"
      ],
      "description": "Capture mode"
    },
    "captureState": {
      "type": "string",
      "description": "Capture state"
    }
  }
}

AP packet capture startFileCapture

POST/v8_1/aps/{apMac}/apPacketCapture/startFileCapture

Use this API to start AP packet capture

Request
HideShow
Body
{
  "captureInterface": "RADIO50",
  "hostIp": "192.168.1.1",
  "includedMac": "1A:2B:3C:4D:5E:6F",
  "includedFrameTypes": [
    "CONTROL",
    "DATA"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "captureInterface": {
      "type": "string",
      "enum": [
        "RADIO24",
        "RADIO50",
        "ETH0",
        "ETH1",
        "ETH2",
        "ETH3",
        "ETH4",
        "ETH5",
        "ETH6",
        "ETH7"
      ],
      "description": "Capture interface"
    },
    "hostIp": {
      "type": "string",
      "description": "Wireshark host IP"
    },
    "includedMac": {
      "type": "string",
      "description": "MAC filter"
    },
    "includedFrameTypes": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "CONTROL",
          "DATA",
          "MANAGEMENT"
        ]
      },
      "description": "Frame type filter"
    }
  },
  "required": [
    "captureInterface"
  ]
}
Response  200
HideShow
Body
{
  "apMac": "A1:B2:C3:D4:E5:F6",
  "captureInterface": "ETH0",
  "hostIp": "192.168.1.1",
  "includedMac": "1A:2B:3C:4D:5E:6F",
  "includedFrameTypes": [
    "MANAGEMENT"
  ],
  "captureMode": "STREAMING",
  "captureState": "Streaming"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "apMac": {
      "type": "string",
      "description": "AP MAC address"
    },
    "captureInterface": {
      "type": "string",
      "enum": [
        "RADIO24",
        "RADIO50",
        "ETH0",
        "ETH1",
        "ETH2",
        "ETH3",
        "ETH4",
        "ETH5",
        "ETH6",
        "ETH7"
      ],
      "description": "Capture interface"
    },
    "hostIp": {
      "type": "string",
      "description": "Wireshark host IP"
    },
    "includedMac": {
      "type": "string",
      "description": "MAC filter"
    },
    "includedFrameTypes": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "CONTROL",
          "DATA",
          "MANAGEMENT"
        ]
      },
      "description": "Frame type filter"
    },
    "captureMode": {
      "type": "string",
      "enum": [
        "STREAMING",
        "FILE_CAPTURE"
      ],
      "description": "Capture mode"
    },
    "captureState": {
      "type": "string",
      "description": "Capture state"
    }
  }
}

AP packet capture

GET/v8_1/aps/{apMac}/apPacketCapture

Use this API to get AP packet capture status

Response  200
HideShow
Body
{
  "apMac": "A1:B2:C3:D4:E5:F6",
  "captureInterface": "ETH0",
  "hostIp": "192.168.1.1",
  "includedMac": "1A:2B:3C:4D:5E:6F",
  "includedFrameTypes": [
    "MANAGEMENT"
  ],
  "captureMode": "STREAMING",
  "captureState": "Streaming"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "apMac": {
      "type": "string",
      "description": "AP MAC address"
    },
    "captureInterface": {
      "type": "string",
      "enum": [
        "RADIO24",
        "RADIO50",
        "ETH0",
        "ETH1",
        "ETH2",
        "ETH3",
        "ETH4",
        "ETH5",
        "ETH6",
        "ETH7"
      ],
      "description": "Capture interface"
    },
    "hostIp": {
      "type": "string",
      "description": "Wireshark host IP"
    },
    "includedMac": {
      "type": "string",
      "description": "MAC filter"
    },
    "includedFrameTypes": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "CONTROL",
          "DATA",
          "MANAGEMENT"
        ]
      },
      "description": "Frame type filter"
    },
    "captureMode": {
      "type": "string",
      "enum": [
        "STREAMING",
        "FILE_CAPTURE"
      ],
      "description": "Capture mode"
    },
    "captureState": {
      "type": "string",
      "description": "Capture state"
    }
  }
}

AP packet capture stop

POST/v8_1/aps/{apMac}/apPacketCapture/stop

Use this API to stop AP packet capture or streaming

Response  200

AP Remote CLI

POST/v8_1/aps/{apMac}/remoteCli

Use this API to send a CLI command to specified AP.

Request
HideShow
Body
{
  "mode": "CLI",
  "command": "get version"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "mode": {
      "type": "string",
      "enum": [
        "CLI",
        "Shell",
        "CLIRClient",
        "ShellRClient"
      ]
    },
    "command": {
      "type": "string"
    }
  },
  "required": [
    "mode",
    "command"
  ]
}
Response  200
HideShow
Body
{
  "result": "Ruckus T300 Multimedia Hotzone Wireless AP\nVersion: 5.1.0.99.267\nOK"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "result": {
      "type": "string"
    }
  }
}

WLAN Group

Retrieve List

GET/v8_1/rkszones/{zoneId}/wlangroups

Use this API command to retrieve the list of WLAN groups within a zone.

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

Response  200
HideShow
Body
{
  "totalCount": 2,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "id": "wlanGroupUUID",
      "name": "wlanGroupName",
      "description": "wlanGroupDescription",
      "members": [
        {
          "id": "wlanID",
          "name": "wlanName",
          "accessVlan": 1,
          "nasId": "nasId",
          "vlanPooling": null
        }
      ]
    },
    {
      "id": "wlanGroupUUID2",
      "zoneId": "zoneUUID",
      "name": "wlanGroupName2",
      "description": "wlanGroupDescription2",
      "members": [
        {
          "id": "wlanID2",
          "name": "wlanName2",
          "accessVlan": 1,
          "nasId": "nasId",
          "vlanPooling": null
        }
      ]
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "Identifier of the WLAN group",
            "type": "string"
          },
          "zoneId": {
            "description": "Identifier of the zone to which the WLAN group belongs",
            "type": "string"
          },
          "name": {
            "description": "Name of the WLAN group",
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
          },
          "description": {
            "description": "Description of the WLAN group",
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64
          },
          "members": {
            "description": "Members of the WLAN group",
            "type": "array",
            "items": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "id": {
                  "description": "Identifier of the WLAN",
                  "type": "string"
                },
                "name": {
                  "description": "Name of the WLAN",
                  "type": "string"
                },
                "accessVlan": {
                  "description": "Access VLAN",
                  "type": "integer",
                  "minimum": 1,
                  "maximum": 4094
                },
                "vlanPooling": {
                  "description": "Vlan pooling",
                  "type": [
                    "object",
                    "null"
                  ],
                  "additionalProperties": false,
                  "properties": {
                    "id": {
                      "type": "string"
                    },
                    "name": {
                      "type": "string"
                    }
                  }
                },
                "nasId": {
                  "description": "NAS-ID",
                  "type": "string",
                  "maxLength": 63,
                  "pattern": "^([!-~]([ -~]){0,61}[!-~]|[!-~]{1,1})$"
                }
              },
              "required": [
                "id"
              ]
            }
          },
          "createDateTime": {
            "description": "Timestamp of being created",
            "type": "integer"
          },
          "modifiedDateTime": {
            "description": "Timestamp of being modified",
            "type": "integer"
          },
          "creatorId": {
            "description": "Creator ID",
            "type": "string"
          },
          "modifierId": {
            "description": "Modifier ID",
            "type": "string"
          },
          "creatorUsername": {
            "description": "Creator Name",
            "type": "string"
          },
          "modifierUsername": {
            "description": "Modifier Name",
            "type": "string"
          }
        },
        "required": [
          "name"
        ]
      }
    }
  }
}

Create

POST/v8_1/rkszones/{zoneId}/wlangroups

Use this API command to create a new WLAN group.

Request
HideShow
Body
{
  "name": "wlanGroupName",
  "description": "wlanGroupDescription"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "description": "Name of the WLAN group",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "Description of the WLAN group",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    }
  },
  "required": [
    "name"
  ]
}
Response  201
HideShow
Body
{
  "id": "wlanGroupUUID"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Retrieve

GET/v8_1/rkszones/{zoneId}/wlangroups/{id}

Use this API command to retrieve the WLAN group.

Response  200
HideShow
Body
{
  "id": "wlanGroupUUID2",
  "zoneId": "zoneUUID",
  "name": "wlanGroupName2",
  "description": "wlanGroupDescription2",
  "members": [
    {
      "id": "wlanID2",
      "name": "wlanName2",
      "accessVlan": 1,
      "nasId": "nasId",
      "vlanPooling": null
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "Identifier of the WLAN group",
      "type": "string"
    },
    "zoneId": {
      "description": "Identifier of the zone to which the WLAN group belongs",
      "type": "string"
    },
    "name": {
      "description": "Name of the WLAN group",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "Description of the WLAN group",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "members": {
      "description": "Members of the WLAN group",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "Identifier of the WLAN",
            "type": "string"
          },
          "name": {
            "description": "Name of the WLAN",
            "type": "string"
          },
          "accessVlan": {
            "description": "Access VLAN",
            "type": "integer",
            "minimum": 1,
            "maximum": 4094
          },
          "vlanPooling": {
            "description": "Vlan pooling",
            "type": [
              "object",
              "null"
            ],
            "additionalProperties": false,
            "properties": {
              "id": {
                "type": "string"
              },
              "name": {
                "type": "string"
              }
            }
          },
          "nasId": {
            "description": "NAS-ID",
            "type": "string",
            "maxLength": 63,
            "pattern": "^([!-~]([ -~]){0,61}[!-~]|[!-~]{1,1})$"
          }
        },
        "required": [
          "id"
        ]
      }
    },
    "createDateTime": {
      "description": "Timestamp of being created",
      "type": "integer"
    },
    "modifiedDateTime": {
      "description": "Timestamp of being modified",
      "type": "integer"
    },
    "creatorId": {
      "description": "Creator ID",
      "type": "string"
    },
    "modifierId": {
      "description": "Modifier ID",
      "type": "string"
    },
    "creatorUsername": {
      "description": "Creator Name",
      "type": "string"
    },
    "modifierUsername": {
      "description": "Modifier Name",
      "type": "string"
    }
  },
  "required": [
    "name"
  ]
}

Delete

DELETE/v8_1/rkszones/{zoneId}/wlangroups/{id}

Use this API command to delete a WLAN group.

Response  204

Modify

PATCH/v8_1/rkszones/{zoneId}/wlangroups/{id}

Use this API command to modify the basic information of a WLAN group.

Request
HideShow
Body
{
  "name": "wlanGroupNameModified",
  "description": "wlanGroupDescriptionModified"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "description": "Name of the WLAN group",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "Description of the WLAN group",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    }
  }
}
Response  204

Add Member

POST/v8_1/rkszones/{zoneId}/wlangroups/{id}/members

Use this API command to add a member to a WLAN group.

Request
HideShow
Body
{
  "id": "wlanID",
  "accessVlan": 1
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "Identifier of the WLAN",
      "type": "string"
    },
    "name": {
      "description": "Name of the WLAN",
      "type": "string"
    },
    "accessVlan": {
      "description": "Access VLAN",
      "type": "integer",
      "minimum": 1,
      "maximum": 4094
    },
    "vlanPooling": {
      "description": "Vlan pooling",
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "nasId": {
      "description": "NAS-ID",
      "type": "string",
      "maxLength": 63,
      "pattern": "^([!-~]([ -~]){0,61}[!-~]|[!-~]{1,1})$"
    }
  },
  "required": [
    "id"
  ]
}
Response  201

Modify Member

PATCH/v8_1/rkszones/{zoneId}/wlangroups/{id}/members/{memberId}

Use this API command to modify a member of a WLAN group.

Request
HideShow
Body
{
  "accessVlan": 23,
  "nasId": "nasId",
  "vlanPooling": {
    "id": "a61997e0-699b-11e4-b9bb-08002716c79f",
    "name": "zoneVlanPooling"
  }
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "accessVlan": {
      "description": "Access VLAN",
      "type": "integer",
      "minimum": 1,
      "maximum": 4094
    },
    "vlanPooling": {
      "description": "Vlan pooling",
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "nasId": {
      "description": "NAS-ID",
      "type": "string",
      "maxLength": 63,
      "pattern": "^([!-~]([ -~]){0,61}[!-~]|[!-~]{1,1})$"
    }
  }
}
Response  204

Modify Member VLAN Pooling

PATCH/v8_1/rkszones/{zoneId}/wlangroups/{id}/members/{memberId}/vlanPooling

Use this API command to modify a member’s VLAN pooling of a WLAN group.

Request
HideShow
Body
{
  "id": "a61997e0-699b-11e4-b9bb-08002716c79f",
  "name": "zoneVlanPooling"
}
Schema
{
  "description": "Vlan pooling",
  "type": [
    "object",
    "null"
  ],
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    }
  }
}
Response  204

Disable Member VLAN Override

DELETE/v8_1/rkszones/{zoneId}/wlangroups/{id}/members/{memberId}/vlanOverride

Use this API command to disable a member VLAN override of a WLAN group.

Response  204

Disable Member NAS Override

DELETE/v8_1/rkszones/{zoneId}/wlangroups/{id}/members/{memberId}/nasId

Use this API command to disable a member NAS-ID override of a WLAN group.

Response  204

Remove Member

DELETE/v8_1/rkszones/{zoneId}/wlangroups/{id}/members/{memberId}

Use this API command to remove a member from a WLAN group.

Response  204

WLAN

Retrieve List

GET/v8_1/rkszones/{zoneId}/wlans

Use this API command to retrieve a list of WLANs within a zone.

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

Response  200
HideShow
Body
{
  "totalCount": 2,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "id": "1028",
      "mvnoId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
      "name": "wlan2",
      "ssid": "wlan2"
    },
    {
      "id": "1027",
      "mvnoId": "bbbbbbbb-bbbb-cccc-dddd-eeeeeeeeeeee",
      "name": "wlan1",
      "ssid": "wlan1"
    }
  ]
}
Schema
{
  "additionalProperties": false,
  "properties": {
    "firstIndex": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "list": {
      "items": {
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "Identifier of the WLAN",
            "type": "string"
          },
          "mvnoId": {
            "description": "Tenant UUID",
            "type": "string"
          },
          "name": {
            "description": "Name of the WLAN",
            "type": "string"
          },
          "ssid": {
            "description": "SSID of the WLAN",
            "type": "string"
          },
          "type": {
            "type": "string"
          }
        },
        "type": "object"
      },
      "type": "array"
    },
    "totalCount": {
      "type": "integer"
    }
  },
  "type": "object"
}

Delete

DELETE/v8_1/rkszones/{zoneId}/wlans/{id}

Use this API command to delete a WLAN.

Response  204

Create - Hotspot 2.0 Open

POST/v8_1/rkszones/{zoneId}/wlans/hotspot20open

Use this API command to create a new Hotspot 2.0 Onboarding WLAN with Authentication Method as ‘Open’.

Request
HideShow
Body
{
  "name": "api-test-wlanhs20open",
  "ssid": "api-test-wlanhs20open",
  "description": "wlanDescription"
}
Schema
{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "accessTunnelType" : {
            "description" : "Access tunnel type of the WLAN. APLBO means AP local breakout, and SoftGRE means AP direct SoftGRE tunnel",
            "type" : "string",
            "enum" : [ "APLBO", "RuckusGRE", "SoftGRE" ]
        },
        "accountingServiceOrProfile" : {
            "description" : "Accounting of the WLAN",
            "additionalProperties" : false,
            "properties" : {
                "accountingDelayEnabled" : {
                    "description" : "Indicates whether accounting delay time is enabled",
                    "type" : "boolean"
                },
                "id" : {
                    "description" : "Accounting service or profile ID. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "interimUpdateMin" : {
                    "description" : "Interval (in minutes) for sending interim updates",
                    "maximum" : 1440,
                    "minimum" : 0,
                    "type" : "integer"
                },
                "name" : {
                    "description" : "Accounting service or profile name. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "throughController" : {
                    "description" : "Indicates whether accounting messages were sent through the controller",
                    "type" : "boolean"
                },
                "realmBasedAcct" : {
                    "type" : "boolean"
                },
                "backupAccountingId" : {
                    "description" : "Backup accounting service or profile ID. At least one backupAccountingId or backupAccountingName is required in the request when setting backup accounting service.",
                    "type" : "string"
                },
                "backupAccountingName" : {
                    "description" : "Backup accounting service or profile name. At least one backupAccountingId or backupAccountingName is required in the request when setting backup accounting service.",
                    "type" : "string"
                }
            },
            "type" : "object"
        },
        "advancedOptions" : {
            "description" : "Advanced settings for the WLAN.",
            "additionalProperties" : false,
            "properties" : {
                "avcEnabled" : {
                    "default" : false,
                    "description" : "Indicator of whether AVC support is enabled or disabled",
                    "type" : "boolean"
                },
                "bandBalancing" : {
                    "default" : "UseZoneSetting",
                    "description" : "Indicates whether band balancing is enabled or disabled",
                    "type" : "string",
                    "enum" : [ "Disabled", "UseZoneSetting" ]
                },
                "bssMinRateMbps" : {
                    "description" : "BSS minimum rate (mbps)",
                    "type" : "string",
                    "enum" : [ "Disable", "1 mbps", "2 mbps", "5.5 mbps", "12 mbps", "24 mbps" ],
                    "default" : "Disable"
                },
                "clientFingerprintingEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether client fingerprinting is enabled or disabled",
                    "type" : "boolean"
                },
                "clientIdleTimeoutSec" : {
                    "default" : 120,
                    "description" : "Client idle timeout in seconds",
                    "maximum" : 1000,
                    "minimum" : 60,
                    "type" : "integer"
                },
                "clientIsolationEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether wireless client isolation is enabled or disabled",
                    "type" : "boolean"
                },
                "clientIsolationUnicastEnabled" : {
                    "description" : "Indicates whether isolate unicast of wireless client isolation is enabled or disabled",
                    "type" : "boolean",
                    "default" : true
                },
                "clientIsolationMulticastEnabled" : {
                    "description" : "Indicates whether isolate multicast of wireless client isolation is enabled or disabled",
                    "type" : "boolean"
                },
                "clientIsolationAutoVrrpEnabled" : {
                    "description" : "Indicates whether Automatic support for VRRP of wireless client isolation is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "clientIsolationWhitelist" : {
                    "description" : "Indicates wireless client isolation whitelist",
                    "type" : [ "object", "null" ],
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string"
                        }
                    }
                },
                "clientLoadBalancingEnabled" : {
                    "description" : "Indicates whether Client Load Balancing is enabled or disabled",
                    "type" : "boolean",
                    "default" : true
                },
                "dgafEnabled" : {
                    "description" : "Indicates whether dgaf is enabled or disabled",
                    "type" : "boolean"
                },
                "dhcp82Format" : {
                    "description" : "DHCP Option 82 format. This variable no longer supports from v8_1 and only kept for backward compatibility.",
                    "type" : "string",
                    "enum" : [ "RUCKUS_DEFAULT", "SOFTGRE_CUSTOMIZED" ]
                },
                "dhcpOption82Enabled" : {
                    "default" : false,
                    "description" : "Indicates whether DCHP Option 82 is enabled or disabled. This variable no longer supports from v8_1 and only kept for backward compatibility.",
                    "type" : "boolean"
                },
                "dhcp82SubOpt1Format" : {
                    "description" : "Subopt-1 format",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT1_AP_INFO_LOCATION", "SUBOPT1_AP_INFO", "SUBOPT1_AP_MAC_ESSID_PRIVACYTYPE", "SUBOPT1_AP_MAC_hex", "SUBOPT1_AP_MAC_hex_ESSID", "SUBOPT1_ESSID" ]
                },
                "dhcp82SubOpt2Format" : {
                    "description" : "Subopt-2 format",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT2_CLIENT_MAC", "SUBOPT2_CLIENT_MAC_hex", "SUBOPT2_CLIENT_MAC_hex_ESSID", "SUBOPT2_AP_MAC", "SUBOPT2_AP_MAC_hex", "SUBOPT2_AP_MAC_hex_ESSID" ]
                },
                "dhcp82SubOpt150Format" : {
                    "description" : "Subopt-150 with VLAN-Id",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT150_VLAN_ID" ]
                },
                "dhcp82SubOpt151Format" : {
                    "description" : "Subopt-151 format",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT151_AREA_NAME", "SUBOPT151_ESSID" ]
                },
                "dhcp82SubOpt151AreaName" : {
                    "description" : "Subopt-151 Area Name value",
                    "type" : "string"
                },
                "downlinkEnabled" : {
                    "default" : false,
                    "description" : "SSID Rate Limiting downlink enabled.",
                    "type" : "boolean"
                },
                "downlinkRate" : {
                    "description" : "SSID Rate Limiting downlink.",
                    "type" : "number",
                    "default" : 0.0
                },
                "antiSpoofingEnabled" : {
                    "description" : "Anti-Spoofing enabled",
                    "type" : "boolean",
                    "default" : false
                },
                "arpRequestRateLimit" : {
                    "description" : "ARP packets request rate limit, default value will be 15 if both rate limit not being set.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 100
                },
                "dhcpRequestRateLimit" : {
                    "description" : "DHCP packets request rate limit, default value will be 15 if both rate limit not being set.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 100
                },
                "forceClientDHCPTimeoutSec" : {
                    "default" : 0,
                    "description" : "Force DHCP disconnects the client if the client does not obtain a valid IP address within the timeout peroid. To disable force DHCP, set this value to zero (0).",
                    "type" : "integer",
                    "enum" : [ 0, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15 ]
                },
                "hideSsidEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether the SSID is hidden or broadcast",
                    "type" : "boolean"
                },
                "hs20Onboarding" : {
                    "description" : "Allow WISPr WLAN for Hotspot 2.0 Onboarding",
                    "type" : "boolean",
                    "default" : false
                },
                "maxClientsPerRadio" : {
                    "default" : 100,
                    "description" : "Maximum number of clients per radio",
                    "maximum" : 512,
                    "minimum" : 1,
                    "type" : "integer"
                },
                "mgmtTxRateMbps" : {
                    "description" : "Management TX rate (mbps)",
                    "type" : "string",
                    "enum" : [ "1 mbps", "2 mbps", "5.5 mbps", "6 mbps", "9 mbps", "11 mbps", "12 mbps", "18 mbps", "24 mbps", "36 mbps", "48 mbps", "54 mbps" ],
                    "default" : "2 mbps"
                },
                "ofdmOnlyEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether OFDM only is enabled or disabled",
                    "type" : "boolean"
                },
                "okcEnabled" : {
                    "description" : "Indicator of whether OKC support is enabled or disabled. The default value is true when the WLAN is WPA+AES non open WLAN.",
                    "type" : "boolean"
                },
                "pmkCachingEnabled" : {
                    "description" : "Indicator of whether PKM caching support is enabled or disabled. The default value is true when the WLAN is WPA+AES non open WLAN.",
                    "type" : "boolean"
                },
                "priority" : {
                    "default" : "High",
                    "description" : "Priority of the WLAN",
                    "type" : "string",
                    "enum" : [ "High", "Low" ]
                },
                "proxyARPEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether proxy ARP is enabled or disabled",
                    "type" : "boolean"
                },
                "ndProxyEnabled" : {
                    "description" : "Indicates whether ND Proxy is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "suppressNsEnabled" : {
                    "description" : "Indicates whether supperssNS is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "raProxyEnabled" : {
                    "description" : "Indicates whether RA proxy is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "rsraGuardEnabled" : {
                    "description" : "Indicates whether RS/RA Guard is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "raThrottlingEnabled" : {
                    "description" : "Indicates whether RA Throttling is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "maxAllowedRA" : {
                    "description" : "Max Allowed RAs",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 1440,
                    "default" : 10
                },
                "raInterval" : {
                    "description" : "A timer that RA proxy runs and once receives unsolicited RA checks against the configured time and allow/drop RA based on next timeout",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 256,
                    "default" : 10
                },
                "support80211dEnabled" : {
                    "default" : true,
                    "description" : "Indicates whether support for 802.11d is enabled or disabled",
                    "type" : "boolean"
                },
                "support80211kEnabled" : {
                    "default" : true,
                    "description" : "Indicates whether support for 802.11k is enabled or disabled",
                    "type" : "boolean"
                },
                "unauthClientStatsEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether to send statistics of unauthorized clients or not",
                    "type" : "boolean"
                },
                "uplinkEnabled" : {
                    "default" : false,
                    "description" : "SSID Rate Limiting uplink enabled.",
                    "type" : "boolean"
                },
                "uplinkRate" : {
                    "description" : "SSID Rate Limiting uplink.",
                    "type" : "number",
                    "default" : 0.0
                },
                "ratePerSTAUplink" : {
                    "description" : "UE Rate Limiting uplink.",
                    "type" : "string"
                },
                "ratePerSTADownlink" : {
                    "description" : "UE Rate Limiting downlink.",
                    "type" : "string"
                },
                "dtimInterval" : {
                    "description" : "DTIM Interval",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 255,
                    "default" : 1
                },
                "directedThreshold" : {
                    "description" : "Directed Threshold Setting, Defines the client count at which an AP will stop converting group addressed data traffic to unicast.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 128,
                    "default" : 5
                },
                "flowLogEnabled" : {
                    "description" : "Flow log enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "hdOverheadOptimizeEnable" : {
                    "description" : "Airtime Decongestion enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "probeRssiThr" : {
                    "description" : "Join RSSI threshold.",
                    "type" : "integer",
                    "minimum" : -90,
                    "maximum" : -60,
                    "default" : -85
                },
                "transientClientMgmtEnable" : {
                    "description" : "Transient Client Management enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "joinIgnoreTimeout" : {
                    "description" : "Join wait time.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 60,
                    "default" : 30
                },
                "joinAcceptTimeout" : {
                    "description" : "Join expire time.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 300,
                    "default" : 300
                },
                "joinIgnoreThr" : {
                    "description" : "Join wait threshold.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 50,
                    "default" : 10
                },
                "dropRandomProbesEnabled" : {
                    "description" : "Drop Random Probes enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "authRssiThr" : {
                    "description" : "Auth RSSI threshold.",
                    "type" : "integer",
                    "minimum" : -90,
                    "maximum" : -60
                },
                "assocRssiThr" : {
                    "description" : "Assoc RSSI threshold.",
                    "type" : "integer",
                    "minimum" : -90,
                    "maximum" : -60
                },
                "oceEnabled" : {
                    "description" : "Optimized Connectivity Experience(OCE) enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "oceBroadcastProbeResponseDelay" : {
                    "description" : "Broadcast probe response delay.",
                    "type" : "integer",
                    "minimum" : 8,
                    "maximum" : 120,
                    "default" : 15
                },
                "oceRssiBasedAssociationRejectionThreshold" : {
                    "description" : "RSSI-based association rejection threshold.",
                    "type" : "integer",
                    "minimum" : -90,
                    "maximum" : -60,
                    "default" : -75
                }
            },
            "type" : "object"
        },
        "authServiceOrProfile" : {
            "description" : "Authentication of the WLAN",
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "description" : "Identifier of the authentication service or profile. At least one ID or name or authenticationOption is required in the request.",
                    "type" : "string"
                },
                "locationDeliveryEnabled" : {
                    "description" : "RFC5580 location delivery support",
                    "type" : "boolean"
                },
                "realmBasedAuth" : {
                    "type" : "boolean"
                },
                "name" : {
                    "description" : "Name of the authentication service or profile. At least one ID or name or authenticationOption is required in the request. Or could input the 'Always Accept' or 'Local DB'.",
                    "type" : "string"
                },
                "authenticationOption" : {
                    "description" : "Option of the authentication service or profile, At least one ID or name or authenticationOption is required in the request. This only applies to hotspot and guest WLANs.",
                    "type" : "string",
                    "enum" : [ "Local DB", "Guest", "Always Accept", null ]
                },
                "throughController" : {
                    "description" : "Indicates whether authentication messages were sent through the controller or not",
                    "type" : "boolean"
                },
                "backupAuthenticationId" : {
                    "description" : "Identifier of the backup authentication service or profile. At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service.",
                    "type" : "string"
                },
                "backupAuthenticationName" : {
                    "description" : "Name of the backup authentication service or profile. At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service. Or could input the 'Always Accept'.",
                    "type" : "string"
                },
                "backupAuthenticationOption" : {
                    "description" : "Option of the backup authentication service or profile, At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service. This only applies to hotspot WLANs.",
                    "type" : "string",
                    "enum" : [ "Always Accept", null ]
                }
            },
            "type" : "object"
        },
        "coreTunnelProfile" : {
            "description" : "Core tunnel of the WLAN. This only applies when the access tunnel type is set to RuckusGRE.",
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "description" : "Identifier of the forwarding profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the forwarding profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "type" : {
                    "description" : "Tunnel type",
                    "type" : "string",
                    "enum" : [ "Bridge" ]
                }
            },
            "required" : [ "type" ],
            "type" : "object"
        },
        "defaultUserTrafficProfile" : {
            "description" : "User traffic profile of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "precedenceProfileId" : {
            "type" : "string"
        },
        "flexiVpnProfile" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "zoneAffinityId" : {
                    "type" : "string",
                    "description" : "Zone Affinity ID"
                }
            },
            "required" : [ "zoneAffinityId" ]
        },
        "description" : {
            "description" : "Description of the WLAN",
            "type" : [ "string", "null" ],
            "maxLength" : 64
        },
        "devicePolicy" : {
            "description" : "Device policy of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "diffServProfile" : {
            "description" : "DiffServ profile of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "dnsServerProfile" : {
            "description" : "DNS server profile of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "dpsk" : {
            "description" : "DPSK Setting",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "dpskEnabled" : {
                    "description" : "DPSK enabled",
                    "type" : "boolean",
                    "default" : false
                },
                "length" : {
                    "description" : "Length of DPSK key",
                    "type" : "integer",
                    "default" : 62
                },
                "dpskType" : {
                    "description" : "Type of DPSK key",
                    "type" : "string",
                    "enum" : [ "Secure", "KeyboardFriendly", "NumbersOnly" ],
                    "default" : "Secure"
                },
                "expiration" : {
                    "description" : "Expiration of DPSK key",
                    "type" : "string",
                    "enum" : [ "Unlimited", "OneDay", "TwoDays", "OneWeek", "TwoWeeks", "OneMonth", "SixMonths", "OneYear", "TwoYears" ],
                    "default" : "Unlimited"
                },
                "dpskFromType" : {
                    "description" : "Type of expiration start from",
                    "type" : "string",
                    "enum" : [ "CreateTime", "FirstUse" ],
                    "default" : "CreateTime"
                }
            }
        },
        "externalDpsk" : {
            "description" : "External DPSK Enabled",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "enabled" : {
                    "description" : "Enable External DPSK",
                    "type" : "boolean",
                    "default" : false
                },
                "encryption" : {
                    "description" : "Encryption of the WLAN relate to external DPSK",
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "method" : {
                            "description" : "Encryption method",
                            "type" : "string",
                            "enum" : [ "WPA2", "WPA_Mixed", "None" ]
                        },
                        "algorithm" : {
                            "description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
                            "type" : "string",
                            "enum" : [ "AES", "TKIP_AES" ]
                        }
                    }
                },
                "authService" : {
                    "description" : "Autentication of the WLAN relate to external DPSK",
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "description" : "Identifier of the authentication service. At least one ID or name is required in the request.",
                            "type" : "string"
                        },
                        "name" : {
                            "description" : "Name of the authentication service. At least one ID or name is required in the request.",
                            "type" : "string"
                        }
                    }
                }
            },
            "required" : [ "enabled" ]
        },
        "encryption" : {
            "description" : "Encryption of the WLAN",
            "additionalProperties" : false,
            "properties" : {
                "algorithm" : {
                    "description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
                    "type" : "string",
                    "enum" : [ "AES", "TKIP_AES" ]
                },
                "keyInHex" : {
                    "description" : "Key in hex format. This only applies to WEP64 and WEP128.",
                    "type" : "string"
                },
                "keyIndex" : {
                    "description" : "Key index. This only applies to WEP64 and WEP128.",
                    "type" : "integer"
                },
                "method" : {
                    "description" : "Encryption method",
                    "type" : "string",
                    "enum" : [ "WPA2", "WPA_Mixed", "WEP_64", "WEP_128", "None" ],
                    "default" : "None"
                },
                "mfp" : {
                    "description" : "Management frame protection. This only applies to WPA2 + AES",
                    "type" : "string",
                    "enum" : [ "disabled", "capable", "required" ]
                },
                "mobilityDomainId" : {
                    "description" : "mobility Domain Id.",
                    "maximum" : 65535,
                    "minimum" : 1,
                    "type" : "integer"
                },
                "passphrase" : {
                    "description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
                    "type" : "string"
                },
                "support80211rEnabled" : {
                    "description" : "Enable 802.11r Fast BSS Transition, fast Romaing.",
                    "type" : "boolean"
                }
            },
            "required" : [ "method" ],
            "type" : "object"
        },
        "hessid" : {
            "description" : "HESSID of the WLAN",
            "pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$",
            "type" : "string"
        },
        "hotspot20Profile" : {
            "description" : "Hotspot 2.0 operator profile of the WLAN. id or name of the hotspot 2.0 operator profiles within the zone is required.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "l2ACL" : {
            "description" : "Layer 2 ACL of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "macAuth" : {
            "description" : "MAC address authentication settings of the WLAN. This only applies to standard MAC and Hotspot MAC bypass WLAN.",
            "additionalProperties" : false,
            "properties" : {
                "customizedPassword" : {
                    "description" : "User defined password. When this field is set to an empty string, the MAC address is used as password.",
                    "maxLength" : 64,
                    "pattern" : "^([!-;=?-~]([ -;=?-~]){0,62}[!-;=?-~]|[!-;=?-~]{1,1}|\s{0,0})$",
                    "type" : "string"
                },
                "macAuthMacFormat" : {
                    "description" : "MAC address format. The default format is 0010a42319c0 and the 802.1X format is 00-10-A4-23-19-C0.",
                    "type" : "string",
                    "enum" : [ "Default", "802.1X", "UpperColon", "Upper", "LowerDash", "LowerColon" ]
                }
            },
            "type" : "object"
        },
        "name" : {
            "description" : "Name of the WLAN",
            "type" : "string",
            "minLength" : 1,
            "maxLength" : 32
        },
        "operatorRealm" : {
            "description" : "Operator realm, operatorRealm only supports coreTunnelProfile type is PMIP or authServiceOrProfile.locationDeliveryEnabled is true",
            "type" : "string",
            "maxLength" : 255,
            "pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
        },
        "portalServiceProfile" : {
            "description" : "Portal service of the WLAN. This only applies to hotspot, hotspot MAC bypass, guest and web auth WLANs.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "qosMaps" : {
            "description" : "Qos map set of the WLAN.",
            "items" : {
                "additionalProperties" : false,
                "properties" : {
                    "enable" : {
                        "description" : "Enabled or disabled",
                        "type" : "boolean"
                    },
                    "excepts" : {
                        "items" : {
                            "maximum" : 63,
                            "minimum" : 0,
                            "type" : "integer"
                        },
                        "type" : [ "array", "null" ]
                    },
                    "high" : {
                        "description" : "DSCP range - high",
                        "maximum" : 255,
                        "minimum" : 0,
                        "type" : [ "integer", "null" ]
                    },
                    "low" : {
                        "description" : "DSCP range - low",
                        "maximum" : 255,
                        "minimum" : 0,
                        "type" : [ "integer", "null" ]
                    },
                    "priority" : {
                        "description" : "Priority",
                        "type" : "integer"
                    }
                },
                "required" : [ "enable", "priority" ],
                "type" : "object"
            },
            "type" : "array"
        },
        "radiusOptions" : {
            "description" : "RADIUS options of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "calledStaIdType" : {
                    "default" : "WLAN_BSSID",
                    "description" : "Called station ID type",
                    "type" : "string",
                    "enum" : [ "AP_MAC", "NONE", "WLAN_BSSID" ]
                },
                "customizedNasId" : {
                    "description" : "User defined NAS ID",
                    "maxLength" : 64,
                    "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                    "type" : "string"
                },
                "nasIdType" : {
                    "default" : "WLAN_BSSID",
                    "description" : "NAS ID type",
                    "type" : "string",
                    "enum" : [ "AP_MAC", "Customized", "WLAN_BSSID" ]
                },
                "nasMaxRetry" : {
                    "default" : 2,
                    "description" : "NAS request maximum retry",
                    "maximum" : 10,
                    "minimum" : 2,
                    "type" : "integer"
                },
                "nasReconnectPrimaryMin" : {
                    "default" : 5,
                    "description" : "NAS reconnect primary time in minutes",
                    "maximum" : 60,
                    "minimum" : 1,
                    "type" : "integer"
                },
                "nasRequestTimeoutSec" : {
                    "default" : 3,
                    "description" : "NAS request timeout in seconds",
                    "maximum" : 20,
                    "minimum" : 2,
                    "type" : "integer"
                },
                "nasIpType" : {
                    "description" : "NAS IP type",
                    "type" : "string",
                    "enum" : [ "disabled", "control", "management", "userDefined" ],
                    "default" : "disabled"
                },
                "nasIpUserDefined" : {
                    "description" : "User-defined NAS IP",
                    "type" : "string",
                    "maxLength" : 45
                },
                "singleSessionIdAcctEnabled" : {
                    "description" : "When Single Accounting Session ID is enabled, APs will maintain one accounting session for client roaming",
                    "type" : "boolean",
                    "default" : false
                },
                "vendorSpecificAttributeProfileId" : {
                    "description" : "Vendor Specific Attribute Profile ID",
                    "type" : "string"
                }
            }
        },
        "schedule" : {
            "description" : "Schedule of the WLAN",
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "description" : "Identifier of the schedule profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the schedule profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "type" : {
                    "description" : "Type of WLAN schedule",
                    "type" : "string",
                    "enum" : [ "AlwaysOn", "AlwaysOff", "Customized" ],
                    "default" : "AlwaysOn"
                }
            },
            "required" : [ "type" ],
            "type" : "object"
        },
        "ssid" : {
            "description" : "SSID of the WLAN",
            "type" : "string",
            "minLength" : 1,
            "maxLength" : 32
        },
        "timeboundWhitelist" : {
            "description" : "Hotspot timeboundWhitelist. The ID of the OAuth Authentication service is required.",
            "additionalProperties" : false,
            "properties" : {
                "firstIndex" : {
                    "type" : "integer"
                },
                "hasMore" : {
                    "type" : "boolean"
                },
                "list" : {
                    "items" : {
                        "type" : [ "object", "null" ],
                        "additionalProperties" : false,
                        "properties" : {
                            "id" : {
                                "type" : "string"
                            },
                            "name" : {
                                "type" : "string"
                            }
                        }
                    },
                    "type" : "array"
                },
                "totalCount" : {
                    "type" : "integer"
                }
            },
            "type" : "object"
        },
        "vlan" : {
            "description" : "VLAN (access and/or core) of the WLAN.",
            "additionalProperties" : false,
            "properties" : {
                "aaaVlanOverride" : {
                    "description" : "Indicates whether the AAA VLAN settings can be overriden or not",
                    "type" : "boolean"
                },
                "accessVlan" : {
                    "description" : "Access VLAN ID",
                    "maximum" : 4094,
                    "minimum" : 1,
                    "type" : "integer",
                    "default" : 1
                },
                "vlanPooling" : {
                    "description" : "Vlan pooling",
                    "type" : [ "object", "null" ],
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string"
                        }
                    }
                }
            },
            "type" : "object"
        },
        "accessTunnelProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "accessIpsecProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "splitTunnelProfileId" : {
            "type" : "string"
        }
    },
    "required" : [ "name", "ssid" ]
}
Response  201
HideShow
Body
{
  "id": "wlanID"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Create - Hotspot 2.0 OSEN

POST/v8_1/rkszones/{zoneId}/wlans/hotspot20osen

Use this API command to create a new Hotspot 2.0 Onboarding WLAN with Authentication Method as ‘802.1X’.

Request
HideShow
Body
{
  "name": "api-test-wlanhs20open",
  "ssid": "api-test-wlanhs20open",
  "description": "wlanDescription"
}
Schema
{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "accessTunnelType" : {
            "description" : "Access tunnel type of the WLAN. APLBO means AP local breakout, and SoftGRE means AP direct SoftGRE tunnel",
            "type" : "string",
            "enum" : [ "APLBO", "RuckusGRE", "SoftGRE" ]
        },
        "accountingServiceOrProfile" : {
            "description" : "Accounting of the WLAN",
            "additionalProperties" : false,
            "properties" : {
                "accountingDelayEnabled" : {
                    "description" : "Indicates whether accounting delay time is enabled",
                    "type" : "boolean"
                },
                "id" : {
                    "description" : "Accounting service or profile ID. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "interimUpdateMin" : {
                    "description" : "Interval (in minutes) for sending interim updates",
                    "maximum" : 1440,
                    "minimum" : 0,
                    "type" : "integer"
                },
                "name" : {
                    "description" : "Accounting service or profile name. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "throughController" : {
                    "description" : "Indicates whether accounting messages were sent through the controller",
                    "type" : "boolean"
                },
                "realmBasedAcct" : {
                    "type" : "boolean"
                },
                "backupAccountingId" : {
                    "description" : "Backup accounting service or profile ID. At least one backupAccountingId or backupAccountingName is required in the request when setting backup accounting service.",
                    "type" : "string"
                },
                "backupAccountingName" : {
                    "description" : "Backup accounting service or profile name. At least one backupAccountingId or backupAccountingName is required in the request when setting backup accounting service.",
                    "type" : "string"
                }
            },
            "type" : "object"
        },
        "advancedOptions" : {
            "description" : "Advanced settings for the WLAN.",
            "additionalProperties" : false,
            "properties" : {
                "avcEnabled" : {
                    "default" : false,
                    "description" : "Indicator of whether AVC support is enabled or disabled",
                    "type" : "boolean"
                },
                "bandBalancing" : {
                    "default" : "UseZoneSetting",
                    "description" : "Indicates whether band balancing is enabled or disabled",
                    "type" : "string",
                    "enum" : [ "Disabled", "UseZoneSetting" ]
                },
                "bssMinRateMbps" : {
                    "description" : "BSS minimum rate (mbps)",
                    "type" : "string",
                    "enum" : [ "Disable", "1 mbps", "2 mbps", "5.5 mbps", "12 mbps", "24 mbps" ],
                    "default" : "Disable"
                },
                "clientFingerprintingEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether client fingerprinting is enabled or disabled",
                    "type" : "boolean"
                },
                "clientIdleTimeoutSec" : {
                    "default" : 120,
                    "description" : "Client idle timeout in seconds",
                    "maximum" : 1000,
                    "minimum" : 60,
                    "type" : "integer"
                },
                "clientIsolationEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether wireless client isolation is enabled or disabled",
                    "type" : "boolean"
                },
                "clientIsolationUnicastEnabled" : {
                    "description" : "Indicates whether isolate unicast of wireless client isolation is enabled or disabled",
                    "type" : "boolean",
                    "default" : true
                },
                "clientIsolationMulticastEnabled" : {
                    "description" : "Indicates whether isolate multicast of wireless client isolation is enabled or disabled",
                    "type" : "boolean"
                },
                "clientIsolationAutoVrrpEnabled" : {
                    "description" : "Indicates whether Automatic support for VRRP of wireless client isolation is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "clientIsolationWhitelist" : {
                    "description" : "Indicates wireless client isolation whitelist",
                    "type" : [ "object", "null" ],
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string"
                        }
                    }
                },
                "clientLoadBalancingEnabled" : {
                    "description" : "Indicates whether Client Load Balancing is enabled or disabled",
                    "type" : "boolean",
                    "default" : true
                },
                "dgafEnabled" : {
                    "description" : "Indicates whether dgaf is enabled or disabled",
                    "type" : "boolean"
                },
                "dhcp82Format" : {
                    "description" : "DHCP Option 82 format. This variable no longer supports from v8_1 and only kept for backward compatibility.",
                    "type" : "string",
                    "enum" : [ "RUCKUS_DEFAULT", "SOFTGRE_CUSTOMIZED" ]
                },
                "dhcpOption82Enabled" : {
                    "default" : false,
                    "description" : "Indicates whether DCHP Option 82 is enabled or disabled. This variable no longer supports from v8_1 and only kept for backward compatibility.",
                    "type" : "boolean"
                },
                "dhcp82SubOpt1Format" : {
                    "description" : "Subopt-1 format",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT1_AP_INFO_LOCATION", "SUBOPT1_AP_INFO", "SUBOPT1_AP_MAC_ESSID_PRIVACYTYPE", "SUBOPT1_AP_MAC_hex", "SUBOPT1_AP_MAC_hex_ESSID", "SUBOPT1_ESSID" ]
                },
                "dhcp82SubOpt2Format" : {
                    "description" : "Subopt-2 format",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT2_CLIENT_MAC", "SUBOPT2_CLIENT_MAC_hex", "SUBOPT2_CLIENT_MAC_hex_ESSID", "SUBOPT2_AP_MAC", "SUBOPT2_AP_MAC_hex", "SUBOPT2_AP_MAC_hex_ESSID" ]
                },
                "dhcp82SubOpt150Format" : {
                    "description" : "Subopt-150 with VLAN-Id",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT150_VLAN_ID" ]
                },
                "dhcp82SubOpt151Format" : {
                    "description" : "Subopt-151 format",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT151_AREA_NAME", "SUBOPT151_ESSID" ]
                },
                "dhcp82SubOpt151AreaName" : {
                    "description" : "Subopt-151 Area Name value",
                    "type" : "string"
                },
                "downlinkEnabled" : {
                    "default" : false,
                    "description" : "SSID Rate Limiting downlink enabled.",
                    "type" : "boolean"
                },
                "downlinkRate" : {
                    "description" : "SSID Rate Limiting downlink.",
                    "type" : "number",
                    "default" : 0.0
                },
                "antiSpoofingEnabled" : {
                    "description" : "Anti-Spoofing enabled",
                    "type" : "boolean",
                    "default" : false
                },
                "arpRequestRateLimit" : {
                    "description" : "ARP packets request rate limit, default value will be 15 if both rate limit not being set.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 100
                },
                "dhcpRequestRateLimit" : {
                    "description" : "DHCP packets request rate limit, default value will be 15 if both rate limit not being set.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 100
                },
                "forceClientDHCPTimeoutSec" : {
                    "default" : 0,
                    "description" : "Force DHCP disconnects the client if the client does not obtain a valid IP address within the timeout peroid. To disable force DHCP, set this value to zero (0).",
                    "type" : "integer",
                    "enum" : [ 0, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15 ]
                },
                "hideSsidEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether the SSID is hidden or broadcast",
                    "type" : "boolean"
                },
                "hs20Onboarding" : {
                    "description" : "Allow WISPr WLAN for Hotspot 2.0 Onboarding",
                    "type" : "boolean",
                    "default" : false
                },
                "maxClientsPerRadio" : {
                    "default" : 100,
                    "description" : "Maximum number of clients per radio",
                    "maximum" : 512,
                    "minimum" : 1,
                    "type" : "integer"
                },
                "mgmtTxRateMbps" : {
                    "description" : "Management TX rate (mbps)",
                    "type" : "string",
                    "enum" : [ "1 mbps", "2 mbps", "5.5 mbps", "6 mbps", "9 mbps", "11 mbps", "12 mbps", "18 mbps", "24 mbps", "36 mbps", "48 mbps", "54 mbps" ],
                    "default" : "2 mbps"
                },
                "ofdmOnlyEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether OFDM only is enabled or disabled",
                    "type" : "boolean"
                },
                "okcEnabled" : {
                    "description" : "Indicator of whether OKC support is enabled or disabled. The default value is true when the WLAN is WPA+AES non open WLAN.",
                    "type" : "boolean"
                },
                "pmkCachingEnabled" : {
                    "description" : "Indicator of whether PKM caching support is enabled or disabled. The default value is true when the WLAN is WPA+AES non open WLAN.",
                    "type" : "boolean"
                },
                "priority" : {
                    "default" : "High",
                    "description" : "Priority of the WLAN",
                    "type" : "string",
                    "enum" : [ "High", "Low" ]
                },
                "proxyARPEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether proxy ARP is enabled or disabled",
                    "type" : "boolean"
                },
                "ndProxyEnabled" : {
                    "description" : "Indicates whether ND Proxy is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "suppressNsEnabled" : {
                    "description" : "Indicates whether supperssNS is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "raProxyEnabled" : {
                    "description" : "Indicates whether RA proxy is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "rsraGuardEnabled" : {
                    "description" : "Indicates whether RS/RA Guard is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "raThrottlingEnabled" : {
                    "description" : "Indicates whether RA Throttling is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "maxAllowedRA" : {
                    "description" : "Max Allowed RAs",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 1440,
                    "default" : 10
                },
                "raInterval" : {
                    "description" : "A timer that RA proxy runs and once receives unsolicited RA checks against the configured time and allow/drop RA based on next timeout",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 256,
                    "default" : 10
                },
                "support80211dEnabled" : {
                    "default" : true,
                    "description" : "Indicates whether support for 802.11d is enabled or disabled",
                    "type" : "boolean"
                },
                "support80211kEnabled" : {
                    "default" : true,
                    "description" : "Indicates whether support for 802.11k is enabled or disabled",
                    "type" : "boolean"
                },
                "unauthClientStatsEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether to send statistics of unauthorized clients or not",
                    "type" : "boolean"
                },
                "uplinkEnabled" : {
                    "default" : false,
                    "description" : "SSID Rate Limiting uplink enabled.",
                    "type" : "boolean"
                },
                "uplinkRate" : {
                    "description" : "SSID Rate Limiting uplink.",
                    "type" : "number",
                    "default" : 0.0
                },
                "ratePerSTAUplink" : {
                    "description" : "UE Rate Limiting uplink.",
                    "type" : "string"
                },
                "ratePerSTADownlink" : {
                    "description" : "UE Rate Limiting downlink.",
                    "type" : "string"
                },
                "dtimInterval" : {
                    "description" : "DTIM Interval",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 255,
                    "default" : 1
                },
                "directedThreshold" : {
                    "description" : "Directed Threshold Setting, Defines the client count at which an AP will stop converting group addressed data traffic to unicast.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 128,
                    "default" : 5
                },
                "flowLogEnabled" : {
                    "description" : "Flow log enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "hdOverheadOptimizeEnable" : {
                    "description" : "Airtime Decongestion enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "probeRssiThr" : {
                    "description" : "Join RSSI threshold.",
                    "type" : "integer",
                    "minimum" : -90,
                    "maximum" : -60,
                    "default" : -85
                },
                "transientClientMgmtEnable" : {
                    "description" : "Transient Client Management enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "joinIgnoreTimeout" : {
                    "description" : "Join wait time.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 60,
                    "default" : 30
                },
                "joinAcceptTimeout" : {
                    "description" : "Join expire time.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 300,
                    "default" : 300
                },
                "joinIgnoreThr" : {
                    "description" : "Join wait threshold.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 50,
                    "default" : 10
                },
                "dropRandomProbesEnabled" : {
                    "description" : "Drop Random Probes enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "authRssiThr" : {
                    "description" : "Auth RSSI threshold.",
                    "type" : "integer",
                    "minimum" : -90,
                    "maximum" : -60
                },
                "assocRssiThr" : {
                    "description" : "Assoc RSSI threshold.",
                    "type" : "integer",
                    "minimum" : -90,
                    "maximum" : -60
                },
                "oceEnabled" : {
                    "description" : "Optimized Connectivity Experience(OCE) enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "oceBroadcastProbeResponseDelay" : {
                    "description" : "Broadcast probe response delay.",
                    "type" : "integer",
                    "minimum" : 8,
                    "maximum" : 120,
                    "default" : 15
                },
                "oceRssiBasedAssociationRejectionThreshold" : {
                    "description" : "RSSI-based association rejection threshold.",
                    "type" : "integer",
                    "minimum" : -90,
                    "maximum" : -60,
                    "default" : -75
                }
            },
            "type" : "object"
        },
        "authServiceOrProfile" : {
            "description" : "Authentication of the WLAN",
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "description" : "Identifier of the authentication service or profile. At least one ID or name or authenticationOption is required in the request.",
                    "type" : "string"
                },
                "locationDeliveryEnabled" : {
                    "description" : "RFC5580 location delivery support",
                    "type" : "boolean"
                },
                "realmBasedAuth" : {
                    "type" : "boolean"
                },
                "name" : {
                    "description" : "Name of the authentication service or profile. At least one ID or name or authenticationOption is required in the request. Or could input the 'Always Accept' or 'Local DB'.",
                    "type" : "string"
                },
                "authenticationOption" : {
                    "description" : "Option of the authentication service or profile, At least one ID or name or authenticationOption is required in the request. This only applies to hotspot and guest WLANs.",
                    "type" : "string",
                    "enum" : [ "Local DB", "Guest", "Always Accept", null ]
                },
                "throughController" : {
                    "description" : "Indicates whether authentication messages were sent through the controller or not",
                    "type" : "boolean"
                },
                "backupAuthenticationId" : {
                    "description" : "Identifier of the backup authentication service or profile. At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service.",
                    "type" : "string"
                },
                "backupAuthenticationName" : {
                    "description" : "Name of the backup authentication service or profile. At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service. Or could input the 'Always Accept'.",
                    "type" : "string"
                },
                "backupAuthenticationOption" : {
                    "description" : "Option of the backup authentication service or profile, At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service. This only applies to hotspot WLANs.",
                    "type" : "string",
                    "enum" : [ "Always Accept", null ]
                }
            },
            "type" : "object"
        },
        "coreTunnelProfile" : {
            "description" : "Core tunnel of the WLAN. This only applies when the access tunnel type is set to RuckusGRE.",
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "description" : "Identifier of the forwarding profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the forwarding profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "type" : {
                    "description" : "Tunnel type",
                    "type" : "string",
                    "enum" : [ "Bridge" ]
                }
            },
            "required" : [ "type" ],
            "type" : "object"
        },
        "defaultUserTrafficProfile" : {
            "description" : "User traffic profile of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "precedenceProfileId" : {
            "type" : "string"
        },
        "flexiVpnProfile" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "zoneAffinityId" : {
                    "type" : "string",
                    "description" : "Zone Affinity ID"
                }
            },
            "required" : [ "zoneAffinityId" ]
        },
        "description" : {
            "description" : "Description of the WLAN",
            "type" : [ "string", "null" ],
            "maxLength" : 64
        },
        "devicePolicy" : {
            "description" : "Device policy of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "diffServProfile" : {
            "description" : "DiffServ profile of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "dnsServerProfile" : {
            "description" : "DNS server profile of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "dpsk" : {
            "description" : "DPSK Setting",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "dpskEnabled" : {
                    "description" : "DPSK enabled",
                    "type" : "boolean",
                    "default" : false
                },
                "length" : {
                    "description" : "Length of DPSK key",
                    "type" : "integer",
                    "default" : 62
                },
                "dpskType" : {
                    "description" : "Type of DPSK key",
                    "type" : "string",
                    "enum" : [ "Secure", "KeyboardFriendly", "NumbersOnly" ],
                    "default" : "Secure"
                },
                "expiration" : {
                    "description" : "Expiration of DPSK key",
                    "type" : "string",
                    "enum" : [ "Unlimited", "OneDay", "TwoDays", "OneWeek", "TwoWeeks", "OneMonth", "SixMonths", "OneYear", "TwoYears" ],
                    "default" : "Unlimited"
                },
                "dpskFromType" : {
                    "description" : "Type of expiration start from",
                    "type" : "string",
                    "enum" : [ "CreateTime", "FirstUse" ],
                    "default" : "CreateTime"
                }
            }
        },
        "externalDpsk" : {
            "description" : "External DPSK Enabled",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "enabled" : {
                    "description" : "Enable External DPSK",
                    "type" : "boolean",
                    "default" : false
                },
                "encryption" : {
                    "description" : "Encryption of the WLAN relate to external DPSK",
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "method" : {
                            "description" : "Encryption method",
                            "type" : "string",
                            "enum" : [ "WPA2", "WPA_Mixed", "None" ]
                        },
                        "algorithm" : {
                            "description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
                            "type" : "string",
                            "enum" : [ "AES", "TKIP_AES" ]
                        }
                    }
                },
                "authService" : {
                    "description" : "Autentication of the WLAN relate to external DPSK",
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "description" : "Identifier of the authentication service. At least one ID or name is required in the request.",
                            "type" : "string"
                        },
                        "name" : {
                            "description" : "Name of the authentication service. At least one ID or name is required in the request.",
                            "type" : "string"
                        }
                    }
                }
            },
            "required" : [ "enabled" ]
        },
        "encryption" : {
            "description" : "Encryption of the WLAN",
            "additionalProperties" : false,
            "properties" : {
                "algorithm" : {
                    "description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
                    "type" : "string",
                    "enum" : [ "AES", "TKIP_AES" ]
                },
                "keyInHex" : {
                    "description" : "Key in hex format. This only applies to WEP64 and WEP128.",
                    "type" : "string"
                },
                "keyIndex" : {
                    "description" : "Key index. This only applies to WEP64 and WEP128.",
                    "type" : "integer"
                },
                "method" : {
                    "description" : "Encryption method",
                    "type" : "string",
                    "enum" : [ "WPA2", "WPA_Mixed", "WEP_64", "WEP_128", "None" ],
                    "default" : "None"
                },
                "mfp" : {
                    "description" : "Management frame protection. This only applies to WPA2 + AES",
                    "type" : "string",
                    "enum" : [ "disabled", "capable", "required" ]
                },
                "mobilityDomainId" : {
                    "description" : "mobility Domain Id.",
                    "maximum" : 65535,
                    "minimum" : 1,
                    "type" : "integer"
                },
                "passphrase" : {
                    "description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
                    "type" : "string"
                },
                "support80211rEnabled" : {
                    "description" : "Enable 802.11r Fast BSS Transition, fast Romaing.",
                    "type" : "boolean"
                }
            },
            "required" : [ "method" ],
            "type" : "object"
        },
        "hessid" : {
            "description" : "HESSID of the WLAN",
            "pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$",
            "type" : "string"
        },
        "hotspot20Profile" : {
            "description" : "Hotspot 2.0 operator profile of the WLAN. id or name of the hotspot 2.0 operator profiles within the zone is required.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "l2ACL" : {
            "description" : "Layer 2 ACL of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "macAuth" : {
            "description" : "MAC address authentication settings of the WLAN. This only applies to standard MAC and Hotspot MAC bypass WLAN.",
            "additionalProperties" : false,
            "properties" : {
                "customizedPassword" : {
                    "description" : "User defined password. When this field is set to an empty string, the MAC address is used as password.",
                    "maxLength" : 64,
                    "pattern" : "^([!-;=?-~]([ -;=?-~]){0,62}[!-;=?-~]|[!-;=?-~]{1,1}|\s{0,0})$",
                    "type" : "string"
                },
                "macAuthMacFormat" : {
                    "description" : "MAC address format. The default format is 0010a42319c0 and the 802.1X format is 00-10-A4-23-19-C0.",
                    "type" : "string",
                    "enum" : [ "Default", "802.1X", "UpperColon", "Upper", "LowerDash", "LowerColon" ]
                }
            },
            "type" : "object"
        },
        "name" : {
            "description" : "Name of the WLAN",
            "type" : "string",
            "minLength" : 1,
            "maxLength" : 32
        },
        "operatorRealm" : {
            "description" : "Operator realm, operatorRealm only supports coreTunnelProfile type is PMIP or authServiceOrProfile.locationDeliveryEnabled is true",
            "type" : "string",
            "maxLength" : 255,
            "pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
        },
        "portalServiceProfile" : {
            "description" : "Portal service of the WLAN. This only applies to hotspot, hotspot MAC bypass, guest and web auth WLANs.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "qosMaps" : {
            "description" : "Qos map set of the WLAN.",
            "items" : {
                "additionalProperties" : false,
                "properties" : {
                    "enable" : {
                        "description" : "Enabled or disabled",
                        "type" : "boolean"
                    },
                    "excepts" : {
                        "items" : {
                            "maximum" : 63,
                            "minimum" : 0,
                            "type" : "integer"
                        },
                        "type" : [ "array", "null" ]
                    },
                    "high" : {
                        "description" : "DSCP range - high",
                        "maximum" : 255,
                        "minimum" : 0,
                        "type" : [ "integer", "null" ]
                    },
                    "low" : {
                        "description" : "DSCP range - low",
                        "maximum" : 255,
                        "minimum" : 0,
                        "type" : [ "integer", "null" ]
                    },
                    "priority" : {
                        "description" : "Priority",
                        "type" : "integer"
                    }
                },
                "required" : [ "enable", "priority" ],
                "type" : "object"
            },
            "type" : "array"
        },
        "radiusOptions" : {
            "description" : "RADIUS options of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "calledStaIdType" : {
                    "default" : "WLAN_BSSID",
                    "description" : "Called station ID type",
                    "type" : "string",
                    "enum" : [ "AP_MAC", "NONE", "WLAN_BSSID" ]
                },
                "customizedNasId" : {
                    "description" : "User defined NAS ID",
                    "maxLength" : 64,
                    "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                    "type" : "string"
                },
                "nasIdType" : {
                    "default" : "WLAN_BSSID",
                    "description" : "NAS ID type",
                    "type" : "string",
                    "enum" : [ "AP_MAC", "Customized", "WLAN_BSSID" ]
                },
                "nasMaxRetry" : {
                    "default" : 2,
                    "description" : "NAS request maximum retry",
                    "maximum" : 10,
                    "minimum" : 2,
                    "type" : "integer"
                },
                "nasReconnectPrimaryMin" : {
                    "default" : 5,
                    "description" : "NAS reconnect primary time in minutes",
                    "maximum" : 60,
                    "minimum" : 1,
                    "type" : "integer"
                },
                "nasRequestTimeoutSec" : {
                    "default" : 3,
                    "description" : "NAS request timeout in seconds",
                    "maximum" : 20,
                    "minimum" : 2,
                    "type" : "integer"
                },
                "nasIpType" : {
                    "description" : "NAS IP type",
                    "type" : "string",
                    "enum" : [ "disabled", "control", "management", "userDefined" ],
                    "default" : "disabled"
                },
                "nasIpUserDefined" : {
                    "description" : "User-defined NAS IP",
                    "type" : "string",
                    "maxLength" : 45
                },
                "singleSessionIdAcctEnabled" : {
                    "description" : "When Single Accounting Session ID is enabled, APs will maintain one accounting session for client roaming",
                    "type" : "boolean",
                    "default" : false
                },
                "vendorSpecificAttributeProfileId" : {
                    "description" : "Vendor Specific Attribute Profile ID",
                    "type" : "string"
                }
            }
        },
        "schedule" : {
            "description" : "Schedule of the WLAN",
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "description" : "Identifier of the schedule profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the schedule profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "type" : {
                    "description" : "Type of WLAN schedule",
                    "type" : "string",
                    "enum" : [ "AlwaysOn", "AlwaysOff", "Customized" ],
                    "default" : "AlwaysOn"
                }
            },
            "required" : [ "type" ],
            "type" : "object"
        },
        "ssid" : {
            "description" : "SSID of the WLAN",
            "type" : "string",
            "minLength" : 1,
            "maxLength" : 32
        },
        "timeboundWhitelist" : {
            "description" : "Hotspot timeboundWhitelist. The ID of the OAuth Authentication service is required.",
            "additionalProperties" : false,
            "properties" : {
                "firstIndex" : {
                    "type" : "integer"
                },
                "hasMore" : {
                    "type" : "boolean"
                },
                "list" : {
                    "items" : {
                        "type" : [ "object", "null" ],
                        "additionalProperties" : false,
                        "properties" : {
                            "id" : {
                                "type" : "string"
                            },
                            "name" : {
                                "type" : "string"
                            }
                        }
                    },
                    "type" : "array"
                },
                "totalCount" : {
                    "type" : "integer"
                }
            },
            "type" : "object"
        },
        "vlan" : {
            "description" : "VLAN (access and/or core) of the WLAN.",
            "additionalProperties" : false,
            "properties" : {
                "aaaVlanOverride" : {
                    "description" : "Indicates whether the AAA VLAN settings can be overriden or not",
                    "type" : "boolean"
                },
                "accessVlan" : {
                    "description" : "Access VLAN ID",
                    "maximum" : 4094,
                    "minimum" : 1,
                    "type" : "integer",
                    "default" : 1
                },
                "vlanPooling" : {
                    "description" : "Vlan pooling",
                    "type" : [ "object", "null" ],
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string"
                        }
                    }
                }
            },
            "type" : "object"
        },
        "accessTunnelProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "accessIpsecProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "splitTunnelProfileId" : {
            "type" : "string"
        }
    },
    "required" : [ "name", "ssid" ]
}
Response  201
HideShow
Body
{
  "id": "wlanID"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Modify

PATCH/v8_1/rkszones/{zoneId}/wlans/{id}

Use this API command to modify the basic information of a WLAN.

Request
HideShow
Body
{
  "name": "wlanName",
  "ssid": "wlanSSID",
  "description": "wlanDescription",
  "accessTunnelType": "SoftGRE",
  "accessTunnelProfile": {
    "id": "1fee12a1-ef8e-11e7-8d6f-08002748d78e",
    "name": "softGre1"
  },
  "splitTunnelProfileId": "38119bac-49e1-4410-ab8e-1c1bc88dd770",
  "macAuth": {
    "macAuthMacFormat": "802.1X",
    "customizedPassword": "password"
  },
  "encryption": {
    "method": "WPA2",
    "algorithm": "AES",
    "passphrase": "password",
    "mfp": "disabled",
    "support80211rEnabled": true,
    "mobilityDomainId": 3
  },
  "authServiceOrProfile": {
    "throughController": true,
    "id": "authServiceUUID",
    "locationDeliveryEnabled": true,
    "authenticationOption": null
  },
  "operatorRealm": "operator realm",
  "accountingServiceOrProfile": {
    "throughController": false,
    "id": "accountingServiceUUID",
    "name": "accountingServiceName",
    "interimUpdateMin": 10,
    "accountingDelayEnabled": false,
    "backupAccountingId": "otherAccountingServiceUUID",
    "backupAccountingName": "otherAccountingServiceName"
  },
  "portalServiceProfile": {
    "id": "portalServiceUUID",
    "name": "portalServiceName"
  },
  "hotspot20Profile": {
    "id": "hotspot20ServiceUUID",
    "name": "hotspot20ServiceName"
  },
  "defaultUserTrafficProfile": {
    "id": "userTrafficUUID",
    "name": "userTrafficName"
  },
  "precedenceProfileId": "c514d450-c839-9527-afc9-525400d12345",
  "schedule": {
    "type": "Customized",
    "id": "ServiceUUID",
    "name": "ServiceName"
  },
  "vlan": {
    "accessVlan": 23,
    "aaaVlanOverride": true,
    "vlanpooling": null
  },
  "l2ACL": {
    "id": "l2ACLUUID",
    "name": "l2ACLName"
  },
  "devicePolicy": {
    "id": "devicePolicyUUID",
    "name": "devicePolicyName"
  },
  "radiusOptions": {
    "nasIdType": "Customized",
    "customizedNasId": "nasId",
    "nasRequestTimeoutSec": 12,
    "nasMaxRetry": 3,
    "nasReconnectPrimaryMin": 30,
    "calledStaIdType": "WLAN_BSSID",
    "nasIpType": "disabled",
    "nasIpUserDefined": "192.168.1.1",
    "singleSessionIdAcctEnabled": false,
    "vendorSpecificAttributeProfileId": "6d767421-d1b7-11e8-8ab9-ba2343155a93"
  },
  "advancedOptions": {
    "clientIsolationEnabled": true,
    "clientIsolationUnicastEnabled": true,
    "clientIsolationMulticastEnabled": false,
    "clientIsolationAutoVrrpEnabled": false,
    "clientIsolationWhitelist": {
      "id": "24f24c00-0b47-11e4-a9b5-000c29b1347d",
      "name": "myWhitelist"
    },
    "priority": "High",
    "hideSsidEnabled": true,
    "maxClientsPerRadio": 12,
    "clientIdleTimeoutSec": 12,
    "clientLoadBalancingEnabled": true,
    "proxyARPEnabled": true,
    "support80211dEnabled": false,
    "support80211kEnabled": true,
    "antiSpoofingEnabled": true,
    "arpRequestRateLimit": 15,
    "dhcpRequestRateLimit": 15,
    "forceClientDHCPTimeoutSec": 5,
    "dhcp82SubOpt1Format": "SUBOPT1_AP_INFO_LOCATION",
    "unauthClientStatsEnabled": false,
    "clientFingerprintingEnabled": true,
    "ofdmOnlyEnabled": false,
    "bandBalancing": "UseZoneSetting",
    "bssMinRateMbps": "Disable",
    "mgmtTxRateMbps": "2 mbps",
    "uplinkEnabled": false,
    "downlinkEnabled": false,
    "avcEnabled": true,
    "urlFilteringPolicyEnabled": false,
    "urlFilteringPolicyId": "",
    "wifiCallingPolicyEnabled": false,
    "wifiCallingPolicyIds": [],
    "hdOverheadOptimizeEnable": false,
    "probeRssiThr": -85,
    "transientClientMgmtEnable": true,
    "joinIgnoreTimeout": 30,
    "joinAcceptTimeout": 300,
    "joinIgnoreThr": 10,
    "authRssiThr": -85,
    "assocRssiThr": -85
  },
  "diffServProfile": {
    "id": "diffServId",
    "name": "diffServName"
  },
  "qosMaps": [
    {
      "enable": true,
      "priority": 0,
      "low": 0,
      "high": 7,
      "excepts": null
    },
    {
      "enable": true,
      "priority": 1,
      "low": 8,
      "high": 15,
      "excepts": null
    },
    {
      "enable": true,
      "priority": 2,
      "low": 16,
      "high": 23,
      "excepts": null
    },
    {
      "enable": true,
      "priority": 3,
      "low": 0,
      "high": 32,
      "excepts": [
        43,
        45,
        60
      ]
    },
    {
      "enable": true,
      "priority": 4,
      "low": 32,
      "high": 39,
      "excepts": null
    },
    {
      "enable": true,
      "priority": 5,
      "low": 40,
      "high": 47,
      "excepts": null
    },
    {
      "enable": true,
      "priority": 6,
      "low": 48,
      "high": 55,
      "excepts": [
        46
      ]
    },
    {
      "enable": true,
      "priority": 7,
      "low": 56,
      "high": 63,
      "excepts": null
    }
  ],
  "dpsk": {
    "dpskEnabled": true,
    "length": 8,
    "dpskType": "Secure",
    "expiration": "OneDay",
    "dpskFromType": "FirstUse"
  },
  "timeboundWhitelist": {
    "list": [
      {
        "id": "OAuth authServiceUUID",
        "name": "authServiceName"
      }
    ]
  },
  "externalDpsk": {
    "enabled": true,
    "encryption": {
      "method": "WPA2",
      "algorithm": "AES"
    },
    "authService": {
      "id": "authServiceUUID"
    }
  }
}
Schema
{
    "additionalProperties" : false,
    "properties" : {
        "accessTunnelType" : {
            "description" : "Access tunnel type of the WLAN. APLBO means AP local breakout, and SoftGRE means AP direct SoftGRE tunnel",
            "type" : "string",
            "enum" : [ "APLBO", "RuckusGRE", "SoftGRE" ]
        },
        "accountingServiceOrProfile" : {
            "description" : "Accounting of the WLAN",
            "additionalProperties" : false,
            "properties" : {
                "accountingDelayEnabled" : {
                    "description" : "Indicates whether accounting delay time is enabled",
                    "type" : "boolean"
                },
                "id" : {
                    "description" : "Accounting service or profile ID. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "interimUpdateMin" : {
                    "description" : "Interval (in minutes) for sending interim updates",
                    "maximum" : 1440,
                    "minimum" : 0,
                    "type" : "integer"
                },
                "name" : {
                    "description" : "Accounting service or profile name. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "throughController" : {
                    "description" : "Indicates whether accounting messages were sent through the controller",
                    "type" : "boolean"
                },
                "realmBasedAcct" : {
                    "type" : "boolean"
                },
                "backupAccountingId" : {
                    "description" : "Backup accounting service or profile ID. At least one backupAccountingId or backupAccountingName is required in the request when setting backup accounting service.",
                    "type" : "string"
                },
                "backupAccountingName" : {
                    "description" : "Backup accounting service or profile name. At least one backupAccountingId or backupAccountingName is required in the request when setting backup accounting service.",
                    "type" : "string"
                }
            },
            "type" : "object"
        },
        "advancedOptions" : {
            "description" : "Advanced settings for the WLAN.",
            "additionalProperties" : false,
            "properties" : {
                "avcEnabled" : {
                    "description" : "Indicator of whether AVC support is enabled or disabled",
                    "type" : "boolean"
                },
                "bandBalancing" : {
                    "description" : "Indicates whether band balancing is enabled or disabled",
                    "type" : "string",
                    "enum" : [ "Disabled", "UseZoneSetting" ]
                },
                "bssMinRateMbps" : {
                    "description" : "BSS minimum rate (mbps)",
                    "type" : "string",
                    "enum" : [ "Disable", "1 mbps", "2 mbps", "5.5 mbps", "12 mbps", "24 mbps" ]
                },
                "clientFingerprintingEnabled" : {
                    "description" : "Indicates whether client fingerprinting is enabled or disabled",
                    "type" : "boolean"
                },
                "clientIdleTimeoutSec" : {
                    "description" : "Client idle timeout in seconds",
                    "maximum" : 1000,
                    "minimum" : 60,
                    "type" : "integer"
                },
                "clientIsolationEnabled" : {
                    "description" : "Indicates whether wireless client isolation is enabled or disabled",
                    "type" : "boolean"
                },
                "clientIsolationUnicastEnabled" : {
                    "description" : "Indicates whether isolate unicast of wireless client isolation is enabled or disabled",
                    "type" : "boolean"
                },
                "clientIsolationMulticastEnabled" : {
                    "description" : "Indicates whether isolate multicast of wireless client isolation is enabled or disabled",
                    "type" : "boolean"
                },
                "clientIsolationAutoVrrpEnabled" : {
                    "description" : "Indicates whether Automatic support for VRRP of wireless client isolation is enabled or disabled",
                    "type" : "boolean"
                },
                "clientIsolationWhitelist" : {
                    "description" : "Indicates wireless client isolation whitelist",
                    "type" : [ "object", "null" ],
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string"
                        }
                    }
                },
                "clientLoadBalancingEnabled" : {
                    "description" : "Indicates whether Client Load Balancing is enabled or disabled",
                    "type" : "boolean"
                },
                "dgafEnabled" : {
                    "description" : "Indicates whether dgaf is enabled or disabled",
                    "type" : "boolean"
                },
                "dhcp82Format" : {
                    "description" : "DHCP Option 82 format. This variable no longer supports from v8_1 and only kept for backward compatibility.",
                    "type" : "string",
                    "enum" : [ "RUCKUS_DEFAULT", "SOFTGRE_CUSTOMIZED" ]
                },
                "dhcpOption82Enabled" : {
                    "description" : "Indicates whether DCHP Option 82 is enabled or disabled. This variable no longer supports from v8_1 and only kept for backward compatibility.",
                    "type" : "boolean"
                },
                "dhcp82SubOpt1Format" : {
                    "description" : "Subopt-1 format",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT1_AP_INFO_LOCATION", "SUBOPT1_AP_INFO", "SUBOPT1_AP_MAC_ESSID_PRIVACYTYPE", "SUBOPT1_AP_MAC_hex", "SUBOPT1_AP_MAC_hex_ESSID", "SUBOPT1_ESSID" ]
                },
                "dhcp82SubOpt2Format" : {
                    "description" : "Subopt-2 format",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT2_CLIENT_MAC", "SUBOPT2_CLIENT_MAC_hex", "SUBOPT2_CLIENT_MAC_hex_ESSID", "SUBOPT2_AP_MAC", "SUBOPT2_AP_MAC_hex", "SUBOPT2_AP_MAC_hex_ESSID" ]
                },
                "dhcp82SubOpt150Format" : {
                    "description" : "Subopt-150 with VLAN-Id",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT150_VLAN_ID" ]
                },
                "dhcp82SubOpt151Format" : {
                    "description" : "Subopt-151 format",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT151_AREA_NAME", "SUBOPT151_ESSID" ]
                },
                "dhcp82SubOpt151AreaName" : {
                    "description" : "Subopt-151 Area Name value",
                    "type" : "string"
                },
                "downlinkEnabled" : {
                    "description" : "SSID Rate Limiting downlink enabled.",
                    "type" : "boolean"
                },
                "downlinkRate" : {
                    "description" : "SSID Rate Limiting downlink.",
                    "type" : "number"
                },
                "antiSpoofingEnabled" : {
                    "description" : "Anti-Spoofing enabled",
                    "type" : "boolean"
                },
                "arpRequestRateLimit" : {
                    "description" : "ARP packets request rate limit, default value will be 15 if both rate limit not being set.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 100
                },
                "dhcpRequestRateLimit" : {
                    "description" : "DHCP packets request rate limit, default value will be 15 if both rate limit not being set.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 100
                },
                "forceClientDHCPTimeoutSec" : {
                    "description" : "Force DHCP disconnects the client if the client does not obtain a valid IP address within the timeout peroid. To disable force DHCP, set this value to zero (0).",
                    "type" : "integer",
                    "enum" : [ 0, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15 ]
                },
                "hideSsidEnabled" : {
                    "description" : "Indicates whether the SSID is hidden or broadcast",
                    "type" : "boolean"
                },
                "hs20Onboarding" : {
                    "description" : "Allow WISPr WLAN for Hotspot 2.0 Onboarding",
                    "type" : "boolean"
                },
                "maxClientsPerRadio" : {
                    "description" : "Maximum number of clients per radio",
                    "maximum" : 512,
                    "minimum" : 1,
                    "type" : "integer"
                },
                "mgmtTxRateMbps" : {
                    "description" : "Management TX rate (mbps)",
                    "type" : "string",
                    "enum" : [ "1 mbps", "2 mbps", "5.5 mbps", "6 mbps", "9 mbps", "11 mbps", "12 mbps", "18 mbps", "24 mbps", "36 mbps", "48 mbps", "54 mbps" ]
                },
                "ofdmOnlyEnabled" : {
                    "description" : "Indicates whether OFDM only is enabled or disabled",
                    "type" : "boolean"
                },
                "okcEnabled" : {
                    "description" : "Indicator of whether OKC support is enabled or disabled. The default value is true when the WLAN is WPA+AES non open WLAN.",
                    "type" : "boolean"
                },
                "pmkCachingEnabled" : {
                    "description" : "Indicator of whether PKM caching support is enabled or disabled. The default value is true when the WLAN is WPA+AES non open WLAN.",
                    "type" : "boolean"
                },
                "priority" : {
                    "description" : "Priority of the WLAN",
                    "type" : "string",
                    "enum" : [ "High", "Low" ]
                },
                "proxyARPEnabled" : {
                    "description" : "Indicates whether proxy ARP is enabled or disabled",
                    "type" : "boolean"
                },
                "ndProxyEnabled" : {
                    "description" : "Indicates whether ND Proxy is enabled or disabled",
                    "type" : "boolean"
                },
                "suppressNsEnabled" : {
                    "description" : "Indicates whether supperssNS is enabled or disabled",
                    "type" : "boolean"
                },
                "raProxyEnabled" : {
                    "description" : "Indicates whether RA proxy is enabled or disabled",
                    "type" : "boolean"
                },
                "rsraGuardEnabled" : {
                    "description" : "Indicates whether RS/RA Guard is enabled or disabled",
                    "type" : "boolean"
                },
                "raThrottlingEnabled" : {
                    "description" : "Indicates whether RA Throttling is enabled or disabled",
                    "type" : "boolean"
                },
                "maxAllowedRA" : {
                    "description" : "Max Allowed RAs",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 1440
                },
                "raInterval" : {
                    "description" : "A timer that RA proxy runs and once receives unsolicited RA checks against the configured time and allow/drop RA based on next timeout",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 256
                },
                "support80211dEnabled" : {
                    "description" : "Indicates whether support for 802.11d is enabled or disabled",
                    "type" : "boolean"
                },
                "support80211kEnabled" : {
                    "description" : "Indicates whether support for 802.11k is enabled or disabled",
                    "type" : "boolean"
                },
                "unauthClientStatsEnabled" : {
                    "description" : "Indicates whether to send statistics of unauthorized clients or not",
                    "type" : "boolean"
                },
                "uplinkEnabled" : {
                    "description" : "SSID Rate Limiting uplink enabled.",
                    "type" : "boolean"
                },
                "uplinkRate" : {
                    "description" : "SSID Rate Limiting uplink.",
                    "type" : "number"
                },
                "ratePerSTAUplink" : {
                    "description" : "UE Rate Limiting uplink.",
                    "type" : "string"
                },
                "ratePerSTADownlink" : {
                    "description" : "UE Rate Limiting downlink.",
                    "type" : "string"
                },
                "dtimInterval" : {
                    "description" : "DTIM Interval",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 255
                },
                "directedThreshold" : {
                    "description" : "Directed Threshold Setting, Defines the client count at which an AP will stop converting group addressed data traffic to unicast.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 128
                },
                "flowLogEnabled" : {
                    "description" : "Flow log enabled.",
                    "type" : "boolean"
                },
                "hdOverheadOptimizeEnable" : {
                    "description" : "Airtime Decongestion enabled.",
                    "type" : "boolean"
                },
                "probeRssiThr" : {
                    "description" : "Join RSSI threshold.",
                    "type" : "integer",
                    "minimum" : -90,
                    "maximum" : -60
                },
                "transientClientMgmtEnable" : {
                    "description" : "Transient Client Management enabled.",
                    "type" : "boolean"
                },
                "joinIgnoreTimeout" : {
                    "description" : "Join wait time.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 60
                },
                "joinAcceptTimeout" : {
                    "description" : "Join expire time.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 300
                },
                "joinIgnoreThr" : {
                    "description" : "Join wait threshold.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 50
                },
                "dropRandomProbesEnabled" : {
                    "description" : "Drop Random Probes enabled.",
                    "type" : "boolean"
                },
                "authRssiThr" : {
                    "description" : "Auth RSSI threshold.",
                    "type" : "integer",
                    "minimum" : -90,
                    "maximum" : -60
                },
                "assocRssiThr" : {
                    "description" : "Assoc RSSI threshold.",
                    "type" : "integer",
                    "minimum" : -90,
                    "maximum" : -60
                },
                "oceEnabled" : {
                    "description" : "Optimized Connectivity Experience(OCE) enabled.",
                    "type" : "boolean"
                },
                "oceBroadcastProbeResponseDelay" : {
                    "description" : "Broadcast probe response delay.",
                    "type" : "integer",
                    "minimum" : 8,
                    "maximum" : 120
                },
                "oceRssiBasedAssociationRejectionThreshold" : {
                    "description" : "RSSI-based association rejection threshold.",
                    "type" : "integer",
                    "minimum" : -90,
                    "maximum" : -60
                }
            },
            "type" : "object"
        },
        "authServiceOrProfile" : {
            "description" : "Authentication of the WLAN",
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "description" : "Identifier of the authentication service or profile. At least one ID or name or authenticationOption is required in the request.",
                    "type" : "string"
                },
                "locationDeliveryEnabled" : {
                    "description" : "RFC5580 location delivery support",
                    "type" : "boolean"
                },
                "realmBasedAuth" : {
                    "type" : "boolean"
                },
                "name" : {
                    "description" : "Name of the authentication service or profile. At least one ID or name or authenticationOption is required in the request. Or could input the 'Always Accept' or 'Local DB'.",
                    "type" : "string"
                },
                "authenticationOption" : {
                    "description" : "Option of the authentication service or profile, At least one ID or name or authenticationOption is required in the request. This only applies to hotspot and guest WLANs.",
                    "type" : "string",
                    "enum" : [ "Local DB", "Guest", "Always Accept", null ]
                },
                "throughController" : {
                    "description" : "Indicates whether authentication messages were sent through the controller or not",
                    "type" : "boolean"
                },
                "backupAuthenticationId" : {
                    "description" : "Identifier of the backup authentication service or profile. At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service.",
                    "type" : "string"
                },
                "backupAuthenticationName" : {
                    "description" : "Name of the backup authentication service or profile. At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service. Or could input the 'Always Accept'.",
                    "type" : "string"
                },
                "backupAuthenticationOption" : {
                    "description" : "Option of the backup authentication service or profile, At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service. This only applies to hotspot WLANs.",
                    "type" : "string",
                    "enum" : [ "Always Accept", null ]
                }
            },
            "type" : "object"
        },
        "bypassCNA" : {
            "description" : "Bypass Capitive Network Assitance",
            "type" : "boolean"
        },
        "coreTunnelProfile" : {
            "description" : "Core tunnel of the WLAN. This only applies when the access tunnel type is set to RuckusGRE.",
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "description" : "Identifier of the forwarding profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the forwarding profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "type" : {
                    "description" : "Tunnel type",
                    "type" : "string",
                    "enum" : [ "Bridge" ]
                }
            },
            "required" : [ "type" ],
            "type" : "object"
        },
        "defaultUserTrafficProfile" : {
            "description" : "User traffic profile of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "precedenceProfileId" : {
            "description" : "Precedence profile of the WLAN",
            "type" : "string"
        },
        "flexiVpnProfile" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "zoneAffinityId" : {
                    "type" : "string",
                    "description" : "Zone Affinity ID"
                }
            },
            "required" : [ "zoneAffinityId" ]
        },
        "description" : {
            "description" : "Description of the WLAN",
            "type" : [ "string", "null" ],
            "maxLength" : 64
        },
        "devicePolicy" : {
            "description" : "Device policy of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "diffServProfile" : {
            "description" : "DiffServ profile of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "dnsServerProfile" : {
            "description" : "DNS server profile of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "dpsk" : {
            "description" : "DPSK Setting",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "dpskEnabled" : {
                    "description" : "DPSK enabled",
                    "type" : "boolean"
                },
                "length" : {
                    "description" : "Length of DPSK key",
                    "type" : "integer"
                },
                "dpskType" : {
                    "description" : "Type of DPSK key",
                    "type" : "string",
                    "enum" : [ "Secure", "KeyboardFriendly", "NumbersOnly" ]
                },
                "expiration" : {
                    "description" : "Expiration of DPSK key",
                    "type" : "string",
                    "enum" : [ "Unlimited", "OneDay", "TwoDays", "OneWeek", "TwoWeeks", "OneMonth", "SixMonths", "OneYear", "TwoYears" ]
                },
                "dpskFromType" : {
                    "description" : "Type of expiration start from",
                    "type" : "string",
                    "enum" : [ "CreateTime", "FirstUse" ]
                }
            }
        },
        "externalDpsk" : {
            "description" : "External DPSK Enabled",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "enabled" : {
                    "description" : "Enable External DPSK",
                    "type" : "boolean"
                },
                "encryption" : {
                    "description" : "Encryption of the WLAN relate to external DPSK",
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "method" : {
                            "description" : "Encryption method",
                            "type" : "string",
                            "enum" : [ "WPA2", "WPA_Mixed", "None" ]
                        },
                        "algorithm" : {
                            "description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
                            "type" : "string",
                            "enum" : [ "AES", "TKIP_AES" ]
                        }
                    }
                },
                "authService" : {
                    "description" : "Autentication of the WLAN relate to external DPSK",
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "description" : "Identifier of the authentication service. At least one ID or name is required in the request.",
                            "type" : "string"
                        },
                        "name" : {
                            "description" : "Name of the authentication service. At least one ID or name is required in the request.",
                            "type" : "string"
                        }
                    }
                }
            },
            "required" : [ "enabled" ]
        },
        "encryption" : {
            "description" : "Encryption of the WLAN",
            "additionalProperties" : false,
            "properties" : {
                "algorithm" : {
                    "description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
                    "type" : "string",
                    "enum" : [ "AES", "TKIP_AES" ]
                },
                "keyInHex" : {
                    "description" : "Key in hex format. This only applies to WEP64 and WEP128.",
                    "type" : "string"
                },
                "keyIndex" : {
                    "description" : "Key index. This only applies to WEP64 and WEP128.",
                    "type" : "integer"
                },
                "method" : {
                    "description" : "Encryption method",
                    "type" : "string",
                    "enum" : [ "WPA2", "WPA_Mixed", "WEP_64", "WEP_128", "None" ]
                },
                "mfp" : {
                    "description" : "Management frame protection. This only applies to WPA2 + AES",
                    "type" : "string",
                    "enum" : [ "disabled", "capable", "required" ]
                },
                "mobilityDomainId" : {
                    "description" : "mobility Domain Id.",
                    "maximum" : 65535,
                    "minimum" : 1,
                    "type" : "integer"
                },
                "passphrase" : {
                    "description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
                    "type" : "string"
                },
                "support80211rEnabled" : {
                    "description" : "Enable 802.11r Fast BSS Transition, fast Romaing.",
                    "type" : "boolean"
                }
            },
            "required" : [ "method" ],
            "type" : "object"
        },
        "hessid" : {
            "description" : "HESSID of the WLAN",
            "pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$",
            "type" : "string"
        },
        "hotspot20Profile" : {
            "description" : "Hotspot 2.0 operator profile of the WLAN. id or name of the hotspot 2.0 operator profiles within the zone is required.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "l2ACL" : {
            "description" : "Layer 2 ACL of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "macAuth" : {
            "description" : "MAC address authentication settings of the WLAN. This only applies to standard MAC and Hotspot MAC bypass WLAN.",
            "additionalProperties" : false,
            "properties" : {
                "customizedPassword" : {
                    "description" : "User defined password. When this field is set to an empty string, the MAC address is used as password.",
                    "maxLength" : 64,
                    "pattern" : "^([!-;=?-~]([ -;=?-~]){0,62}[!-;=?-~]|[!-;=?-~]{1,1}|\s{0,0})$",
                    "type" : "string"
                },
                "macAuthMacFormat" : {
                    "description" : "MAC address format. The default format is 0010a42319c0 and the 802.1X format is 00-10-A4-23-19-C0.",
                    "type" : "string",
                    "enum" : [ "Default", "802.1X", "UpperColon", "Upper", "LowerDash", "LowerColon" ]
                }
            },
            "type" : "object"
        },
        "name" : {
            "description" : "Name of the WLAN",
            "type" : "string",
            "minLength" : 1,
            "maxLength" : 32
        },
        "operatorRealm" : {
            "description" : "Operator realm, operatorRealm only supports coreTunnelProfile type is PMIP or authServiceOrProfile.locationDeliveryEnabled is true",
            "type" : "string",
            "maxLength" : 255,
            "pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
        },
        "portalServiceProfile" : {
            "description" : "Portal service of the WLAN. This only applies to hotspot, hotspot MAC bypass, guest and web auth WLANs.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "qosMaps" : {
            "description" : "Qos map set of the WLAN.",
            "items" : {
                "additionalProperties" : false,
                "properties" : {
                    "enable" : {
                        "description" : "Enabled or disabled",
                        "type" : "boolean"
                    },
                    "excepts" : {
                        "items" : {
                            "maximum" : 63,
                            "minimum" : 0,
                            "type" : "integer"
                        },
                        "type" : [ "array", "null" ]
                    },
                    "high" : {
                        "description" : "DSCP range - high",
                        "maximum" : 255,
                        "minimum" : 0,
                        "type" : [ "integer", "null" ]
                    },
                    "low" : {
                        "description" : "DSCP range - low",
                        "maximum" : 255,
                        "minimum" : 0,
                        "type" : [ "integer", "null" ]
                    },
                    "priority" : {
                        "description" : "Priority",
                        "type" : "integer"
                    }
                },
                "required" : [ "enable", "priority" ],
                "type" : "object"
            },
            "type" : "array"
        },
        "radiusOptions" : {
            "description" : "RADIUS options of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "calledStaIdType" : {
                    "description" : "Called station ID type",
                    "type" : "string",
                    "enum" : [ "AP_MAC", "NONE", "WLAN_BSSID" ]
                },
                "customizedNasId" : {
                    "description" : "User defined NAS ID",
                    "maxLength" : 64,
                    "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                    "type" : "string"
                },
                "nasIdType" : {
                    "description" : "NAS ID type",
                    "type" : "string",
                    "enum" : [ "AP_MAC", "Customized", "WLAN_BSSID" ]
                },
                "nasMaxRetry" : {
                    "description" : "NAS request maximum retry",
                    "maximum" : 10,
                    "minimum" : 2,
                    "type" : "integer"
                },
                "nasReconnectPrimaryMin" : {
                    "description" : "NAS reconnect primary time in minutes",
                    "maximum" : 60,
                    "minimum" : 1,
                    "type" : "integer"
                },
                "nasRequestTimeoutSec" : {
                    "description" : "NAS request timeout in seconds",
                    "maximum" : 20,
                    "minimum" : 2,
                    "type" : "integer"
                },
                "nasIpType" : {
                    "description" : "NAS IP type",
                    "type" : "string",
                    "enum" : [ "disabled", "control", "management", "userDefined" ]
                },
                "nasIpUserDefined" : {
                    "description" : "User-defined NAS IP",
                    "type" : "string",
                    "maxLength" : 45
                },
                "singleSessionIdAcctEnabled" : {
                    "description" : "When Single Accounting Session ID is enabled, APs will maintain one accounting session for client roaming",
                    "type" : "boolean"
                },
                "vendorSpecificAttributeProfileId" : {
                    "description" : "Vendor Specific Attribute Profile ID",
                    "type" : "string"
                }
            }
        },
        "schedule" : {
            "description" : "Schedule of the WLAN",
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "description" : "Identifier of the schedule profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the schedule profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "type" : {
                    "description" : "Type of WLAN schedule",
                    "type" : "string",
                    "enum" : [ "AlwaysOn", "AlwaysOff", "Customized" ]
                }
            },
            "required" : [ "type" ],
            "type" : "object"
        },
        "ssid" : {
            "description" : "SSID of the WLAN",
            "type" : "string",
            "minLength" : 1,
            "maxLength" : 32
        },
        "timeboundWhitelist" : {
            "description" : "Hotspot timeboundWhitelist. The ID of the OAuth Authentication service is required.",
            "additionalProperties" : false,
            "properties" : {
                "firstIndex" : {
                    "type" : "integer"
                },
                "hasMore" : {
                    "type" : "boolean"
                },
                "list" : {
                    "items" : {
                        "type" : [ "object", "null" ],
                        "additionalProperties" : false,
                        "properties" : {
                            "id" : {
                                "type" : "string"
                            },
                            "name" : {
                                "type" : "string"
                            }
                        }
                    },
                    "type" : "array"
                },
                "totalCount" : {
                    "type" : "integer"
                }
            },
            "type" : "object"
        },
        "vlan" : {
            "description" : "VLAN (access and/or core) of the WLAN.",
            "additionalProperties" : false,
            "properties" : {
                "aaaVlanOverride" : {
                    "description" : "Indicates whether the AAA VLAN settings can be overriden or not",
                    "type" : "boolean"
                },
                "accessVlan" : {
                    "description" : "Access VLAN ID",
                    "maximum" : 4094,
                    "minimum" : 1,
                    "type" : "integer"
                },
                "vlanPooling" : {
                    "description" : "Vlan pooling",
                    "type" : [ "object", "null" ],
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string"
                        }
                    }
                }
            },
            "type" : "object"
        },
        "accessTunnelProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "accessIpsecProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "splitTunnelProfileId" : {
            "type" : "string"
        }
    },
    "type" : "object"
}
Response  204

Modify Authentication

PATCH/v8_1/rkszones/{zoneId}/wlans/{id}/authServiceOrProfile

Use this API command to modify the authentication method of a WLAN.

Request
HideShow
Body
{
  "throughController": true,
  "id": "authServiceUUID",
  "locationDeliveryEnabled": true,
  "authenticationOption": null
}
Schema
{
  "description": "Authentication of the WLAN",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "Identifier of the authentication service or profile. At least one ID or name or authenticationOption is required in the request.",
      "type": "string"
    },
    "locationDeliveryEnabled": {
      "description": "RFC5580 location delivery support",
      "type": "boolean"
    },
    "realmBasedAuth": {
      "type": "boolean"
    },
    "name": {
      "description": "Name of the authentication service or profile. At least one ID or name or authenticationOption is required in the request. Or could input the 'Always Accept' or 'Local DB'.",
      "type": "string"
    },
    "authenticationOption": {
      "description": "Option of the authentication service or profile, At least one ID or name or authenticationOption is required in the request. This only applies to hotspot and guest WLANs.",
      "type": "string",
      "enum": [
        "Local DB",
        "Guest",
        "Always Accept",
        null
      ]
    },
    "throughController": {
      "description": "Indicates whether authentication messages were sent through the controller or not",
      "type": "boolean"
    },
    "backupAuthenticationId": {
      "description": "Identifier of the backup authentication service or profile. At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service.",
      "type": "string"
    },
    "backupAuthenticationName": {
      "description": "Name of the backup authentication service or profile. At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service. Or could input the 'Always Accept'.",
      "type": "string"
    },
    "backupAuthenticationOption": {
      "description": "Option of the backup authentication service or profile, At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service. This only applies to hotspot WLANs.",
      "type": "string",
      "enum": [
        "Always Accept",
        null
      ]
    }
  },
  "type": "object"
}
Response  204

Modify MAC Auth

PATCH/v8_1/rkszones/{zoneId}/wlans/{id}/macAuth

Use this API command to modify the MAC authentication settings of a WLAN. macAuthMacFormat : Open (aabbccddeeff), 802.1X (AA-BB-CC-DD-EE-FF), UpperColon (AA:BB:CC:DD:EE:FF), Upper (AABBCCDDEEFF), LowerDash (aa-bb-cc-dd-ee-ff) and LowerColon (aa:bb:cc:dd:ee:ff).

Request
HideShow
Body
{
  "macAuthMacFormat": "802.1X",
  "customizedPassword": "password"
}
Schema
{
    "description" : "MAC address authentication settings of the WLAN. This only applies to standard MAC and Hotspot MAC bypass WLAN.",
    "additionalProperties" : false,
    "properties" : {
        "customizedPassword" : {
            "description" : "User defined password. When this field is set to an empty string, the MAC address is used as password.",
            "maxLength" : 64,
            "pattern" : "^([!-;=?-~]([ -;=?-~]){0,62}[!-;=?-~]|[!-;=?-~]{1,1}|\s{0,0})$",
            "type" : "string"
        },
        "macAuthMacFormat" : {
            "description" : "MAC address format. The default format is 0010a42319c0 and the 802.1X format is 00-10-A4-23-19-C0.",
            "type" : "string",
            "enum" : [ "Default", "802.1X", "UpperColon", "Upper", "LowerDash", "LowerColon" ]
        }
    },
    "type" : "object"
}
Response  204

Modify Accounting

PATCH/v8_1/rkszones/{zoneId}/wlans/{id}/accountingServiceOrProfile

Use this API command to modify the accounting settings of a WLAN.

Request
HideShow
Body
{
  "throughController": false,
  "id": "accountingServiceUUID",
  "name": "accountingServiceName",
  "interimUpdateMin": 10,
  "accountingDelayEnabled": false,
  "backupAccountingId": "otherAccountingServiceUUID",
  "backupAccountingName": "otherAccountingServiceName"
}
Schema
{
  "description": "Accounting of the WLAN",
  "additionalProperties": false,
  "properties": {
    "accountingDelayEnabled": {
      "description": "Indicates whether accounting delay time is enabled",
      "type": "boolean"
    },
    "id": {
      "description": "Accounting service or profile ID. At least one ID or name is required in the request.",
      "type": "string"
    },
    "interimUpdateMin": {
      "description": "Interval (in minutes) for sending interim updates",
      "maximum": 1440,
      "minimum": 0,
      "type": "integer"
    },
    "name": {
      "description": "Accounting service or profile name. At least one ID or name is required in the request.",
      "type": "string"
    },
    "throughController": {
      "description": "Indicates whether accounting messages were sent through the controller",
      "type": "boolean"
    },
    "realmBasedAcct": {
      "type": "boolean"
    },
    "backupAccountingId": {
      "description": "Backup accounting service or profile ID. At least one backupAccountingId or backupAccountingName is required in the request when setting backup accounting service.",
      "type": "string"
    },
    "backupAccountingName": {
      "description": "Backup accounting service or profile name. At least one backupAccountingId or backupAccountingName is required in the request when setting backup accounting service.",
      "type": "string"
    }
  },
  "type": "object"
}
Response  204

Modify Encryption

PATCH/v8_1/rkszones/{zoneId}/wlans/{id}/encryption

Use this API command to modify the encryption settings of a WLAN.

Request
HideShow
Body
{
  "method": "WPA2",
  "algorithm": "AES",
  "passphrase": "password",
  "mfp": "disabled",
  "support80211rEnabled": true,
  "mobilityDomainId": 3
}
Schema
{
  "description": "Encryption of the WLAN",
  "additionalProperties": false,
  "properties": {
    "algorithm": {
      "description": "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
      "type": "string",
      "enum": [
        "AES",
        "TKIP_AES"
      ]
    },
    "keyInHex": {
      "description": "Key in hex format. This only applies to WEP64 and WEP128.",
      "type": "string"
    },
    "keyIndex": {
      "description": "Key index. This only applies to WEP64 and WEP128.",
      "type": "integer"
    },
    "method": {
      "description": "Encryption method",
      "type": "string",
      "enum": [
        "WPA2",
        "WPA_Mixed",
        "WEP_64",
        "WEP_128",
        "None"
      ]
    },
    "mfp": {
      "description": "Management frame protection. This only applies to WPA2 + AES",
      "type": "string",
      "enum": [
        "disabled",
        "capable",
        "required"
      ]
    },
    "mobilityDomainId": {
      "description": "mobility Domain Id.",
      "maximum": 65535,
      "minimum": 1,
      "type": "integer"
    },
    "passphrase": {
      "description": "Passphrase. This only applies to WPA2 and WPA mixed mode.",
      "type": "string"
    },
    "support80211rEnabled": {
      "description": "Enable 802.11r Fast BSS Transition, fast Romaing.",
      "type": "boolean"
    }
  },
  "required": [
    "method"
  ],
  "type": "object"
}
Response  204

Modify Core Tunnel

PATCH/v8_1/rkszones/{zoneId}/wlans/{id}/coreTunnelProfile

Use this API command to modify the core tunnel configuration of a WLAN.

Request
HideShow
Schema
{
  "description": "Core tunnel of the WLAN. This only applies when the access tunnel type is set to RuckusGRE.",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "Identifier of the forwarding profile. At least one ID or name is required in the request.",
      "type": "string"
    },
    "name": {
      "description": "Name of the forwarding profile. At least one ID or name is required in the request.",
      "type": "string"
    },
    "type": {
      "description": "Tunnel type",
      "type": "string",
      "enum": [
        "Bridge"
      ]
    }
  },
  "required": [
    "type"
  ],
  "type": "object"
}
Response  204

Modify Portal Profile

PATCH/v8_1/rkszones/{zoneId}/wlans/{id}/portalServiceProfile

Use this API command to modify the portal configuration of a WLAN.

Request
HideShow
Body
{
  "id": "portalServiceUUID",
  "name": "portalServiceName"
}
Schema
{
  "description": "Portal service of the WLAN. This only applies to hotspot, hotspot MAC bypass, guest and web auth WLANs.",
  "type": [
    "object",
    "null"
  ],
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    }
  }
}
Response  204

Modify Hotspot20 Profile

PATCH/v8_1/rkszones/{zoneId}/wlans/{id}/hotspot20Profile

Use this API command to modify the Hotspot 2.0 profile configuration of a WLAN.

Request
HideShow
Body
{
  "id": "hotspot20ServiceUUID",
  "name": "hotspot20ServiceName"
}
Schema
{
  "description": "Hotspot 2.0 operator profile of the WLAN. id or name of the hotspot 2.0 operator profiles within the zone is required.",
  "type": [
    "object",
    "null"
  ],
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    }
  }
}
Response  204

Modify User Traffic Profile

PATCH/v8_1/rkszones/{zoneId}/wlans/{id}/defaultUserTrafficProfile

Use this API command to modify the user traffic profile configuration of a WLAN.

Request
HideShow
Body
{
  "id": "userTrafficUUID",
  "name": "userTrafficName"
}
Schema
{
  "description": "User traffic profile of the WLAN",
  "type": [
    "object",
    "null"
  ],
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    }
  }
}
Response  204

Modify Schedule

PATCH/v8_1/rkszones/{zoneId}/wlans/{id}/schedule

Use this API command to modify the schedule configuration of a WLAN.

Request
HideShow
Body
{
  "type": "Customized",
  "id": "ServiceUUID",
  "name": "ServiceName"
}
Schema
{
  "description": "Schedule of the WLAN",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "Identifier of the schedule profile. At least one ID or name is required in the request.",
      "type": "string"
    },
    "name": {
      "description": "Name of the schedule profile. At least one ID or name is required in the request.",
      "type": "string"
    },
    "type": {
      "description": "Type of WLAN schedule",
      "type": "string",
      "enum": [
        "AlwaysOn",
        "AlwaysOff",
        "Customized"
      ]
    }
  },
  "required": [
    "type"
  ],
  "type": "object"
}
Response  204

Modify VLAN

PATCH/v8_1/rkszones/{zoneId}/wlans/{id}/vlan

Use this API command to modify the VLAN configuration of a WLAN.

Request
HideShow
Body
{
  "accessVlan": 23,
  "aaaVlanOverride": true,
  "vlanpooling": null
}
Schema
{
  "description": "VLAN (access and/or core) of the WLAN.",
  "additionalProperties": false,
  "properties": {
    "aaaVlanOverride": {
      "description": "Indicates whether the AAA VLAN settings can be overriden or not",
      "type": "boolean"
    },
    "accessVlan": {
      "description": "Access VLAN ID",
      "maximum": 4094,
      "minimum": 1,
      "type": "integer"
    },
    "vlanPooling": {
      "description": "Vlan pooling",
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    }
  },
  "type": "object"
}
Response  204

Modify Layer 2 ACL

PATCH/v8_1/rkszones/{zoneId}/wlans/{id}/l2ACL

Use this API command to modify the layer 2 access control list (ACL) configuration of a WLAN.

Request
HideShow
Body
{
  "id": "l2ACLUUID",
  "name": "l2ACLName"
}
Schema
{
  "description": "Layer 2 ACL of the WLAN",
  "type": [
    "object",
    "null"
  ],
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    }
  }
}
Response  204

Modify Device Policy

PATCH/v8_1/rkszones/{zoneId}/wlans/{id}/devicePolicy

Use this API command to modify the device policy of a WLAN.

Request
HideShow
Body
{
  "id": "devicePolicyUUID",
  "name": "devicePolicyName"
}
Schema
{
  "description": "Device policy of the WLAN",
  "type": [
    "object",
    "null"
  ],
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    }
  }
}
Response  204

Modify RADIUS Options

PATCH/v8_1/rkszones/{zoneId}/wlans/{id}/radiusOptions

Use this API command to modify the RADIUS settings of a WLAN.

Request
HideShow
Body
{
  "nasIdType": "Customized",
  "customizedNasId": "nasId",
  "nasRequestTimeoutSec": 12,
  "nasMaxRetry": 3,
  "nasReconnectPrimaryMin": 30,
  "calledStaIdType": "WLAN_BSSID",
  "nasIpType": "disabled",
  "nasIpUserDefined": "192.168.1.1",
  "singleSessionIdAcctEnabled": false,
  "vendorSpecificAttributeProfileId": "6d767421-d1b7-11e8-8ab9-ba2343155a93"
}
Schema
{
  "description": "RADIUS options of the WLAN",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "calledStaIdType": {
      "description": "Called station ID type",
      "type": "string",
      "enum": [
        "AP_MAC",
        "NONE",
        "WLAN_BSSID"
      ]
    },
    "customizedNasId": {
      "description": "User defined NAS ID",
      "maxLength": 64,
      "pattern": "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
      "type": "string"
    },
    "nasIdType": {
      "description": "NAS ID type",
      "type": "string",
      "enum": [
        "AP_MAC",
        "Customized",
        "WLAN_BSSID"
      ]
    },
    "nasMaxRetry": {
      "description": "NAS request maximum retry",
      "maximum": 10,
      "minimum": 2,
      "type": "integer"
    },
    "nasReconnectPrimaryMin": {
      "description": "NAS reconnect primary time in minutes",
      "maximum": 60,
      "minimum": 1,
      "type": "integer"
    },
    "nasRequestTimeoutSec": {
      "description": "NAS request timeout in seconds",
      "maximum": 20,
      "minimum": 2,
      "type": "integer"
    },
    "nasIpType": {
      "description": "NAS IP type",
      "type": "string",
      "enum": [
        "disabled",
        "control",
        "management",
        "userDefined"
      ]
    },
    "nasIpUserDefined": {
      "description": "User-defined NAS IP",
      "type": "string",
      "maxLength": 45
    },
    "singleSessionIdAcctEnabled": {
      "description": "When Single Accounting Session ID is enabled, APs will maintain one accounting session for client roaming",
      "type": "boolean"
    },
    "vendorSpecificAttributeProfileId": {
      "description": "Vendor Specific Attribute Profile ID",
      "type": "string"
    }
  }
}
Response  204

Modify Advanced Options

PATCH/v8_1/rkszones/{zoneId}/wlans/{id}/advancedOptions

Use this API command to modify the advanced settings of a WLAN.

Request
HideShow
Body
{
  "clientIsolationEnabled": true,
  "clientIsolationUnicastEnabled": true,
  "clientIsolationMulticastEnabled": false,
  "clientIsolationAutoVrrpEnabled": false,
  "clientIsolationWhitelist": {
    "id": "24f24c00-0b47-11e4-a9b5-000c29b1347d",
    "name": "myWhitelist"
  },
  "priority": "High",
  "hideSsidEnabled": true,
  "maxClientsPerRadio": 12,
  "clientIdleTimeoutSec": 12,
  "clientLoadBalancingEnabled": true,
  "proxyARPEnabled": true,
  "support80211dEnabled": false,
  "support80211kEnabled": true,
  "antiSpoofingEnabled": true,
  "arpRequestRateLimit": 15,
  "dhcpRequestRateLimit": 15,
  "forceClientDHCPTimeoutSec": 5,
  "dhcp82SubOpt1Format": "SUBOPT1_AP_INFO_LOCATION",
  "unauthClientStatsEnabled": false,
  "clientFingerprintingEnabled": true,
  "ofdmOnlyEnabled": false,
  "bandBalancing": "UseZoneSetting",
  "bssMinRateMbps": "Disable",
  "mgmtTxRateMbps": "2 mbps",
  "uplinkEnabled": false,
  "downlinkEnabled": false,
  "avcEnabled": true,
  "urlFilteringPolicyEnabled": false,
  "urlFilteringPolicyId": "",
  "wifiCallingPolicyEnabled": false,
  "wifiCallingPolicyIds": [],
  "hdOverheadOptimizeEnable": false,
  "probeRssiThr": -85,
  "transientClientMgmtEnable": true,
  "joinIgnoreTimeout": 30,
  "joinAcceptTimeout": 300,
  "joinIgnoreThr": 10,
  "authRssiThr": -85,
  "assocRssiThr": -85
}
Schema
{
  "description": "Advanced settings for the WLAN.",
  "additionalProperties": false,
  "properties": {
    "avcEnabled": {
      "description": "Indicator of whether AVC support is enabled or disabled",
      "type": "boolean"
    },
    "bandBalancing": {
      "description": "Indicates whether band balancing is enabled or disabled",
      "type": "string",
      "enum": [
        "Disabled",
        "UseZoneSetting"
      ]
    },
    "bssMinRateMbps": {
      "description": "BSS minimum rate (mbps)",
      "type": "string",
      "enum": [
        "Disable",
        "1 mbps",
        "2 mbps",
        "5.5 mbps",
        "12 mbps",
        "24 mbps"
      ]
    },
    "clientFingerprintingEnabled": {
      "description": "Indicates whether client fingerprinting is enabled or disabled",
      "type": "boolean"
    },
    "clientIdleTimeoutSec": {
      "description": "Client idle timeout in seconds",
      "maximum": 1000,
      "minimum": 60,
      "type": "integer"
    },
    "clientIsolationEnabled": {
      "description": "Indicates whether wireless client isolation is enabled or disabled",
      "type": "boolean"
    },
    "clientIsolationUnicastEnabled": {
      "description": "Indicates whether isolate unicast of wireless client isolation is enabled or disabled",
      "type": "boolean"
    },
    "clientIsolationMulticastEnabled": {
      "description": "Indicates whether isolate multicast of wireless client isolation is enabled or disabled",
      "type": "boolean"
    },
    "clientIsolationAutoVrrpEnabled": {
      "description": "Indicates whether Automatic support for VRRP of wireless client isolation is enabled or disabled",
      "type": "boolean"
    },
    "clientIsolationWhitelist": {
      "description": "Indicates wireless client isolation whitelist",
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "clientLoadBalancingEnabled": {
      "description": "Indicates whether Client Load Balancing is enabled or disabled",
      "type": "boolean"
    },
    "dgafEnabled": {
      "description": "Indicates whether dgaf is enabled or disabled",
      "type": "boolean"
    },
    "dhcp82Format": {
      "description": "DHCP Option 82 format. This variable no longer supports from v8_1 and only kept for backward compatibility.",
      "type": "string",
      "enum": [
        "RUCKUS_DEFAULT",
        "SOFTGRE_CUSTOMIZED"
      ]
    },
    "dhcpOption82Enabled": {
      "description": "Indicates whether DCHP Option 82 is enabled or disabled. This variable no longer supports from v8_1 and only kept for backward compatibility.",
      "type": "boolean"
    },
    "dhcp82SubOpt1Format": {
      "description": "Subopt-1 format",
      "type": "string",
      "enum": [
        "NONE",
        "SUBOPT1_AP_INFO_LOCATION",
        "SUBOPT1_AP_INFO",
        "SUBOPT1_AP_MAC_ESSID_PRIVACYTYPE",
        "SUBOPT1_AP_MAC_hex",
        "SUBOPT1_AP_MAC_hex_ESSID",
        "SUBOPT1_ESSID"
      ]
    },
    "dhcp82SubOpt2Format": {
      "description": "Subopt-2 format",
      "type": "string",
      "enum": [
        "NONE",
        "SUBOPT2_CLIENT_MAC",
        "SUBOPT2_CLIENT_MAC_hex",
        "SUBOPT2_CLIENT_MAC_hex_ESSID",
        "SUBOPT2_AP_MAC",
        "SUBOPT2_AP_MAC_hex",
        "SUBOPT2_AP_MAC_hex_ESSID"
      ]
    },
    "dhcp82SubOpt150Format": {
      "description": "Subopt-150 with VLAN-Id",
      "type": "string",
      "enum": [
        "NONE",
        "SUBOPT150_VLAN_ID"
      ]
    },
    "dhcp82SubOpt151Format": {
      "description": "Subopt-151 format",
      "type": "string",
      "enum": [
        "NONE",
        "SUBOPT151_AREA_NAME",
        "SUBOPT151_ESSID"
      ]
    },
    "dhcp82SubOpt151AreaName": {
      "description": "Subopt-151 Area Name value",
      "type": "string"
    },
    "downlinkEnabled": {
      "description": "SSID Rate Limiting downlink enabled.",
      "type": "boolean"
    },
    "downlinkRate": {
      "description": "SSID Rate Limiting downlink.",
      "type": "number"
    },
    "antiSpoofingEnabled": {
      "description": "Anti-Spoofing enabled",
      "type": "boolean"
    },
    "arpRequestRateLimit": {
      "description": "ARP packets request rate limit, default value will be 15 if both rate limit not being set.",
      "type": "integer",
      "minimum": 0,
      "maximum": 100
    },
    "dhcpRequestRateLimit": {
      "description": "DHCP packets request rate limit, default value will be 15 if both rate limit not being set.",
      "type": "integer",
      "minimum": 0,
      "maximum": 100
    },
    "forceClientDHCPTimeoutSec": {
      "description": "Force DHCP disconnects the client if the client does not obtain a valid IP address within the timeout peroid. To disable force DHCP, set this value to zero (0).",
      "type": "integer",
      "enum": [
        0,
        5,
        6,
        7,
        8,
        9,
        10,
        11,
        12,
        13,
        14,
        15
      ]
    },
    "hideSsidEnabled": {
      "description": "Indicates whether the SSID is hidden or broadcast",
      "type": "boolean"
    },
    "hs20Onboarding": {
      "description": "Allow WISPr WLAN for Hotspot 2.0 Onboarding",
      "type": "boolean"
    },
    "maxClientsPerRadio": {
      "description": "Maximum number of clients per radio",
      "maximum": 512,
      "minimum": 1,
      "type": "integer"
    },
    "mgmtTxRateMbps": {
      "description": "Management TX rate (mbps)",
      "type": "string",
      "enum": [
        "1 mbps",
        "2 mbps",
        "5.5 mbps",
        "6 mbps",
        "9 mbps",
        "11 mbps",
        "12 mbps",
        "18 mbps",
        "24 mbps",
        "36 mbps",
        "48 mbps",
        "54 mbps"
      ]
    },
    "ofdmOnlyEnabled": {
      "description": "Indicates whether OFDM only is enabled or disabled",
      "type": "boolean"
    },
    "okcEnabled": {
      "description": "Indicator of whether OKC support is enabled or disabled. The default value is true when the WLAN is WPA+AES non open WLAN.",
      "type": "boolean"
    },
    "pmkCachingEnabled": {
      "description": "Indicator of whether PKM caching support is enabled or disabled. The default value is true when the WLAN is WPA+AES non open WLAN.",
      "type": "boolean"
    },
    "priority": {
      "description": "Priority of the WLAN",
      "type": "string",
      "enum": [
        "High",
        "Low"
      ]
    },
    "proxyARPEnabled": {
      "description": "Indicates whether proxy ARP is enabled or disabled",
      "type": "boolean"
    },
    "ndProxyEnabled": {
      "description": "Indicates whether ND Proxy is enabled or disabled",
      "type": "boolean"
    },
    "suppressNsEnabled": {
      "description": "Indicates whether supperssNS is enabled or disabled",
      "type": "boolean"
    },
    "raProxyEnabled": {
      "description": "Indicates whether RA proxy is enabled or disabled",
      "type": "boolean"
    },
    "rsraGuardEnabled": {
      "description": "Indicates whether RS/RA Guard is enabled or disabled",
      "type": "boolean"
    },
    "raThrottlingEnabled": {
      "description": "Indicates whether RA Throttling is enabled or disabled",
      "type": "boolean"
    },
    "maxAllowedRA": {
      "description": "Max Allowed RAs",
      "type": "integer",
      "minimum": 1,
      "maximum": 1440
    },
    "raInterval": {
      "description": "A timer that RA proxy runs and once receives unsolicited RA checks against the configured time and allow/drop RA based on next timeout",
      "type": "integer",
      "minimum": 1,
      "maximum": 256
    },
    "support80211dEnabled": {
      "description": "Indicates whether support for 802.11d is enabled or disabled",
      "type": "boolean"
    },
    "support80211kEnabled": {
      "description": "Indicates whether support for 802.11k is enabled or disabled",
      "type": "boolean"
    },
    "unauthClientStatsEnabled": {
      "description": "Indicates whether to send statistics of unauthorized clients or not",
      "type": "boolean"
    },
    "uplinkEnabled": {
      "description": "SSID Rate Limiting uplink enabled.",
      "type": "boolean"
    },
    "uplinkRate": {
      "description": "SSID Rate Limiting uplink.",
      "type": "number"
    },
    "ratePerSTAUplink": {
      "description": "UE Rate Limiting uplink.",
      "type": "string"
    },
    "ratePerSTADownlink": {
      "description": "UE Rate Limiting downlink.",
      "type": "string"
    },
    "dtimInterval": {
      "description": "DTIM Interval",
      "type": "integer",
      "minimum": 1,
      "maximum": 255
    },
    "directedThreshold": {
      "description": "Directed Threshold Setting, Defines the client count at which an AP will stop converting group addressed data traffic to unicast.",
      "type": "integer",
      "minimum": 0,
      "maximum": 128
    },
    "flowLogEnabled": {
      "description": "Flow log enabled.",
      "type": "boolean"
    },
    "hdOverheadOptimizeEnable": {
      "description": "Airtime Decongestion enabled.",
      "type": "boolean"
    },
    "probeRssiThr": {
      "description": "Join RSSI threshold.",
      "type": "integer",
      "minimum": -90,
      "maximum": -60
    },
    "transientClientMgmtEnable": {
      "description": "Transient Client Management enabled.",
      "type": "boolean"
    },
    "joinIgnoreTimeout": {
      "description": "Join wait time.",
      "type": "integer",
      "minimum": 1,
      "maximum": 60
    },
    "joinAcceptTimeout": {
      "description": "Join expire time.",
      "type": "integer",
      "minimum": 1,
      "maximum": 300
    },
    "joinIgnoreThr": {
      "description": "Join wait threshold.",
      "type": "integer",
      "minimum": 1,
      "maximum": 50
    },
    "dropRandomProbesEnabled": {
      "description": "Drop Random Probes enabled.",
      "type": "boolean"
    },
    "authRssiThr": {
      "description": "Auth RSSI threshold.",
      "type": "integer",
      "minimum": -90,
      "maximum": -60
    },
    "assocRssiThr": {
      "description": "Assoc RSSI threshold.",
      "type": "integer",
      "minimum": -90,
      "maximum": -60
    },
    "oceEnabled": {
      "description": "Optimized Connectivity Experience(OCE) enabled.",
      "type": "boolean"
    },
    "oceBroadcastProbeResponseDelay": {
      "description": "Broadcast probe response delay.",
      "type": "integer",
      "minimum": 8,
      "maximum": 120
    },
    "oceRssiBasedAssociationRejectionThreshold": {
      "description": "RSSI-based association rejection threshold.",
      "type": "integer",
      "minimum": -90,
      "maximum": -60
    }
  },
  "type": "object"
}
Response  204

Modify DiffServ Profile

PATCH/v8_1/rkszones/{zoneId}/wlans/{id}/diffServProfile

Use this API command to modify the DiffServ profile of a WLAN.

Request
HideShow
Body
{
  "id": "diffServId",
  "name": "diffServName"
}
Schema
{
  "description": "DiffServ profile of the WLAN",
  "type": [
    "object",
    "null"
  ],
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    }
  }
}
Response  204

Modify Qos Map Set

PATCH/v8_1/rkszones/{zoneId}/wlans/{id}/qosMaps

Use this API command to modify Qos Map Set of a WLAN.

Request
HideShow
Body
[
  {
    "enable": true,
    "priority": 0,
    "low": 0,
    "high": 7,
    "excepts": null
  },
  {
    "enable": true,
    "priority": 1,
    "low": 8,
    "high": 15,
    "excepts": null
  },
  {
    "enable": true,
    "priority": 2,
    "low": 16,
    "high": 23,
    "excepts": null
  },
  {
    "enable": true,
    "priority": 3,
    "low": 0,
    "high": 32,
    "excepts": [
      43,
      45,
      60
    ]
  },
  {
    "enable": true,
    "priority": 4,
    "low": 32,
    "high": 39,
    "excepts": null
  },
  {
    "enable": true,
    "priority": 5,
    "low": 40,
    "high": 47,
    "excepts": null
  },
  {
    "enable": true,
    "priority": 6,
    "low": 48,
    "high": 55,
    "excepts": [
      46
    ]
  },
  {
    "enable": true,
    "priority": 7,
    "low": 56,
    "high": 63,
    "excepts": null
  }
]
Schema
{
  "description": "Qos map set of the WLAN.",
  "items": {
    "additionalProperties": false,
    "properties": {
      "enable": {
        "description": "Enabled or disabled",
        "type": "boolean"
      },
      "excepts": {
        "items": {
          "maximum": 63,
          "minimum": 0,
          "type": "integer"
        },
        "type": [
          "array",
          "null"
        ]
      },
      "high": {
        "description": "DSCP range - high",
        "maximum": 255,
        "minimum": 0,
        "type": [
          "integer",
          "null"
        ]
      },
      "low": {
        "description": "DSCP range - low",
        "maximum": 255,
        "minimum": 0,
        "type": [
          "integer",
          "null"
        ]
      },
      "priority": {
        "description": "Priority",
        "type": "integer"
      }
    },
    "required": [
      "enable",
      "priority"
    ],
    "type": "object"
  },
  "type": "array"
}
Response  204

Modify DNS server profile

PATCH/v8_1/rkszones/{zoneId}/wlans/{id}/dnsServerProfile

Use this API command to modify DNS server profile of a WLAN.

Request
HideShow
Schema
{
  "description": "DNS server profile of the WLAN",
  "type": [
    "object",
    "null"
  ],
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    }
  }
}
Response  204

Modify DPSK Setting

PATCH/v8_1/rkszones/{zoneId}/wlans/{id}/dpsk

Use this API command to modify DPSK setting of a WLAN.

Request
HideShow
Body
{
  "dpskEnabled": true,
  "length": 8,
  "dpskType": "Secure",
  "expiration": "OneDay",
  "dpskFromType": "FirstUse"
}
Schema
{
  "description": "DPSK Setting",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "dpskEnabled": {
      "description": "DPSK enabled",
      "type": "boolean"
    },
    "length": {
      "description": "Length of DPSK key",
      "type": "integer"
    },
    "dpskType": {
      "description": "Type of DPSK key",
      "type": "string",
      "enum": [
        "Secure",
        "KeyboardFriendly",
        "NumbersOnly"
      ]
    },
    "expiration": {
      "description": "Expiration of DPSK key",
      "type": "string",
      "enum": [
        "Unlimited",
        "OneDay",
        "TwoDays",
        "OneWeek",
        "TwoWeeks",
        "OneMonth",
        "SixMonths",
        "OneYear",
        "TwoYears"
      ]
    },
    "dpskFromType": {
      "description": "Type of expiration start from",
      "type": "string",
      "enum": [
        "CreateTime",
        "FirstUse"
      ]
    }
  }
}
Response  204

Modify External DPSK Setting

PATCH/v8_1/rkszones/{zoneId}/wlans/{id}/externalDpsk

Use this API command to modify External DPSK setting of a WLAN.

Request
HideShow
Body
‧ Sample : Enable external DPSK with encryption WPA2 and radius authentication service of proxy mode
{
    "enabled" : true,
    "encryption" : {
        "method" : "WPA2",
        "algorithm" : "AES"
    },
    "authService" : {
        "id" : "authServiceUUID"
    }
}
‧ Sample : Disable external DPSK with encryption None
{
    "enabled" : false,
    "encryption" : {
        "method" : "None"
    }
}
Schema
{
    "description" : "External DPSK Enabled",
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "enabled" : {
            "description" : "Enable External DPSK",
            "type" : "boolean"
        },
        "encryption" : {
            "description" : "Encryption of the WLAN relate to external DPSK",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "method" : {
                    "description" : "Encryption method",
                    "type" : "string",
                    "enum" : [ "WPA2", "WPA_Mixed", "None" ]
                },
                "algorithm" : {
                    "description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
                    "type" : "string",
                    "enum" : [ "AES", "TKIP_AES" ]
                }
            }
        },
        "authService" : {
            "description" : "Autentication of the WLAN relate to external DPSK",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "description" : "Identifier of the authentication service. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the authentication service. At least one ID or name is required in the request.",
                    "type" : "string"
                }
            }
        }
    },
    "required" : [ "enabled" ]
}
Response  204

Modify Entire

PUT/v8_1/rkszones/{zoneId}/wlans/{id}

Use this API command to modify entire information of a WLAN.

Request
HideShow
Body
{
  "name": "wlanName",
  "ssid": "wlanSSID",
  "description": "wlanDescription",
  "accessTunnelType": "SoftGRE",
  "accessTunnelProfile": {
    "id": "1fee12a1-ef8e-11e7-8d6f-08002748d78e",
    "name": "softGre1"
  },
  "splitTunnelProfileId": "38119bac-49e1-4410-ab8e-1c1bc88dd770",
  "macAuth": {
    "macAuthMacFormat": "802.1X",
    "customizedPassword": "password"
  },
  "encryption": {
    "method": "WPA2",
    "algorithm": "AES",
    "passphrase": "password",
    "mfp": "disabled",
    "support80211rEnabled": true,
    "mobilityDomainId": 3
  },
  "authServiceOrProfile": {
    "throughController": true,
    "id": "authServiceUUID",
    "locationDeliveryEnabled": true,
    "authenticationOption": null
  },
  "operatorRealm": "operator realm",
  "accountingServiceOrProfile": {
    "throughController": false,
    "id": "accountingServiceUUID",
    "name": "accountingServiceName",
    "interimUpdateMin": 10,
    "accountingDelayEnabled": false,
    "backupAccountingId": "otherAccountingServiceUUID",
    "backupAccountingName": "otherAccountingServiceName"
  },
  "portalServiceProfile": {
    "id": "portalServiceUUID",
    "name": "portalServiceName"
  },
  "hotspot20Profile": {
    "id": "hotspot20ServiceUUID",
    "name": "hotspot20ServiceName"
  },
  "defaultUserTrafficProfile": {
    "id": "userTrafficUUID",
    "name": "userTrafficName"
  },
  "precedenceProfileId": "c514d450-c839-9527-afc9-525400d12345",
  "schedule": {
    "type": "Customized",
    "id": "ServiceUUID",
    "name": "ServiceName"
  },
  "vlan": {
    "accessVlan": 23,
    "aaaVlanOverride": true,
    "vlanpooling": null
  },
  "l2ACL": {
    "id": "l2ACLUUID",
    "name": "l2ACLName"
  },
  "devicePolicy": {
    "id": "devicePolicyUUID",
    "name": "devicePolicyName"
  },
  "radiusOptions": {
    "nasIdType": "Customized",
    "customizedNasId": "nasId",
    "nasRequestTimeoutSec": 12,
    "nasMaxRetry": 3,
    "nasReconnectPrimaryMin": 30,
    "calledStaIdType": "WLAN_BSSID",
    "nasIpType": "disabled",
    "nasIpUserDefined": "192.168.1.1",
    "singleSessionIdAcctEnabled": false,
    "vendorSpecificAttributeProfileId": "6d767421-d1b7-11e8-8ab9-ba2343155a93"
  },
  "advancedOptions": {
    "clientIsolationEnabled": true,
    "clientIsolationUnicastEnabled": true,
    "clientIsolationMulticastEnabled": false,
    "clientIsolationAutoVrrpEnabled": false,
    "clientIsolationWhitelist": {
      "id": "24f24c00-0b47-11e4-a9b5-000c29b1347d",
      "name": "myWhitelist"
    },
    "priority": "High",
    "hideSsidEnabled": true,
    "maxClientsPerRadio": 12,
    "clientIdleTimeoutSec": 12,
    "clientLoadBalancingEnabled": true,
    "proxyARPEnabled": true,
    "support80211dEnabled": false,
    "support80211kEnabled": true,
    "antiSpoofingEnabled": true,
    "arpRequestRateLimit": 15,
    "dhcpRequestRateLimit": 15,
    "forceClientDHCPTimeoutSec": 5,
    "dhcp82SubOpt1Format": "SUBOPT1_AP_INFO_LOCATION",
    "unauthClientStatsEnabled": false,
    "clientFingerprintingEnabled": true,
    "ofdmOnlyEnabled": false,
    "bandBalancing": "UseZoneSetting",
    "bssMinRateMbps": "Disable",
    "mgmtTxRateMbps": "2 mbps",
    "uplinkEnabled": false,
    "downlinkEnabled": false,
    "avcEnabled": true,
    "urlFilteringPolicyEnabled": false,
    "urlFilteringPolicyId": "",
    "wifiCallingPolicyEnabled": false,
    "wifiCallingPolicyIds": [],
    "hdOverheadOptimizeEnable": false,
    "probeRssiThr": -85,
    "transientClientMgmtEnable": true,
    "joinIgnoreTimeout": 30,
    "joinAcceptTimeout": 300,
    "joinIgnoreThr": 10,
    "authRssiThr": -85,
    "assocRssiThr": -85
  },
  "diffServProfile": {
    "id": "diffServId",
    "name": "diffServName"
  },
  "qosMaps": [
    {
      "enable": true,
      "priority": 0,
      "low": 0,
      "high": 7,
      "excepts": null
    },
    {
      "enable": true,
      "priority": 1,
      "low": 8,
      "high": 15,
      "excepts": null
    },
    {
      "enable": true,
      "priority": 2,
      "low": 16,
      "high": 23,
      "excepts": null
    },
    {
      "enable": true,
      "priority": 3,
      "low": 0,
      "high": 32,
      "excepts": [
        43,
        45,
        60
      ]
    },
    {
      "enable": true,
      "priority": 4,
      "low": 32,
      "high": 39,
      "excepts": null
    },
    {
      "enable": true,
      "priority": 5,
      "low": 40,
      "high": 47,
      "excepts": null
    },
    {
      "enable": true,
      "priority": 6,
      "low": 48,
      "high": 55,
      "excepts": [
        46
      ]
    },
    {
      "enable": true,
      "priority": 7,
      "low": 56,
      "high": 63,
      "excepts": null
    }
  ],
  "dpsk": {
    "dpskEnabled": true,
    "length": 8,
    "dpskType": "Secure",
    "expiration": "OneDay",
    "dpskFromType": "FirstUse"
  },
  "timeboundWhitelist": {
    "list": [
      {
        "id": "OAuth authServiceUUID",
        "name": "authServiceName"
      }
    ]
  },
  "externalDpsk": {
    "enabled": true,
    "encryption": {
      "method": "WPA2",
      "algorithm": "AES"
    },
    "authService": {
      "id": "authServiceUUID"
    }
  }
}
Schema
{
    "additionalProperties" : false,
    "properties" : {
        "accessTunnelType" : {
            "description" : "Access tunnel type of the WLAN. APLBO means AP local breakout, and SoftGRE means AP direct SoftGRE tunnel",
            "type" : "string",
            "enum" : [ "APLBO", "RuckusGRE", "SoftGRE" ]
        },
        "accountingServiceOrProfile" : {
            "description" : "Accounting of the WLAN",
            "additionalProperties" : false,
            "properties" : {
                "accountingDelayEnabled" : {
                    "description" : "Indicates whether accounting delay time is enabled",
                    "type" : "boolean"
                },
                "id" : {
                    "description" : "Accounting service or profile ID. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "interimUpdateMin" : {
                    "description" : "Interval (in minutes) for sending interim updates",
                    "maximum" : 1440,
                    "minimum" : 0,
                    "type" : "integer"
                },
                "name" : {
                    "description" : "Accounting service or profile name. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "throughController" : {
                    "description" : "Indicates whether accounting messages were sent through the controller",
                    "type" : "boolean"
                },
                "realmBasedAcct" : {
                    "type" : "boolean"
                },
                "backupAccountingId" : {
                    "description" : "Backup accounting service or profile ID. At least one backupAccountingId or backupAccountingName is required in the request when setting backup accounting service.",
                    "type" : "string"
                },
                "backupAccountingName" : {
                    "description" : "Backup accounting service or profile name. At least one backupAccountingId or backupAccountingName is required in the request when setting backup accounting service.",
                    "type" : "string"
                }
            },
            "type" : "object"
        },
        "advancedOptions" : {
            "description" : "Advanced settings for the WLAN.",
            "additionalProperties" : false,
            "properties" : {
                "avcEnabled" : {
                    "description" : "Indicator of whether AVC support is enabled or disabled",
                    "type" : "boolean"
                },
                "bandBalancing" : {
                    "description" : "Indicates whether band balancing is enabled or disabled",
                    "type" : "string",
                    "enum" : [ "Disabled", "UseZoneSetting" ]
                },
                "bssMinRateMbps" : {
                    "description" : "BSS minimum rate (mbps)",
                    "type" : "string",
                    "enum" : [ "Disable", "1 mbps", "2 mbps", "5.5 mbps", "12 mbps", "24 mbps" ]
                },
                "clientFingerprintingEnabled" : {
                    "description" : "Indicates whether client fingerprinting is enabled or disabled",
                    "type" : "boolean"
                },
                "clientIdleTimeoutSec" : {
                    "description" : "Client idle timeout in seconds",
                    "maximum" : 1000,
                    "minimum" : 60,
                    "type" : "integer"
                },
                "clientIsolationEnabled" : {
                    "description" : "Indicates whether wireless client isolation is enabled or disabled",
                    "type" : "boolean"
                },
                "clientIsolationUnicastEnabled" : {
                    "description" : "Indicates whether isolate unicast of wireless client isolation is enabled or disabled",
                    "type" : "boolean"
                },
                "clientIsolationMulticastEnabled" : {
                    "description" : "Indicates whether isolate multicast of wireless client isolation is enabled or disabled",
                    "type" : "boolean"
                },
                "clientIsolationAutoVrrpEnabled" : {
                    "description" : "Indicates whether Automatic support for VRRP of wireless client isolation is enabled or disabled",
                    "type" : "boolean"
                },
                "clientIsolationWhitelist" : {
                    "description" : "Indicates wireless client isolation whitelist",
                    "type" : [ "object", "null" ],
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string"
                        }
                    }
                },
                "clientLoadBalancingEnabled" : {
                    "description" : "Indicates whether Client Load Balancing is enabled or disabled",
                    "type" : "boolean"
                },
                "dgafEnabled" : {
                    "description" : "Indicates whether dgaf is enabled or disabled",
                    "type" : "boolean"
                },
                "dhcp82Format" : {
                    "description" : "DHCP Option 82 format. This variable no longer supports from v8_1 and only kept for backward compatibility.",
                    "type" : "string",
                    "enum" : [ "RUCKUS_DEFAULT", "SOFTGRE_CUSTOMIZED" ]
                },
                "dhcpOption82Enabled" : {
                    "description" : "Indicates whether DCHP Option 82 is enabled or disabled. This variable no longer supports from v8_1 and only kept for backward compatibility.",
                    "type" : "boolean"
                },
                "dhcp82SubOpt1Format" : {
                    "description" : "Subopt-1 format",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT1_AP_INFO_LOCATION", "SUBOPT1_AP_INFO", "SUBOPT1_AP_MAC_ESSID_PRIVACYTYPE", "SUBOPT1_AP_MAC_hex", "SUBOPT1_AP_MAC_hex_ESSID", "SUBOPT1_ESSID" ]
                },
                "dhcp82SubOpt2Format" : {
                    "description" : "Subopt-2 format",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT2_CLIENT_MAC", "SUBOPT2_CLIENT_MAC_hex", "SUBOPT2_CLIENT_MAC_hex_ESSID", "SUBOPT2_AP_MAC", "SUBOPT2_AP_MAC_hex", "SUBOPT2_AP_MAC_hex_ESSID" ]
                },
                "dhcp82SubOpt150Format" : {
                    "description" : "Subopt-150 with VLAN-Id",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT150_VLAN_ID" ]
                },
                "dhcp82SubOpt151Format" : {
                    "description" : "Subopt-151 format",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT151_AREA_NAME", "SUBOPT151_ESSID" ]
                },
                "dhcp82SubOpt151AreaName" : {
                    "description" : "Subopt-151 Area Name value",
                    "type" : "string"
                },
                "downlinkEnabled" : {
                    "description" : "SSID Rate Limiting downlink enabled.",
                    "type" : "boolean"
                },
                "downlinkRate" : {
                    "description" : "SSID Rate Limiting downlink.",
                    "type" : "number"
                },
                "antiSpoofingEnabled" : {
                    "description" : "Anti-Spoofing enabled",
                    "type" : "boolean"
                },
                "arpRequestRateLimit" : {
                    "description" : "ARP packets request rate limit, default value will be 15 if both rate limit not being set.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 100
                },
                "dhcpRequestRateLimit" : {
                    "description" : "DHCP packets request rate limit, default value will be 15 if both rate limit not being set.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 100
                },
                "forceClientDHCPTimeoutSec" : {
                    "description" : "Force DHCP disconnects the client if the client does not obtain a valid IP address within the timeout peroid. To disable force DHCP, set this value to zero (0).",
                    "type" : "integer",
                    "enum" : [ 0, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15 ]
                },
                "hideSsidEnabled" : {
                    "description" : "Indicates whether the SSID is hidden or broadcast",
                    "type" : "boolean"
                },
                "hs20Onboarding" : {
                    "description" : "Allow WISPr WLAN for Hotspot 2.0 Onboarding",
                    "type" : "boolean"
                },
                "maxClientsPerRadio" : {
                    "description" : "Maximum number of clients per radio",
                    "maximum" : 512,
                    "minimum" : 1,
                    "type" : "integer"
                },
                "mgmtTxRateMbps" : {
                    "description" : "Management TX rate (mbps)",
                    "type" : "string",
                    "enum" : [ "1 mbps", "2 mbps", "5.5 mbps", "6 mbps", "9 mbps", "11 mbps", "12 mbps", "18 mbps", "24 mbps", "36 mbps", "48 mbps", "54 mbps" ]
                },
                "ofdmOnlyEnabled" : {
                    "description" : "Indicates whether OFDM only is enabled or disabled",
                    "type" : "boolean"
                },
                "okcEnabled" : {
                    "description" : "Indicator of whether OKC support is enabled or disabled. The default value is true when the WLAN is WPA+AES non open WLAN.",
                    "type" : "boolean"
                },
                "pmkCachingEnabled" : {
                    "description" : "Indicator of whether PKM caching support is enabled or disabled. The default value is true when the WLAN is WPA+AES non open WLAN.",
                    "type" : "boolean"
                },
                "priority" : {
                    "description" : "Priority of the WLAN",
                    "type" : "string",
                    "enum" : [ "High", "Low" ]
                },
                "proxyARPEnabled" : {
                    "description" : "Indicates whether proxy ARP is enabled or disabled",
                    "type" : "boolean"
                },
                "ndProxyEnabled" : {
                    "description" : "Indicates whether ND Proxy is enabled or disabled",
                    "type" : "boolean"
                },
                "suppressNsEnabled" : {
                    "description" : "Indicates whether supperssNS is enabled or disabled",
                    "type" : "boolean"
                },
                "raProxyEnabled" : {
                    "description" : "Indicates whether RA proxy is enabled or disabled",
                    "type" : "boolean"
                },
                "rsraGuardEnabled" : {
                    "description" : "Indicates whether RS/RA Guard is enabled or disabled",
                    "type" : "boolean"
                },
                "raThrottlingEnabled" : {
                    "description" : "Indicates whether RA Throttling is enabled or disabled",
                    "type" : "boolean"
                },
                "maxAllowedRA" : {
                    "description" : "Max Allowed RAs",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 1440
                },
                "raInterval" : {
                    "description" : "A timer that RA proxy runs and once receives unsolicited RA checks against the configured time and allow/drop RA based on next timeout",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 256
                },
                "support80211dEnabled" : {
                    "description" : "Indicates whether support for 802.11d is enabled or disabled",
                    "type" : "boolean"
                },
                "support80211kEnabled" : {
                    "description" : "Indicates whether support for 802.11k is enabled or disabled",
                    "type" : "boolean"
                },
                "unauthClientStatsEnabled" : {
                    "description" : "Indicates whether to send statistics of unauthorized clients or not",
                    "type" : "boolean"
                },
                "uplinkEnabled" : {
                    "description" : "SSID Rate Limiting uplink enabled.",
                    "type" : "boolean"
                },
                "uplinkRate" : {
                    "description" : "SSID Rate Limiting uplink.",
                    "type" : "number"
                },
                "ratePerSTAUplink" : {
                    "description" : "UE Rate Limiting uplink.",
                    "type" : "string"
                },
                "ratePerSTADownlink" : {
                    "description" : "UE Rate Limiting downlink.",
                    "type" : "string"
                },
                "dtimInterval" : {
                    "description" : "DTIM Interval",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 255
                },
                "directedThreshold" : {
                    "description" : "Directed Threshold Setting, Defines the client count at which an AP will stop converting group addressed data traffic to unicast.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 128
                },
                "flowLogEnabled" : {
                    "description" : "Flow log enabled.",
                    "type" : "boolean"
                },
                "hdOverheadOptimizeEnable" : {
                    "description" : "Airtime Decongestion enabled.",
                    "type" : "boolean"
                },
                "probeRssiThr" : {
                    "description" : "Join RSSI threshold.",
                    "type" : "integer",
                    "minimum" : -90,
                    "maximum" : -60
                },
                "transientClientMgmtEnable" : {
                    "description" : "Transient Client Management enabled.",
                    "type" : "boolean"
                },
                "joinIgnoreTimeout" : {
                    "description" : "Join wait time.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 60
                },
                "joinAcceptTimeout" : {
                    "description" : "Join expire time.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 300
                },
                "joinIgnoreThr" : {
                    "description" : "Join wait threshold.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 50
                },
                "dropRandomProbesEnabled" : {
                    "description" : "Drop Random Probes enabled.",
                    "type" : "boolean"
                },
                "authRssiThr" : {
                    "description" : "Auth RSSI threshold.",
                    "type" : "integer",
                    "minimum" : -90,
                    "maximum" : -60
                },
                "assocRssiThr" : {
                    "description" : "Assoc RSSI threshold.",
                    "type" : "integer",
                    "minimum" : -90,
                    "maximum" : -60
                },
                "oceEnabled" : {
                    "description" : "Optimized Connectivity Experience(OCE) enabled.",
                    "type" : "boolean"
                },
                "oceBroadcastProbeResponseDelay" : {
                    "description" : "Broadcast probe response delay.",
                    "type" : "integer",
                    "minimum" : 8,
                    "maximum" : 120
                },
                "oceRssiBasedAssociationRejectionThreshold" : {
                    "description" : "RSSI-based association rejection threshold.",
                    "type" : "integer",
                    "minimum" : -90,
                    "maximum" : -60
                }
            },
            "type" : "object"
        },
        "authServiceOrProfile" : {
            "description" : "Authentication of the WLAN",
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "description" : "Identifier of the authentication service or profile. At least one ID or name or authenticationOption is required in the request.",
                    "type" : "string"
                },
                "locationDeliveryEnabled" : {
                    "description" : "RFC5580 location delivery support",
                    "type" : "boolean"
                },
                "realmBasedAuth" : {
                    "type" : "boolean"
                },
                "name" : {
                    "description" : "Name of the authentication service or profile. At least one ID or name or authenticationOption is required in the request. Or could input the 'Always Accept' or 'Local DB'.",
                    "type" : "string"
                },
                "authenticationOption" : {
                    "description" : "Option of the authentication service or profile, At least one ID or name or authenticationOption is required in the request. This only applies to hotspot and guest WLANs.",
                    "type" : "string",
                    "enum" : [ "Local DB", "Guest", "Always Accept", null ]
                },
                "throughController" : {
                    "description" : "Indicates whether authentication messages were sent through the controller or not",
                    "type" : "boolean"
                },
                "backupAuthenticationId" : {
                    "description" : "Identifier of the backup authentication service or profile. At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service.",
                    "type" : "string"
                },
                "backupAuthenticationName" : {
                    "description" : "Name of the backup authentication service or profile. At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service. Or could input the 'Always Accept'.",
                    "type" : "string"
                },
                "backupAuthenticationOption" : {
                    "description" : "Option of the backup authentication service or profile, At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service. This only applies to hotspot WLANs.",
                    "type" : "string",
                    "enum" : [ "Always Accept", null ]
                }
            },
            "type" : "object"
        },
        "bypassCNA" : {
            "description" : "Bypass Capitive Network Assitance",
            "type" : "boolean"
        },
        "coreTunnelProfile" : {
            "description" : "Core tunnel of the WLAN. This only applies when the access tunnel type is set to RuckusGRE.",
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "description" : "Identifier of the forwarding profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the forwarding profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "type" : {
                    "description" : "Tunnel type",
                    "type" : "string",
                    "enum" : [ "Bridge" ]
                }
            },
            "required" : [ "type" ],
            "type" : "object"
        },
        "defaultUserTrafficProfile" : {
            "description" : "User traffic profile of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "precedenceProfileId" : {
            "description" : "Precedence profile of the WLAN",
            "type" : "string"
        },
        "flexiVpnProfile" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "zoneAffinityId" : {
                    "type" : "string",
                    "description" : "Zone Affinity ID"
                }
            },
            "required" : [ "zoneAffinityId" ]
        },
        "description" : {
            "description" : "Description of the WLAN",
            "type" : [ "string", "null" ],
            "maxLength" : 64
        },
        "devicePolicy" : {
            "description" : "Device policy of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "diffServProfile" : {
            "description" : "DiffServ profile of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "dnsServerProfile" : {
            "description" : "DNS server profile of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "dpsk" : {
            "description" : "DPSK Setting",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "dpskEnabled" : {
                    "description" : "DPSK enabled",
                    "type" : "boolean"
                },
                "length" : {
                    "description" : "Length of DPSK key",
                    "type" : "integer"
                },
                "dpskType" : {
                    "description" : "Type of DPSK key",
                    "type" : "string",
                    "enum" : [ "Secure", "KeyboardFriendly", "NumbersOnly" ]
                },
                "expiration" : {
                    "description" : "Expiration of DPSK key",
                    "type" : "string",
                    "enum" : [ "Unlimited", "OneDay", "TwoDays", "OneWeek", "TwoWeeks", "OneMonth", "SixMonths", "OneYear", "TwoYears" ]
                },
                "dpskFromType" : {
                    "description" : "Type of expiration start from",
                    "type" : "string",
                    "enum" : [ "CreateTime", "FirstUse" ]
                }
            }
        },
        "externalDpsk" : {
            "description" : "External DPSK Enabled",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "enabled" : {
                    "description" : "Enable External DPSK",
                    "type" : "boolean"
                },
                "encryption" : {
                    "description" : "Encryption of the WLAN relate to external DPSK",
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "method" : {
                            "description" : "Encryption method",
                            "type" : "string",
                            "enum" : [ "WPA2", "WPA_Mixed", "None" ]
                        },
                        "algorithm" : {
                            "description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
                            "type" : "string",
                            "enum" : [ "AES", "TKIP_AES" ]
                        }
                    }
                },
                "authService" : {
                    "description" : "Autentication of the WLAN relate to external DPSK",
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "description" : "Identifier of the authentication service. At least one ID or name is required in the request.",
                            "type" : "string"
                        },
                        "name" : {
                            "description" : "Name of the authentication service. At least one ID or name is required in the request.",
                            "type" : "string"
                        }
                    }
                }
            },
            "required" : [ "enabled" ]
        },
        "encryption" : {
            "description" : "Encryption of the WLAN",
            "additionalProperties" : false,
            "properties" : {
                "algorithm" : {
                    "description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
                    "type" : "string",
                    "enum" : [ "AES", "TKIP_AES" ]
                },
                "keyInHex" : {
                    "description" : "Key in hex format. This only applies to WEP64 and WEP128.",
                    "type" : "string"
                },
                "keyIndex" : {
                    "description" : "Key index. This only applies to WEP64 and WEP128.",
                    "type" : "integer"
                },
                "method" : {
                    "description" : "Encryption method",
                    "type" : "string",
                    "enum" : [ "WPA2", "WPA_Mixed", "WEP_64", "WEP_128", "None" ]
                },
                "mfp" : {
                    "description" : "Management frame protection. This only applies to WPA2 + AES",
                    "type" : "string",
                    "enum" : [ "disabled", "capable", "required" ]
                },
                "mobilityDomainId" : {
                    "description" : "mobility Domain Id.",
                    "maximum" : 65535,
                    "minimum" : 1,
                    "type" : "integer"
                },
                "passphrase" : {
                    "description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
                    "type" : "string"
                },
                "support80211rEnabled" : {
                    "description" : "Enable 802.11r Fast BSS Transition, fast Romaing.",
                    "type" : "boolean"
                }
            },
            "required" : [ "method" ],
            "type" : "object"
        },
        "hessid" : {
            "description" : "HESSID of the WLAN",
            "pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$",
            "type" : "string"
        },
        "hotspot20Profile" : {
            "description" : "Hotspot 2.0 operator profile of the WLAN. id or name of the hotspot 2.0 operator profiles within the zone is required.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "l2ACL" : {
            "description" : "Layer 2 ACL of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "macAuth" : {
            "description" : "MAC address authentication settings of the WLAN. This only applies to standard MAC and Hotspot MAC bypass WLAN.",
            "additionalProperties" : false,
            "properties" : {
                "customizedPassword" : {
                    "description" : "User defined password. When this field is set to an empty string, the MAC address is used as password.",
                    "maxLength" : 64,
                    "pattern" : "^([!-;=?-~]([ -;=?-~]){0,62}[!-;=?-~]|[!-;=?-~]{1,1}|\s{0,0})$",
                    "type" : "string"
                },
                "macAuthMacFormat" : {
                    "description" : "MAC address format. The default format is 0010a42319c0 and the 802.1X format is 00-10-A4-23-19-C0.",
                    "type" : "string",
                    "enum" : [ "Default", "802.1X", "UpperColon", "Upper", "LowerDash", "LowerColon" ]
                }
            },
            "type" : "object"
        },
        "name" : {
            "description" : "Name of the WLAN",
            "type" : "string",
            "minLength" : 1,
            "maxLength" : 32
        },
        "operatorRealm" : {
            "description" : "Operator realm, operatorRealm only supports coreTunnelProfile type is PMIP or authServiceOrProfile.locationDeliveryEnabled is true",
            "type" : "string",
            "maxLength" : 255,
            "pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
        },
        "portalServiceProfile" : {
            "description" : "Portal service of the WLAN. This only applies to hotspot, hotspot MAC bypass, guest and web auth WLANs.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "qosMaps" : {
            "description" : "Qos map set of the WLAN.",
            "items" : {
                "additionalProperties" : false,
                "properties" : {
                    "enable" : {
                        "description" : "Enabled or disabled",
                        "type" : "boolean"
                    },
                    "excepts" : {
                        "items" : {
                            "maximum" : 63,
                            "minimum" : 0,
                            "type" : "integer"
                        },
                        "type" : [ "array", "null" ]
                    },
                    "high" : {
                        "description" : "DSCP range - high",
                        "maximum" : 255,
                        "minimum" : 0,
                        "type" : [ "integer", "null" ]
                    },
                    "low" : {
                        "description" : "DSCP range - low",
                        "maximum" : 255,
                        "minimum" : 0,
                        "type" : [ "integer", "null" ]
                    },
                    "priority" : {
                        "description" : "Priority",
                        "type" : "integer"
                    }
                },
                "required" : [ "enable", "priority" ],
                "type" : "object"
            },
            "type" : "array"
        },
        "radiusOptions" : {
            "description" : "RADIUS options of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "calledStaIdType" : {
                    "description" : "Called station ID type",
                    "type" : "string",
                    "enum" : [ "AP_MAC", "NONE", "WLAN_BSSID" ]
                },
                "customizedNasId" : {
                    "description" : "User defined NAS ID",
                    "maxLength" : 64,
                    "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                    "type" : "string"
                },
                "nasIdType" : {
                    "description" : "NAS ID type",
                    "type" : "string",
                    "enum" : [ "AP_MAC", "Customized", "WLAN_BSSID" ]
                },
                "nasMaxRetry" : {
                    "description" : "NAS request maximum retry",
                    "maximum" : 10,
                    "minimum" : 2,
                    "type" : "integer"
                },
                "nasReconnectPrimaryMin" : {
                    "description" : "NAS reconnect primary time in minutes",
                    "maximum" : 60,
                    "minimum" : 1,
                    "type" : "integer"
                },
                "nasRequestTimeoutSec" : {
                    "description" : "NAS request timeout in seconds",
                    "maximum" : 20,
                    "minimum" : 2,
                    "type" : "integer"
                },
                "nasIpType" : {
                    "description" : "NAS IP type",
                    "type" : "string",
                    "enum" : [ "disabled", "control", "management", "userDefined" ]
                },
                "nasIpUserDefined" : {
                    "description" : "User-defined NAS IP",
                    "type" : "string",
                    "maxLength" : 45
                },
                "singleSessionIdAcctEnabled" : {
                    "description" : "When Single Accounting Session ID is enabled, APs will maintain one accounting session for client roaming",
                    "type" : "boolean"
                },
                "vendorSpecificAttributeProfileId" : {
                    "description" : "Vendor Specific Attribute Profile ID",
                    "type" : "string"
                }
            }
        },
        "schedule" : {
            "description" : "Schedule of the WLAN",
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "description" : "Identifier of the schedule profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the schedule profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "type" : {
                    "description" : "Type of WLAN schedule",
                    "type" : "string",
                    "enum" : [ "AlwaysOn", "AlwaysOff", "Customized" ]
                }
            },
            "required" : [ "type" ],
            "type" : "object"
        },
        "ssid" : {
            "description" : "SSID of the WLAN",
            "type" : "string",
            "minLength" : 1,
            "maxLength" : 32
        },
        "timeboundWhitelist" : {
            "description" : "Hotspot timeboundWhitelist. The ID of the OAuth Authentication service is required.",
            "additionalProperties" : false,
            "properties" : {
                "firstIndex" : {
                    "type" : "integer"
                },
                "hasMore" : {
                    "type" : "boolean"
                },
                "list" : {
                    "items" : {
                        "type" : [ "object", "null" ],
                        "additionalProperties" : false,
                        "properties" : {
                            "id" : {
                                "type" : "string"
                            },
                            "name" : {
                                "type" : "string"
                            }
                        }
                    },
                    "type" : "array"
                },
                "totalCount" : {
                    "type" : "integer"
                }
            },
            "type" : "object"
        },
        "vlan" : {
            "description" : "VLAN (access and/or core) of the WLAN.",
            "additionalProperties" : false,
            "properties" : {
                "aaaVlanOverride" : {
                    "description" : "Indicates whether the AAA VLAN settings can be overriden or not",
                    "type" : "boolean"
                },
                "accessVlan" : {
                    "description" : "Access VLAN ID",
                    "maximum" : 4094,
                    "minimum" : 1,
                    "type" : "integer"
                },
                "vlanPooling" : {
                    "description" : "Vlan pooling",
                    "type" : [ "object", "null" ],
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string"
                        }
                    }
                }
            },
            "type" : "object"
        },
        "accessTunnelProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "accessIpsecProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "splitTunnelProfileId" : {
            "type" : "string"
        }
    },
    "type" : "object"
}
Response  204

Enable Qos Map Set

POST/v8_1/rkszones/{zoneId}/wlans/{id}/qosMaps

Use this API command to enable Qos Map Set of a WLAN.

Response  201

Retrieve

GET/v8_1/rkszones/{zoneId}/wlans/{id}

Use this API command to retrieve a WLAN.

Response  200
HideShow
Body
{
  "id": "1027",
  "zoneId": "21a18b1c-e260-48c8-866c-69e66c81368e",
  "name": "wlan1",
  "ssid": "wlan1",
  "description": "",
  "type": "Standard_Open",
  "encryption": {
    "method": "None"
  },
  "macAuth": null,
  "authServiceOrProfile": null,
  "operatorRealm": null,
  "accountingServiceOrProfile": {
    "throughController": false,
    "id": "accountingServiceUUID",
    "name": "accountingServiceName",
    "interimUpdateMin": 10,
    "accountingDelayEnabled": false,
    "accountingTTGSessionEnabled": false,
    "backupAccountingId": "otherAccountingServiceUUID",
    "backupAccountingName": "otherAccountingServiceName"
  },
  "accessTunnelType": "APLBO",
  "portalServiceProfile": null,
  "hotspot20Profile": null,
  "defaultUserTrafficProfile": {
    "id": "24f24c00-0b47-11e4-a9b5-000c29b1347d",
    "name": "Factory Default"
  },
  "precedenceProfileId": "ca1edc50-c839-11e6-afc9-525400da2f0d",
  "l2ACL": null,
  "devicePolicy": null,
  "vlan": {
    "accessVlan": null,
    "aaaVlanOverride": false,
    "vlanpooling": {
      "id": "0b8d4e50-167a-11e6-97a5-56847afe9799",
      "name": "X27s"
    }
  },
  "schedule": {
    "id": null,
    "name": null,
    "type": "AlwaysOn"
  },
  "radiusOptions": {
    "nasIdType": "WLAN_BSSID",
    "customizedNasId": null,
    "nasRequestTimeoutSec": 3,
    "nasMaxRetry": 2,
    "nasReconnectPrimaryMin": 5,
    "calledStaIdType": "WLAN_BSSID",
    "nasIpType": "disabled",
    "nasIpUserDefined": "192.168.1.1",
    "vendorSpecificAttributeProfileId": "6d767421-d1b7-11e8-8ab9-ba2343155a93"
  },
  "advancedOptions": {
    "uplinkEnabled": false,
    "downlinkEnabled": false,
    "clientIsolationEnabled": true,
    "clientIsolationUnicastEnabled": true,
    "clientIsolationMulticastEnabled": false,
    "clientIsolationAutoVrrpEnabled": false,
    "clientIsolationWhitelist": {
      "id": "24f24c00-0b47-11e4-a9b5-000c29b1347d",
      "name": "myWhitelist"
    },
    "priority": "High",
    "hideSsidEnabled": true,
    "clientLoadBalancingEnabled": true,
    "proxyARPEnabled": false,
    "dgafEnabled": null,
    "maxClientsPerRadio": 100,
    "support80211dEnabled": false,
    "support80211kEnabled": true,
    "antiSpoofingEnabled": true,
    "arpRequestRateLimit": 15,
    "dhcpRequestRateLimit": 15,
    "forceClientDHCPTimeoutSec": 5,
    "dhcp82SubOpt1Format": "SUBOPT1_AP_INFO_LOCATION",
    "unauthClientStatsEnabled": false,
    "clientIdleTimeoutSec": 120,
    "clientFingerprintingEnabled": false,
    "ofdmOnlyEnabled": false,
    "bssMinRateMbps": "Disable",
    "mgmtTxRateMbps": "2 mbps",
    "avcEnabled": true,
    "urlFilteringPolicyEnabled": false,
    "urlFilteringPolicyId": "",
    "wifiCallingPolicyEnabled": false,
    "wifiCallingPolicyIds": [],
    "bandBalancing": "UseZoneSetting"
  },
  "qosMaps": [
    {
      "enable": true,
      "priority": 0,
      "low": 0,
      "high": 7,
      "excepts": null
    },
    {
      "enable": true,
      "priority": 1,
      "low": 8,
      "high": 15,
      "excepts": null
    },
    {
      "enable": true,
      "priority": 2,
      "low": 16,
      "high": 23,
      "excepts": null
    },
    {
      "enable": true,
      "priority": 3,
      "low": 0,
      "high": 32,
      "excepts": [
        43,
        45,
        60
      ]
    },
    {
      "enable": true,
      "priority": 4,
      "low": 32,
      "high": 39,
      "excepts": null
    },
    {
      "enable": true,
      "priority": 5,
      "low": 40,
      "high": 47,
      "excepts": null
    },
    {
      "enable": true,
      "priority": 6,
      "low": 48,
      "high": 55,
      "excepts": [
        46
      ]
    },
    {
      "enable": true,
      "priority": 7,
      "low": 56,
      "high": 63,
      "excepts": null
    }
  ],
  "dpsk": {
    "dpskEnabled": true,
    "length": 8,
    "dpskType": "Secure",
    "expiration": "OneDay",
    "dpskFromType": "FirstUse"
  },
  "bssid": [
    "E0:10:7F:28:C9:D8",
    "E0:10:7F:28:C9:DC"
  ]
}
Schema
{
    "additionalProperties" : false,
    "properties" : {
        "accessTunnelType" : {
            "description" : "Access tunnel type of the WLAN. APLBO means AP local breakout, SoftGRE means AP direct SoftGRE tunnel",
            "type" : "string",
            "enum" : [ "APLBO", "RuckusGRE", "SoftGRE" ]
        },
        "accountingServiceOrProfile" : {
            "description" : "Accounting of the WLAN",
            "additionalProperties" : false,
            "properties" : {
                "accountingDelayEnabled" : {
                    "description" : "Indicates whether accounting delay time is enabled",
                    "type" : "boolean"
                },
                "id" : {
                    "description" : "Accounting service or profile ID. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "interimUpdateMin" : {
                    "description" : "Interval (in minutes) for sending interim updates",
                    "maximum" : 1440,
                    "minimum" : 0,
                    "type" : "integer"
                },
                "name" : {
                    "description" : "Accounting service or profile name. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "throughController" : {
                    "description" : "Indicates whether accounting messages were sent through the controller",
                    "type" : "boolean"
                },
                "realmBasedAcct" : {
                    "type" : "boolean"
                },
                "backupAccountingId" : {
                    "description" : "Backup accounting service or profile ID. At least one backupAccountingId or backupAccountingName is required in the request when setting backup accounting service.",
                    "type" : "string"
                },
                "backupAccountingName" : {
                    "description" : "Backup accounting service or profile name. At least one backupAccountingId or backupAccountingName is required in the request when setting backup accounting service.",
                    "type" : "string"
                }
            },
            "type" : "object"
        },
        "advancedOptions" : {
            "description" : "Advanced settings for the WLAN.",
            "additionalProperties" : false,
            "properties" : {
                "avcEnabled" : {
                    "default" : false,
                    "description" : "Indicator of whether AVC support is enabled or disabled",
                    "type" : "boolean"
                },
                "bandBalancing" : {
                    "default" : "UseZoneSetting",
                    "description" : "Indicates whether band balancing is enabled or disabled",
                    "type" : "string",
                    "enum" : [ "Disabled", "UseZoneSetting" ]
                },
                "bssMinRateMbps" : {
                    "description" : "BSS minimum rate (mbps)",
                    "type" : "string",
                    "enum" : [ "Disable", "1 mbps", "2 mbps", "5.5 mbps", "12 mbps", "24 mbps" ],
                    "default" : "Disable"
                },
                "clientFingerprintingEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether client fingerprinting is enabled or disabled",
                    "type" : "boolean"
                },
                "clientIdleTimeoutSec" : {
                    "default" : 120,
                    "description" : "Client idle timeout in seconds",
                    "maximum" : 1000,
                    "minimum" : 60,
                    "type" : "integer"
                },
                "clientIsolationEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether wireless client isolation is enabled or disabled",
                    "type" : "boolean"
                },
                "clientIsolationUnicastEnabled" : {
                    "description" : "Indicates whether isolate unicast of wireless client isolation is enabled or disabled",
                    "type" : "boolean",
                    "default" : true
                },
                "clientIsolationMulticastEnabled" : {
                    "description" : "Indicates whether isolate multicast of wireless client isolation is enabled or disabled",
                    "type" : "boolean"
                },
                "clientIsolationAutoVrrpEnabled" : {
                    "description" : "Indicates whether Automatic support for VRRP of wireless client isolation is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "clientIsolationWhitelist" : {
                    "description" : "Indicates wireless client isolation whitelist",
                    "type" : [ "object", "null" ],
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string"
                        }
                    }
                },
                "clientLoadBalancingEnabled" : {
                    "description" : "Indicates whether Client Load Balancing is enabled or disabled",
                    "type" : "boolean",
                    "default" : true
                },
                "dgafEnabled" : {
                    "description" : "Indicates whether dgaf is enabled or disabled",
                    "type" : "boolean"
                },
                "dhcp82Format" : {
                    "description" : "DHCP Option 82 format. This variable no longer supports from v8_1 and only kept for backward compatibility.",
                    "type" : "string",
                    "enum" : [ "RUCKUS_DEFAULT", "SOFTGRE_CUSTOMIZED" ]
                },
                "dhcpOption82Enabled" : {
                    "default" : false,
                    "description" : "Indicates whether DCHP Option 82 is enabled or disabled. This variable no longer supports from v8_1 and only kept for backward compatibility.",
                    "type" : "boolean"
                },
                "dhcp82SubOpt1Format" : {
                    "description" : "Subopt-1 format",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT1_AP_INFO_LOCATION", "SUBOPT1_AP_INFO", "SUBOPT1_AP_MAC_ESSID_PRIVACYTYPE", "SUBOPT1_AP_MAC_hex", "SUBOPT1_AP_MAC_hex_ESSID", "SUBOPT1_ESSID" ]
                },
                "dhcp82SubOpt2Format" : {
                    "description" : "Subopt-2 format",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT2_CLIENT_MAC", "SUBOPT2_CLIENT_MAC_hex", "SUBOPT2_CLIENT_MAC_hex_ESSID", "SUBOPT2_AP_MAC", "SUBOPT2_AP_MAC_hex", "SUBOPT2_AP_MAC_hex_ESSID" ]
                },
                "dhcp82SubOpt150Format" : {
                    "description" : "Subopt-150 with VLAN-Id",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT150_VLAN_ID" ]
                },
                "dhcp82SubOpt151Format" : {
                    "description" : "Subopt-151 format",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT151_AREA_NAME", "SUBOPT151_ESSID" ]
                },
                "dhcp82SubOpt151AreaName" : {
                    "description" : "Subopt-151 Area Name value",
                    "type" : "string"
                },
                "downlinkEnabled" : {
                    "default" : false,
                    "description" : "SSID Rate Limiting downlink enabled.",
                    "type" : "boolean"
                },
                "downlinkRate" : {
                    "description" : "SSID Rate Limiting downlink.",
                    "type" : "number",
                    "default" : 0.0
                },
                "antiSpoofingEnabled" : {
                    "description" : "Anti-Spoofing enabled",
                    "type" : "boolean",
                    "default" : false
                },
                "arpRequestRateLimit" : {
                    "description" : "ARP packets request rate limit, default value will be 15 if both rate limit not being set.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 100
                },
                "dhcpRequestRateLimit" : {
                    "description" : "DHCP packets request rate limit, default value will be 15 if both rate limit not being set.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 100
                },
                "forceClientDHCPTimeoutSec" : {
                    "default" : 0,
                    "description" : "Force DHCP disconnects the client if the client does not obtain a valid IP address within the timeout peroid. To disable force DHCP, set this value to zero (0).",
                    "type" : "integer",
                    "enum" : [ 0, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15 ]
                },
                "hideSsidEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether the SSID is hidden or broadcast",
                    "type" : "boolean"
                },
                "hs20Onboarding" : {
                    "description" : "Allow WISPr WLAN for Hotspot 2.0 Onboarding",
                    "type" : "boolean",
                    "default" : false
                },
                "maxClientsPerRadio" : {
                    "default" : 100,
                    "description" : "Maximum number of clients per radio",
                    "maximum" : 512,
                    "minimum" : 1,
                    "type" : "integer"
                },
                "mgmtTxRateMbps" : {
                    "description" : "Management TX rate (mbps)",
                    "type" : "string",
                    "enum" : [ "1 mbps", "2 mbps", "5.5 mbps", "6 mbps", "9 mbps", "11 mbps", "12 mbps", "18 mbps", "24 mbps", "36 mbps", "48 mbps", "54 mbps" ],
                    "default" : "2 mbps"
                },
                "ofdmOnlyEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether OFDM only is enabled or disabled",
                    "type" : "boolean"
                },
                "okcEnabled" : {
                    "description" : "Indicator of whether OKC support is enabled or disabled. The default value is true when the WLAN is WPA+AES non open WLAN.",
                    "type" : "boolean"
                },
                "pmkCachingEnabled" : {
                    "description" : "Indicator of whether PKM caching support is enabled or disabled. The default value is true when the WLAN is WPA+AES non open WLAN.",
                    "type" : "boolean"
                },
                "priority" : {
                    "default" : "High",
                    "description" : "Priority of the WLAN",
                    "type" : "string",
                    "enum" : [ "High", "Low" ]
                },
                "proxyARPEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether proxy ARP is enabled or disabled",
                    "type" : "boolean"
                },
                "ndProxyEnabled" : {
                    "description" : "Indicates whether ND Proxy is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "suppressNsEnabled" : {
                    "description" : "Indicates whether supperssNS is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "raProxyEnabled" : {
                    "description" : "Indicates whether RA proxy is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "rsraGuardEnabled" : {
                    "description" : "Indicates whether RS/RA Guard is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "raThrottlingEnabled" : {
                    "description" : "Indicates whether RA Throttling is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "maxAllowedRA" : {
                    "description" : "Max Allowed RAs",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 1440,
                    "default" : 10
                },
                "raInterval" : {
                    "description" : "A timer that RA proxy runs and once receives unsolicited RA checks against the configured time and allow/drop RA based on next timeout",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 256,
                    "default" : 10
                },
                "support80211dEnabled" : {
                    "default" : true,
                    "description" : "Indicates whether support for 802.11d is enabled or disabled",
                    "type" : "boolean"
                },
                "support80211kEnabled" : {
                    "default" : true,
                    "description" : "Indicates whether support for 802.11k is enabled or disabled",
                    "type" : "boolean"
                },
                "unauthClientStatsEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether to send statistics of unauthorized clients or not",
                    "type" : "boolean"
                },
                "uplinkEnabled" : {
                    "default" : false,
                    "description" : "SSID Rate Limiting uplink enabled.",
                    "type" : "boolean"
                },
                "uplinkRate" : {
                    "description" : "SSID Rate Limiting uplink.",
                    "type" : "number",
                    "default" : 0.0
                },
                "ratePerSTAUplink" : {
                    "description" : "UE Rate Limiting uplink.",
                    "type" : "string"
                },
                "ratePerSTADownlink" : {
                    "description" : "UE Rate Limiting downlink.",
                    "type" : "string"
                },
                "dtimInterval" : {
                    "description" : "DTIM Interval",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 255,
                    "default" : 1
                },
                "directedThreshold" : {
                    "description" : "Directed Threshold Setting, Defines the client count at which an AP will stop converting group addressed data traffic to unicast.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 128,
                    "default" : 5
                },
                "flowLogEnabled" : {
                    "description" : "Flow log enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "hdOverheadOptimizeEnable" : {
                    "description" : "Airtime Decongestion enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "probeRssiThr" : {
                    "description" : "Join RSSI threshold.",
                    "type" : "integer",
                    "minimum" : -90,
                    "maximum" : -60,
                    "default" : -85
                },
                "transientClientMgmtEnable" : {
                    "description" : "Transient Client Management enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "joinIgnoreTimeout" : {
                    "description" : "Join wait time.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 60,
                    "default" : 30
                },
                "joinAcceptTimeout" : {
                    "description" : "Join expire time.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 300,
                    "default" : 300
                },
                "joinIgnoreThr" : {
                    "description" : "Join wait threshold.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 50,
                    "default" : 10
                },
                "dropRandomProbesEnabled" : {
                    "description" : "Drop Random Probes enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "authRssiThr" : {
                    "description" : "Auth RSSI threshold.",
                    "type" : "integer",
                    "minimum" : -90,
                    "maximum" : -60
                },
                "assocRssiThr" : {
                    "description" : "Assoc RSSI threshold.",
                    "type" : "integer",
                    "minimum" : -90,
                    "maximum" : -60
                },
                "oceEnabled" : {
                    "description" : "Optimized Connectivity Experience(OCE) enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "oceBroadcastProbeResponseDelay" : {
                    "description" : "Broadcast probe response delay.",
                    "type" : "integer",
                    "minimum" : 8,
                    "maximum" : 120,
                    "default" : 15
                },
                "oceRssiBasedAssociationRejectionThreshold" : {
                    "description" : "RSSI-based association rejection threshold.",
                    "type" : "integer",
                    "minimum" : -90,
                    "maximum" : -60,
                    "default" : -75
                }
            },
            "type" : "object"
        },
        "authServiceOrProfile" : {
            "description" : "Autentication of the WLAN",
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "description" : "Identifier of the authentication service or profile. At least one ID or name or authenticationOption is required in the request.",
                    "type" : "string"
                },
                "locationDeliveryEnabled" : {
                    "description" : "RFC5580 location delivery support",
                    "type" : "boolean"
                },
                "realmBasedAuth" : {
                    "type" : "boolean"
                },
                "name" : {
                    "description" : "Name of the authentication service or profile. At least one ID or name or authenticationOption is required in the request. Or could input the 'Always Accept' or 'Local DB'.",
                    "type" : "string"
                },
                "authenticationOption" : {
                    "description" : "Option of the authentication service or profile, At least one ID or name or authenticationOption is required in the request. This only applies to hotspot and guest WLANs.",
                    "type" : "string",
                    "enum" : [ "Local DB", "Guest", "Always Accept", null ]
                },
                "throughController" : {
                    "description" : "Indicates whether authentication messages were sent through the controller or not",
                    "type" : "boolean"
                },
                "backupAuthenticationId" : {
                    "description" : "Identifier of the backup authentication service or profile. At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service.",
                    "type" : "string"
                },
                "backupAuthenticationName" : {
                    "description" : "Name of the backup authentication service or profile. At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service. Or could input the 'Always Accept'.",
                    "type" : "string"
                },
                "backupAuthenticationOption" : {
                    "description" : "Option of the backup authentication service or profile, At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service. This only applies to hotspot WLANs.",
                    "type" : "string",
                    "enum" : [ "Always Accept", null ]
                }
            },
            "type" : "object"
        },
        "bypassCNA" : {
            "description" : "Bypass Capitive Network Assitance",
            "type" : "boolean"
        },
        "coreTunnelProfile" : {
            "description" : "Core tunnel of the WLAN. This only applies when the access tunnel type is set to RuckusGRE.",
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "description" : "Identifier of the forwarding profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the forwarding profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "type" : {
                    "description" : "Tunnel type",
                    "type" : "string",
                    "enum" : [ "Bridge" ]
                }
            },
            "required" : [ "type" ],
            "type" : "object"
        },
        "defaultUserTrafficProfile" : {
            "description" : "User traffic profile of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "precedenceProfileId" : {
            "description" : "Precedence profile of the WLAN",
            "type" : "string"
        },
        "description" : {
            "description" : "Description of the WLAN",
            "type" : "string"
        },
        "devicePolicy" : {
            "description" : "Device policy of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "diffServProfile" : {
            "description" : "DiffServ profile of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "dnsServerProfile" : {
            "description" : "DNS server profile of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "dpsk" : {
            "description" : "DPSK Setting",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "dpskEnabled" : {
                    "description" : "DPSK enabled",
                    "type" : "boolean",
                    "default" : false
                },
                "length" : {
                    "description" : "Length of DPSK key",
                    "type" : "integer",
                    "default" : 62
                },
                "dpskType" : {
                    "description" : "Type of DPSK key",
                    "type" : "string",
                    "enum" : [ "Secure", "KeyboardFriendly", "NumbersOnly" ],
                    "default" : "Secure"
                },
                "expiration" : {
                    "description" : "Expiration of DPSK key",
                    "type" : "string",
                    "enum" : [ "Unlimited", "OneDay", "TwoDays", "OneWeek", "TwoWeeks", "OneMonth", "SixMonths", "OneYear", "TwoYears" ],
                    "default" : "Unlimited"
                },
                "dpskFromType" : {
                    "description" : "Type of expiration start from",
                    "type" : "string",
                    "enum" : [ "CreateTime", "FirstUse" ],
                    "default" : "CreateTime"
                }
            }
        },
        "encryption" : {
            "description" : "Encryption of the WLAN",
            "additionalProperties" : false,
            "properties" : {
                "algorithm" : {
                    "description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
                    "type" : "string",
                    "enum" : [ "AES", "TKIP_AES" ]
                },
                "keyInHex" : {
                    "description" : "Key in hex format. This only applies to WEP64 and WEP128.",
                    "type" : "string"
                },
                "keyIndex" : {
                    "description" : "Key index. This only applies to WEP64 and WEP128.",
                    "type" : "integer"
                },
                "method" : {
                    "description" : "Encryption method",
                    "type" : "string",
                    "enum" : [ "WPA2", "WPA_Mixed", "WEP_64", "WEP_128", "None" ],
                    "default" : "None"
                },
                "mfp" : {
                    "description" : "Management frame protection. This only applies to WPA2 + AES",
                    "type" : "string",
                    "enum" : [ "disabled", "capable", "required" ]
                },
                "mobilityDomainId" : {
                    "description" : "mobility Domain Id.",
                    "maximum" : 65535,
                    "minimum" : 1,
                    "type" : "integer"
                },
                "passphrase" : {
                    "description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
                    "type" : "string"
                },
                "support80211rEnabled" : {
                    "description" : "Enable 802.11r Fast BSS Transition, fast Romaing.",
                    "type" : "boolean"
                }
            },
            "required" : [ "method" ],
            "type" : "object"
        },
        "hessid" : {
            "description" : "HESSID of the WLAN",
            "pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$",
            "type" : "string"
        },
        "hotspot20Profile" : {
            "description" : "Hotspot 2.0 operator profile of the WLAN. id or name of the hotspot 2.0 operator profiles within the zone is required.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "id" : {
            "description" : "Identifier of the WLAN",
            "type" : "string"
        },
        "l2ACL" : {
            "description" : "Layer 2 ACL of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "macAuth" : {
            "description" : "MAC authentication of the WLAN",
            "additionalProperties" : false,
            "properties" : {
                "customizedPassword" : {
                    "description" : "User defined password. When this field is set to an empty string, the MAC address is used as password.",
                    "maxLength" : 64,
                    "pattern" : "^([!-;=?-~]([ -;=?-~]){0,62}[!-;=?-~]|[!-;=?-~]{1,1}|\s{0,0})$",
                    "type" : "string"
                },
                "macAuthMacFormat" : {
                    "description" : "MAC address format. The default format is 0010a42319c0 and the 802.1X format is 00-10-A4-23-19-C0.",
                    "type" : "string",
                    "enum" : [ "Default", "802.1X", "UpperColon", "Upper", "LowerDash", "LowerColon" ]
                }
            },
            "type" : "object"
        },
        "name" : {
            "description" : "Name of the WLAN",
            "type" : "string"
        },
        "operatorRealm" : {
            "description" : "Operator realm, operatorRealm only supports coreTunnelProfile type is PMIP or authServiceOrProfile.locationDeliveryEnabled is true",
            "type" : "string",
            "maxLength" : 255,
            "pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
        },
        "portalServiceProfile" : {
            "description" : "Portal service of the WLAN. This only applies to hotspot, hotspot MAC bypass, guest and web auth WLANs.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "qosMaps" : {
            "description" : "Qos map set of the WLAN.",
            "items" : {
                "additionalProperties" : false,
                "properties" : {
                    "enable" : {
                        "description" : "Enabled or disabled",
                        "type" : "boolean"
                    },
                    "excepts" : {
                        "items" : {
                            "maximum" : 63,
                            "minimum" : 0,
                            "type" : "integer"
                        },
                        "type" : [ "array", "null" ]
                    },
                    "high" : {
                        "description" : "DSCP range - high",
                        "maximum" : 255,
                        "minimum" : 0,
                        "type" : [ "integer", "null" ]
                    },
                    "low" : {
                        "description" : "DSCP range - low",
                        "maximum" : 255,
                        "minimum" : 0,
                        "type" : [ "integer", "null" ]
                    },
                    "priority" : {
                        "description" : "Priority",
                        "type" : "integer"
                    }
                },
                "required" : [ "enable", "priority" ],
                "type" : "object"
            },
            "type" : "array"
        },
        "radiusOptions" : {
            "description" : "RADIUS options of the WLAN.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "calledStaIdType" : {
                    "default" : "WLAN_BSSID",
                    "description" : "Called station ID type",
                    "type" : "string",
                    "enum" : [ "AP_MAC", "NONE", "WLAN_BSSID" ]
                },
                "customizedNasId" : {
                    "description" : "User defined NAS ID",
                    "maxLength" : 64,
                    "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                    "type" : "string"
                },
                "nasIdType" : {
                    "default" : "WLAN_BSSID",
                    "description" : "NAS ID type",
                    "type" : "string",
                    "enum" : [ "AP_MAC", "Customized", "WLAN_BSSID" ]
                },
                "nasMaxRetry" : {
                    "default" : 2,
                    "description" : "NAS request maximum retry",
                    "maximum" : 10,
                    "minimum" : 2,
                    "type" : "integer"
                },
                "nasReconnectPrimaryMin" : {
                    "default" : 5,
                    "description" : "NAS reconnect primary time in minutes",
                    "maximum" : 60,
                    "minimum" : 1,
                    "type" : "integer"
                },
                "nasRequestTimeoutSec" : {
                    "default" : 3,
                    "description" : "NAS request timeout in seconds",
                    "maximum" : 20,
                    "minimum" : 2,
                    "type" : "integer"
                },
                "nasIpType" : {
                    "description" : "NAS IP type",
                    "type" : "string",
                    "enum" : [ "disabled", "control", "management", "userDefined" ],
                    "default" : "disabled"
                },
                "nasIpUserDefined" : {
                    "description" : "User-defined NAS IP",
                    "type" : "string",
                    "maxLength" : 45
                },
                "singleSessionIdAcctEnabled" : {
                    "description" : "When Single Accounting Session ID is enabled, APs will maintain one accounting session for client roaming",
                    "type" : "boolean",
                    "default" : false
                },
                "vendorSpecificAttributeProfileId" : {
                    "description" : "Vendor Specific Attribute Profile ID",
                    "type" : "string"
                }
            }
        },
        "schedule" : {
            "description" : "Schedule of the WLAN.",
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "description" : "Identifier of the schedule profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the schedule profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "type" : {
                    "description" : "Type of WLAN schedule",
                    "type" : "string",
                    "enum" : [ "AlwaysOn", "AlwaysOff", "Customized" ],
                    "default" : "AlwaysOn"
                }
            },
            "required" : [ "type" ],
            "type" : "object"
        },
        "ssid" : {
            "description" : "SSID of the WLAN",
            "type" : "string"
        },
        "type" : {
            "description" : "Type of the WLAN",
            "type" : "string",
            "enum" : [ "Guest", "Hotspot", "Hotspot20", "Hotspot20_Open", "Hotspot20_OSEN", "Hotspot_MacByPass", "Standard_8021X", "Standard_Mac", "Standard_Open", "WebAuth" ]
        },
        "vlan" : {
            "description" : "VLAN (access and/or core) of the WLAN.",
            "additionalProperties" : false,
            "properties" : {
                "aaaVlanOverride" : {
                    "description" : "Indicates whether the AAA VLAN settings can be overriden or not",
                    "type" : "boolean"
                },
                "accessVlan" : {
                    "description" : "Access VLAN ID",
                    "maximum" : 4094,
                    "minimum" : 1,
                    "type" : "integer",
                    "default" : 1
                },
                "vlanPooling" : {
                    "description" : "Vlan pooling",
                    "type" : [ "object", "null" ],
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string"
                        }
                    }
                }
            },
            "type" : "object"
        },
        "zoneId" : {
            "description" : "Identifier of the zone to which the WLAN belongs",
            "type" : "string"
        },
        "accessTunnelProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "accessIpsecProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "splitTunnelProfileId" : {
            "type" : "string"
        }
    },
    "type" : "object"
}

Create - Standard Open

POST/v8_1/rkszones/{zoneId}/wlans

Use this API command to create a new standard, open and non-tunneled basic WLAN.

Request
HideShow
Body
{
  "name": "wlanName",
  "ssid": "wlanSSID",
  "description": "wlanDescription",
  "accessTunnelType": "RuckusGRE",
  "accessTunnelProfile": {
    "id": "f5b92938-aa4e-4d02-90ea-273799ff689b",
    "name": "Default Tunnel Profile"
  },
  "accessIpsecProfile": null,
  "splitTunnelProfileId": "38119bac-49e1-4410-ab8e-1c1bc88dd770",
  "coreTunnelProfile": {
    "type": "Bridge",
    "id": "forwardingUUID",
    "name": "forwardingName"
  },
  "encryption": {
    "method": "WPA2",
    "algorithm": "AES",
    "passphrase": "password",
    "mfp": "disabled",
    "support80211rEnabled": true,
    "mobilityDomainId": 3
  },
  "operatorRealm": "operator realm",
  "defaultUserTrafficProfile": {
    "id": "userTrafficUUID",
    "name": "userTrafficName"
  },
  "precedenceProfileId": "c514d450-c839-9527-afc9-525400d12345",
  "flexiVpnProfile": {
    "zoneAffinityId": "91fa3fe0-03da-11e7-8d82-0a0027000000"
  },
  "portalDetectionProfileId": "de0fa30c-9565-11e8-9eb6-529269fb1459",
  "schedule": {
    "type": "Customized",
    "id": "ServiceUUID",
    "name": "ServiceName"
  },
  "vlan": {
    "accessVlan": 23,
    "coreQinQEnabled": false,
    "coreSVlan": 1,
    "vlanPooling": null
  },
  "l2ACL": {
    "id": "l2ACLUUID",
    "name": "l2ACLName"
  },
  "devicePolicy": {
    "id": "devicePolicyUUID",
    "name": "devicePolicyName"
  },
  "radiusOptions": {
    "nasIdType": "Customized",
    "customizedNasId": "nasId",
    "nasRequestTimeoutSec": 12,
    "nasMaxRetry": 3,
    "nasReconnectPrimaryMin": 30,
    "calledStaIdType": "WLAN_BSSID",
    "nasIpType": "disabled",
    "nasIpUserDefined": "192.168.1.1",
    "vendorSpecificAttributeProfileId": "6d767421-d1b7-11e8-8ab9-ba2343155a93"
  },
  "advancedOptions": {
    "clientIsolationEnabled": true,
    "clientIsolationUnicastEnabled": true,
    "clientIsolationMulticastEnabled": false,
    "clientIsolationAutoVrrpEnabled": false,
    "clientIsolationWhitelist": {
      "id": "b89323e1-3168-11e7-b027-5254009ae3f0",
      "name": "myWhitelist"
    },
    "priority": "High",
    "hideSsidEnabled": true,
    "maxClientsPerRadio": 12,
    "clientIdleTimeoutSec": 60,
    "clientLoadBalancingEnabled": true,
    "proxyARPEnabled": true,
    "ndProxyEnabled": false,
    "suppressNsEnabled": false,
    "raProxyEnabled": false,
    "rsraGuardEnabled": false,
    "raThrottlingEnabled": false,
    "maxAllowedRA": 10,
    "raInterval": 10,
    "support80211dEnabled": false,
    "support80211kEnabled": true,
    "antiSpoofingEnabled": true,
    "arpRequestRateLimit": 15,
    "dhcpRequestRateLimit": 15,
    "forceClientDHCPTimeoutSec": 5,
    "dhcp82SubOpt1Format": "SUBOPT1_AP_INFO_LOCATION",
    "unauthClientStatsEnabled": false,
    "clientFingerprintingEnabled": true,
    "ofdmOnlyEnabled": false,
    "bandBalancing": "UseZoneSetting",
    "bssMinRateMbps": "Disable",
    "mgmtTxRateMbps": "2 mbps",
    "avcEnabled": true,
    "uplinkEnabled": true,
    "uplinkRate": 100,
    "downlinkEnabled": true,
    "downlinkRate": 200,
    "ratePerSTAUplink": "650mbps",
    "ratePerSTADownlink": "1mbps",
    "urlFilteringPolicyEnabled": true,
    "urlFilteringPolicyId": "eabd4fa0-5015-11e7-84d0-525400a0e6c5",
    "wifiCallingPolicyEnabled": true,
    "wifiCallingPolicyIds": [
      "75e26590-547f-11e6-9ca7-5a095364c13c",
      "869bb532-547f-11e6-9ca7-5a095364c13c"
    ],
    "hdOverheadOptimizeEnable": false,
    "probeRssiThr": -85,
    "transientClientMgmtEnable": true,
    "joinIgnoreTimeout": 30,
    "joinAcceptTimeout": 300,
    "joinIgnoreThr": 10,
    "authRssiThr": -85,
    "assocRssiThr": -85
  },
  "diffServProfile": {
    "id": "diffServId",
    "name": "diffServName"
  },
  "qosMaps": [
    {
      "enable": true,
      "priority": 0,
      "low": 0,
      "high": 7,
      "excepts": null
    },
    {
      "enable": true,
      "priority": 1,
      "low": 8,
      "high": 15,
      "excepts": null
    },
    {
      "enable": true,
      "priority": 2,
      "low": 16,
      "high": 23,
      "excepts": null
    },
    {
      "enable": true,
      "priority": 3,
      "low": 0,
      "high": 32,
      "excepts": [
        43,
        45,
        60
      ]
    },
    {
      "enable": true,
      "priority": 4,
      "low": 32,
      "high": 39,
      "excepts": null
    },
    {
      "enable": true,
      "priority": 5,
      "low": 40,
      "high": 47,
      "excepts": null
    },
    {
      "enable": true,
      "priority": 6,
      "low": 48,
      "high": 55,
      "excepts": [
        46
      ]
    },
    {
      "enable": true,
      "priority": 7,
      "low": 56,
      "high": 63,
      "excepts": null
    }
  ],
  "dnsServerProfile": {
    "id": "DNS server profile UUID",
    "name": "DNS server profile name"
  },
  "dpsk": {
    "dpskEnabled": true,
    "length": 8,
    "dpskType": "Secure",
    "expiration": "OneDay",
    "dpskFromType": "FirstUse"
  },
  "externalDpsk": {
    "enabled": false,
    "encryption": {
      "method": "None"
    }
  }
}
Schema
{
    "additionalProperties" : false,
    "properties" : {
        "accessTunnelType" : {
            "description" : "Access tunnel type of the WLAN. APLBO means AP local breakout, and SoftGRE means AP direct SoftGRE tunnel",
            "type" : "string",
            "enum" : [ "APLBO", "RuckusGRE", "SoftGRE" ],
            "default" : "APLBO"
        },
        "accountingServiceOrProfile" : {
            "description" : "Accounting of the WLAN",
            "additionalProperties" : false,
            "properties" : {
                "accountingDelayEnabled" : {
                    "description" : "Indicates whether accounting delay time is enabled",
                    "type" : "boolean"
                },
                "id" : {
                    "description" : "Accounting service or profile ID. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "interimUpdateMin" : {
                    "description" : "Interval (in minutes) for sending interim updates",
                    "maximum" : 1440,
                    "minimum" : 0,
                    "type" : "integer"
                },
                "name" : {
                    "description" : "Accounting service or profile name. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "throughController" : {
                    "description" : "Indicates whether accounting messages were sent through the controller",
                    "type" : "boolean"
                },
                "realmBasedAcct" : {
                    "type" : "boolean"
                },
                "backupAccountingId" : {
                    "description" : "Backup accounting service or profile ID. At least one backupAccountingId or backupAccountingName is required in the request when setting backup accounting service.",
                    "type" : "string"
                },
                "backupAccountingName" : {
                    "description" : "Backup accounting service or profile name. At least one backupAccountingId or backupAccountingName is required in the request when setting backup accounting service.",
                    "type" : "string"
                }
            },
            "type" : "object"
        },
        "advancedOptions" : {
            "description" : "Advanced settings for the WLAN.",
            "additionalProperties" : false,
            "properties" : {
                "avcEnabled" : {
                    "default" : false,
                    "description" : "Indicator of whether AVC support is enabled or disabled",
                    "type" : "boolean"
                },
                "bandBalancing" : {
                    "default" : "UseZoneSetting",
                    "description" : "Indicates whether band balancing is enabled or disabled",
                    "type" : "string",
                    "enum" : [ "Disabled", "UseZoneSetting" ]
                },
                "bssMinRateMbps" : {
                    "description" : "BSS minimum rate (mbps)",
                    "type" : "string",
                    "enum" : [ "Disable", "1 mbps", "2 mbps", "5.5 mbps", "12 mbps", "24 mbps" ],
                    "default" : "Disable"
                },
                "clientFingerprintingEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether client fingerprinting is enabled or disabled",
                    "type" : "boolean"
                },
                "clientIdleTimeoutSec" : {
                    "default" : 120,
                    "description" : "Client idle timeout in seconds",
                    "maximum" : 1000,
                    "minimum" : 60,
                    "type" : "integer"
                },
                "clientIsolationEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether wireless client isolation is enabled or disabled",
                    "type" : "boolean"
                },
                "clientIsolationUnicastEnabled" : {
                    "description" : "Indicates whether isolate unicast of wireless client isolation is enabled or disabled",
                    "type" : "boolean",
                    "default" : true
                },
                "clientIsolationMulticastEnabled" : {
                    "description" : "Indicates whether isolate multicast of wireless client isolation is enabled or disabled",
                    "type" : "boolean"
                },
                "clientIsolationAutoVrrpEnabled" : {
                    "description" : "Indicates whether Automatic support for VRRP of wireless client isolation is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "clientIsolationWhitelist" : {
                    "description" : "Indicates wireless client isolation whitelist",
                    "type" : [ "object", "null" ],
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string"
                        }
                    }
                },
                "clientLoadBalancingEnabled" : {
                    "description" : "Indicates whether Client Load Balancing is enabled or disabled",
                    "type" : "boolean",
                    "default" : true
                },
                "dgafEnabled" : {
                    "description" : "Indicates whether dgaf is enabled or disabled",
                    "type" : "boolean"
                },
                "dhcp82Format" : {
                    "description" : "DHCP Option 82 format. This variable no longer supports from v8_1 and only kept for backward compatibility.",
                    "type" : "string",
                    "enum" : [ "RUCKUS_DEFAULT", "SOFTGRE_CUSTOMIZED" ]
                },
                "dhcpOption82Enabled" : {
                    "default" : false,
                    "description" : "Indicates whether DCHP Option 82 is enabled or disabled. This variable no longer supports from v8_1 and only kept for backward compatibility.",
                    "type" : "boolean"
                },
                "dhcp82SubOpt1Format" : {
                    "description" : "Subopt-1 format",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT1_AP_INFO_LOCATION", "SUBOPT1_AP_INFO", "SUBOPT1_AP_MAC_ESSID_PRIVACYTYPE", "SUBOPT1_AP_MAC_hex", "SUBOPT1_AP_MAC_hex_ESSID", "SUBOPT1_ESSID" ]
                },
                "dhcp82SubOpt2Format" : {
                    "description" : "Subopt-2 format",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT2_CLIENT_MAC", "SUBOPT2_CLIENT_MAC_hex", "SUBOPT2_CLIENT_MAC_hex_ESSID", "SUBOPT2_AP_MAC", "SUBOPT2_AP_MAC_hex", "SUBOPT2_AP_MAC_hex_ESSID" ]
                },
                "dhcp82SubOpt150Format" : {
                    "description" : "Subopt-150 with VLAN-Id",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT150_VLAN_ID" ]
                },
                "dhcp82SubOpt151Format" : {
                    "description" : "Subopt-151 format",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT151_AREA_NAME", "SUBOPT151_ESSID" ]
                },
                "dhcp82SubOpt151AreaName" : {
                    "description" : "Subopt-151 Area Name value",
                    "type" : "string"
                },
                "downlinkEnabled" : {
                    "default" : false,
                    "description" : "SSID Rate Limiting downlink enabled.",
                    "type" : "boolean"
                },
                "downlinkRate" : {
                    "description" : "SSID Rate Limiting downlink.",
                    "type" : "number",
                    "default" : 0.0
                },
                "antiSpoofingEnabled" : {
                    "description" : "Anti-Spoofing enabled",
                    "type" : "boolean",
                    "default" : false
                },
                "arpRequestRateLimit" : {
                    "description" : "ARP packets request rate limit, default value will be 15 if both rate limit not being set.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 100
                },
                "dhcpRequestRateLimit" : {
                    "description" : "DHCP packets request rate limit, default value will be 15 if both rate limit not being set.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 100
                },
                "forceClientDHCPTimeoutSec" : {
                    "default" : 0,
                    "description" : "Force DHCP disconnects the client if the client does not obtain a valid IP address within the timeout peroid. To disable force DHCP, set this value to zero (0).",
                    "type" : "integer",
                    "enum" : [ 0, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15 ]
                },
                "hideSsidEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether the SSID is hidden or broadcast",
                    "type" : "boolean"
                },
                "hs20Onboarding" : {
                    "description" : "Allow WISPr WLAN for Hotspot 2.0 Onboarding",
                    "type" : "boolean",
                    "default" : false
                },
                "maxClientsPerRadio" : {
                    "default" : 100,
                    "description" : "Maximum number of clients per radio",
                    "maximum" : 512,
                    "minimum" : 1,
                    "type" : "integer"
                },
                "mgmtTxRateMbps" : {
                    "description" : "Management TX rate (mbps)",
                    "type" : "string",
                    "enum" : [ "1 mbps", "2 mbps", "5.5 mbps", "6 mbps", "9 mbps", "11 mbps", "12 mbps", "18 mbps", "24 mbps", "36 mbps", "48 mbps", "54 mbps" ],
                    "default" : "2 mbps"
                },
                "ofdmOnlyEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether OFDM only is enabled or disabled",
                    "type" : "boolean"
                },
                "okcEnabled" : {
                    "description" : "Indicator of whether OKC support is enabled or disabled. The default value is true when the WLAN is WPA+AES non open WLAN.",
                    "type" : "boolean"
                },
                "pmkCachingEnabled" : {
                    "description" : "Indicator of whether PKM caching support is enabled or disabled. The default value is true when the WLAN is WPA+AES non open WLAN.",
                    "type" : "boolean"
                },
                "priority" : {
                    "default" : "High",
                    "description" : "Priority of the WLAN",
                    "type" : "string",
                    "enum" : [ "High", "Low" ]
                },
                "proxyARPEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether proxy ARP is enabled or disabled",
                    "type" : "boolean"
                },
                "ndProxyEnabled" : {
                    "description" : "Indicates whether ND Proxy is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "suppressNsEnabled" : {
                    "description" : "Indicates whether supperssNS is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "raProxyEnabled" : {
                    "description" : "Indicates whether RA proxy is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "rsraGuardEnabled" : {
                    "description" : "Indicates whether RS/RA Guard is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "raThrottlingEnabled" : {
                    "description" : "Indicates whether RA Throttling is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "maxAllowedRA" : {
                    "description" : "Max Allowed RAs",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 1440,
                    "default" : 10
                },
                "raInterval" : {
                    "description" : "A timer that RA proxy runs and once receives unsolicited RA checks against the configured time and allow/drop RA based on next timeout",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 256,
                    "default" : 10
                },
                "support80211dEnabled" : {
                    "default" : true,
                    "description" : "Indicates whether support for 802.11d is enabled or disabled",
                    "type" : "boolean"
                },
                "support80211kEnabled" : {
                    "default" : true,
                    "description" : "Indicates whether support for 802.11k is enabled or disabled",
                    "type" : "boolean"
                },
                "unauthClientStatsEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether to send statistics of unauthorized clients or not",
                    "type" : "boolean"
                },
                "uplinkEnabled" : {
                    "default" : false,
                    "description" : "SSID Rate Limiting uplink enabled.",
                    "type" : "boolean"
                },
                "uplinkRate" : {
                    "description" : "SSID Rate Limiting uplink.",
                    "type" : "number",
                    "default" : 0.0
                },
                "ratePerSTAUplink" : {
                    "description" : "UE Rate Limiting uplink.",
                    "type" : "string"
                },
                "ratePerSTADownlink" : {
                    "description" : "UE Rate Limiting downlink.",
                    "type" : "string"
                },
                "dtimInterval" : {
                    "description" : "DTIM Interval",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 255,
                    "default" : 1
                },
                "directedThreshold" : {
                    "description" : "Directed Threshold Setting, Defines the client count at which an AP will stop converting group addressed data traffic to unicast.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 128,
                    "default" : 5
                },
                "flowLogEnabled" : {
                    "description" : "Flow log enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "hdOverheadOptimizeEnable" : {
                    "description" : "Airtime Decongestion enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "probeRssiThr" : {
                    "description" : "Join RSSI threshold.",
                    "type" : "integer",
                    "minimum" : -90,
                    "maximum" : -60,
                    "default" : -85
                },
                "transientClientMgmtEnable" : {
                    "description" : "Transient Client Management enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "joinIgnoreTimeout" : {
                    "description" : "Join wait time.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 60,
                    "default" : 30
                },
                "joinAcceptTimeout" : {
                    "description" : "Join expire time.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 300,
                    "default" : 300
                },
                "joinIgnoreThr" : {
                    "description" : "Join wait threshold.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 50,
                    "default" : 10
                },
                "dropRandomProbesEnabled" : {
                    "description" : "Drop Random Probes enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "authRssiThr" : {
                    "description" : "Auth RSSI threshold.",
                    "type" : "integer",
                    "minimum" : -90,
                    "maximum" : -60
                },
                "assocRssiThr" : {
                    "description" : "Assoc RSSI threshold.",
                    "type" : "integer",
                    "minimum" : -90,
                    "maximum" : -60
                },
                "oceEnabled" : {
                    "description" : "Optimized Connectivity Experience(OCE) enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "oceBroadcastProbeResponseDelay" : {
                    "description" : "Broadcast probe response delay.",
                    "type" : "integer",
                    "minimum" : 8,
                    "maximum" : 120,
                    "default" : 15
                },
                "oceRssiBasedAssociationRejectionThreshold" : {
                    "description" : "RSSI-based association rejection threshold.",
                    "type" : "integer",
                    "minimum" : -90,
                    "maximum" : -60,
                    "default" : -75
                }
            },
            "type" : "object"
        },
        "authServiceOrProfile" : {
            "description" : "Authentication of the WLAN",
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "description" : "Identifier of the authentication service or profile. At least one ID or name or authenticationOption is required in the request.",
                    "type" : "string"
                },
                "locationDeliveryEnabled" : {
                    "description" : "RFC5580 location delivery support",
                    "type" : "boolean"
                },
                "realmBasedAuth" : {
                    "type" : "boolean"
                },
                "name" : {
                    "description" : "Name of the authentication service or profile. At least one ID or name or authenticationOption is required in the request. Or could input the 'Always Accept' or 'Local DB'.",
                    "type" : "string"
                },
                "authenticationOption" : {
                    "description" : "Option of the authentication service or profile, At least one ID or name or authenticationOption is required in the request. This only applies to hotspot and guest WLANs.",
                    "type" : "string",
                    "enum" : [ "Local DB", "Guest", "Always Accept", null ]
                },
                "throughController" : {
                    "description" : "Indicates whether authentication messages were sent through the controller or not",
                    "type" : "boolean"
                },
                "backupAuthenticationId" : {
                    "description" : "Identifier of the backup authentication service or profile. At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service.",
                    "type" : "string"
                },
                "backupAuthenticationName" : {
                    "description" : "Name of the backup authentication service or profile. At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service. Or could input the 'Always Accept'.",
                    "type" : "string"
                },
                "backupAuthenticationOption" : {
                    "description" : "Option of the backup authentication service or profile, At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service. This only applies to hotspot WLANs.",
                    "type" : "string",
                    "enum" : [ "Always Accept", null ]
                }
            },
            "type" : "object"
        },
        "coreTunnelProfile" : {
            "description" : "Core tunnel of the WLAN. This only applies when the access tunnel type is set to RuckusGRE.",
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "description" : "Identifier of the forwarding profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the forwarding profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "type" : {
                    "description" : "Tunnel type",
                    "type" : "string",
                    "enum" : [ "Bridge" ]
                }
            },
            "required" : [ "type" ],
            "type" : "object"
        },
        "defaultUserTrafficProfile" : {
            "description" : "User traffic profile of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "precedenceProfileId" : {
            "description" : "Precedence profile of the WLAN",
            "type" : "string"
        },
        "flexiVpnProfile" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "zoneAffinityId" : {
                    "type" : "string",
                    "description" : "Zone Affinity ID"
                }
            },
            "required" : [ "zoneAffinityId" ]
        },
        "description" : {
            "description" : "Description of the WLAN",
            "type" : [ "string", "null" ],
            "maxLength" : 64
        },
        "devicePolicy" : {
            "description" : "Device policy of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "diffServProfile" : {
            "description" : "DiffServ profile of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "dnsServerProfile" : {
            "description" : "DNS server profile of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "dpsk" : {
            "description" : "DPSK Setting",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "dpskEnabled" : {
                    "description" : "DPSK enabled",
                    "type" : "boolean",
                    "default" : false
                },
                "length" : {
                    "description" : "Length of DPSK key",
                    "type" : "integer",
                    "default" : 62
                },
                "dpskType" : {
                    "description" : "Type of DPSK key",
                    "type" : "string",
                    "enum" : [ "Secure", "KeyboardFriendly", "NumbersOnly" ],
                    "default" : "Secure"
                },
                "expiration" : {
                    "description" : "Expiration of DPSK key",
                    "type" : "string",
                    "enum" : [ "Unlimited", "OneDay", "TwoDays", "OneWeek", "TwoWeeks", "OneMonth", "SixMonths", "OneYear", "TwoYears" ],
                    "default" : "Unlimited"
                },
                "dpskFromType" : {
                    "description" : "Type of expiration start from",
                    "type" : "string",
                    "enum" : [ "CreateTime", "FirstUse" ],
                    "default" : "CreateTime"
                }
            }
        },
        "externalDpsk" : {
            "description" : "External DPSK Enabled",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "enabled" : {
                    "description" : "Enable External DPSK",
                    "type" : "boolean",
                    "default" : false
                },
                "encryption" : {
                    "description" : "Encryption of the WLAN relate to external DPSK",
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "method" : {
                            "description" : "Encryption method",
                            "type" : "string",
                            "enum" : [ "WPA2", "WPA_Mixed", "None" ]
                        },
                        "algorithm" : {
                            "description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
                            "type" : "string",
                            "enum" : [ "AES", "TKIP_AES" ]
                        }
                    }
                },
                "authService" : {
                    "description" : "Autentication of the WLAN relate to external DPSK",
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "description" : "Identifier of the authentication service. At least one ID or name is required in the request.",
                            "type" : "string"
                        },
                        "name" : {
                            "description" : "Name of the authentication service. At least one ID or name is required in the request.",
                            "type" : "string"
                        }
                    }
                }
            },
            "required" : [ "enabled" ]
        },
        "encryption" : {
            "description" : "Encryption of the WLAN",
            "additionalProperties" : false,
            "properties" : {
                "algorithm" : {
                    "description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
                    "type" : "string",
                    "enum" : [ "AES", "TKIP_AES" ]
                },
                "keyInHex" : {
                    "description" : "Key in hex format. This only applies to WEP64 and WEP128.",
                    "type" : "string"
                },
                "keyIndex" : {
                    "description" : "Key index. This only applies to WEP64 and WEP128.",
                    "type" : "integer"
                },
                "method" : {
                    "description" : "Encryption method",
                    "type" : "string",
                    "enum" : [ "WPA2", "WPA_Mixed", "WEP_64", "WEP_128", "None" ],
                    "default" : "None"
                },
                "mfp" : {
                    "description" : "Management frame protection. This only applies to WPA2 + AES",
                    "type" : "string",
                    "enum" : [ "disabled", "capable", "required" ]
                },
                "mobilityDomainId" : {
                    "description" : "mobility Domain Id.",
                    "maximum" : 65535,
                    "minimum" : 1,
                    "type" : "integer"
                },
                "passphrase" : {
                    "description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
                    "type" : "string"
                },
                "support80211rEnabled" : {
                    "description" : "Enable 802.11r Fast BSS Transition, fast Romaing.",
                    "type" : "boolean"
                }
            },
            "required" : [ "method" ],
            "type" : "object"
        },
        "hessid" : {
            "description" : "HESSID of the WLAN",
            "pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$",
            "type" : "string"
        },
        "hotspot20Profile" : {
            "description" : "Hotspot 2.0 operator profile of the WLAN. id or name of the hotspot 2.0 operator profiles within the zone is required.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "l2ACL" : {
            "description" : "Layer 2 ACL of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "macAuth" : {
            "description" : "MAC address authentication settings of the WLAN. This only applies to standard MAC and Hotspot MAC bypass WLAN.",
            "additionalProperties" : false,
            "properties" : {
                "customizedPassword" : {
                    "description" : "User defined password. When this field is set to an empty string, the MAC address is used as password.",
                    "maxLength" : 64,
                    "pattern" : "^([!-;=?-~]([ -;=?-~]){0,62}[!-;=?-~]|[!-;=?-~]{1,1}|\s{0,0})$",
                    "type" : "string"
                },
                "macAuthMacFormat" : {
                    "description" : "MAC address format. The default format is 0010a42319c0 and the 802.1X format is 00-10-A4-23-19-C0.",
                    "type" : "string",
                    "enum" : [ "Default", "802.1X", "UpperColon", "Upper", "LowerDash", "LowerColon" ]
                }
            },
            "type" : "object"
        },
        "name" : {
            "description" : "Name of the WLAN",
            "type" : "string",
            "minLength" : 1,
            "maxLength" : 32
        },
        "operatorRealm" : {
            "description" : "Operator realm, operatorRealm only supports coreTunnelProfile type is PMIP or authServiceOrProfile.locationDeliveryEnabled is true",
            "type" : "string",
            "maxLength" : 255,
            "pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
        },
        "portalServiceProfile" : {
            "description" : "Portal service of the WLAN. This only applies to hotspot, hotspot MAC bypass, guest and web auth WLANs.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "qosMaps" : {
            "description" : "Qos map set of the WLAN.",
            "items" : {
                "additionalProperties" : false,
                "properties" : {
                    "enable" : {
                        "description" : "Enabled or disabled",
                        "type" : "boolean"
                    },
                    "excepts" : {
                        "items" : {
                            "maximum" : 63,
                            "minimum" : 0,
                            "type" : "integer"
                        },
                        "type" : [ "array", "null" ]
                    },
                    "high" : {
                        "description" : "DSCP range - high",
                        "maximum" : 255,
                        "minimum" : 0,
                        "type" : [ "integer", "null" ]
                    },
                    "low" : {
                        "description" : "DSCP range - low",
                        "maximum" : 255,
                        "minimum" : 0,
                        "type" : [ "integer", "null" ]
                    },
                    "priority" : {
                        "description" : "Priority",
                        "type" : "integer"
                    }
                },
                "required" : [ "enable", "priority" ],
                "type" : "object"
            },
            "type" : "array"
        },
        "radiusOptions" : {
            "description" : "RADIUS options of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "calledStaIdType" : {
                    "default" : "WLAN_BSSID",
                    "description" : "Called station ID type",
                    "type" : "string",
                    "enum" : [ "AP_MAC", "NONE", "WLAN_BSSID" ]
                },
                "customizedNasId" : {
                    "description" : "User defined NAS ID",
                    "maxLength" : 64,
                    "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                    "type" : "string"
                },
                "nasIdType" : {
                    "default" : "WLAN_BSSID",
                    "description" : "NAS ID type",
                    "type" : "string",
                    "enum" : [ "AP_MAC", "Customized", "WLAN_BSSID" ]
                },
                "nasMaxRetry" : {
                    "default" : 2,
                    "description" : "NAS request maximum retry",
                    "maximum" : 10,
                    "minimum" : 2,
                    "type" : "integer"
                },
                "nasReconnectPrimaryMin" : {
                    "default" : 5,
                    "description" : "NAS reconnect primary time in minutes",
                    "maximum" : 60,
                    "minimum" : 1,
                    "type" : "integer"
                },
                "nasRequestTimeoutSec" : {
                    "default" : 3,
                    "description" : "NAS request timeout in seconds",
                    "maximum" : 20,
                    "minimum" : 2,
                    "type" : "integer"
                },
                "nasIpType" : {
                    "description" : "NAS IP type",
                    "type" : "string",
                    "enum" : [ "disabled", "control", "management", "userDefined" ],
                    "default" : "disabled"
                },
                "nasIpUserDefined" : {
                    "description" : "User-defined NAS IP",
                    "type" : "string",
                    "maxLength" : 45
                },
                "singleSessionIdAcctEnabled" : {
                    "description" : "When Single Accounting Session ID is enabled, APs will maintain one accounting session for client roaming",
                    "type" : "boolean",
                    "default" : false
                },
                "vendorSpecificAttributeProfileId" : {
                    "description" : "Vendor Specific Attribute Profile ID",
                    "type" : "string"
                }
            }
        },
        "schedule" : {
            "description" : "Schedule of the WLAN",
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "description" : "Identifier of the schedule profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the schedule profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "type" : {
                    "description" : "Type of WLAN schedule",
                    "type" : "string",
                    "enum" : [ "AlwaysOn", "AlwaysOff", "Customized" ],
                    "default" : "AlwaysOn"
                }
            },
            "required" : [ "type" ],
            "type" : "object"
        },
        "ssid" : {
            "description" : "SSID of the WLAN",
            "type" : "string",
            "minLength" : 1,
            "maxLength" : 32
        },
        "timeboundWhitelist" : {
            "description" : "Hotspot timeboundWhitelist. The ID of the OAuth Authentication service is required.",
            "additionalProperties" : false,
            "properties" : {
                "firstIndex" : {
                    "type" : "integer"
                },
                "hasMore" : {
                    "type" : "boolean"
                },
                "list" : {
                    "items" : {
                        "type" : [ "object", "null" ],
                        "additionalProperties" : false,
                        "properties" : {
                            "id" : {
                                "type" : "string"
                            },
                            "name" : {
                                "type" : "string"
                            }
                        }
                    },
                    "type" : "array"
                },
                "totalCount" : {
                    "type" : "integer"
                }
            },
            "type" : "object"
        },
        "vlan" : {
            "description" : "VLAN (access and/or core) of the WLAN.",
            "additionalProperties" : false,
            "properties" : {
                "aaaVlanOverride" : {
                    "description" : "Indicates whether the AAA VLAN settings can be overriden or not",
                    "type" : "boolean"
                },
                "accessVlan" : {
                    "description" : "Access VLAN ID",
                    "maximum" : 4094,
                    "minimum" : 1,
                    "type" : "integer",
                    "default" : 1
                },
                "vlanPooling" : {
                    "description" : "Vlan pooling",
                    "type" : [ "object", "null" ],
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string"
                        }
                    }
                }
            },
            "type" : "object"
        },
        "accessTunnelProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "accessIpsecProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "splitTunnelProfileId" : {
            "type" : "string"
        }
    },
    "required" : [ "name", "ssid" ],
    "type" : "object"
}
Response  201
HideShow
Body
{
  "id": "wlanID"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Create - 802.1X

POST/v8_1/rkszones/{zoneId}/wlans/standard8021X

Use this API command to create a new standard, 802.1X and non-tunneled WLAN.

Request
HideShow
Body
{
  "name": "wlanName",
  "ssid": "wlanSSID",
  "description": "wlanDescription",
  "authServiceOrProfile": {
    "throughController": false,
    "id": "authServiceUUID",
    "name": "authServiceName",
    "authenticationOption": null
  },
  "accessTunnelType": "RuckusGRE",
  "accessTunnelProfile": {
    "id": "f5b92938-aa4e-4d02-90ea-273799ff689b",
    "name": "Default Tunnel Profile"
  },
  "splitTunnelProfileId": "38119bac-49e1-4410-ab8e-1c1bc88dd770",
  "coreTunnelProfile": {
    "type": "Bridge",
    "id": "forwardingUUID",
    "name": "forwardingName"
  },
  "encryption": {
    "method": "WPA2",
    "algorithm": "AES",
    "mfp": "disabled",
    "support80211rEnabled": true,
    "mobilityDomainId": 3
  },
  "operatorRealm": "operator realm",
  "defaultUserTrafficProfile": {
    "id": "userTrafficUUID",
    "name": "userTrafficName"
  },
  "precedenceProfileId": "c514d450-c839-9527-afc9-525400d12345",
  "portalDetectionProfileId": "de0fa30c-9565-11e8-9eb6-529269fb1459",
  "schedule": {
    "type": "Customized",
    "id": "ServiceUUID",
    "name": "ServiceName"
  },
  "vlan": {
    "accessVlan": 23,
    "aaaVlanOverride": true,
    "coreQinQEnabled": false,
    "coreSVlan": 1,
    "vlanPooling": null
  },
  "l2ACL": {
    "id": "l2ACLUUID",
    "name": "l2ACLName"
  },
  "devicePolicy": {
    "id": "devicePolicyUUID",
    "name": "devicePolicyName"
  },
  "radiusOptions": {
    "nasIdType": "Customized",
    "customizedNasId": "nasId",
    "nasRequestTimeoutSec": 12,
    "nasMaxRetry": 3,
    "nasReconnectPrimaryMin": 30,
    "calledStaIdType": "WLAN_BSSID",
    "nasIpType": "disabled",
    "nasIpUserDefined": "192.168.1.1",
    "vendorSpecificAttributeProfileId": "6d767421-d1b7-11e8-8ab9-ba2343155a93"
  },
  "advancedOptions": {
    "clientIsolationEnabled": true,
    "clientIsolationUnicastEnabled": true,
    "clientIsolationMulticastEnabled": false,
    "clientIsolationAutoVrrpEnabled": false,
    "clientIsolationWhitelist": {
      "id": "b89323e1-3168-11e7-b027-5254009ae3f0",
      "name": "myWhitelist"
    },
    "priority": "High",
    "hideSsidEnabled": true,
    "maxClientsPerRadio": 12,
    "clientIdleTimeoutSec": 60,
    "clientLoadBalancingEnabled": true,
    "proxyARPEnabled": true,
    "ndProxyEnabled": false,
    "suppressNsEnabled": false,
    "raProxyEnabled": false,
    "rsraGuardEnabled": false,
    "raThrottlingEnabled": false,
    "maxAllowedRA": 10,
    "raInterval": 10,
    "support80211dEnabled": false,
    "support80211kEnabled": true,
    "forceClientDHCPTimeoutSec": 5,
    "dhcp82SubOpt1Format": "SUBOPT1_AP_INFO_LOCATION",
    "unauthClientStatsEnabled": false,
    "clientFingerprintingEnabled": true,
    "ofdmOnlyEnabled": false,
    "bandBalancing": "UseZoneSetting",
    "bssMinRateMbps": "Disable",
    "mgmtTxRateMbps": "2 mbps",
    "avcEnabled": true,
    "urlFilteringPolicyEnabled": true,
    "urlFilteringPolicyId": "eabd4fa0-5015-11e7-84d0-525400a0e6c5",
    "wifiCallingPolicyEnabled": true,
    "wifiCallingPolicyIds": [
      "75e26590-547f-11e6-9ca7-5a095364c13c",
      "869bb532-547f-11e6-9ca7-5a095364c13c"
    ],
    "uplinkEnabled": true,
    "uplinkRate": 100,
    "downlinkEnabled": true,
    "downlinkRate": 200,
    "ratePerSTAUplink": "650mbps",
    "ratePerSTADownlink": "1mbps"
  },
  "diffServProfile": {
    "id": "diffServId",
    "name": "diffServName"
  },
  "qosMaps": [
    {
      "enable": true,
      "priority": 0,
      "low": 0,
      "high": 7,
      "excepts": null
    },
    {
      "enable": true,
      "priority": 1,
      "low": 8,
      "high": 15,
      "excepts": null
    },
    {
      "enable": true,
      "priority": 2,
      "low": 16,
      "high": 23,
      "excepts": null
    },
    {
      "enable": true,
      "priority": 3,
      "low": 0,
      "high": 32,
      "excepts": [
        43,
        45,
        60
      ]
    },
    {
      "enable": true,
      "priority": 4,
      "low": 32,
      "high": 39,
      "excepts": null
    },
    {
      "enable": true,
      "priority": 5,
      "low": 40,
      "high": 47,
      "excepts": null
    },
    {
      "enable": true,
      "priority": 6,
      "low": 48,
      "high": 55,
      "excepts": [
        46
      ]
    },
    {
      "enable": true,
      "priority": 7,
      "low": 56,
      "high": 63,
      "excepts": null
    }
  ],
  "dnsServerProfile": {
    "id": "DNS server profile UUID",
    "name": "DNS server profile name"
  },
  "dpsk": {
    "dpskEnabled": false,
    "length": 8,
    "dpskType": "Secure",
    "expiration": "OneDay",
    "dpskFromType": "FirstUse"
  },
  "externalDpsk": {
    "enabled": true,
    "encryption": {
      "method": "WPA2",
      "algorithm": "AES"
    },
    "authService": {
      "id": "authServiceUUID"
    }
  }
}
Schema
{
    "additionalProperties" : false,
    "properties" : {
        "accessTunnelType" : {
            "description" : "Access tunnel type of the WLAN. APLBO means AP local breakout, and SoftGRE means AP direct SoftGRE tunnel",
            "type" : "string",
            "enum" : [ "APLBO", "RuckusGRE", "SoftGRE" ]
        },
        "accountingServiceOrProfile" : {
            "description" : "Accounting of the WLAN",
            "additionalProperties" : false,
            "properties" : {
                "accountingDelayEnabled" : {
                    "description" : "Indicates whether accounting delay time is enabled",
                    "type" : "boolean"
                },
                "id" : {
                    "description" : "Accounting service or profile ID. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "interimUpdateMin" : {
                    "description" : "Interval (in minutes) for sending interim updates",
                    "maximum" : 1440,
                    "minimum" : 0,
                    "type" : "integer"
                },
                "name" : {
                    "description" : "Accounting service or profile name. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "throughController" : {
                    "description" : "Indicates whether accounting messages were sent through the controller",
                    "type" : "boolean"
                },
                "realmBasedAcct" : {
                    "type" : "boolean"
                },
                "backupAccountingId" : {
                    "description" : "Backup accounting service or profile ID. At least one backupAccountingId or backupAccountingName is required in the request when setting backup accounting service.",
                    "type" : "string"
                },
                "backupAccountingName" : {
                    "description" : "Backup accounting service or profile name. At least one backupAccountingId or backupAccountingName is required in the request when setting backup accounting service.",
                    "type" : "string"
                }
            },
            "type" : "object"
        },
        "advancedOptions" : {
            "description" : "Advanced settings for the WLAN.",
            "additionalProperties" : false,
            "properties" : {
                "avcEnabled" : {
                    "default" : false,
                    "description" : "Indicator of whether AVC support is enabled or disabled",
                    "type" : "boolean"
                },
                "bandBalancing" : {
                    "default" : "UseZoneSetting",
                    "description" : "Indicates whether band balancing is enabled or disabled",
                    "type" : "string",
                    "enum" : [ "Disabled", "UseZoneSetting" ]
                },
                "bssMinRateMbps" : {
                    "description" : "BSS minimum rate (mbps)",
                    "type" : "string",
                    "enum" : [ "Disable", "1 mbps", "2 mbps", "5.5 mbps", "12 mbps", "24 mbps" ],
                    "default" : "Disable"
                },
                "clientFingerprintingEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether client fingerprinting is enabled or disabled",
                    "type" : "boolean"
                },
                "clientIdleTimeoutSec" : {
                    "default" : 120,
                    "description" : "Client idle timeout in seconds",
                    "maximum" : 1000,
                    "minimum" : 60,
                    "type" : "integer"
                },
                "clientIsolationEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether wireless client isolation is enabled or disabled",
                    "type" : "boolean"
                },
                "clientIsolationUnicastEnabled" : {
                    "description" : "Indicates whether isolate unicast of wireless client isolation is enabled or disabled",
                    "type" : "boolean",
                    "default" : true
                },
                "clientIsolationMulticastEnabled" : {
                    "description" : "Indicates whether isolate multicast of wireless client isolation is enabled or disabled",
                    "type" : "boolean"
                },
                "clientIsolationAutoVrrpEnabled" : {
                    "description" : "Indicates whether Automatic support for VRRP of wireless client isolation is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "clientIsolationWhitelist" : {
                    "description" : "Indicates wireless client isolation whitelist",
                    "type" : [ "object", "null" ],
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string"
                        }
                    }
                },
                "clientLoadBalancingEnabled" : {
                    "description" : "Indicates whether Client Load Balancing is enabled or disabled",
                    "type" : "boolean",
                    "default" : true
                },
                "dgafEnabled" : {
                    "description" : "Indicates whether dgaf is enabled or disabled",
                    "type" : "boolean"
                },
                "dhcp82Format" : {
                    "description" : "DHCP Option 82 format. This variable no longer supports from v8_1 and only kept for backward compatibility.",
                    "type" : "string",
                    "enum" : [ "RUCKUS_DEFAULT", "SOFTGRE_CUSTOMIZED" ]
                },
                "dhcpOption82Enabled" : {
                    "default" : false,
                    "description" : "Indicates whether DCHP Option 82 is enabled or disabled. This variable no longer supports from v8_1 and only kept for backward compatibility.",
                    "type" : "boolean"
                },
                "dhcp82SubOpt1Format" : {
                    "description" : "Subopt-1 format",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT1_AP_INFO_LOCATION", "SUBOPT1_AP_INFO", "SUBOPT1_AP_MAC_ESSID_PRIVACYTYPE", "SUBOPT1_AP_MAC_hex", "SUBOPT1_AP_MAC_hex_ESSID", "SUBOPT1_ESSID" ]
                },
                "dhcp82SubOpt2Format" : {
                    "description" : "Subopt-2 format",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT2_CLIENT_MAC", "SUBOPT2_CLIENT_MAC_hex", "SUBOPT2_CLIENT_MAC_hex_ESSID", "SUBOPT2_AP_MAC", "SUBOPT2_AP_MAC_hex", "SUBOPT2_AP_MAC_hex_ESSID" ]
                },
                "dhcp82SubOpt150Format" : {
                    "description" : "Subopt-150 with VLAN-Id",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT150_VLAN_ID" ]
                },
                "dhcp82SubOpt151Format" : {
                    "description" : "Subopt-151 format",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT151_AREA_NAME", "SUBOPT151_ESSID" ]
                },
                "dhcp82SubOpt151AreaName" : {
                    "description" : "Subopt-151 Area Name value",
                    "type" : "string"
                },
                "downlinkEnabled" : {
                    "default" : false,
                    "description" : "SSID Rate Limiting downlink enabled.",
                    "type" : "boolean"
                },
                "downlinkRate" : {
                    "description" : "SSID Rate Limiting downlink.",
                    "type" : "number",
                    "default" : 0.0
                },
                "antiSpoofingEnabled" : {
                    "description" : "Anti-Spoofing enabled",
                    "type" : "boolean",
                    "default" : false
                },
                "arpRequestRateLimit" : {
                    "description" : "ARP packets request rate limit, default value will be 15 if both rate limit not being set.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 100
                },
                "dhcpRequestRateLimit" : {
                    "description" : "DHCP packets request rate limit, default value will be 15 if both rate limit not being set.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 100
                },
                "forceClientDHCPTimeoutSec" : {
                    "default" : 0,
                    "description" : "Force DHCP disconnects the client if the client does not obtain a valid IP address within the timeout peroid. To disable force DHCP, set this value to zero (0).",
                    "type" : "integer",
                    "enum" : [ 0, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15 ]
                },
                "hideSsidEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether the SSID is hidden or broadcast",
                    "type" : "boolean"
                },
                "hs20Onboarding" : {
                    "description" : "Allow WISPr WLAN for Hotspot 2.0 Onboarding",
                    "type" : "boolean",
                    "default" : false
                },
                "maxClientsPerRadio" : {
                    "default" : 100,
                    "description" : "Maximum number of clients per radio",
                    "maximum" : 512,
                    "minimum" : 1,
                    "type" : "integer"
                },
                "mgmtTxRateMbps" : {
                    "description" : "Management TX rate (mbps)",
                    "type" : "string",
                    "enum" : [ "1 mbps", "2 mbps", "5.5 mbps", "6 mbps", "9 mbps", "11 mbps", "12 mbps", "18 mbps", "24 mbps", "36 mbps", "48 mbps", "54 mbps" ],
                    "default" : "2 mbps"
                },
                "ofdmOnlyEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether OFDM only is enabled or disabled",
                    "type" : "boolean"
                },
                "okcEnabled" : {
                    "description" : "Indicator of whether OKC support is enabled or disabled. The default value is true when the WLAN is WPA+AES non open WLAN.",
                    "type" : "boolean"
                },
                "pmkCachingEnabled" : {
                    "description" : "Indicator of whether PKM caching support is enabled or disabled. The default value is true when the WLAN is WPA+AES non open WLAN.",
                    "type" : "boolean"
                },
                "priority" : {
                    "default" : "High",
                    "description" : "Priority of the WLAN",
                    "type" : "string",
                    "enum" : [ "High", "Low" ]
                },
                "proxyARPEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether proxy ARP is enabled or disabled",
                    "type" : "boolean"
                },
                "ndProxyEnabled" : {
                    "description" : "Indicates whether ND Proxy is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "suppressNsEnabled" : {
                    "description" : "Indicates whether supperssNS is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "raProxyEnabled" : {
                    "description" : "Indicates whether RA proxy is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "rsraGuardEnabled" : {
                    "description" : "Indicates whether RS/RA Guard is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "raThrottlingEnabled" : {
                    "description" : "Indicates whether RA Throttling is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "maxAllowedRA" : {
                    "description" : "Max Allowed RAs",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 1440,
                    "default" : 10
                },
                "raInterval" : {
                    "description" : "A timer that RA proxy runs and once receives unsolicited RA checks against the configured time and allow/drop RA based on next timeout",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 256,
                    "default" : 10
                },
                "support80211dEnabled" : {
                    "default" : true,
                    "description" : "Indicates whether support for 802.11d is enabled or disabled",
                    "type" : "boolean"
                },
                "support80211kEnabled" : {
                    "default" : true,
                    "description" : "Indicates whether support for 802.11k is enabled or disabled",
                    "type" : "boolean"
                },
                "unauthClientStatsEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether to send statistics of unauthorized clients or not",
                    "type" : "boolean"
                },
                "uplinkEnabled" : {
                    "default" : false,
                    "description" : "SSID Rate Limiting uplink enabled.",
                    "type" : "boolean"
                },
                "uplinkRate" : {
                    "description" : "SSID Rate Limiting uplink.",
                    "type" : "number",
                    "default" : 0.0
                },
                "ratePerSTAUplink" : {
                    "description" : "UE Rate Limiting uplink.",
                    "type" : "string"
                },
                "ratePerSTADownlink" : {
                    "description" : "UE Rate Limiting downlink.",
                    "type" : "string"
                },
                "dtimInterval" : {
                    "description" : "DTIM Interval",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 255,
                    "default" : 1
                },
                "directedThreshold" : {
                    "description" : "Directed Threshold Setting, Defines the client count at which an AP will stop converting group addressed data traffic to unicast.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 128,
                    "default" : 5
                },
                "flowLogEnabled" : {
                    "description" : "Flow log enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "hdOverheadOptimizeEnable" : {
                    "description" : "Airtime Decongestion enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "probeRssiThr" : {
                    "description" : "Join RSSI threshold.",
                    "type" : "integer",
                    "minimum" : -90,
                    "maximum" : -60,
                    "default" : -85
                },
                "transientClientMgmtEnable" : {
                    "description" : "Transient Client Management enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "joinIgnoreTimeout" : {
                    "description" : "Join wait time.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 60,
                    "default" : 30
                },
                "joinAcceptTimeout" : {
                    "description" : "Join expire time.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 300,
                    "default" : 300
                },
                "joinIgnoreThr" : {
                    "description" : "Join wait threshold.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 50,
                    "default" : 10
                },
                "dropRandomProbesEnabled" : {
                    "description" : "Drop Random Probes enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "authRssiThr" : {
                    "description" : "Auth RSSI threshold.",
                    "type" : "integer",
                    "minimum" : -90,
                    "maximum" : -60
                },
                "assocRssiThr" : {
                    "description" : "Assoc RSSI threshold.",
                    "type" : "integer",
                    "minimum" : -90,
                    "maximum" : -60
                },
                "oceEnabled" : {
                    "description" : "Optimized Connectivity Experience(OCE) enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "oceBroadcastProbeResponseDelay" : {
                    "description" : "Broadcast probe response delay.",
                    "type" : "integer",
                    "minimum" : 8,
                    "maximum" : 120,
                    "default" : 15
                },
                "oceRssiBasedAssociationRejectionThreshold" : {
                    "description" : "RSSI-based association rejection threshold.",
                    "type" : "integer",
                    "minimum" : -90,
                    "maximum" : -60,
                    "default" : -75
                }
            },
            "type" : "object"
        },
        "authServiceOrProfile" : {
            "description" : "Authentication of the WLAN. If authentication messages are sent through the controller, the ID or name of the global authentication profiles is required. If authentication messages are not sent through the controller, the ID or name of the authentication services configured within the zone is required.",
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "description" : "Identifier of the authentication service or profile. At least one ID or name or authenticationOption is required in the request.",
                    "type" : "string"
                },
                "locationDeliveryEnabled" : {
                    "description" : "RFC5580 location delivery support",
                    "type" : "boolean"
                },
                "realmBasedAuth" : {
                    "type" : "boolean"
                },
                "name" : {
                    "description" : "Name of the authentication service or profile. At least one ID or name or authenticationOption is required in the request. Or could input the 'Always Accept' or 'Local DB'.",
                    "type" : "string"
                },
                "authenticationOption" : {
                    "description" : "Option of the authentication service or profile, At least one ID or name or authenticationOption is required in the request. This only applies to hotspot and guest WLANs.",
                    "type" : "string",
                    "enum" : [ "Local DB", "Guest", "Always Accept", null ]
                },
                "throughController" : {
                    "description" : "Indicates whether authentication messages were sent through the controller or not",
                    "type" : "boolean"
                },
                "backupAuthenticationId" : {
                    "description" : "Identifier of the backup authentication service or profile. At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service.",
                    "type" : "string"
                },
                "backupAuthenticationName" : {
                    "description" : "Name of the backup authentication service or profile. At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service. Or could input the 'Always Accept'.",
                    "type" : "string"
                },
                "backupAuthenticationOption" : {
                    "description" : "Option of the backup authentication service or profile, At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service. This only applies to hotspot WLANs.",
                    "type" : "string",
                    "enum" : [ "Always Accept", null ]
                }
            },
            "type" : "object"
        },
        "coreTunnelProfile" : {
            "description" : "Core tunnel of the WLAN. This only applies when the access tunnel type is set to RuckusGRE.",
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "description" : "Identifier of the forwarding profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the forwarding profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "type" : {
                    "description" : "Tunnel type",
                    "type" : "string",
                    "enum" : [ "Bridge" ]
                }
            },
            "required" : [ "type" ],
            "type" : "object"
        },
        "defaultUserTrafficProfile" : {
            "description" : "User traffic profile of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "precedenceProfileId" : {
            "description" : "Precedence profile of the WLAN",
            "type" : "string"
        },
        "description" : {
            "description" : "Description of the WLAN",
            "type" : [ "string", "null" ],
            "maxLength" : 64
        },
        "devicePolicy" : {
            "description" : "Device policy of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "diffServProfile" : {
            "description" : "DiffServ profile of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "dnsServerProfile" : {
            "description" : "DNS server profile of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "dpsk" : {
            "description" : "DPSK Setting",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "dpskEnabled" : {
                    "description" : "DPSK enabled",
                    "type" : "boolean",
                    "default" : false
                },
                "length" : {
                    "description" : "Length of DPSK key",
                    "type" : "integer",
                    "default" : 62
                },
                "dpskType" : {
                    "description" : "Type of DPSK key",
                    "type" : "string",
                    "enum" : [ "Secure", "KeyboardFriendly", "NumbersOnly" ],
                    "default" : "Secure"
                },
                "expiration" : {
                    "description" : "Expiration of DPSK key",
                    "type" : "string",
                    "enum" : [ "Unlimited", "OneDay", "TwoDays", "OneWeek", "TwoWeeks", "OneMonth", "SixMonths", "OneYear", "TwoYears" ],
                    "default" : "Unlimited"
                },
                "dpskFromType" : {
                    "description" : "Type of expiration start from",
                    "type" : "string",
                    "enum" : [ "CreateTime", "FirstUse" ],
                    "default" : "CreateTime"
                }
            }
        },
        "externalDpsk" : {
            "description" : "External DPSK Enabled",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "enabled" : {
                    "description" : "Enable External DPSK",
                    "type" : "boolean",
                    "default" : false
                },
                "encryption" : {
                    "description" : "Encryption of the WLAN relate to external DPSK",
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "method" : {
                            "description" : "Encryption method",
                            "type" : "string",
                            "enum" : [ "WPA2", "WPA_Mixed", "None" ]
                        },
                        "algorithm" : {
                            "description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
                            "type" : "string",
                            "enum" : [ "AES", "TKIP_AES" ]
                        }
                    }
                },
                "authService" : {
                    "description" : "Autentication of the WLAN relate to external DPSK",
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "description" : "Identifier of the authentication service. At least one ID or name is required in the request.",
                            "type" : "string"
                        },
                        "name" : {
                            "description" : "Name of the authentication service. At least one ID or name is required in the request.",
                            "type" : "string"
                        }
                    }
                }
            },
            "required" : [ "enabled" ]
        },
        "encryption" : {
            "description" : "Encryption of the WLAN",
            "additionalProperties" : false,
            "properties" : {
                "algorithm" : {
                    "description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
                    "type" : "string",
                    "enum" : [ "AES", "TKIP_AES" ]
                },
                "keyInHex" : {
                    "description" : "Key in hex format. This only applies to WEP64 and WEP128.",
                    "type" : "string"
                },
                "keyIndex" : {
                    "description" : "Key index. This only applies to WEP64 and WEP128.",
                    "type" : "integer"
                },
                "method" : {
                    "description" : "Encryption method",
                    "type" : "string",
                    "enum" : [ "WPA2", "WPA_Mixed", "WEP_64", "WEP_128", "None" ],
                    "default" : "None"
                },
                "mfp" : {
                    "description" : "Management frame protection. This only applies to WPA2 + AES",
                    "type" : "string",
                    "enum" : [ "disabled", "capable", "required" ]
                },
                "mobilityDomainId" : {
                    "description" : "mobility Domain Id.",
                    "maximum" : 65535,
                    "minimum" : 1,
                    "type" : "integer"
                },
                "passphrase" : {
                    "description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
                    "type" : "string"
                },
                "support80211rEnabled" : {
                    "description" : "Enable 802.11r Fast BSS Transition, fast Romaing.",
                    "type" : "boolean"
                }
            },
            "required" : [ "method" ],
            "type" : "object"
        },
        "hessid" : {
            "description" : "HESSID of the WLAN",
            "pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$",
            "type" : "string"
        },
        "hotspot20Profile" : {
            "description" : "Hotspot 2.0 operator profile of the WLAN. id or name of the hotspot 2.0 operator profiles within the zone is required.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "l2ACL" : {
            "description" : "Layer 2 ACL of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "macAuth" : {
            "description" : "MAC address authentication settings of the WLAN. This only applies to standard MAC and Hotspot MAC bypass WLAN.",
            "additionalProperties" : false,
            "properties" : {
                "customizedPassword" : {
                    "description" : "User defined password. When this field is set to an empty string, the MAC address is used as password.",
                    "maxLength" : 64,
                    "pattern" : "^([!-;=?-~]([ -;=?-~]){0,62}[!-;=?-~]|[!-;=?-~]{1,1}|\s{0,0})$",
                    "type" : "string"
                },
                "macAuthMacFormat" : {
                    "description" : "MAC address format. The default format is 0010a42319c0 and the 802.1X format is 00-10-A4-23-19-C0.",
                    "type" : "string",
                    "enum" : [ "Default", "802.1X", "UpperColon", "Upper", "LowerDash", "LowerColon" ]
                }
            },
            "type" : "object"
        },
        "name" : {
            "description" : "Name of the WLAN",
            "type" : "string",
            "minLength" : 1,
            "maxLength" : 32
        },
        "operatorRealm" : {
            "description" : "Operator realm, operatorRealm only supports coreTunnelProfile type is PMIP or authServiceOrProfile.locationDeliveryEnabled is true",
            "type" : "string",
            "maxLength" : 255,
            "pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
        },
        "portalServiceProfile" : {
            "description" : "Portal service of the WLAN. This only applies to hotspot, hotspot MAC bypass, guest and web auth WLANs.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "qosMaps" : {
            "description" : "Qos map set of the WLAN.",
            "items" : {
                "additionalProperties" : false,
                "properties" : {
                    "enable" : {
                        "description" : "Enabled or disabled",
                        "type" : "boolean"
                    },
                    "excepts" : {
                        "items" : {
                            "maximum" : 63,
                            "minimum" : 0,
                            "type" : "integer"
                        },
                        "type" : [ "array", "null" ]
                    },
                    "high" : {
                        "description" : "DSCP range - high",
                        "maximum" : 255,
                        "minimum" : 0,
                        "type" : [ "integer", "null" ]
                    },
                    "low" : {
                        "description" : "DSCP range - low",
                        "maximum" : 255,
                        "minimum" : 0,
                        "type" : [ "integer", "null" ]
                    },
                    "priority" : {
                        "description" : "Priority",
                        "type" : "integer"
                    }
                },
                "required" : [ "enable", "priority" ],
                "type" : "object"
            },
            "type" : "array"
        },
        "radiusOptions" : {
            "description" : "RADIUS options of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "calledStaIdType" : {
                    "default" : "WLAN_BSSID",
                    "description" : "Called station ID type",
                    "type" : "string",
                    "enum" : [ "AP_MAC", "NONE", "WLAN_BSSID" ]
                },
                "customizedNasId" : {
                    "description" : "User defined NAS ID",
                    "maxLength" : 64,
                    "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                    "type" : "string"
                },
                "nasIdType" : {
                    "default" : "WLAN_BSSID",
                    "description" : "NAS ID type",
                    "type" : "string",
                    "enum" : [ "AP_MAC", "Customized", "WLAN_BSSID" ]
                },
                "nasMaxRetry" : {
                    "default" : 2,
                    "description" : "NAS request maximum retry",
                    "maximum" : 10,
                    "minimum" : 2,
                    "type" : "integer"
                },
                "nasReconnectPrimaryMin" : {
                    "default" : 5,
                    "description" : "NAS reconnect primary time in minutes",
                    "maximum" : 60,
                    "minimum" : 1,
                    "type" : "integer"
                },
                "nasRequestTimeoutSec" : {
                    "default" : 3,
                    "description" : "NAS request timeout in seconds",
                    "maximum" : 20,
                    "minimum" : 2,
                    "type" : "integer"
                },
                "nasIpType" : {
                    "description" : "NAS IP type",
                    "type" : "string",
                    "enum" : [ "disabled", "control", "management", "userDefined" ],
                    "default" : "disabled"
                },
                "nasIpUserDefined" : {
                    "description" : "User-defined NAS IP",
                    "type" : "string",
                    "maxLength" : 45
                },
                "singleSessionIdAcctEnabled" : {
                    "description" : "When Single Accounting Session ID is enabled, APs will maintain one accounting session for client roaming",
                    "type" : "boolean",
                    "default" : false
                },
                "vendorSpecificAttributeProfileId" : {
                    "description" : "Vendor Specific Attribute Profile ID",
                    "type" : "string"
                }
            }
        },
        "schedule" : {
            "description" : "Schedule of the WLAN",
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "description" : "Identifier of the schedule profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the schedule profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "type" : {
                    "description" : "Type of WLAN schedule",
                    "type" : "string",
                    "enum" : [ "AlwaysOn", "AlwaysOff", "Customized" ],
                    "default" : "AlwaysOn"
                }
            },
            "required" : [ "type" ],
            "type" : "object"
        },
        "ssid" : {
            "description" : "SSID of the WLAN",
            "type" : "string",
            "minLength" : 1,
            "maxLength" : 32
        },
        "timeboundWhitelist" : {
            "description" : "Hotspot timeboundWhitelist. The ID of the OAuth Authentication service is required.",
            "additionalProperties" : false,
            "properties" : {
                "firstIndex" : {
                    "type" : "integer"
                },
                "hasMore" : {
                    "type" : "boolean"
                },
                "list" : {
                    "items" : {
                        "type" : [ "object", "null" ],
                        "additionalProperties" : false,
                        "properties" : {
                            "id" : {
                                "type" : "string"
                            },
                            "name" : {
                                "type" : "string"
                            }
                        }
                    },
                    "type" : "array"
                },
                "totalCount" : {
                    "type" : "integer"
                }
            },
            "type" : "object"
        },
        "vlan" : {
            "description" : "VLAN (access and/or core) of the WLAN.",
            "additionalProperties" : false,
            "properties" : {
                "aaaVlanOverride" : {
                    "description" : "Indicates whether the AAA VLAN settings can be overriden or not",
                    "type" : "boolean"
                },
                "accessVlan" : {
                    "description" : "Access VLAN ID",
                    "maximum" : 4094,
                    "minimum" : 1,
                    "type" : "integer",
                    "default" : 1
                },
                "vlanPooling" : {
                    "description" : "Vlan pooling",
                    "type" : [ "object", "null" ],
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string"
                        }
                    }
                }
            },
            "type" : "object"
        },
        "accessTunnelProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "accessIpsecProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "splitTunnelProfileId" : {
            "type" : "string"
        }
    },
    "required" : [ "name", "ssid", "authServiceOrProfile" ],
    "type" : "object"
}
Response  201
HideShow
Body
{
  "id": "wlanID"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Create - 802.1X with MAC Address

POST/v8_1/rkszones/{zoneId}/wlans/standard8021Xmac

Use this API command to create a new standard, 802.1X with MAC address and non-tunneled WLAN.

Request
HideShow
Body
{
  "name": "wlanName",
  "ssid": "wlanSSID",
  "description": "wlanDescription",
  "authServiceOrProfile": {
    "throughController": false,
    "id": "authServiceUUID",
    "name": "authServiceName",
    "authenticationOption": null
  },
  "accessTunnelType": "RuckusGRE",
  "accessTunnelProfile": {
    "id": "f5b92938-aa4e-4d02-90ea-273799ff689b",
    "name": "Default Tunnel Profile"
  },
  "splitTunnelProfileId": "38119bac-49e1-4410-ab8e-1c1bc88dd770",
  "coreTunnelProfile": {
    "type": "Bridge",
    "id": "forwardingUUID",
    "name": "forwardingName"
  },
  "encryption": {
    "method": "WPA2",
    "algorithm": "AES",
    "mfp": "disabled",
    "support80211rEnabled": true,
    "mobilityDomainId": 3
  },
  "operatorRealm": "operator realm",
  "defaultUserTrafficProfile": {
    "id": "userTrafficUUID",
    "name": "userTrafficName"
  },
  "precedenceProfileId": "c514d450-c839-9527-afc9-525400d12345",
  "portalDetectionProfileId": "de0fa30c-9565-11e8-9eb6-529269fb1459",
  "schedule": {
    "type": "Customized",
    "id": "ServiceUUID",
    "name": "ServiceName"
  },
  "vlan": {
    "accessVlan": 23,
    "aaaVlanOverride": true,
    "coreQinQEnabled": false,
    "coreSVlan": 1,
    "vlanPooling": null
  },
  "l2ACL": {
    "id": "l2ACLUUID",
    "name": "l2ACLName"
  },
  "devicePolicy": {
    "id": "devicePolicyUUID",
    "name": "devicePolicyName"
  },
  "radiusOptions": {
    "nasIdType": "Customized",
    "customizedNasId": "nasId",
    "nasRequestTimeoutSec": 12,
    "nasMaxRetry": 3,
    "nasReconnectPrimaryMin": 30,
    "calledStaIdType": "WLAN_BSSID",
    "nasIpType": "disabled",
    "nasIpUserDefined": "192.168.1.1",
    "vendorSpecificAttributeProfileId": "6d767421-d1b7-11e8-8ab9-ba2343155a93"
  },
  "advancedOptions": {
    "clientIsolationEnabled": true,
    "clientIsolationUnicastEnabled": true,
    "clientIsolationMulticastEnabled": false,
    "clientIsolationAutoVrrpEnabled": false,
    "clientIsolationWhitelist": {
      "id": "b89323e1-3168-11e7-b027-5254009ae3f0",
      "name": "myWhitelist"
    },
    "priority": "High",
    "hideSsidEnabled": true,
    "maxClientsPerRadio": 12,
    "clientIdleTimeoutSec": 60,
    "clientLoadBalancingEnabled": true,
    "proxyARPEnabled": true,
    "ndProxyEnabled": false,
    "suppressNsEnabled": false,
    "raProxyEnabled": false,
    "rsraGuardEnabled": false,
    "raThrottlingEnabled": false,
    "maxAllowedRA": 10,
    "raInterval": 10,
    "support80211dEnabled": false,
    "support80211kEnabled": true,
    "forceClientDHCPTimeoutSec": 5,
    "dhcp82SubOpt1Format": "SUBOPT1_AP_INFO_LOCATION",
    "unauthClientStatsEnabled": false,
    "clientFingerprintingEnabled": true,
    "ofdmOnlyEnabled": false,
    "bandBalancing": "UseZoneSetting",
    "bssMinRateMbps": "Disable",
    "mgmtTxRateMbps": "2 mbps",
    "avcEnabled": true,
    "urlFilteringPolicyEnabled": true,
    "urlFilteringPolicyId": "eabd4fa0-5015-11e7-84d0-525400a0e6c5",
    "wifiCallingPolicyEnabled": true,
    "wifiCallingPolicyIds": [
      "75e26590-547f-11e6-9ca7-5a095364c13c",
      "869bb532-547f-11e6-9ca7-5a095364c13c"
    ],
    "uplinkEnabled": true,
    "uplinkRate": 100,
    "downlinkEnabled": true,
    "downlinkRate": 200,
    "ratePerSTAUplink": "650mbps",
    "ratePerSTADownlink": "1mbps"
  },
  "diffServProfile": {
    "id": "diffServId",
    "name": "diffServName"
  },
  "qosMaps": [
    {
      "enable": true,
      "priority": 0,
      "low": 0,
      "high": 7,
      "excepts": null
    },
    {
      "enable": true,
      "priority": 1,
      "low": 8,
      "high": 15,
      "excepts": null
    },
    {
      "enable": true,
      "priority": 2,
      "low": 16,
      "high": 23,
      "excepts": null
    },
    {
      "enable": true,
      "priority": 3,
      "low": 0,
      "high": 32,
      "excepts": [
        43,
        45,
        60
      ]
    },
    {
      "enable": true,
      "priority": 4,
      "low": 32,
      "high": 39,
      "excepts": null
    },
    {
      "enable": true,
      "priority": 5,
      "low": 40,
      "high": 47,
      "excepts": null
    },
    {
      "enable": true,
      "priority": 6,
      "low": 48,
      "high": 55,
      "excepts": [
        46
      ]
    },
    {
      "enable": true,
      "priority": 7,
      "low": 56,
      "high": 63,
      "excepts": null
    }
  ],
  "dnsServerProfile": {
    "id": "DNS server profile UUID",
    "name": "DNS server profile name"
  },
  "dpsk": {
    "dpskEnabled": false,
    "length": 8,
    "dpskType": "Secure",
    "expiration": "OneDay",
    "dpskFromType": "FirstUse"
  },
  "externalDpsk": {
    "enabled": true,
    "encryption": {
      "method": "WPA2",
      "algorithm": "AES"
    },
    "authService": {
      "id": "authServiceUUID"
    }
  }
}
Schema
{
    "additionalProperties" : false,
    "properties" : {
        "accessTunnelType" : {
            "description" : "Access tunnel type of the WLAN. APLBO means AP local breakout, and SoftGRE means AP direct SoftGRE tunnel",
            "type" : "string",
            "enum" : [ "APLBO", "RuckusGRE", "SoftGRE" ]
        },
        "accountingServiceOrProfile" : {
            "description" : "Accounting of the WLAN",
            "additionalProperties" : false,
            "properties" : {
                "accountingDelayEnabled" : {
                    "description" : "Indicates whether accounting delay time is enabled",
                    "type" : "boolean"
                },
                "id" : {
                    "description" : "Accounting service or profile ID. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "interimUpdateMin" : {
                    "description" : "Interval (in minutes) for sending interim updates",
                    "maximum" : 1440,
                    "minimum" : 0,
                    "type" : "integer"
                },
                "name" : {
                    "description" : "Accounting service or profile name. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "throughController" : {
                    "description" : "Indicates whether accounting messages were sent through the controller",
                    "type" : "boolean"
                },
                "realmBasedAcct" : {
                    "type" : "boolean"
                },
                "backupAccountingId" : {
                    "description" : "Backup accounting service or profile ID. At least one backupAccountingId or backupAccountingName is required in the request when setting backup accounting service.",
                    "type" : "string"
                },
                "backupAccountingName" : {
                    "description" : "Backup accounting service or profile name. At least one backupAccountingId or backupAccountingName is required in the request when setting backup accounting service.",
                    "type" : "string"
                }
            },
            "type" : "object"
        },
        "advancedOptions" : {
            "description" : "Advanced settings for the WLAN.",
            "additionalProperties" : false,
            "properties" : {
                "avcEnabled" : {
                    "default" : false,
                    "description" : "Indicator of whether AVC support is enabled or disabled",
                    "type" : "boolean"
                },
                "bandBalancing" : {
                    "default" : "UseZoneSetting",
                    "description" : "Indicates whether band balancing is enabled or disabled",
                    "type" : "string",
                    "enum" : [ "Disabled", "UseZoneSetting" ]
                },
                "bssMinRateMbps" : {
                    "description" : "BSS minimum rate (mbps)",
                    "type" : "string",
                    "enum" : [ "Disable", "1 mbps", "2 mbps", "5.5 mbps", "12 mbps", "24 mbps" ],
                    "default" : "Disable"
                },
                "clientFingerprintingEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether client fingerprinting is enabled or disabled",
                    "type" : "boolean"
                },
                "clientIdleTimeoutSec" : {
                    "default" : 120,
                    "description" : "Client idle timeout in seconds",
                    "maximum" : 1000,
                    "minimum" : 60,
                    "type" : "integer"
                },
                "clientIsolationEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether wireless client isolation is enabled or disabled",
                    "type" : "boolean"
                },
                "clientIsolationUnicastEnabled" : {
                    "description" : "Indicates whether isolate unicast of wireless client isolation is enabled or disabled",
                    "type" : "boolean",
                    "default" : true
                },
                "clientIsolationMulticastEnabled" : {
                    "description" : "Indicates whether isolate multicast of wireless client isolation is enabled or disabled",
                    "type" : "boolean"
                },
                "clientIsolationAutoVrrpEnabled" : {
                    "description" : "Indicates whether Automatic support for VRRP of wireless client isolation is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "clientIsolationWhitelist" : {
                    "description" : "Indicates wireless client isolation whitelist",
                    "type" : [ "object", "null" ],
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string"
                        }
                    }
                },
                "clientLoadBalancingEnabled" : {
                    "description" : "Indicates whether Client Load Balancing is enabled or disabled",
                    "type" : "boolean",
                    "default" : true
                },
                "dgafEnabled" : {
                    "description" : "Indicates whether dgaf is enabled or disabled",
                    "type" : "boolean"
                },
                "dhcp82Format" : {
                    "description" : "DHCP Option 82 format. This variable no longer supports from v8_1 and only kept for backward compatibility.",
                    "type" : "string",
                    "enum" : [ "RUCKUS_DEFAULT", "SOFTGRE_CUSTOMIZED" ]
                },
                "dhcpOption82Enabled" : {
                    "default" : false,
                    "description" : "Indicates whether DCHP Option 82 is enabled or disabled. This variable no longer supports from v8_1 and only kept for backward compatibility.",
                    "type" : "boolean"
                },
                "dhcp82SubOpt1Format" : {
                    "description" : "Subopt-1 format",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT1_AP_INFO_LOCATION", "SUBOPT1_AP_INFO", "SUBOPT1_AP_MAC_ESSID_PRIVACYTYPE", "SUBOPT1_AP_MAC_hex", "SUBOPT1_AP_MAC_hex_ESSID", "SUBOPT1_ESSID" ]
                },
                "dhcp82SubOpt2Format" : {
                    "description" : "Subopt-2 format",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT2_CLIENT_MAC", "SUBOPT2_CLIENT_MAC_hex", "SUBOPT2_CLIENT_MAC_hex_ESSID", "SUBOPT2_AP_MAC", "SUBOPT2_AP_MAC_hex", "SUBOPT2_AP_MAC_hex_ESSID" ]
                },
                "dhcp82SubOpt150Format" : {
                    "description" : "Subopt-150 with VLAN-Id",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT150_VLAN_ID" ]
                },
                "dhcp82SubOpt151Format" : {
                    "description" : "Subopt-151 format",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT151_AREA_NAME", "SUBOPT151_ESSID" ]
                },
                "dhcp82SubOpt151AreaName" : {
                    "description" : "Subopt-151 Area Name value",
                    "type" : "string"
                },
                "downlinkEnabled" : {
                    "default" : false,
                    "description" : "SSID Rate Limiting downlink enabled.",
                    "type" : "boolean"
                },
                "downlinkRate" : {
                    "description" : "SSID Rate Limiting downlink.",
                    "type" : "number",
                    "default" : 0.0
                },
                "antiSpoofingEnabled" : {
                    "description" : "Anti-Spoofing enabled",
                    "type" : "boolean",
                    "default" : false
                },
                "arpRequestRateLimit" : {
                    "description" : "ARP packets request rate limit, default value will be 15 if both rate limit not being set.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 100
                },
                "dhcpRequestRateLimit" : {
                    "description" : "DHCP packets request rate limit, default value will be 15 if both rate limit not being set.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 100
                },
                "forceClientDHCPTimeoutSec" : {
                    "default" : 0,
                    "description" : "Force DHCP disconnects the client if the client does not obtain a valid IP address within the timeout peroid. To disable force DHCP, set this value to zero (0).",
                    "type" : "integer",
                    "enum" : [ 0, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15 ]
                },
                "hideSsidEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether the SSID is hidden or broadcast",
                    "type" : "boolean"
                },
                "hs20Onboarding" : {
                    "description" : "Allow WISPr WLAN for Hotspot 2.0 Onboarding",
                    "type" : "boolean",
                    "default" : false
                },
                "maxClientsPerRadio" : {
                    "default" : 100,
                    "description" : "Maximum number of clients per radio",
                    "maximum" : 512,
                    "minimum" : 1,
                    "type" : "integer"
                },
                "mgmtTxRateMbps" : {
                    "description" : "Management TX rate (mbps)",
                    "type" : "string",
                    "enum" : [ "1 mbps", "2 mbps", "5.5 mbps", "6 mbps", "9 mbps", "11 mbps", "12 mbps", "18 mbps", "24 mbps", "36 mbps", "48 mbps", "54 mbps" ],
                    "default" : "2 mbps"
                },
                "ofdmOnlyEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether OFDM only is enabled or disabled",
                    "type" : "boolean"
                },
                "okcEnabled" : {
                    "description" : "Indicator of whether OKC support is enabled or disabled. The default value is true when the WLAN is WPA+AES non open WLAN.",
                    "type" : "boolean"
                },
                "pmkCachingEnabled" : {
                    "description" : "Indicator of whether PKM caching support is enabled or disabled. The default value is true when the WLAN is WPA+AES non open WLAN.",
                    "type" : "boolean"
                },
                "priority" : {
                    "default" : "High",
                    "description" : "Priority of the WLAN",
                    "type" : "string",
                    "enum" : [ "High", "Low" ]
                },
                "proxyARPEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether proxy ARP is enabled or disabled",
                    "type" : "boolean"
                },
                "ndProxyEnabled" : {
                    "description" : "Indicates whether ND Proxy is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "suppressNsEnabled" : {
                    "description" : "Indicates whether supperssNS is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "raProxyEnabled" : {
                    "description" : "Indicates whether RA proxy is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "rsraGuardEnabled" : {
                    "description" : "Indicates whether RS/RA Guard is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "raThrottlingEnabled" : {
                    "description" : "Indicates whether RA Throttling is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "maxAllowedRA" : {
                    "description" : "Max Allowed RAs",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 1440,
                    "default" : 10
                },
                "raInterval" : {
                    "description" : "A timer that RA proxy runs and once receives unsolicited RA checks against the configured time and allow/drop RA based on next timeout",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 256,
                    "default" : 10
                },
                "support80211dEnabled" : {
                    "default" : true,
                    "description" : "Indicates whether support for 802.11d is enabled or disabled",
                    "type" : "boolean"
                },
                "support80211kEnabled" : {
                    "default" : true,
                    "description" : "Indicates whether support for 802.11k is enabled or disabled",
                    "type" : "boolean"
                },
                "unauthClientStatsEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether to send statistics of unauthorized clients or not",
                    "type" : "boolean"
                },
                "uplinkEnabled" : {
                    "default" : false,
                    "description" : "SSID Rate Limiting uplink enabled.",
                    "type" : "boolean"
                },
                "uplinkRate" : {
                    "description" : "SSID Rate Limiting uplink.",
                    "type" : "number",
                    "default" : 0.0
                },
                "ratePerSTAUplink" : {
                    "description" : "UE Rate Limiting uplink.",
                    "type" : "string"
                },
                "ratePerSTADownlink" : {
                    "description" : "UE Rate Limiting downlink.",
                    "type" : "string"
                },
                "dtimInterval" : {
                    "description" : "DTIM Interval",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 255,
                    "default" : 1
                },
                "directedThreshold" : {
                    "description" : "Directed Threshold Setting, Defines the client count at which an AP will stop converting group addressed data traffic to unicast.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 128,
                    "default" : 5
                },
                "flowLogEnabled" : {
                    "description" : "Flow log enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "hdOverheadOptimizeEnable" : {
                    "description" : "Airtime Decongestion enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "probeRssiThr" : {
                    "description" : "Join RSSI threshold.",
                    "type" : "integer",
                    "minimum" : -90,
                    "maximum" : -60,
                    "default" : -85
                },
                "transientClientMgmtEnable" : {
                    "description" : "Transient Client Management enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "joinIgnoreTimeout" : {
                    "description" : "Join wait time.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 60,
                    "default" : 30
                },
                "joinAcceptTimeout" : {
                    "description" : "Join expire time.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 300,
                    "default" : 300
                },
                "joinIgnoreThr" : {
                    "description" : "Join wait threshold.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 50,
                    "default" : 10
                },
                "dropRandomProbesEnabled" : {
                    "description" : "Drop Random Probes enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "authRssiThr" : {
                    "description" : "Auth RSSI threshold.",
                    "type" : "integer",
                    "minimum" : -90,
                    "maximum" : -60
                },
                "assocRssiThr" : {
                    "description" : "Assoc RSSI threshold.",
                    "type" : "integer",
                    "minimum" : -90,
                    "maximum" : -60
                },
                "oceEnabled" : {
                    "description" : "Optimized Connectivity Experience(OCE) enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "oceBroadcastProbeResponseDelay" : {
                    "description" : "Broadcast probe response delay.",
                    "type" : "integer",
                    "minimum" : 8,
                    "maximum" : 120,
                    "default" : 15
                },
                "oceRssiBasedAssociationRejectionThreshold" : {
                    "description" : "RSSI-based association rejection threshold.",
                    "type" : "integer",
                    "minimum" : -90,
                    "maximum" : -60,
                    "default" : -75
                }
            },
            "type" : "object"
        },
        "authServiceOrProfile" : {
            "description" : "Authentication of the WLAN. If authentication messages are sent through the controller, the ID or name of the global authentication profiles is required. If authentication messages are not sent through the controller, the ID or name of the authentication services configured within the zone is required.",
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "description" : "Identifier of the authentication service or profile. At least one ID or name or authenticationOption is required in the request.",
                    "type" : "string"
                },
                "locationDeliveryEnabled" : {
                    "description" : "RFC5580 location delivery support",
                    "type" : "boolean"
                },
                "realmBasedAuth" : {
                    "type" : "boolean"
                },
                "name" : {
                    "description" : "Name of the authentication service or profile. At least one ID or name or authenticationOption is required in the request. Or could input the 'Always Accept' or 'Local DB'.",
                    "type" : "string"
                },
                "authenticationOption" : {
                    "description" : "Option of the authentication service or profile, At least one ID or name or authenticationOption is required in the request. This only applies to hotspot and guest WLANs.",
                    "type" : "string",
                    "enum" : [ "Local DB", "Guest", "Always Accept", null ]
                },
                "throughController" : {
                    "description" : "Indicates whether authentication messages were sent through the controller or not",
                    "type" : "boolean"
                },
                "backupAuthenticationId" : {
                    "description" : "Identifier of the backup authentication service or profile. At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service.",
                    "type" : "string"
                },
                "backupAuthenticationName" : {
                    "description" : "Name of the backup authentication service or profile. At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service. Or could input the 'Always Accept'.",
                    "type" : "string"
                },
                "backupAuthenticationOption" : {
                    "description" : "Option of the backup authentication service or profile, At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service. This only applies to hotspot WLANs.",
                    "type" : "string",
                    "enum" : [ "Always Accept", null ]
                }
            },
            "type" : "object"
        },
        "coreTunnelProfile" : {
            "description" : "Core tunnel of the WLAN. This only applies when the access tunnel type is set to RuckusGRE.",
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "description" : "Identifier of the forwarding profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the forwarding profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "type" : {
                    "description" : "Tunnel type",
                    "type" : "string",
                    "enum" : [ "Bridge" ]
                }
            },
            "required" : [ "type" ],
            "type" : "object"
        },
        "defaultUserTrafficProfile" : {
            "description" : "User traffic profile of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "precedenceProfileId" : {
            "description" : "Precedence profile of the WLAN",
            "type" : "string"
        },
        "description" : {
            "description" : "Description of the WLAN",
            "type" : [ "string", "null" ],
            "maxLength" : 64
        },
        "devicePolicy" : {
            "description" : "Device policy of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "diffServProfile" : {
            "description" : "DiffServ profile of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "dnsServerProfile" : {
            "description" : "DNS server profile of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "dpsk" : {
            "description" : "DPSK Setting",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "dpskEnabled" : {
                    "description" : "DPSK enabled",
                    "type" : "boolean",
                    "default" : false
                },
                "length" : {
                    "description" : "Length of DPSK key",
                    "type" : "integer",
                    "default" : 62
                },
                "dpskType" : {
                    "description" : "Type of DPSK key",
                    "type" : "string",
                    "enum" : [ "Secure", "KeyboardFriendly", "NumbersOnly" ],
                    "default" : "Secure"
                },
                "expiration" : {
                    "description" : "Expiration of DPSK key",
                    "type" : "string",
                    "enum" : [ "Unlimited", "OneDay", "TwoDays", "OneWeek", "TwoWeeks", "OneMonth", "SixMonths", "OneYear", "TwoYears" ],
                    "default" : "Unlimited"
                },
                "dpskFromType" : {
                    "description" : "Type of expiration start from",
                    "type" : "string",
                    "enum" : [ "CreateTime", "FirstUse" ],
                    "default" : "CreateTime"
                }
            }
        },
        "externalDpsk" : {
            "description" : "External DPSK Enabled",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "enabled" : {
                    "description" : "Enable External DPSK",
                    "type" : "boolean",
                    "default" : false
                },
                "encryption" : {
                    "description" : "Encryption of the WLAN relate to external DPSK",
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "method" : {
                            "description" : "Encryption method",
                            "type" : "string",
                            "enum" : [ "WPA2", "WPA_Mixed", "None" ]
                        },
                        "algorithm" : {
                            "description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
                            "type" : "string",
                            "enum" : [ "AES", "TKIP_AES" ]
                        }
                    }
                },
                "authService" : {
                    "description" : "Autentication of the WLAN relate to external DPSK",
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "description" : "Identifier of the authentication service. At least one ID or name is required in the request.",
                            "type" : "string"
                        },
                        "name" : {
                            "description" : "Name of the authentication service. At least one ID or name is required in the request.",
                            "type" : "string"
                        }
                    }
                }
            },
            "required" : [ "enabled" ]
        },
        "encryption" : {
            "description" : "Encryption of the WLAN",
            "additionalProperties" : false,
            "properties" : {
                "algorithm" : {
                    "description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
                    "type" : "string",
                    "enum" : [ "AES", "TKIP_AES" ]
                },
                "keyInHex" : {
                    "description" : "Key in hex format. This only applies to WEP64 and WEP128.",
                    "type" : "string"
                },
                "keyIndex" : {
                    "description" : "Key index. This only applies to WEP64 and WEP128.",
                    "type" : "integer"
                },
                "method" : {
                    "description" : "Encryption method",
                    "type" : "string",
                    "enum" : [ "WPA2", "WPA_Mixed", "WEP_64", "WEP_128", "None" ],
                    "default" : "None"
                },
                "mfp" : {
                    "description" : "Management frame protection. This only applies to WPA2 + AES",
                    "type" : "string",
                    "enum" : [ "disabled", "capable", "required" ]
                },
                "mobilityDomainId" : {
                    "description" : "mobility Domain Id.",
                    "maximum" : 65535,
                    "minimum" : 1,
                    "type" : "integer"
                },
                "passphrase" : {
                    "description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
                    "type" : "string"
                },
                "support80211rEnabled" : {
                    "description" : "Enable 802.11r Fast BSS Transition, fast Romaing.",
                    "type" : "boolean"
                }
            },
            "required" : [ "method" ],
            "type" : "object"
        },
        "hessid" : {
            "description" : "HESSID of the WLAN",
            "pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$",
            "type" : "string"
        },
        "hotspot20Profile" : {
            "description" : "Hotspot 2.0 operator profile of the WLAN. id or name of the hotspot 2.0 operator profiles within the zone is required.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "l2ACL" : {
            "description" : "Layer 2 ACL of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "macAuth" : {
            "description" : "MAC address authentication settings of the WLAN. This only applies to standard MAC and Hotspot MAC bypass WLAN.",
            "additionalProperties" : false,
            "properties" : {
                "customizedPassword" : {
                    "description" : "User defined password. When this field is set to an empty string, the MAC address is used as password.",
                    "maxLength" : 64,
                    "pattern" : "^([!-;=?-~]([ -;=?-~]){0,62}[!-;=?-~]|[!-;=?-~]{1,1}|\s{0,0})$",
                    "type" : "string"
                },
                "macAuthMacFormat" : {
                    "description" : "MAC address format. The default format is 0010a42319c0 and the 802.1X format is 00-10-A4-23-19-C0.",
                    "type" : "string",
                    "enum" : [ "Default", "802.1X", "UpperColon", "Upper", "LowerDash", "LowerColon" ]
                }
            },
            "type" : "object"
        },
        "name" : {
            "description" : "Name of the WLAN",
            "type" : "string",
            "minLength" : 1,
            "maxLength" : 32
        },
        "operatorRealm" : {
            "description" : "Operator realm, operatorRealm only supports coreTunnelProfile type is PMIP or authServiceOrProfile.locationDeliveryEnabled is true",
            "type" : "string",
            "maxLength" : 255,
            "pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
        },
        "portalServiceProfile" : {
            "description" : "Portal service of the WLAN. This only applies to hotspot, hotspot MAC bypass, guest and web auth WLANs.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "qosMaps" : {
            "description" : "Qos map set of the WLAN.",
            "items" : {
                "additionalProperties" : false,
                "properties" : {
                    "enable" : {
                        "description" : "Enabled or disabled",
                        "type" : "boolean"
                    },
                    "excepts" : {
                        "items" : {
                            "maximum" : 63,
                            "minimum" : 0,
                            "type" : "integer"
                        },
                        "type" : [ "array", "null" ]
                    },
                    "high" : {
                        "description" : "DSCP range - high",
                        "maximum" : 255,
                        "minimum" : 0,
                        "type" : [ "integer", "null" ]
                    },
                    "low" : {
                        "description" : "DSCP range - low",
                        "maximum" : 255,
                        "minimum" : 0,
                        "type" : [ "integer", "null" ]
                    },
                    "priority" : {
                        "description" : "Priority",
                        "type" : "integer"
                    }
                },
                "required" : [ "enable", "priority" ],
                "type" : "object"
            },
            "type" : "array"
        },
        "radiusOptions" : {
            "description" : "RADIUS options of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "calledStaIdType" : {
                    "default" : "WLAN_BSSID",
                    "description" : "Called station ID type",
                    "type" : "string",
                    "enum" : [ "AP_MAC", "NONE", "WLAN_BSSID" ]
                },
                "customizedNasId" : {
                    "description" : "User defined NAS ID",
                    "maxLength" : 64,
                    "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                    "type" : "string"
                },
                "nasIdType" : {
                    "default" : "WLAN_BSSID",
                    "description" : "NAS ID type",
                    "type" : "string",
                    "enum" : [ "AP_MAC", "Customized", "WLAN_BSSID" ]
                },
                "nasMaxRetry" : {
                    "default" : 2,
                    "description" : "NAS request maximum retry",
                    "maximum" : 10,
                    "minimum" : 2,
                    "type" : "integer"
                },
                "nasReconnectPrimaryMin" : {
                    "default" : 5,
                    "description" : "NAS reconnect primary time in minutes",
                    "maximum" : 60,
                    "minimum" : 1,
                    "type" : "integer"
                },
                "nasRequestTimeoutSec" : {
                    "default" : 3,
                    "description" : "NAS request timeout in seconds",
                    "maximum" : 20,
                    "minimum" : 2,
                    "type" : "integer"
                },
                "nasIpType" : {
                    "description" : "NAS IP type",
                    "type" : "string",
                    "enum" : [ "disabled", "control", "management", "userDefined" ],
                    "default" : "disabled"
                },
                "nasIpUserDefined" : {
                    "description" : "User-defined NAS IP",
                    "type" : "string",
                    "maxLength" : 45
                },
                "singleSessionIdAcctEnabled" : {
                    "description" : "When Single Accounting Session ID is enabled, APs will maintain one accounting session for client roaming",
                    "type" : "boolean",
                    "default" : false
                },
                "vendorSpecificAttributeProfileId" : {
                    "description" : "Vendor Specific Attribute Profile ID",
                    "type" : "string"
                }
            }
        },
        "schedule" : {
            "description" : "Schedule of the WLAN",
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "description" : "Identifier of the schedule profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the schedule profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "type" : {
                    "description" : "Type of WLAN schedule",
                    "type" : "string",
                    "enum" : [ "AlwaysOn", "AlwaysOff", "Customized" ],
                    "default" : "AlwaysOn"
                }
            },
            "required" : [ "type" ],
            "type" : "object"
        },
        "ssid" : {
            "description" : "SSID of the WLAN",
            "type" : "string",
            "minLength" : 1,
            "maxLength" : 32
        },
        "timeboundWhitelist" : {
            "description" : "Hotspot timeboundWhitelist. The ID of the OAuth Authentication service is required.",
            "additionalProperties" : false,
            "properties" : {
                "firstIndex" : {
                    "type" : "integer"
                },
                "hasMore" : {
                    "type" : "boolean"
                },
                "list" : {
                    "items" : {
                        "type" : [ "object", "null" ],
                        "additionalProperties" : false,
                        "properties" : {
                            "id" : {
                                "type" : "string"
                            },
                            "name" : {
                                "type" : "string"
                            }
                        }
                    },
                    "type" : "array"
                },
                "totalCount" : {
                    "type" : "integer"
                }
            },
            "type" : "object"
        },
        "vlan" : {
            "description" : "VLAN (access and/or core) of the WLAN.",
            "additionalProperties" : false,
            "properties" : {
                "aaaVlanOverride" : {
                    "description" : "Indicates whether the AAA VLAN settings can be overriden or not",
                    "type" : "boolean"
                },
                "accessVlan" : {
                    "description" : "Access VLAN ID",
                    "maximum" : 4094,
                    "minimum" : 1,
                    "type" : "integer",
                    "default" : 1
                },
                "vlanPooling" : {
                    "description" : "Vlan pooling",
                    "type" : [ "object", "null" ],
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string"
                        }
                    }
                }
            },
            "type" : "object"
        },
        "accessTunnelProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "accessIpsecProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "splitTunnelProfileId" : {
            "type" : "string"
        }
    },
    "required" : [ "name", "ssid", "authServiceOrProfile" ],
    "type" : "object"
}
Response  201
HideShow
Body
{
  "id": "wlanID"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Create - MAC Auth

POST/v8_1/rkszones/{zoneId}/wlans/standardmac

Use this API command to create a new standard, MAC auth and non-tunneled WLAN.

Request
HideShow
Body
{
  "name": "wlanName",
  "ssid": "wlanSSID",
  "description": "wlanDescription",
  "authServiceOrProfile": {
    "throughController": false,
    "id": "authServiceUUID",
    "name": "authServiceName",
    "authenticationOption": null
  },
  "accessTunnelType": "RuckusGRE",
  "accessTunnelProfile": {
    "id": "f5b92938-aa4e-4d02-90ea-273799ff689b",
    "name": "Default Tunnel Profile"
  },
  "splitTunnelProfileId": "38119bac-49e1-4410-ab8e-1c1bc88dd770",
  "coreTunnelProfile": {
    "type": "Bridge",
    "id": "forwardingUUID",
    "name": "forwardingName"
  },
  "encryption": {
    "method": "WPA2",
    "algorithm": "AES",
    "mfp": "disabled",
    "support80211rEnabled": true,
    "mobilityDomainId": 3
  },
  "operatorRealm": "operator realm",
  "defaultUserTrafficProfile": {
    "id": "userTrafficUUID",
    "name": "userTrafficName"
  },
  "precedenceProfileId": "c514d450-c839-9527-afc9-525400d12345",
  "portalDetectionProfileId": "de0fa30c-9565-11e8-9eb6-529269fb1459",
  "schedule": {
    "type": "Customized",
    "id": "ServiceUUID",
    "name": "ServiceName"
  },
  "vlan": {
    "accessVlan": 23,
    "aaaVlanOverride": true,
    "coreQinQEnabled": false,
    "coreSVlan": 1,
    "vlanPooling": null
  },
  "l2ACL": {
    "id": "l2ACLUUID",
    "name": "l2ACLName"
  },
  "devicePolicy": {
    "id": "devicePolicyUUID",
    "name": "devicePolicyName"
  },
  "radiusOptions": {
    "nasIdType": "Customized",
    "customizedNasId": "nasId",
    "nasRequestTimeoutSec": 12,
    "nasMaxRetry": 3,
    "nasReconnectPrimaryMin": 30,
    "calledStaIdType": "WLAN_BSSID",
    "nasIpType": "disabled",
    "nasIpUserDefined": "192.168.1.1",
    "vendorSpecificAttributeProfileId": "6d767421-d1b7-11e8-8ab9-ba2343155a93"
  },
  "advancedOptions": {
    "clientIsolationEnabled": true,
    "clientIsolationUnicastEnabled": true,
    "clientIsolationMulticastEnabled": false,
    "clientIsolationAutoVrrpEnabled": false,
    "clientIsolationWhitelist": {
      "id": "b89323e1-3168-11e7-b027-5254009ae3f0",
      "name": "myWhitelist"
    },
    "priority": "High",
    "hideSsidEnabled": true,
    "maxClientsPerRadio": 12,
    "clientIdleTimeoutSec": 60,
    "clientLoadBalancingEnabled": true,
    "proxyARPEnabled": true,
    "ndProxyEnabled": false,
    "suppressNsEnabled": false,
    "raProxyEnabled": false,
    "rsraGuardEnabled": false,
    "raThrottlingEnabled": false,
    "maxAllowedRA": 10,
    "raInterval": 10,
    "support80211dEnabled": false,
    "support80211kEnabled": true,
    "forceClientDHCPTimeoutSec": 5,
    "dhcp82SubOpt1Format": "SUBOPT1_AP_INFO_LOCATION",
    "unauthClientStatsEnabled": false,
    "clientFingerprintingEnabled": true,
    "ofdmOnlyEnabled": false,
    "bandBalancing": "UseZoneSetting",
    "bssMinRateMbps": "Disable",
    "mgmtTxRateMbps": "2 mbps",
    "avcEnabled": true,
    "urlFilteringPolicyEnabled": true,
    "urlFilteringPolicyId": "eabd4fa0-5015-11e7-84d0-525400a0e6c5",
    "wifiCallingPolicyEnabled": true,
    "wifiCallingPolicyIds": [
      "75e26590-547f-11e6-9ca7-5a095364c13c",
      "869bb532-547f-11e6-9ca7-5a095364c13c"
    ],
    "uplinkEnabled": true,
    "uplinkRate": 100,
    "downlinkEnabled": true,
    "downlinkRate": 200,
    "ratePerSTAUplink": "650mbps",
    "ratePerSTADownlink": "1mbps"
  },
  "diffServProfile": {
    "id": "diffServId",
    "name": "diffServName"
  },
  "qosMaps": [
    {
      "enable": true,
      "priority": 0,
      "low": 0,
      "high": 7,
      "excepts": null
    },
    {
      "enable": true,
      "priority": 1,
      "low": 8,
      "high": 15,
      "excepts": null
    },
    {
      "enable": true,
      "priority": 2,
      "low": 16,
      "high": 23,
      "excepts": null
    },
    {
      "enable": true,
      "priority": 3,
      "low": 0,
      "high": 32,
      "excepts": [
        43,
        45,
        60
      ]
    },
    {
      "enable": true,
      "priority": 4,
      "low": 32,
      "high": 39,
      "excepts": null
    },
    {
      "enable": true,
      "priority": 5,
      "low": 40,
      "high": 47,
      "excepts": null
    },
    {
      "enable": true,
      "priority": 6,
      "low": 48,
      "high": 55,
      "excepts": [
        46
      ]
    },
    {
      "enable": true,
      "priority": 7,
      "low": 56,
      "high": 63,
      "excepts": null
    }
  ],
  "dnsServerProfile": {
    "id": "DNS server profile UUID",
    "name": "DNS server profile name"
  },
  "dpsk": {
    "dpskEnabled": false,
    "length": 8,
    "dpskType": "Secure",
    "expiration": "OneDay",
    "dpskFromType": "FirstUse"
  },
  "externalDpsk": {
    "enabled": true,
    "encryption": {
      "method": "WPA2",
      "algorithm": "AES"
    },
    "authService": {
      "id": "authServiceUUID"
    }
  }
}
Schema
{
    "additionalProperties" : false,
    "properties" : {
        "accessTunnelType" : {
            "description" : "Access tunnel type of the WLAN. APLBO means AP local breakout, and SoftGRE means AP direct SoftGRE tunnel",
            "type" : "string",
            "enum" : [ "APLBO", "RuckusGRE", "SoftGRE" ]
        },
        "accountingServiceOrProfile" : {
            "description" : "Accounting of the WLAN",
            "additionalProperties" : false,
            "properties" : {
                "accountingDelayEnabled" : {
                    "description" : "Indicates whether accounting delay time is enabled",
                    "type" : "boolean"
                },
                "id" : {
                    "description" : "Accounting service or profile ID. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "interimUpdateMin" : {
                    "description" : "Interval (in minutes) for sending interim updates",
                    "maximum" : 1440,
                    "minimum" : 0,
                    "type" : "integer"
                },
                "name" : {
                    "description" : "Accounting service or profile name. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "throughController" : {
                    "description" : "Indicates whether accounting messages were sent through the controller",
                    "type" : "boolean"
                },
                "realmBasedAcct" : {
                    "type" : "boolean"
                },
                "backupAccountingId" : {
                    "description" : "Backup accounting service or profile ID. At least one backupAccountingId or backupAccountingName is required in the request when setting backup accounting service.",
                    "type" : "string"
                },
                "backupAccountingName" : {
                    "description" : "Backup accounting service or profile name. At least one backupAccountingId or backupAccountingName is required in the request when setting backup accounting service.",
                    "type" : "string"
                }
            },
            "type" : "object"
        },
        "advancedOptions" : {
            "description" : "Advanced settings for the WLAN.",
            "additionalProperties" : false,
            "properties" : {
                "avcEnabled" : {
                    "default" : false,
                    "description" : "Indicator of whether AVC support is enabled or disabled",
                    "type" : "boolean"
                },
                "bandBalancing" : {
                    "default" : "UseZoneSetting",
                    "description" : "Indicates whether band balancing is enabled or disabled",
                    "type" : "string",
                    "enum" : [ "Disabled", "UseZoneSetting" ]
                },
                "bssMinRateMbps" : {
                    "description" : "BSS minimum rate (mbps)",
                    "type" : "string",
                    "enum" : [ "Disable", "1 mbps", "2 mbps", "5.5 mbps", "12 mbps", "24 mbps" ],
                    "default" : "Disable"
                },
                "clientFingerprintingEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether client fingerprinting is enabled or disabled",
                    "type" : "boolean"
                },
                "clientIdleTimeoutSec" : {
                    "default" : 120,
                    "description" : "Client idle timeout in seconds",
                    "maximum" : 1000,
                    "minimum" : 60,
                    "type" : "integer"
                },
                "clientIsolationEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether wireless client isolation is enabled or disabled",
                    "type" : "boolean"
                },
                "clientIsolationUnicastEnabled" : {
                    "description" : "Indicates whether isolate unicast of wireless client isolation is enabled or disabled",
                    "type" : "boolean",
                    "default" : true
                },
                "clientIsolationMulticastEnabled" : {
                    "description" : "Indicates whether isolate multicast of wireless client isolation is enabled or disabled",
                    "type" : "boolean"
                },
                "clientIsolationAutoVrrpEnabled" : {
                    "description" : "Indicates whether Automatic support for VRRP of wireless client isolation is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "clientIsolationWhitelist" : {
                    "description" : "Indicates wireless client isolation whitelist",
                    "type" : [ "object", "null" ],
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string"
                        }
                    }
                },
                "clientLoadBalancingEnabled" : {
                    "description" : "Indicates whether Client Load Balancing is enabled or disabled",
                    "type" : "boolean",
                    "default" : true
                },
                "dgafEnabled" : {
                    "description" : "Indicates whether dgaf is enabled or disabled",
                    "type" : "boolean"
                },
                "dhcp82Format" : {
                    "description" : "DHCP Option 82 format. This variable no longer supports from v8_1 and only kept for backward compatibility.",
                    "type" : "string",
                    "enum" : [ "RUCKUS_DEFAULT", "SOFTGRE_CUSTOMIZED" ]
                },
                "dhcpOption82Enabled" : {
                    "default" : false,
                    "description" : "Indicates whether DCHP Option 82 is enabled or disabled. This variable no longer supports from v8_1 and only kept for backward compatibility.",
                    "type" : "boolean"
                },
                "dhcp82SubOpt1Format" : {
                    "description" : "Subopt-1 format",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT1_AP_INFO_LOCATION", "SUBOPT1_AP_INFO", "SUBOPT1_AP_MAC_ESSID_PRIVACYTYPE", "SUBOPT1_AP_MAC_hex", "SUBOPT1_AP_MAC_hex_ESSID", "SUBOPT1_ESSID" ]
                },
                "dhcp82SubOpt2Format" : {
                    "description" : "Subopt-2 format",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT2_CLIENT_MAC", "SUBOPT2_CLIENT_MAC_hex", "SUBOPT2_CLIENT_MAC_hex_ESSID", "SUBOPT2_AP_MAC", "SUBOPT2_AP_MAC_hex", "SUBOPT2_AP_MAC_hex_ESSID" ]
                },
                "dhcp82SubOpt150Format" : {
                    "description" : "Subopt-150 with VLAN-Id",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT150_VLAN_ID" ]
                },
                "dhcp82SubOpt151Format" : {
                    "description" : "Subopt-151 format",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT151_AREA_NAME", "SUBOPT151_ESSID" ]
                },
                "dhcp82SubOpt151AreaName" : {
                    "description" : "Subopt-151 Area Name value",
                    "type" : "string"
                },
                "downlinkEnabled" : {
                    "default" : false,
                    "description" : "SSID Rate Limiting downlink enabled.",
                    "type" : "boolean"
                },
                "downlinkRate" : {
                    "description" : "SSID Rate Limiting downlink.",
                    "type" : "number",
                    "default" : 0.0
                },
                "antiSpoofingEnabled" : {
                    "description" : "Anti-Spoofing enabled",
                    "type" : "boolean",
                    "default" : false
                },
                "arpRequestRateLimit" : {
                    "description" : "ARP packets request rate limit, default value will be 15 if both rate limit not being set.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 100
                },
                "dhcpRequestRateLimit" : {
                    "description" : "DHCP packets request rate limit, default value will be 15 if both rate limit not being set.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 100
                },
                "forceClientDHCPTimeoutSec" : {
                    "default" : 0,
                    "description" : "Force DHCP disconnects the client if the client does not obtain a valid IP address within the timeout peroid. To disable force DHCP, set this value to zero (0).",
                    "type" : "integer",
                    "enum" : [ 0, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15 ]
                },
                "hideSsidEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether the SSID is hidden or broadcast",
                    "type" : "boolean"
                },
                "hs20Onboarding" : {
                    "description" : "Allow WISPr WLAN for Hotspot 2.0 Onboarding",
                    "type" : "boolean",
                    "default" : false
                },
                "maxClientsPerRadio" : {
                    "default" : 100,
                    "description" : "Maximum number of clients per radio",
                    "maximum" : 512,
                    "minimum" : 1,
                    "type" : "integer"
                },
                "mgmtTxRateMbps" : {
                    "description" : "Management TX rate (mbps)",
                    "type" : "string",
                    "enum" : [ "1 mbps", "2 mbps", "5.5 mbps", "6 mbps", "9 mbps", "11 mbps", "12 mbps", "18 mbps", "24 mbps", "36 mbps", "48 mbps", "54 mbps" ],
                    "default" : "2 mbps"
                },
                "ofdmOnlyEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether OFDM only is enabled or disabled",
                    "type" : "boolean"
                },
                "okcEnabled" : {
                    "description" : "Indicator of whether OKC support is enabled or disabled. The default value is true when the WLAN is WPA+AES non open WLAN.",
                    "type" : "boolean"
                },
                "pmkCachingEnabled" : {
                    "description" : "Indicator of whether PKM caching support is enabled or disabled. The default value is true when the WLAN is WPA+AES non open WLAN.",
                    "type" : "boolean"
                },
                "priority" : {
                    "default" : "High",
                    "description" : "Priority of the WLAN",
                    "type" : "string",
                    "enum" : [ "High", "Low" ]
                },
                "proxyARPEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether proxy ARP is enabled or disabled",
                    "type" : "boolean"
                },
                "ndProxyEnabled" : {
                    "description" : "Indicates whether ND Proxy is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "suppressNsEnabled" : {
                    "description" : "Indicates whether supperssNS is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "raProxyEnabled" : {
                    "description" : "Indicates whether RA proxy is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "rsraGuardEnabled" : {
                    "description" : "Indicates whether RS/RA Guard is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "raThrottlingEnabled" : {
                    "description" : "Indicates whether RA Throttling is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "maxAllowedRA" : {
                    "description" : "Max Allowed RAs",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 1440,
                    "default" : 10
                },
                "raInterval" : {
                    "description" : "A timer that RA proxy runs and once receives unsolicited RA checks against the configured time and allow/drop RA based on next timeout",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 256,
                    "default" : 10
                },
                "support80211dEnabled" : {
                    "default" : true,
                    "description" : "Indicates whether support for 802.11d is enabled or disabled",
                    "type" : "boolean"
                },
                "support80211kEnabled" : {
                    "default" : true,
                    "description" : "Indicates whether support for 802.11k is enabled or disabled",
                    "type" : "boolean"
                },
                "unauthClientStatsEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether to send statistics of unauthorized clients or not",
                    "type" : "boolean"
                },
                "uplinkEnabled" : {
                    "default" : false,
                    "description" : "SSID Rate Limiting uplink enabled.",
                    "type" : "boolean"
                },
                "uplinkRate" : {
                    "description" : "SSID Rate Limiting uplink.",
                    "type" : "number",
                    "default" : 0.0
                },
                "ratePerSTAUplink" : {
                    "description" : "UE Rate Limiting uplink.",
                    "type" : "string"
                },
                "ratePerSTADownlink" : {
                    "description" : "UE Rate Limiting downlink.",
                    "type" : "string"
                },
                "dtimInterval" : {
                    "description" : "DTIM Interval",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 255,
                    "default" : 1
                },
                "directedThreshold" : {
                    "description" : "Directed Threshold Setting, Defines the client count at which an AP will stop converting group addressed data traffic to unicast.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 128,
                    "default" : 5
                },
                "flowLogEnabled" : {
                    "description" : "Flow log enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "hdOverheadOptimizeEnable" : {
                    "description" : "Airtime Decongestion enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "probeRssiThr" : {
                    "description" : "Join RSSI threshold.",
                    "type" : "integer",
                    "minimum" : -90,
                    "maximum" : -60,
                    "default" : -85
                },
                "transientClientMgmtEnable" : {
                    "description" : "Transient Client Management enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "joinIgnoreTimeout" : {
                    "description" : "Join wait time.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 60,
                    "default" : 30
                },
                "joinAcceptTimeout" : {
                    "description" : "Join expire time.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 300,
                    "default" : 300
                },
                "joinIgnoreThr" : {
                    "description" : "Join wait threshold.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 50,
                    "default" : 10
                },
                "dropRandomProbesEnabled" : {
                    "description" : "Drop Random Probes enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "authRssiThr" : {
                    "description" : "Auth RSSI threshold.",
                    "type" : "integer",
                    "minimum" : -90,
                    "maximum" : -60
                },
                "assocRssiThr" : {
                    "description" : "Assoc RSSI threshold.",
                    "type" : "integer",
                    "minimum" : -90,
                    "maximum" : -60
                },
                "oceEnabled" : {
                    "description" : "Optimized Connectivity Experience(OCE) enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "oceBroadcastProbeResponseDelay" : {
                    "description" : "Broadcast probe response delay.",
                    "type" : "integer",
                    "minimum" : 8,
                    "maximum" : 120,
                    "default" : 15
                },
                "oceRssiBasedAssociationRejectionThreshold" : {
                    "description" : "RSSI-based association rejection threshold.",
                    "type" : "integer",
                    "minimum" : -90,
                    "maximum" : -60,
                    "default" : -75
                }
            },
            "type" : "object"
        },
        "authServiceOrProfile" : {
            "description" : "Authentication of the WLAN. If authentication messages are sent through the controller, the ID or name of the global authentication profiles is required. If authentication messages are not sent through the controller, the ID or name of the authentication services configured within the zone is required.",
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "description" : "Identifier of the authentication service or profile. At least one ID or name or authenticationOption is required in the request.",
                    "type" : "string"
                },
                "locationDeliveryEnabled" : {
                    "description" : "RFC5580 location delivery support",
                    "type" : "boolean"
                },
                "realmBasedAuth" : {
                    "type" : "boolean"
                },
                "name" : {
                    "description" : "Name of the authentication service or profile. At least one ID or name or authenticationOption is required in the request. Or could input the 'Always Accept' or 'Local DB'.",
                    "type" : "string"
                },
                "authenticationOption" : {
                    "description" : "Option of the authentication service or profile, At least one ID or name or authenticationOption is required in the request. This only applies to hotspot and guest WLANs.",
                    "type" : "string",
                    "enum" : [ "Local DB", "Guest", "Always Accept", null ]
                },
                "throughController" : {
                    "description" : "Indicates whether authentication messages were sent through the controller or not",
                    "type" : "boolean"
                },
                "backupAuthenticationId" : {
                    "description" : "Identifier of the backup authentication service or profile. At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service.",
                    "type" : "string"
                },
                "backupAuthenticationName" : {
                    "description" : "Name of the backup authentication service or profile. At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service. Or could input the 'Always Accept'.",
                    "type" : "string"
                },
                "backupAuthenticationOption" : {
                    "description" : "Option of the backup authentication service or profile, At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service. This only applies to hotspot WLANs.",
                    "type" : "string",
                    "enum" : [ "Always Accept", null ]
                }
            },
            "type" : "object"
        },
        "coreTunnelProfile" : {
            "description" : "Core tunnel of the WLAN. This only applies when the access tunnel type is set to RuckusGRE.",
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "description" : "Identifier of the forwarding profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the forwarding profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "type" : {
                    "description" : "Tunnel type",
                    "type" : "string",
                    "enum" : [ "Bridge" ]
                }
            },
            "required" : [ "type" ],
            "type" : "object"
        },
        "defaultUserTrafficProfile" : {
            "description" : "User traffic profile of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "precedenceProfileId" : {
            "description" : "Precedence profile of the WLAN",
            "type" : "string"
        },
        "description" : {
            "description" : "Description of the WLAN",
            "type" : [ "string", "null" ],
            "maxLength" : 64
        },
        "devicePolicy" : {
            "description" : "Device policy of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "diffServProfile" : {
            "description" : "DiffServ profile of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "dnsServerProfile" : {
            "description" : "DNS server profile of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "dpsk" : {
            "description" : "DPSK Setting",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "dpskEnabled" : {
                    "description" : "DPSK enabled",
                    "type" : "boolean",
                    "default" : false
                },
                "length" : {
                    "description" : "Length of DPSK key",
                    "type" : "integer",
                    "default" : 62
                },
                "dpskType" : {
                    "description" : "Type of DPSK key",
                    "type" : "string",
                    "enum" : [ "Secure", "KeyboardFriendly", "NumbersOnly" ],
                    "default" : "Secure"
                },
                "expiration" : {
                    "description" : "Expiration of DPSK key",
                    "type" : "string",
                    "enum" : [ "Unlimited", "OneDay", "TwoDays", "OneWeek", "TwoWeeks", "OneMonth", "SixMonths", "OneYear", "TwoYears" ],
                    "default" : "Unlimited"
                },
                "dpskFromType" : {
                    "description" : "Type of expiration start from",
                    "type" : "string",
                    "enum" : [ "CreateTime", "FirstUse" ],
                    "default" : "CreateTime"
                }
            }
        },
        "externalDpsk" : {
            "description" : "External DPSK Enabled",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "enabled" : {
                    "description" : "Enable External DPSK",
                    "type" : "boolean",
                    "default" : false
                },
                "encryption" : {
                    "description" : "Encryption of the WLAN relate to external DPSK",
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "method" : {
                            "description" : "Encryption method",
                            "type" : "string",
                            "enum" : [ "WPA2", "WPA_Mixed", "None" ]
                        },
                        "algorithm" : {
                            "description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
                            "type" : "string",
                            "enum" : [ "AES", "TKIP_AES" ]
                        }
                    }
                },
                "authService" : {
                    "description" : "Autentication of the WLAN relate to external DPSK",
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "description" : "Identifier of the authentication service. At least one ID or name is required in the request.",
                            "type" : "string"
                        },
                        "name" : {
                            "description" : "Name of the authentication service. At least one ID or name is required in the request.",
                            "type" : "string"
                        }
                    }
                }
            },
            "required" : [ "enabled" ]
        },
        "encryption" : {
            "description" : "Encryption of the WLAN",
            "additionalProperties" : false,
            "properties" : {
                "algorithm" : {
                    "description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
                    "type" : "string",
                    "enum" : [ "AES", "TKIP_AES" ]
                },
                "keyInHex" : {
                    "description" : "Key in hex format. This only applies to WEP64 and WEP128.",
                    "type" : "string"
                },
                "keyIndex" : {
                    "description" : "Key index. This only applies to WEP64 and WEP128.",
                    "type" : "integer"
                },
                "method" : {
                    "description" : "Encryption method",
                    "type" : "string",
                    "enum" : [ "WPA2", "WPA_Mixed", "WEP_64", "WEP_128", "None" ],
                    "default" : "None"
                },
                "mfp" : {
                    "description" : "Management frame protection. This only applies to WPA2 + AES",
                    "type" : "string",
                    "enum" : [ "disabled", "capable", "required" ]
                },
                "mobilityDomainId" : {
                    "description" : "mobility Domain Id.",
                    "maximum" : 65535,
                    "minimum" : 1,
                    "type" : "integer"
                },
                "passphrase" : {
                    "description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
                    "type" : "string"
                },
                "support80211rEnabled" : {
                    "description" : "Enable 802.11r Fast BSS Transition, fast Romaing.",
                    "type" : "boolean"
                }
            },
            "required" : [ "method" ],
            "type" : "object"
        },
        "hessid" : {
            "description" : "HESSID of the WLAN",
            "pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$",
            "type" : "string"
        },
        "hotspot20Profile" : {
            "description" : "Hotspot 2.0 operator profile of the WLAN. id or name of the hotspot 2.0 operator profiles within the zone is required.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "l2ACL" : {
            "description" : "Layer 2 ACL of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "macAuth" : {
            "description" : "MAC address authentication settings of the WLAN. This only applies to standard MAC and Hotspot MAC bypass WLAN.",
            "additionalProperties" : false,
            "properties" : {
                "customizedPassword" : {
                    "description" : "User defined password. When this field is set to an empty string, the MAC address is used as password.",
                    "maxLength" : 64,
                    "pattern" : "^([!-;=?-~]([ -;=?-~]){0,62}[!-;=?-~]|[!-;=?-~]{1,1}|\s{0,0})$",
                    "type" : "string"
                },
                "macAuthMacFormat" : {
                    "description" : "MAC address format. The default format is 0010a42319c0 and the 802.1X format is 00-10-A4-23-19-C0.",
                    "type" : "string",
                    "enum" : [ "Default", "802.1X", "UpperColon", "Upper", "LowerDash", "LowerColon" ]
                }
            },
            "type" : "object"
        },
        "name" : {
            "description" : "Name of the WLAN",
            "type" : "string",
            "minLength" : 1,
            "maxLength" : 32
        },
        "operatorRealm" : {
            "description" : "Operator realm, operatorRealm only supports coreTunnelProfile type is PMIP or authServiceOrProfile.locationDeliveryEnabled is true",
            "type" : "string",
            "maxLength" : 255,
            "pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
        },
        "portalServiceProfile" : {
            "description" : "Portal service of the WLAN. This only applies to hotspot, hotspot MAC bypass, guest and web auth WLANs.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "qosMaps" : {
            "description" : "Qos map set of the WLAN.",
            "items" : {
                "additionalProperties" : false,
                "properties" : {
                    "enable" : {
                        "description" : "Enabled or disabled",
                        "type" : "boolean"
                    },
                    "excepts" : {
                        "items" : {
                            "maximum" : 63,
                            "minimum" : 0,
                            "type" : "integer"
                        },
                        "type" : [ "array", "null" ]
                    },
                    "high" : {
                        "description" : "DSCP range - high",
                        "maximum" : 255,
                        "minimum" : 0,
                        "type" : [ "integer", "null" ]
                    },
                    "low" : {
                        "description" : "DSCP range - low",
                        "maximum" : 255,
                        "minimum" : 0,
                        "type" : [ "integer", "null" ]
                    },
                    "priority" : {
                        "description" : "Priority",
                        "type" : "integer"
                    }
                },
                "required" : [ "enable", "priority" ],
                "type" : "object"
            },
            "type" : "array"
        },
        "radiusOptions" : {
            "description" : "RADIUS options of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "calledStaIdType" : {
                    "default" : "WLAN_BSSID",
                    "description" : "Called station ID type",
                    "type" : "string",
                    "enum" : [ "AP_MAC", "NONE", "WLAN_BSSID" ]
                },
                "customizedNasId" : {
                    "description" : "User defined NAS ID",
                    "maxLength" : 64,
                    "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                    "type" : "string"
                },
                "nasIdType" : {
                    "default" : "WLAN_BSSID",
                    "description" : "NAS ID type",
                    "type" : "string",
                    "enum" : [ "AP_MAC", "Customized", "WLAN_BSSID" ]
                },
                "nasMaxRetry" : {
                    "default" : 2,
                    "description" : "NAS request maximum retry",
                    "maximum" : 10,
                    "minimum" : 2,
                    "type" : "integer"
                },
                "nasReconnectPrimaryMin" : {
                    "default" : 5,
                    "description" : "NAS reconnect primary time in minutes",
                    "maximum" : 60,
                    "minimum" : 1,
                    "type" : "integer"
                },
                "nasRequestTimeoutSec" : {
                    "default" : 3,
                    "description" : "NAS request timeout in seconds",
                    "maximum" : 20,
                    "minimum" : 2,
                    "type" : "integer"
                },
                "nasIpType" : {
                    "description" : "NAS IP type",
                    "type" : "string",
                    "enum" : [ "disabled", "control", "management", "userDefined" ],
                    "default" : "disabled"
                },
                "nasIpUserDefined" : {
                    "description" : "User-defined NAS IP",
                    "type" : "string",
                    "maxLength" : 45
                },
                "singleSessionIdAcctEnabled" : {
                    "description" : "When Single Accounting Session ID is enabled, APs will maintain one accounting session for client roaming",
                    "type" : "boolean",
                    "default" : false
                },
                "vendorSpecificAttributeProfileId" : {
                    "description" : "Vendor Specific Attribute Profile ID",
                    "type" : "string"
                }
            }
        },
        "schedule" : {
            "description" : "Schedule of the WLAN",
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "description" : "Identifier of the schedule profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the schedule profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "type" : {
                    "description" : "Type of WLAN schedule",
                    "type" : "string",
                    "enum" : [ "AlwaysOn", "AlwaysOff", "Customized" ],
                    "default" : "AlwaysOn"
                }
            },
            "required" : [ "type" ],
            "type" : "object"
        },
        "ssid" : {
            "description" : "SSID of the WLAN",
            "type" : "string",
            "minLength" : 1,
            "maxLength" : 32
        },
        "timeboundWhitelist" : {
            "description" : "Hotspot timeboundWhitelist. The ID of the OAuth Authentication service is required.",
            "additionalProperties" : false,
            "properties" : {
                "firstIndex" : {
                    "type" : "integer"
                },
                "hasMore" : {
                    "type" : "boolean"
                },
                "list" : {
                    "items" : {
                        "type" : [ "object", "null" ],
                        "additionalProperties" : false,
                        "properties" : {
                            "id" : {
                                "type" : "string"
                            },
                            "name" : {
                                "type" : "string"
                            }
                        }
                    },
                    "type" : "array"
                },
                "totalCount" : {
                    "type" : "integer"
                }
            },
            "type" : "object"
        },
        "vlan" : {
            "description" : "VLAN (access and/or core) of the WLAN.",
            "additionalProperties" : false,
            "properties" : {
                "aaaVlanOverride" : {
                    "description" : "Indicates whether the AAA VLAN settings can be overriden or not",
                    "type" : "boolean"
                },
                "accessVlan" : {
                    "description" : "Access VLAN ID",
                    "maximum" : 4094,
                    "minimum" : 1,
                    "type" : "integer",
                    "default" : 1
                },
                "vlanPooling" : {
                    "description" : "Vlan pooling",
                    "type" : [ "object", "null" ],
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string"
                        }
                    }
                }
            },
            "type" : "object"
        },
        "accessTunnelProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "accessIpsecProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "splitTunnelProfileId" : {
            "type" : "string"
        }
    },
    "required" : [ "name", "ssid", "authServiceOrProfile" ],
    "type" : "object"
}
Response  201
HideShow
Body
{
  "id": "wlanID"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Create - Hotspot

POST/v8_1/rkszones/{zoneId}/wlans/wispr

Use this API command to create new hotspot (WISPr) WLAN.

Request
HideShow
Body
‧ Sample : Create a Hotspot (WISPr) WLAN with default configurations
{
    "name" : "wlanName",
    "ssid" : "wlanSSID",
    "description" : "wlanDescription",
    "authServiceOrProfile" : {
        "throughController" : false,
        "id" : "authServiceUUID",
        "name" : "authServiceName",
        "authenticationOption" : null
    },
    "portalServiceProfile" : {
        "id" : "portalServiceUUID",
        "name" : "portalServiceName"
    },
    "accessTunnelType" : "RuckusGRE",
    "accessTunnelProfile" : {
        "id" : "f5b92938-aa4e-4d02-90ea-273799ff689b",
        "name" : "Default Tunnel Profile"
    },
    "splitTunnelProfileId" : "38119bac-49e1-4410-ab8e-1c1bc88dd770",
    "coreTunnelProfile" : {
        "type" : "Bridge",
        "id" : "forwardingUUID",
        "name" : "forwardingName"
    },
    "encryption" : {
        "method" : "WPA2",
        "algorithm" : "AES",
        "passphrase" : "password",
        "mfp" : "disabled",
        "support80211rEnabled" : true,
        "mobilityDomainId" : 3
    },
    "operatorRealm" : "operator realm",
    "defaultUserTrafficProfile" : {
        "id" : "userTrafficUUID",
        "name" : "userTrafficName"
    },
    "precedenceProfileId" : "c514d450-c839-9527-afc9-525400d12345",
    "schedule" : {
        "type" : "Customized",
        "id" : "ServiceUUID",
        "name" : "ServiceName"
    },
    "vlan" : {
        "accessVlan" : 23,
        "coreQinQEnabled" : false,
        "coreSVlan" : 1,
        "vlanPooling" : null
    },
    "l2ACL" : {
        "id" : "l2ACLUUID",
        "name" : "l2ACLName"
    },
    "devicePolicy" : {
        "id" : "devicePolicyUUID",
        "name" : "devicePolicyName"
    },
    "radiusOptions" : {
        "nasIdType" : "Customized",
        "customizedNasId" : "nasId",
        "nasRequestTimeoutSec" : 12,
        "nasMaxRetry" : 3,
        "nasReconnectPrimaryMin" : 30,
        "calledStaIdType" : "WLAN_BSSID",
        "nasIpType" : "disabled",
        "nasIpUserDefined" : "192.168.1.1",
        "vendorSpecificAttributeProfileId" : "6d767421-d1b7-11e8-8ab9-ba2343155a93"
    },
    "advancedOptions" : {
        "clientIsolationEnabled" : true,
        "clientIsolationUnicastEnabled" : true,
        "clientIsolationMulticastEnabled" : false,
        "clientIsolationAutoVrrpEnabled" : false,
        "clientIsolationWhitelist" : {
            "id" : "b89323e1-3168-11e7-b027-5254009ae3f0",
            "name" : "myWhitelist"
        },
        "priority" : "High",
        "hideSsidEnabled" : true,
        "maxClientsPerRadio" : 12,
        "clientIdleTimeoutSec" : 60,
        "clientLoadBalancingEnabled" : true,
        "proxyARPEnabled" : true,
        "support80211dEnabled" : false,
        "support80211kEnabled" : true,
        "antiSpoofingEnabled" : true,
        "arpRequestRateLimit" : 15,
        "dhcpRequestRateLimit" : 15,
        "forceClientDHCPTimeoutSec" : 5,
        "dhcp82SubOpt1Format" : "SUBOPT1_AP_INFO_LOCATION",
        "unauthClientStatsEnabled" : false,
        "clientFingerprintingEnabled" : true,
        "ofdmOnlyEnabled" : false,
        "bandBalancing" : "UseZoneSetting",
        "bssMinRateMbps" : "Disable",
        "mgmtTxRateMbps" : "2 mbps",
        "avcEnabled" : true,
        "urlFilteringPolicyEnabled" : false,
        "urlFilteringPolicyId" : "",
        "wifiCallingPolicyEnabled" : false,
        "wifiCallingPolicyIds" : [ ],
        "uplinkEnabled" : true,
        "uplinkRate" : 100,
        "downlinkEnabled" : true,
        "downlinkRate" : 200,
        "ratePerSTAUplink" : "650mbps",
        "ratePerSTADownlink" : "1mbps",
        "hdOverheadOptimizeEnable" : false,
        "probeRssiThr" : -85,
        "transientClientMgmtEnable" : true,
        "joinIgnoreTimeout" : 30,
        "joinAcceptTimeout" : 300,
        "joinIgnoreThr" : 10,
        "dropRandomProbesEnabled" : true,
        "authRssiThr" : -85,
        "assocRssiThr" : -85
    },
    "diffServProfile" : {
        "id" : "diffServId",
        "name" : "diffServName"
    },
    "qosMaps" : [ {
        "enable" : true,
        "priority" : 0,
        "low" : 0,
        "high" : 7,
        "excepts" : null
    }, {
        "enable" : true,
        "priority" : 1,
        "low" : 8,
        "high" : 15,
        "excepts" : null
    }, {
        "enable" : true,
        "priority" : 2,
        "low" : 16,
        "high" : 23,
        "excepts" : null
    }, {
        "enable" : true,
        "priority" : 3,
        "low" : 0,
        "high" : 32,
        "excepts" : [ 43, 45, 60 ]
    }, {
        "enable" : true,
        "priority" : 4,
        "low" : 32,
        "high" : 39,
        "excepts" : null
    }, {
        "enable" : true,
        "priority" : 5,
        "low" : 40,
        "high" : 47,
        "excepts" : null
    }, {
        "enable" : true,
        "priority" : 6,
        "low" : 48,
        "high" : 55,
        "excepts" : [ 46 ]
    }, {
        "enable" : true,
        "priority" : 7,
        "low" : 56,
        "high" : 63,
        "excepts" : null
    } ],
    "dnsServerProfile" : {
        "id" : "DNS server profile UUID",
        "name" : "DNS server profile name"
    },
    "dpsk" : {
        "dpskEnabled" : false,
        "length" : 8,
        "dpskType" : "Secure",
        "expiration" : "OneDay",
        "dpskFromType" : "FirstUse"
    },
    "externalDpsk" : {
        "enabled" : true,
        "encryption" : {
            "method" : "WPA2",
            "algorithm" : "AES"
        },
        "authService" : {
            "id" : "authServiceUUID"
        }
    },
    "timeboundWhitelist" : {
        "list" : [ {
            "id" : "OAuth authServiceUUID",
            "name" : "authServiceName"
        } ]
    }
}
‧ Sample : Create a Hotspot (WISPr) WLAN with authenticationOption configurations
{
    "name" : "wlanName",
    "ssid" : "wlanSSID",
    "description" : "wlanDescription",
    "authServiceOrProfile" : {
        "throughController" : true,
        "authenticationOption" : "Local DB"
    },
    "portalServiceProfile" : {
        "id" : "portalServiceUUID",
        "name" : "portalServiceName"
    }
}
Schema
{
    "additionalProperties" : false,
    "properties" : {
        "accessTunnelType" : {
            "description" : "Access tunnel type of the WLAN. APLBO means AP local breakout, and SoftGRE means AP direct SoftGRE tunnel",
            "type" : "string",
            "enum" : [ "APLBO", "RuckusGRE", "SoftGRE" ]
        },
        "accountingServiceOrProfile" : {
            "description" : "Accounting of the WLAN",
            "additionalProperties" : false,
            "properties" : {
                "accountingDelayEnabled" : {
                    "description" : "Indicates whether accounting delay time is enabled",
                    "type" : "boolean"
                },
                "id" : {
                    "description" : "Accounting service or profile ID. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "interimUpdateMin" : {
                    "description" : "Interval (in minutes) for sending interim updates",
                    "maximum" : 1440,
                    "minimum" : 0,
                    "type" : "integer"
                },
                "name" : {
                    "description" : "Accounting service or profile name. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "throughController" : {
                    "description" : "Indicates whether accounting messages were sent through the controller",
                    "type" : "boolean"
                },
                "realmBasedAcct" : {
                    "type" : "boolean"
                },
                "backupAccountingId" : {
                    "description" : "Backup accounting service or profile ID. At least one backupAccountingId or backupAccountingName is required in the request when setting backup accounting service.",
                    "type" : "string"
                },
                "backupAccountingName" : {
                    "description" : "Backup accounting service or profile name. At least one backupAccountingId or backupAccountingName is required in the request when setting backup accounting service.",
                    "type" : "string"
                }
            },
            "type" : "object"
        },
        "advancedOptions" : {
            "description" : "Advanced settings for the WLAN.",
            "additionalProperties" : false,
            "properties" : {
                "avcEnabled" : {
                    "default" : false,
                    "description" : "Indicator of whether AVC support is enabled or disabled",
                    "type" : "boolean"
                },
                "bandBalancing" : {
                    "default" : "UseZoneSetting",
                    "description" : "Indicates whether band balancing is enabled or disabled",
                    "type" : "string",
                    "enum" : [ "Disabled", "UseZoneSetting" ]
                },
                "bssMinRateMbps" : {
                    "description" : "BSS minimum rate (mbps)",
                    "type" : "string",
                    "enum" : [ "Disable", "1 mbps", "2 mbps", "5.5 mbps", "12 mbps", "24 mbps" ],
                    "default" : "Disable"
                },
                "clientFingerprintingEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether client fingerprinting is enabled or disabled",
                    "type" : "boolean"
                },
                "clientIdleTimeoutSec" : {
                    "default" : 120,
                    "description" : "Client idle timeout in seconds",
                    "maximum" : 1000,
                    "minimum" : 60,
                    "type" : "integer"
                },
                "clientIsolationEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether wireless client isolation is enabled or disabled",
                    "type" : "boolean"
                },
                "clientIsolationUnicastEnabled" : {
                    "description" : "Indicates whether isolate unicast of wireless client isolation is enabled or disabled",
                    "type" : "boolean",
                    "default" : true
                },
                "clientIsolationMulticastEnabled" : {
                    "description" : "Indicates whether isolate multicast of wireless client isolation is enabled or disabled",
                    "type" : "boolean"
                },
                "clientIsolationAutoVrrpEnabled" : {
                    "description" : "Indicates whether Automatic support for VRRP of wireless client isolation is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "clientIsolationWhitelist" : {
                    "description" : "Indicates wireless client isolation whitelist",
                    "type" : [ "object", "null" ],
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string"
                        }
                    }
                },
                "clientLoadBalancingEnabled" : {
                    "description" : "Indicates whether Client Load Balancing is enabled or disabled",
                    "type" : "boolean",
                    "default" : true
                },
                "dgafEnabled" : {
                    "description" : "Indicates whether dgaf is enabled or disabled",
                    "type" : "boolean"
                },
                "dhcp82Format" : {
                    "description" : "DHCP Option 82 format. This variable no longer supports from v8_1 and only kept for backward compatibility.",
                    "type" : "string",
                    "enum" : [ "RUCKUS_DEFAULT", "SOFTGRE_CUSTOMIZED" ]
                },
                "dhcpOption82Enabled" : {
                    "default" : false,
                    "description" : "Indicates whether DCHP Option 82 is enabled or disabled. This variable no longer supports from v8_1 and only kept for backward compatibility.",
                    "type" : "boolean"
                },
                "dhcp82SubOpt1Format" : {
                    "description" : "Subopt-1 format",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT1_AP_INFO_LOCATION", "SUBOPT1_AP_INFO", "SUBOPT1_AP_MAC_ESSID_PRIVACYTYPE", "SUBOPT1_AP_MAC_hex", "SUBOPT1_AP_MAC_hex_ESSID", "SUBOPT1_ESSID" ]
                },
                "dhcp82SubOpt2Format" : {
                    "description" : "Subopt-2 format",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT2_CLIENT_MAC", "SUBOPT2_CLIENT_MAC_hex", "SUBOPT2_CLIENT_MAC_hex_ESSID", "SUBOPT2_AP_MAC", "SUBOPT2_AP_MAC_hex", "SUBOPT2_AP_MAC_hex_ESSID" ]
                },
                "dhcp82SubOpt150Format" : {
                    "description" : "Subopt-150 with VLAN-Id",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT150_VLAN_ID" ]
                },
                "dhcp82SubOpt151Format" : {
                    "description" : "Subopt-151 format",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT151_AREA_NAME", "SUBOPT151_ESSID" ]
                },
                "dhcp82SubOpt151AreaName" : {
                    "description" : "Subopt-151 Area Name value",
                    "type" : "string"
                },
                "downlinkEnabled" : {
                    "default" : false,
                    "description" : "SSID Rate Limiting downlink enabled.",
                    "type" : "boolean"
                },
                "downlinkRate" : {
                    "description" : "SSID Rate Limiting downlink.",
                    "type" : "number",
                    "default" : 0.0
                },
                "antiSpoofingEnabled" : {
                    "description" : "Anti-Spoofing enabled",
                    "type" : "boolean",
                    "default" : false
                },
                "arpRequestRateLimit" : {
                    "description" : "ARP packets request rate limit, default value will be 15 if both rate limit not being set.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 100
                },
                "dhcpRequestRateLimit" : {
                    "description" : "DHCP packets request rate limit, default value will be 15 if both rate limit not being set.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 100
                },
                "forceClientDHCPTimeoutSec" : {
                    "default" : 0,
                    "description" : "Force DHCP disconnects the client if the client does not obtain a valid IP address within the timeout peroid. To disable force DHCP, set this value to zero (0).",
                    "type" : "integer",
                    "enum" : [ 0, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15 ]
                },
                "hideSsidEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether the SSID is hidden or broadcast",
                    "type" : "boolean"
                },
                "hs20Onboarding" : {
                    "description" : "Allow WISPr WLAN for Hotspot 2.0 Onboarding",
                    "type" : "boolean",
                    "default" : false
                },
                "maxClientsPerRadio" : {
                    "default" : 100,
                    "description" : "Maximum number of clients per radio",
                    "maximum" : 512,
                    "minimum" : 1,
                    "type" : "integer"
                },
                "mgmtTxRateMbps" : {
                    "description" : "Management TX rate (mbps)",
                    "type" : "string",
                    "enum" : [ "1 mbps", "2 mbps", "5.5 mbps", "6 mbps", "9 mbps", "11 mbps", "12 mbps", "18 mbps", "24 mbps", "36 mbps", "48 mbps", "54 mbps" ],
                    "default" : "2 mbps"
                },
                "ofdmOnlyEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether OFDM only is enabled or disabled",
                    "type" : "boolean"
                },
                "okcEnabled" : {
                    "description" : "Indicator of whether OKC support is enabled or disabled. The default value is true when the WLAN is WPA+AES non open WLAN.",
                    "type" : "boolean"
                },
                "pmkCachingEnabled" : {
                    "description" : "Indicator of whether PKM caching support is enabled or disabled. The default value is true when the WLAN is WPA+AES non open WLAN.",
                    "type" : "boolean"
                },
                "priority" : {
                    "default" : "High",
                    "description" : "Priority of the WLAN",
                    "type" : "string",
                    "enum" : [ "High", "Low" ]
                },
                "proxyARPEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether proxy ARP is enabled or disabled",
                    "type" : "boolean"
                },
                "ndProxyEnabled" : {
                    "description" : "Indicates whether ND Proxy is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "suppressNsEnabled" : {
                    "description" : "Indicates whether supperssNS is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "raProxyEnabled" : {
                    "description" : "Indicates whether RA proxy is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "rsraGuardEnabled" : {
                    "description" : "Indicates whether RS/RA Guard is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "raThrottlingEnabled" : {
                    "description" : "Indicates whether RA Throttling is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "maxAllowedRA" : {
                    "description" : "Max Allowed RAs",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 1440,
                    "default" : 10
                },
                "raInterval" : {
                    "description" : "A timer that RA proxy runs and once receives unsolicited RA checks against the configured time and allow/drop RA based on next timeout",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 256,
                    "default" : 10
                },
                "support80211dEnabled" : {
                    "default" : true,
                    "description" : "Indicates whether support for 802.11d is enabled or disabled",
                    "type" : "boolean"
                },
                "support80211kEnabled" : {
                    "default" : true,
                    "description" : "Indicates whether support for 802.11k is enabled or disabled",
                    "type" : "boolean"
                },
                "unauthClientStatsEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether to send statistics of unauthorized clients or not",
                    "type" : "boolean"
                },
                "uplinkEnabled" : {
                    "default" : false,
                    "description" : "SSID Rate Limiting uplink enabled.",
                    "type" : "boolean"
                },
                "uplinkRate" : {
                    "description" : "SSID Rate Limiting uplink.",
                    "type" : "number",
                    "default" : 0.0
                },
                "ratePerSTAUplink" : {
                    "description" : "UE Rate Limiting uplink.",
                    "type" : "string"
                },
                "ratePerSTADownlink" : {
                    "description" : "UE Rate Limiting downlink.",
                    "type" : "string"
                },
                "dtimInterval" : {
                    "description" : "DTIM Interval",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 255,
                    "default" : 1
                },
                "directedThreshold" : {
                    "description" : "Directed Threshold Setting, Defines the client count at which an AP will stop converting group addressed data traffic to unicast.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 128,
                    "default" : 5
                },
                "flowLogEnabled" : {
                    "description" : "Flow log enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "hdOverheadOptimizeEnable" : {
                    "description" : "Airtime Decongestion enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "probeRssiThr" : {
                    "description" : "Join RSSI threshold.",
                    "type" : "integer",
                    "minimum" : -90,
                    "maximum" : -60,
                    "default" : -85
                },
                "transientClientMgmtEnable" : {
                    "description" : "Transient Client Management enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "joinIgnoreTimeout" : {
                    "description" : "Join wait time.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 60,
                    "default" : 30
                },
                "joinAcceptTimeout" : {
                    "description" : "Join expire time.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 300,
                    "default" : 300
                },
                "joinIgnoreThr" : {
                    "description" : "Join wait threshold.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 50,
                    "default" : 10
                },
                "dropRandomProbesEnabled" : {
                    "description" : "Drop Random Probes enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "authRssiThr" : {
                    "description" : "Auth RSSI threshold.",
                    "type" : "integer",
                    "minimum" : -90,
                    "maximum" : -60
                },
                "assocRssiThr" : {
                    "description" : "Assoc RSSI threshold.",
                    "type" : "integer",
                    "minimum" : -90,
                    "maximum" : -60
                },
                "oceEnabled" : {
                    "description" : "Optimized Connectivity Experience(OCE) enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "oceBroadcastProbeResponseDelay" : {
                    "description" : "Broadcast probe response delay.",
                    "type" : "integer",
                    "minimum" : 8,
                    "maximum" : 120,
                    "default" : 15
                },
                "oceRssiBasedAssociationRejectionThreshold" : {
                    "description" : "RSSI-based association rejection threshold.",
                    "type" : "integer",
                    "minimum" : -90,
                    "maximum" : -60,
                    "default" : -75
                }
            },
            "type" : "object"
        },
        "authServiceOrProfile" : {
            "description" : "Authentication of the WLAN. The hotspot WLAN requires authentication messages to be sent through the controller. The ID or name of the authentication services configured globally is required.",
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "description" : "Identifier of the authentication service or profile. At least one ID or name or authenticationOption is required in the request.",
                    "type" : "string"
                },
                "locationDeliveryEnabled" : {
                    "description" : "RFC5580 location delivery support",
                    "type" : "boolean"
                },
                "realmBasedAuth" : {
                    "type" : "boolean"
                },
                "name" : {
                    "description" : "Name of the authentication service or profile. At least one ID or name or authenticationOption is required in the request. Or could input the 'Always Accept' or 'Local DB'.",
                    "type" : "string"
                },
                "authenticationOption" : {
                    "description" : "Option of the authentication service or profile, At least one ID or name or authenticationOption is required in the request. This only applies to hotspot and guest WLANs.",
                    "type" : "string",
                    "enum" : [ "Local DB", "Guest", "Always Accept", null ]
                },
                "throughController" : {
                    "description" : "Indicates whether authentication messages were sent through the controller or not",
                    "type" : "boolean"
                },
                "backupAuthenticationId" : {
                    "description" : "Identifier of the backup authentication service or profile. At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service.",
                    "type" : "string"
                },
                "backupAuthenticationName" : {
                    "description" : "Name of the backup authentication service or profile. At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service. Or could input the 'Always Accept'.",
                    "type" : "string"
                },
                "backupAuthenticationOption" : {
                    "description" : "Option of the backup authentication service or profile, At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service. This only applies to hotspot WLANs.",
                    "type" : "string",
                    "enum" : [ "Always Accept", null ]
                }
            },
            "type" : "object"
        },
        "bypassCNA" : {
            "description" : "Bypass Capitive Network Assitance",
            "type" : "boolean",
            "default" : false
        },
        "coreTunnelProfile" : {
            "description" : "Core tunnel of the WLAN. This only applies when the access tunnel type is set to RuckusGRE.",
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "description" : "Identifier of the forwarding profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the forwarding profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "type" : {
                    "description" : "Tunnel type",
                    "type" : "string",
                    "enum" : [ "Bridge" ]
                }
            },
            "required" : [ "type" ],
            "type" : "object"
        },
        "defaultUserTrafficProfile" : {
            "description" : "User traffic profile of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "precedenceProfileId" : {
            "description" : "Precedence profile of the WLAN",
            "type" : "string"
        },
        "flexiVpnProfile" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "zoneAffinityId" : {
                    "type" : "string",
                    "description" : "Zone Affinity ID"
                }
            },
            "required" : [ "zoneAffinityId" ]
        },
        "description" : {
            "description" : "Description of the WLAN",
            "type" : [ "string", "null" ],
            "maxLength" : 64
        },
        "devicePolicy" : {
            "description" : "Device policy of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "diffServProfile" : {
            "description" : "DiffServ profile of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "dnsServerProfile" : {
            "description" : "DNS server profile of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "dpsk" : {
            "description" : "DPSK Setting",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "dpskEnabled" : {
                    "description" : "DPSK enabled",
                    "type" : "boolean",
                    "default" : false
                },
                "length" : {
                    "description" : "Length of DPSK key",
                    "type" : "integer",
                    "default" : 62
                },
                "dpskType" : {
                    "description" : "Type of DPSK key",
                    "type" : "string",
                    "enum" : [ "Secure", "KeyboardFriendly", "NumbersOnly" ],
                    "default" : "Secure"
                },
                "expiration" : {
                    "description" : "Expiration of DPSK key",
                    "type" : "string",
                    "enum" : [ "Unlimited", "OneDay", "TwoDays", "OneWeek", "TwoWeeks", "OneMonth", "SixMonths", "OneYear", "TwoYears" ],
                    "default" : "Unlimited"
                },
                "dpskFromType" : {
                    "description" : "Type of expiration start from",
                    "type" : "string",
                    "enum" : [ "CreateTime", "FirstUse" ],
                    "default" : "CreateTime"
                }
            }
        },
        "externalDpsk" : {
            "description" : "External DPSK Enabled",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "enabled" : {
                    "description" : "Enable External DPSK",
                    "type" : "boolean",
                    "default" : false
                },
                "encryption" : {
                    "description" : "Encryption of the WLAN relate to external DPSK",
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "method" : {
                            "description" : "Encryption method",
                            "type" : "string",
                            "enum" : [ "WPA2", "WPA_Mixed", "None" ]
                        },
                        "algorithm" : {
                            "description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
                            "type" : "string",
                            "enum" : [ "AES", "TKIP_AES" ]
                        }
                    }
                },
                "authService" : {
                    "description" : "Autentication of the WLAN relate to external DPSK",
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "description" : "Identifier of the authentication service. At least one ID or name is required in the request.",
                            "type" : "string"
                        },
                        "name" : {
                            "description" : "Name of the authentication service. At least one ID or name is required in the request.",
                            "type" : "string"
                        }
                    }
                }
            },
            "required" : [ "enabled" ]
        },
        "encryption" : {
            "description" : "Encryption of the WLAN",
            "additionalProperties" : false,
            "properties" : {
                "algorithm" : {
                    "description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
                    "type" : "string",
                    "enum" : [ "AES", "TKIP_AES" ]
                },
                "keyInHex" : {
                    "description" : "Key in hex format. This only applies to WEP64 and WEP128.",
                    "type" : "string"
                },
                "keyIndex" : {
                    "description" : "Key index. This only applies to WEP64 and WEP128.",
                    "type" : "integer"
                },
                "method" : {
                    "description" : "Encryption method",
                    "type" : "string",
                    "enum" : [ "WPA2", "WPA_Mixed", "WEP_64", "WEP_128", "None" ],
                    "default" : "None"
                },
                "mfp" : {
                    "description" : "Management frame protection. This only applies to WPA2 + AES",
                    "type" : "string",
                    "enum" : [ "disabled", "capable", "required" ]
                },
                "mobilityDomainId" : {
                    "description" : "mobility Domain Id.",
                    "maximum" : 65535,
                    "minimum" : 1,
                    "type" : "integer"
                },
                "passphrase" : {
                    "description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
                    "type" : "string"
                },
                "support80211rEnabled" : {
                    "description" : "Enable 802.11r Fast BSS Transition, fast Romaing.",
                    "type" : "boolean"
                }
            },
            "required" : [ "method" ],
            "type" : "object"
        },
        "hessid" : {
            "description" : "HESSID of the WLAN",
            "pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$",
            "type" : "string"
        },
        "hotspot20Profile" : {
            "description" : "Hotspot 2.0 operator profile of the WLAN. id or name of the hotspot 2.0 operator profiles within the zone is required.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "l2ACL" : {
            "description" : "Layer 2 ACL of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "macAuth" : {
            "description" : "MAC address authentication settings of the WLAN. This only applies to standard MAC and Hotspot MAC bypass WLAN.",
            "additionalProperties" : false,
            "properties" : {
                "customizedPassword" : {
                    "description" : "User defined password. When this field is set to an empty string, the MAC address is used as password.",
                    "maxLength" : 64,
                    "pattern" : "^([!-;=?-~]([ -;=?-~]){0,62}[!-;=?-~]|[!-;=?-~]{1,1}|\s{0,0})$",
                    "type" : "string"
                },
                "macAuthMacFormat" : {
                    "description" : "MAC address format. The default format is 0010a42319c0 and the 802.1X format is 00-10-A4-23-19-C0.",
                    "type" : "string",
                    "enum" : [ "Default", "802.1X", "UpperColon", "Upper", "LowerDash", "LowerColon" ]
                }
            },
            "type" : "object"
        },
        "name" : {
            "description" : "Name of the WLAN",
            "type" : "string",
            "minLength" : 1,
            "maxLength" : 32
        },
        "operatorRealm" : {
            "description" : "Operator realm, operatorRealm only supports coreTunnelProfile type is PMIP or authServiceOrProfile.locationDeliveryEnabled is true",
            "type" : "string",
            "maxLength" : 255,
            "pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
        },
        "portalServiceProfile" : {
            "description" : "Hotspot portal service of the WLAN. The ID or name of the hotspot portal services within the zone is required.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "qosMaps" : {
            "description" : "Qos map set of the WLAN.",
            "items" : {
                "additionalProperties" : false,
                "properties" : {
                    "enable" : {
                        "description" : "Enabled or disabled",
                        "type" : "boolean"
                    },
                    "excepts" : {
                        "items" : {
                            "maximum" : 63,
                            "minimum" : 0,
                            "type" : "integer"
                        },
                        "type" : [ "array", "null" ]
                    },
                    "high" : {
                        "description" : "DSCP range - high",
                        "maximum" : 255,
                        "minimum" : 0,
                        "type" : [ "integer", "null" ]
                    },
                    "low" : {
                        "description" : "DSCP range - low",
                        "maximum" : 255,
                        "minimum" : 0,
                        "type" : [ "integer", "null" ]
                    },
                    "priority" : {
                        "description" : "Priority",
                        "type" : "integer"
                    }
                },
                "required" : [ "enable", "priority" ],
                "type" : "object"
            },
            "type" : "array"
        },
        "radiusOptions" : {
            "description" : "RADIUS options of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "calledStaIdType" : {
                    "default" : "WLAN_BSSID",
                    "description" : "Called station ID type",
                    "type" : "string",
                    "enum" : [ "AP_MAC", "NONE", "WLAN_BSSID" ]
                },
                "customizedNasId" : {
                    "description" : "User defined NAS ID",
                    "maxLength" : 64,
                    "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                    "type" : "string"
                },
                "nasIdType" : {
                    "default" : "WLAN_BSSID",
                    "description" : "NAS ID type",
                    "type" : "string",
                    "enum" : [ "AP_MAC", "Customized", "WLAN_BSSID" ]
                },
                "nasMaxRetry" : {
                    "default" : 2,
                    "description" : "NAS request maximum retry",
                    "maximum" : 10,
                    "minimum" : 2,
                    "type" : "integer"
                },
                "nasReconnectPrimaryMin" : {
                    "default" : 5,
                    "description" : "NAS reconnect primary time in minutes",
                    "maximum" : 60,
                    "minimum" : 1,
                    "type" : "integer"
                },
                "nasRequestTimeoutSec" : {
                    "default" : 3,
                    "description" : "NAS request timeout in seconds",
                    "maximum" : 20,
                    "minimum" : 2,
                    "type" : "integer"
                },
                "nasIpType" : {
                    "description" : "NAS IP type",
                    "type" : "string",
                    "enum" : [ "disabled", "control", "management", "userDefined" ],
                    "default" : "disabled"
                },
                "nasIpUserDefined" : {
                    "description" : "User-defined NAS IP",
                    "type" : "string",
                    "maxLength" : 45
                },
                "singleSessionIdAcctEnabled" : {
                    "description" : "When Single Accounting Session ID is enabled, APs will maintain one accounting session for client roaming",
                    "type" : "boolean",
                    "default" : false
                },
                "vendorSpecificAttributeProfileId" : {
                    "description" : "Vendor Specific Attribute Profile ID",
                    "type" : "string"
                }
            }
        },
        "schedule" : {
            "description" : "Schedule of the WLAN",
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "description" : "Identifier of the schedule profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the schedule profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "type" : {
                    "description" : "Type of WLAN schedule",
                    "type" : "string",
                    "enum" : [ "AlwaysOn", "AlwaysOff", "Customized" ],
                    "default" : "AlwaysOn"
                }
            },
            "required" : [ "type" ],
            "type" : "object"
        },
        "ssid" : {
            "description" : "SSID of the WLAN",
            "type" : "string",
            "minLength" : 1,
            "maxLength" : 32
        },
        "timeboundWhitelist" : {
            "description" : "Hotspot timeboundWhitelist. The ID Hotspot timeboundWhitelist. The ID of the OAuth Authentication service is required.",
            "additionalProperties" : false,
            "properties" : {
                "firstIndex" : {
                    "type" : "integer"
                },
                "hasMore" : {
                    "type" : "boolean"
                },
                "list" : {
                    "items" : {
                        "type" : [ "object", "null" ],
                        "additionalProperties" : false,
                        "properties" : {
                            "id" : {
                                "type" : "string"
                            },
                            "name" : {
                                "type" : "string"
                            }
                        }
                    },
                    "type" : "array"
                },
                "totalCount" : {
                    "type" : "integer"
                }
            },
            "type" : "object"
        },
        "vlan" : {
            "description" : "VLAN (access and/or core) of the WLAN.",
            "additionalProperties" : false,
            "properties" : {
                "aaaVlanOverride" : {
                    "description" : "Indicates whether the AAA VLAN settings can be overriden or not",
                    "type" : "boolean"
                },
                "accessVlan" : {
                    "description" : "Access VLAN ID",
                    "maximum" : 4094,
                    "minimum" : 1,
                    "type" : "integer",
                    "default" : 1
                },
                "vlanPooling" : {
                    "description" : "Vlan pooling",
                    "type" : [ "object", "null" ],
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string"
                        }
                    }
                }
            },
            "type" : "object"
        },
        "accessTunnelProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "accessIpsecProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "splitTunnelProfileId" : {
            "type" : "string"
        }
    },
    "required" : [ "name", "ssid", "authServiceOrProfile", "portalServiceProfile" ],
    "type" : "object"
}
Response  201
HideShow
Body
{
  "id": "wlanID"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Create - Hotspot + MAC bypass

POST/v8_1/rkszones/{zoneId}/wlans/wisprmac

Use this API command to create a new hotspot (WISPr) with MAC bypass WLAN.

Request
HideShow
Body
‧ Sample : Create a Hotspot (WISPr) WLAN with default configurations
{
    "name" : "wlanName",
    "ssid" : "wlanSSID",
    "description" : "wlanDescription",
    "authServiceOrProfile" : {
        "throughController" : false,
        "id" : "authServiceUUID",
        "name" : "authServiceName",
        "authenticationOption" : null
    },
    "portalServiceProfile" : {
        "id" : "portalServiceUUID",
        "name" : "portalServiceName"
    },
    "accessTunnelType" : "RuckusGRE",
    "accessTunnelProfile" : {
        "id" : "f5b92938-aa4e-4d02-90ea-273799ff689b",
        "name" : "Default Tunnel Profile"
    },
    "splitTunnelProfileId" : "38119bac-49e1-4410-ab8e-1c1bc88dd770",
    "coreTunnelProfile" : {
        "type" : "Bridge",
        "id" : "forwardingUUID",
        "name" : "forwardingName"
    },
    "encryption" : {
        "method" : "WPA2",
        "algorithm" : "AES",
        "passphrase" : "password",
        "mfp" : "disabled",
        "support80211rEnabled" : true,
        "mobilityDomainId" : 3
    },
    "operatorRealm" : "operator realm",
    "defaultUserTrafficProfile" : {
        "id" : "userTrafficUUID",
        "name" : "userTrafficName"
    },
    "precedenceProfileId" : "c514d450-c839-9527-afc9-525400d12345",
    "schedule" : {
        "type" : "Customized",
        "id" : "ServiceUUID",
        "name" : "ServiceName"
    },
    "vlan" : {
        "accessVlan" : 23,
        "coreQinQEnabled" : false,
        "coreSVlan" : 1,
        "vlanPooling" : null
    },
    "l2ACL" : {
        "id" : "l2ACLUUID",
        "name" : "l2ACLName"
    },
    "devicePolicy" : {
        "id" : "devicePolicyUUID",
        "name" : "devicePolicyName"
    },
    "radiusOptions" : {
        "nasIdType" : "Customized",
        "customizedNasId" : "nasId",
        "nasRequestTimeoutSec" : 12,
        "nasMaxRetry" : 3,
        "nasReconnectPrimaryMin" : 30,
        "calledStaIdType" : "WLAN_BSSID",
        "nasIpType" : "disabled",
        "nasIpUserDefined" : "192.168.1.1",
        "vendorSpecificAttributeProfileId" : "6d767421-d1b7-11e8-8ab9-ba2343155a93"
    },
    "advancedOptions" : {
        "clientIsolationEnabled" : true,
        "clientIsolationUnicastEnabled" : true,
        "clientIsolationMulticastEnabled" : false,
        "clientIsolationAutoVrrpEnabled" : false,
        "clientIsolationWhitelist" : {
            "id" : "b89323e1-3168-11e7-b027-5254009ae3f0",
            "name" : "myWhitelist"
        },
        "priority" : "High",
        "hideSsidEnabled" : true,
        "maxClientsPerRadio" : 12,
        "clientIdleTimeoutSec" : 60,
        "clientLoadBalancingEnabled" : true,
        "proxyARPEnabled" : true,
        "support80211dEnabled" : false,
        "support80211kEnabled" : true,
        "antiSpoofingEnabled" : true,
        "arpRequestRateLimit" : 15,
        "dhcpRequestRateLimit" : 15,
        "forceClientDHCPTimeoutSec" : 5,
        "dhcp82SubOpt1Format" : "SUBOPT1_AP_INFO_LOCATION",
        "unauthClientStatsEnabled" : false,
        "clientFingerprintingEnabled" : true,
        "ofdmOnlyEnabled" : false,
        "bandBalancing" : "UseZoneSetting",
        "bssMinRateMbps" : "Disable",
        "mgmtTxRateMbps" : "2 mbps",
        "avcEnabled" : true,
        "urlFilteringPolicyEnabled" : false,
        "urlFilteringPolicyId" : "",
        "wifiCallingPolicyEnabled" : false,
        "wifiCallingPolicyIds" : [ ],
        "uplinkEnabled" : true,
        "uplinkRate" : 100,
        "downlinkEnabled" : true,
        "downlinkRate" : 200,
        "ratePerSTAUplink" : "650mbps",
        "ratePerSTADownlink" : "1mbps",
        "hdOverheadOptimizeEnable" : false,
        "probeRssiThr" : -85,
        "transientClientMgmtEnable" : true,
        "joinIgnoreTimeout" : 30,
        "joinAcceptTimeout" : 300,
        "joinIgnoreThr" : 10,
        "dropRandomProbesEnabled" : true,
        "authRssiThr" : -85,
        "assocRssiThr" : -85
    },
    "diffServProfile" : {
        "id" : "diffServId",
        "name" : "diffServName"
    },
    "qosMaps" : [ {
        "enable" : true,
        "priority" : 0,
        "low" : 0,
        "high" : 7,
        "excepts" : null
    }, {
        "enable" : true,
        "priority" : 1,
        "low" : 8,
        "high" : 15,
        "excepts" : null
    }, {
        "enable" : true,
        "priority" : 2,
        "low" : 16,
        "high" : 23,
        "excepts" : null
    }, {
        "enable" : true,
        "priority" : 3,
        "low" : 0,
        "high" : 32,
        "excepts" : [ 43, 45, 60 ]
    }, {
        "enable" : true,
        "priority" : 4,
        "low" : 32,
        "high" : 39,
        "excepts" : null
    }, {
        "enable" : true,
        "priority" : 5,
        "low" : 40,
        "high" : 47,
        "excepts" : null
    }, {
        "enable" : true,
        "priority" : 6,
        "low" : 48,
        "high" : 55,
        "excepts" : [ 46 ]
    }, {
        "enable" : true,
        "priority" : 7,
        "low" : 56,
        "high" : 63,
        "excepts" : null
    } ],
    "dnsServerProfile" : {
        "id" : "DNS server profile UUID",
        "name" : "DNS server profile name"
    },
    "dpsk" : {
        "dpskEnabled" : false,
        "length" : 8,
        "dpskType" : "Secure",
        "expiration" : "OneDay",
        "dpskFromType" : "FirstUse"
    },
    "externalDpsk" : {
        "enabled" : true,
        "encryption" : {
            "method" : "WPA2",
            "algorithm" : "AES"
        },
        "authService" : {
            "id" : "authServiceUUID"
        }
    },
    "timeboundWhitelist" : {
        "list" : [ {
            "id" : "OAuth authServiceUUID",
            "name" : "authServiceName"
        } ]
    }
}
‧ Sample : Create a Hotspot (WISPr) WLAN with authenticationOption configurations
{
    "name" : "wlanName",
    "ssid" : "wlanSSID",
    "description" : "wlanDescription",
    "authServiceOrProfile" : {
        "throughController" : true,
        "authenticationOption" : "Local DB"
    },
    "portalServiceProfile" : {
        "id" : "portalServiceUUID",
        "name" : "portalServiceName"
    }
}
Schema
{
    "additionalProperties" : false,
    "properties" : {
        "accessTunnelType" : {
            "description" : "Access tunnel type of the WLAN. APLBO means AP local breakout, and SoftGRE means AP direct SoftGRE tunnel",
            "type" : "string",
            "enum" : [ "APLBO", "RuckusGRE", "SoftGRE" ]
        },
        "accountingServiceOrProfile" : {
            "description" : "Accounting of the WLAN",
            "additionalProperties" : false,
            "properties" : {
                "accountingDelayEnabled" : {
                    "description" : "Indicates whether accounting delay time is enabled",
                    "type" : "boolean"
                },
                "id" : {
                    "description" : "Accounting service or profile ID. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "interimUpdateMin" : {
                    "description" : "Interval (in minutes) for sending interim updates",
                    "maximum" : 1440,
                    "minimum" : 0,
                    "type" : "integer"
                },
                "name" : {
                    "description" : "Accounting service or profile name. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "throughController" : {
                    "description" : "Indicates whether accounting messages were sent through the controller",
                    "type" : "boolean"
                },
                "realmBasedAcct" : {
                    "type" : "boolean"
                },
                "backupAccountingId" : {
                    "description" : "Backup accounting service or profile ID. At least one backupAccountingId or backupAccountingName is required in the request when setting backup accounting service.",
                    "type" : "string"
                },
                "backupAccountingName" : {
                    "description" : "Backup accounting service or profile name. At least one backupAccountingId or backupAccountingName is required in the request when setting backup accounting service.",
                    "type" : "string"
                }
            },
            "type" : "object"
        },
        "advancedOptions" : {
            "description" : "Advanced settings for the WLAN.",
            "additionalProperties" : false,
            "properties" : {
                "avcEnabled" : {
                    "default" : false,
                    "description" : "Indicator of whether AVC support is enabled or disabled",
                    "type" : "boolean"
                },
                "bandBalancing" : {
                    "default" : "UseZoneSetting",
                    "description" : "Indicates whether band balancing is enabled or disabled",
                    "type" : "string",
                    "enum" : [ "Disabled", "UseZoneSetting" ]
                },
                "bssMinRateMbps" : {
                    "description" : "BSS minimum rate (mbps)",
                    "type" : "string",
                    "enum" : [ "Disable", "1 mbps", "2 mbps", "5.5 mbps", "12 mbps", "24 mbps" ],
                    "default" : "Disable"
                },
                "clientFingerprintingEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether client fingerprinting is enabled or disabled",
                    "type" : "boolean"
                },
                "clientIdleTimeoutSec" : {
                    "default" : 120,
                    "description" : "Client idle timeout in seconds",
                    "maximum" : 1000,
                    "minimum" : 60,
                    "type" : "integer"
                },
                "clientIsolationEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether wireless client isolation is enabled or disabled",
                    "type" : "boolean"
                },
                "clientIsolationUnicastEnabled" : {
                    "description" : "Indicates whether isolate unicast of wireless client isolation is enabled or disabled",
                    "type" : "boolean",
                    "default" : true
                },
                "clientIsolationMulticastEnabled" : {
                    "description" : "Indicates whether isolate multicast of wireless client isolation is enabled or disabled",
                    "type" : "boolean"
                },
                "clientIsolationAutoVrrpEnabled" : {
                    "description" : "Indicates whether Automatic support for VRRP of wireless client isolation is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "clientIsolationWhitelist" : {
                    "description" : "Indicates wireless client isolation whitelist",
                    "type" : [ "object", "null" ],
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string"
                        }
                    }
                },
                "clientLoadBalancingEnabled" : {
                    "description" : "Indicates whether Client Load Balancing is enabled or disabled",
                    "type" : "boolean",
                    "default" : true
                },
                "dgafEnabled" : {
                    "description" : "Indicates whether dgaf is enabled or disabled",
                    "type" : "boolean"
                },
                "dhcp82Format" : {
                    "description" : "DHCP Option 82 format. This variable no longer supports from v8_1 and only kept for backward compatibility.",
                    "type" : "string",
                    "enum" : [ "RUCKUS_DEFAULT", "SOFTGRE_CUSTOMIZED" ]
                },
                "dhcpOption82Enabled" : {
                    "default" : false,
                    "description" : "Indicates whether DCHP Option 82 is enabled or disabled. This variable no longer supports from v8_1 and only kept for backward compatibility.",
                    "type" : "boolean"
                },
                "dhcp82SubOpt1Format" : {
                    "description" : "Subopt-1 format",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT1_AP_INFO_LOCATION", "SUBOPT1_AP_INFO", "SUBOPT1_AP_MAC_ESSID_PRIVACYTYPE", "SUBOPT1_AP_MAC_hex", "SUBOPT1_AP_MAC_hex_ESSID", "SUBOPT1_ESSID" ]
                },
                "dhcp82SubOpt2Format" : {
                    "description" : "Subopt-2 format",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT2_CLIENT_MAC", "SUBOPT2_CLIENT_MAC_hex", "SUBOPT2_CLIENT_MAC_hex_ESSID", "SUBOPT2_AP_MAC", "SUBOPT2_AP_MAC_hex", "SUBOPT2_AP_MAC_hex_ESSID" ]
                },
                "dhcp82SubOpt150Format" : {
                    "description" : "Subopt-150 with VLAN-Id",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT150_VLAN_ID" ]
                },
                "dhcp82SubOpt151Format" : {
                    "description" : "Subopt-151 format",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT151_AREA_NAME", "SUBOPT151_ESSID" ]
                },
                "dhcp82SubOpt151AreaName" : {
                    "description" : "Subopt-151 Area Name value",
                    "type" : "string"
                },
                "downlinkEnabled" : {
                    "default" : false,
                    "description" : "SSID Rate Limiting downlink enabled.",
                    "type" : "boolean"
                },
                "downlinkRate" : {
                    "description" : "SSID Rate Limiting downlink.",
                    "type" : "number",
                    "default" : 0.0
                },
                "antiSpoofingEnabled" : {
                    "description" : "Anti-Spoofing enabled",
                    "type" : "boolean",
                    "default" : false
                },
                "arpRequestRateLimit" : {
                    "description" : "ARP packets request rate limit, default value will be 15 if both rate limit not being set.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 100
                },
                "dhcpRequestRateLimit" : {
                    "description" : "DHCP packets request rate limit, default value will be 15 if both rate limit not being set.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 100
                },
                "forceClientDHCPTimeoutSec" : {
                    "default" : 0,
                    "description" : "Force DHCP disconnects the client if the client does not obtain a valid IP address within the timeout peroid. To disable force DHCP, set this value to zero (0).",
                    "type" : "integer",
                    "enum" : [ 0, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15 ]
                },
                "hideSsidEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether the SSID is hidden or broadcast",
                    "type" : "boolean"
                },
                "hs20Onboarding" : {
                    "description" : "Allow WISPr WLAN for Hotspot 2.0 Onboarding",
                    "type" : "boolean",
                    "default" : false
                },
                "maxClientsPerRadio" : {
                    "default" : 100,
                    "description" : "Maximum number of clients per radio",
                    "maximum" : 512,
                    "minimum" : 1,
                    "type" : "integer"
                },
                "mgmtTxRateMbps" : {
                    "description" : "Management TX rate (mbps)",
                    "type" : "string",
                    "enum" : [ "1 mbps", "2 mbps", "5.5 mbps", "6 mbps", "9 mbps", "11 mbps", "12 mbps", "18 mbps", "24 mbps", "36 mbps", "48 mbps", "54 mbps" ],
                    "default" : "2 mbps"
                },
                "ofdmOnlyEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether OFDM only is enabled or disabled",
                    "type" : "boolean"
                },
                "okcEnabled" : {
                    "description" : "Indicator of whether OKC support is enabled or disabled. The default value is true when the WLAN is WPA+AES non open WLAN.",
                    "type" : "boolean"
                },
                "pmkCachingEnabled" : {
                    "description" : "Indicator of whether PKM caching support is enabled or disabled. The default value is true when the WLAN is WPA+AES non open WLAN.",
                    "type" : "boolean"
                },
                "priority" : {
                    "default" : "High",
                    "description" : "Priority of the WLAN",
                    "type" : "string",
                    "enum" : [ "High", "Low" ]
                },
                "proxyARPEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether proxy ARP is enabled or disabled",
                    "type" : "boolean"
                },
                "ndProxyEnabled" : {
                    "description" : "Indicates whether ND Proxy is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "suppressNsEnabled" : {
                    "description" : "Indicates whether supperssNS is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "raProxyEnabled" : {
                    "description" : "Indicates whether RA proxy is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "rsraGuardEnabled" : {
                    "description" : "Indicates whether RS/RA Guard is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "raThrottlingEnabled" : {
                    "description" : "Indicates whether RA Throttling is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "maxAllowedRA" : {
                    "description" : "Max Allowed RAs",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 1440,
                    "default" : 10
                },
                "raInterval" : {
                    "description" : "A timer that RA proxy runs and once receives unsolicited RA checks against the configured time and allow/drop RA based on next timeout",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 256,
                    "default" : 10
                },
                "support80211dEnabled" : {
                    "default" : true,
                    "description" : "Indicates whether support for 802.11d is enabled or disabled",
                    "type" : "boolean"
                },
                "support80211kEnabled" : {
                    "default" : true,
                    "description" : "Indicates whether support for 802.11k is enabled or disabled",
                    "type" : "boolean"
                },
                "unauthClientStatsEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether to send statistics of unauthorized clients or not",
                    "type" : "boolean"
                },
                "uplinkEnabled" : {
                    "default" : false,
                    "description" : "SSID Rate Limiting uplink enabled.",
                    "type" : "boolean"
                },
                "uplinkRate" : {
                    "description" : "SSID Rate Limiting uplink.",
                    "type" : "number",
                    "default" : 0.0
                },
                "ratePerSTAUplink" : {
                    "description" : "UE Rate Limiting uplink.",
                    "type" : "string"
                },
                "ratePerSTADownlink" : {
                    "description" : "UE Rate Limiting downlink.",
                    "type" : "string"
                },
                "dtimInterval" : {
                    "description" : "DTIM Interval",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 255,
                    "default" : 1
                },
                "directedThreshold" : {
                    "description" : "Directed Threshold Setting, Defines the client count at which an AP will stop converting group addressed data traffic to unicast.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 128,
                    "default" : 5
                },
                "flowLogEnabled" : {
                    "description" : "Flow log enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "hdOverheadOptimizeEnable" : {
                    "description" : "Airtime Decongestion enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "probeRssiThr" : {
                    "description" : "Join RSSI threshold.",
                    "type" : "integer",
                    "minimum" : -90,
                    "maximum" : -60,
                    "default" : -85
                },
                "transientClientMgmtEnable" : {
                    "description" : "Transient Client Management enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "joinIgnoreTimeout" : {
                    "description" : "Join wait time.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 60,
                    "default" : 30
                },
                "joinAcceptTimeout" : {
                    "description" : "Join expire time.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 300,
                    "default" : 300
                },
                "joinIgnoreThr" : {
                    "description" : "Join wait threshold.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 50,
                    "default" : 10
                },
                "dropRandomProbesEnabled" : {
                    "description" : "Drop Random Probes enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "authRssiThr" : {
                    "description" : "Auth RSSI threshold.",
                    "type" : "integer",
                    "minimum" : -90,
                    "maximum" : -60
                },
                "assocRssiThr" : {
                    "description" : "Assoc RSSI threshold.",
                    "type" : "integer",
                    "minimum" : -90,
                    "maximum" : -60
                },
                "oceEnabled" : {
                    "description" : "Optimized Connectivity Experience(OCE) enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "oceBroadcastProbeResponseDelay" : {
                    "description" : "Broadcast probe response delay.",
                    "type" : "integer",
                    "minimum" : 8,
                    "maximum" : 120,
                    "default" : 15
                },
                "oceRssiBasedAssociationRejectionThreshold" : {
                    "description" : "RSSI-based association rejection threshold.",
                    "type" : "integer",
                    "minimum" : -90,
                    "maximum" : -60,
                    "default" : -75
                }
            },
            "type" : "object"
        },
        "authServiceOrProfile" : {
            "description" : "Authentication of the WLAN. The hotspot WLAN requires authentication messages to be sent through the controller. The ID or name of the authentication services configured globally is required.",
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "description" : "Identifier of the authentication service or profile. At least one ID or name or authenticationOption is required in the request.",
                    "type" : "string"
                },
                "locationDeliveryEnabled" : {
                    "description" : "RFC5580 location delivery support",
                    "type" : "boolean"
                },
                "realmBasedAuth" : {
                    "type" : "boolean"
                },
                "name" : {
                    "description" : "Name of the authentication service or profile. At least one ID or name or authenticationOption is required in the request. Or could input the 'Always Accept' or 'Local DB'.",
                    "type" : "string"
                },
                "authenticationOption" : {
                    "description" : "Option of the authentication service or profile, At least one ID or name or authenticationOption is required in the request. This only applies to hotspot and guest WLANs.",
                    "type" : "string",
                    "enum" : [ "Local DB", "Guest", "Always Accept", null ]
                },
                "throughController" : {
                    "description" : "Indicates whether authentication messages were sent through the controller or not",
                    "type" : "boolean"
                },
                "backupAuthenticationId" : {
                    "description" : "Identifier of the backup authentication service or profile. At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service.",
                    "type" : "string"
                },
                "backupAuthenticationName" : {
                    "description" : "Name of the backup authentication service or profile. At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service. Or could input the 'Always Accept'.",
                    "type" : "string"
                },
                "backupAuthenticationOption" : {
                    "description" : "Option of the backup authentication service or profile, At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service. This only applies to hotspot WLANs.",
                    "type" : "string",
                    "enum" : [ "Always Accept", null ]
                }
            },
            "type" : "object"
        },
        "bypassCNA" : {
            "description" : "Bypass Capitive Network Assitance",
            "type" : "boolean",
            "default" : false
        },
        "coreTunnelProfile" : {
            "description" : "Core tunnel of the WLAN. This only applies when the access tunnel type is set to RuckusGRE.",
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "description" : "Identifier of the forwarding profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the forwarding profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "type" : {
                    "description" : "Tunnel type",
                    "type" : "string",
                    "enum" : [ "Bridge" ]
                }
            },
            "required" : [ "type" ],
            "type" : "object"
        },
        "defaultUserTrafficProfile" : {
            "description" : "User traffic profile of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "precedenceProfileId" : {
            "description" : "Precedence profile of the WLAN",
            "type" : "string"
        },
        "flexiVpnProfile" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "zoneAffinityId" : {
                    "type" : "string",
                    "description" : "Zone Affinity ID"
                }
            },
            "required" : [ "zoneAffinityId" ]
        },
        "description" : {
            "description" : "Description of the WLAN",
            "type" : [ "string", "null" ],
            "maxLength" : 64
        },
        "devicePolicy" : {
            "description" : "Device policy of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "diffServProfile" : {
            "description" : "DiffServ profile of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "dnsServerProfile" : {
            "description" : "DNS server profile of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "dpsk" : {
            "description" : "DPSK Setting",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "dpskEnabled" : {
                    "description" : "DPSK enabled",
                    "type" : "boolean",
                    "default" : false
                },
                "length" : {
                    "description" : "Length of DPSK key",
                    "type" : "integer",
                    "default" : 62
                },
                "dpskType" : {
                    "description" : "Type of DPSK key",
                    "type" : "string",
                    "enum" : [ "Secure", "KeyboardFriendly", "NumbersOnly" ],
                    "default" : "Secure"
                },
                "expiration" : {
                    "description" : "Expiration of DPSK key",
                    "type" : "string",
                    "enum" : [ "Unlimited", "OneDay", "TwoDays", "OneWeek", "TwoWeeks", "OneMonth", "SixMonths", "OneYear", "TwoYears" ],
                    "default" : "Unlimited"
                },
                "dpskFromType" : {
                    "description" : "Type of expiration start from",
                    "type" : "string",
                    "enum" : [ "CreateTime", "FirstUse" ],
                    "default" : "CreateTime"
                }
            }
        },
        "externalDpsk" : {
            "description" : "External DPSK Enabled",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "enabled" : {
                    "description" : "Enable External DPSK",
                    "type" : "boolean",
                    "default" : false
                },
                "encryption" : {
                    "description" : "Encryption of the WLAN relate to external DPSK",
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "method" : {
                            "description" : "Encryption method",
                            "type" : "string",
                            "enum" : [ "WPA2", "WPA_Mixed", "None" ]
                        },
                        "algorithm" : {
                            "description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
                            "type" : "string",
                            "enum" : [ "AES", "TKIP_AES" ]
                        }
                    }
                },
                "authService" : {
                    "description" : "Autentication of the WLAN relate to external DPSK",
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "description" : "Identifier of the authentication service. At least one ID or name is required in the request.",
                            "type" : "string"
                        },
                        "name" : {
                            "description" : "Name of the authentication service. At least one ID or name is required in the request.",
                            "type" : "string"
                        }
                    }
                }
            },
            "required" : [ "enabled" ]
        },
        "encryption" : {
            "description" : "Encryption of the WLAN",
            "additionalProperties" : false,
            "properties" : {
                "algorithm" : {
                    "description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
                    "type" : "string",
                    "enum" : [ "AES", "TKIP_AES" ]
                },
                "keyInHex" : {
                    "description" : "Key in hex format. This only applies to WEP64 and WEP128.",
                    "type" : "string"
                },
                "keyIndex" : {
                    "description" : "Key index. This only applies to WEP64 and WEP128.",
                    "type" : "integer"
                },
                "method" : {
                    "description" : "Encryption method",
                    "type" : "string",
                    "enum" : [ "WPA2", "WPA_Mixed", "WEP_64", "WEP_128", "None" ],
                    "default" : "None"
                },
                "mfp" : {
                    "description" : "Management frame protection. This only applies to WPA2 + AES",
                    "type" : "string",
                    "enum" : [ "disabled", "capable", "required" ]
                },
                "mobilityDomainId" : {
                    "description" : "mobility Domain Id.",
                    "maximum" : 65535,
                    "minimum" : 1,
                    "type" : "integer"
                },
                "passphrase" : {
                    "description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
                    "type" : "string"
                },
                "support80211rEnabled" : {
                    "description" : "Enable 802.11r Fast BSS Transition, fast Romaing.",
                    "type" : "boolean"
                }
            },
            "required" : [ "method" ],
            "type" : "object"
        },
        "hessid" : {
            "description" : "HESSID of the WLAN",
            "pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$",
            "type" : "string"
        },
        "hotspot20Profile" : {
            "description" : "Hotspot 2.0 operator profile of the WLAN. id or name of the hotspot 2.0 operator profiles within the zone is required.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "l2ACL" : {
            "description" : "Layer 2 ACL of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "macAuth" : {
            "description" : "MAC address authentication settings of the WLAN. This only applies to standard MAC and Hotspot MAC bypass WLAN.",
            "additionalProperties" : false,
            "properties" : {
                "customizedPassword" : {
                    "description" : "User defined password. When this field is set to an empty string, the MAC address is used as password.",
                    "maxLength" : 64,
                    "pattern" : "^([!-;=?-~]([ -;=?-~]){0,62}[!-;=?-~]|[!-;=?-~]{1,1}|\s{0,0})$",
                    "type" : "string"
                },
                "macAuthMacFormat" : {
                    "description" : "MAC address format. The default format is 0010a42319c0 and the 802.1X format is 00-10-A4-23-19-C0.",
                    "type" : "string",
                    "enum" : [ "Default", "802.1X", "UpperColon", "Upper", "LowerDash", "LowerColon" ]
                }
            },
            "type" : "object"
        },
        "name" : {
            "description" : "Name of the WLAN",
            "type" : "string",
            "minLength" : 1,
            "maxLength" : 32
        },
        "operatorRealm" : {
            "description" : "Operator realm, operatorRealm only supports coreTunnelProfile type is PMIP or authServiceOrProfile.locationDeliveryEnabled is true",
            "type" : "string",
            "maxLength" : 255,
            "pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
        },
        "portalServiceProfile" : {
            "description" : "Hotspot portal service of the WLAN. The ID or name of the hotspot portal services within the zone is required.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "qosMaps" : {
            "description" : "Qos map set of the WLAN.",
            "items" : {
                "additionalProperties" : false,
                "properties" : {
                    "enable" : {
                        "description" : "Enabled or disabled",
                        "type" : "boolean"
                    },
                    "excepts" : {
                        "items" : {
                            "maximum" : 63,
                            "minimum" : 0,
                            "type" : "integer"
                        },
                        "type" : [ "array", "null" ]
                    },
                    "high" : {
                        "description" : "DSCP range - high",
                        "maximum" : 255,
                        "minimum" : 0,
                        "type" : [ "integer", "null" ]
                    },
                    "low" : {
                        "description" : "DSCP range - low",
                        "maximum" : 255,
                        "minimum" : 0,
                        "type" : [ "integer", "null" ]
                    },
                    "priority" : {
                        "description" : "Priority",
                        "type" : "integer"
                    }
                },
                "required" : [ "enable", "priority" ],
                "type" : "object"
            },
            "type" : "array"
        },
        "radiusOptions" : {
            "description" : "RADIUS options of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "calledStaIdType" : {
                    "default" : "WLAN_BSSID",
                    "description" : "Called station ID type",
                    "type" : "string",
                    "enum" : [ "AP_MAC", "NONE", "WLAN_BSSID" ]
                },
                "customizedNasId" : {
                    "description" : "User defined NAS ID",
                    "maxLength" : 64,
                    "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                    "type" : "string"
                },
                "nasIdType" : {
                    "default" : "WLAN_BSSID",
                    "description" : "NAS ID type",
                    "type" : "string",
                    "enum" : [ "AP_MAC", "Customized", "WLAN_BSSID" ]
                },
                "nasMaxRetry" : {
                    "default" : 2,
                    "description" : "NAS request maximum retry",
                    "maximum" : 10,
                    "minimum" : 2,
                    "type" : "integer"
                },
                "nasReconnectPrimaryMin" : {
                    "default" : 5,
                    "description" : "NAS reconnect primary time in minutes",
                    "maximum" : 60,
                    "minimum" : 1,
                    "type" : "integer"
                },
                "nasRequestTimeoutSec" : {
                    "default" : 3,
                    "description" : "NAS request timeout in seconds",
                    "maximum" : 20,
                    "minimum" : 2,
                    "type" : "integer"
                },
                "nasIpType" : {
                    "description" : "NAS IP type",
                    "type" : "string",
                    "enum" : [ "disabled", "control", "management", "userDefined" ],
                    "default" : "disabled"
                },
                "nasIpUserDefined" : {
                    "description" : "User-defined NAS IP",
                    "type" : "string",
                    "maxLength" : 45
                },
                "singleSessionIdAcctEnabled" : {
                    "description" : "When Single Accounting Session ID is enabled, APs will maintain one accounting session for client roaming",
                    "type" : "boolean",
                    "default" : false
                },
                "vendorSpecificAttributeProfileId" : {
                    "description" : "Vendor Specific Attribute Profile ID",
                    "type" : "string"
                }
            }
        },
        "schedule" : {
            "description" : "Schedule of the WLAN",
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "description" : "Identifier of the schedule profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the schedule profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "type" : {
                    "description" : "Type of WLAN schedule",
                    "type" : "string",
                    "enum" : [ "AlwaysOn", "AlwaysOff", "Customized" ],
                    "default" : "AlwaysOn"
                }
            },
            "required" : [ "type" ],
            "type" : "object"
        },
        "ssid" : {
            "description" : "SSID of the WLAN",
            "type" : "string",
            "minLength" : 1,
            "maxLength" : 32
        },
        "timeboundWhitelist" : {
            "description" : "Hotspot timeboundWhitelist. The ID Hotspot timeboundWhitelist. The ID of the OAuth Authentication service is required.",
            "additionalProperties" : false,
            "properties" : {
                "firstIndex" : {
                    "type" : "integer"
                },
                "hasMore" : {
                    "type" : "boolean"
                },
                "list" : {
                    "items" : {
                        "type" : [ "object", "null" ],
                        "additionalProperties" : false,
                        "properties" : {
                            "id" : {
                                "type" : "string"
                            },
                            "name" : {
                                "type" : "string"
                            }
                        }
                    },
                    "type" : "array"
                },
                "totalCount" : {
                    "type" : "integer"
                }
            },
            "type" : "object"
        },
        "vlan" : {
            "description" : "VLAN (access and/or core) of the WLAN.",
            "additionalProperties" : false,
            "properties" : {
                "aaaVlanOverride" : {
                    "description" : "Indicates whether the AAA VLAN settings can be overriden or not",
                    "type" : "boolean"
                },
                "accessVlan" : {
                    "description" : "Access VLAN ID",
                    "maximum" : 4094,
                    "minimum" : 1,
                    "type" : "integer",
                    "default" : 1
                },
                "vlanPooling" : {
                    "description" : "Vlan pooling",
                    "type" : [ "object", "null" ],
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string"
                        }
                    }
                }
            },
            "type" : "object"
        },
        "accessTunnelProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "accessIpsecProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "splitTunnelProfileId" : {
            "type" : "string"
        }
    },
    "required" : [ "name", "ssid", "authServiceOrProfile", "portalServiceProfile" ],
    "type" : "object"
}
Response  201
HideShow
Body
{
  "id": "wlanID"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Create - Hotspot + 802.1X

POST/v8_1/rkszones/{zoneId}/wlans/wispr8021X

Use this API command to create a new hotspot (WISPr) with 802.1X WLAN.

Request
HideShow
Body
‧ Sample : Create a Hotspot (WISPr) WLAN with default configurations
{
    "name" : "wlanName",
    "ssid" : "wlanSSID",
    "description" : "wlanDescription",
    "authServiceOrProfile" : {
        "throughController" : false,
        "id" : "authServiceUUID",
        "name" : "authServiceName",
        "authenticationOption" : null
    },
    "portalServiceProfile" : {
        "id" : "portalServiceUUID",
        "name" : "portalServiceName"
    },
    "accessTunnelType" : "RuckusGRE",
    "accessTunnelProfile" : {
        "id" : "f5b92938-aa4e-4d02-90ea-273799ff689b",
        "name" : "Default Tunnel Profile"
    },
    "splitTunnelProfileId" : "38119bac-49e1-4410-ab8e-1c1bc88dd770",
    "coreTunnelProfile" : {
        "type" : "Bridge",
        "id" : "forwardingUUID",
        "name" : "forwardingName"
    },
    "encryption" : {
        "method" : "WPA2",
        "algorithm" : "AES",
        "passphrase" : "password",
        "mfp" : "disabled",
        "support80211rEnabled" : true,
        "mobilityDomainId" : 3
    },
    "operatorRealm" : "operator realm",
    "defaultUserTrafficProfile" : {
        "id" : "userTrafficUUID",
        "name" : "userTrafficName"
    },
    "precedenceProfileId" : "c514d450-c839-9527-afc9-525400d12345",
    "schedule" : {
        "type" : "Customized",
        "id" : "ServiceUUID",
        "name" : "ServiceName"
    },
    "vlan" : {
        "accessVlan" : 23,
        "coreQinQEnabled" : false,
        "coreSVlan" : 1,
        "vlanPooling" : null
    },
    "l2ACL" : {
        "id" : "l2ACLUUID",
        "name" : "l2ACLName"
    },
    "devicePolicy" : {
        "id" : "devicePolicyUUID",
        "name" : "devicePolicyName"
    },
    "radiusOptions" : {
        "nasIdType" : "Customized",
        "customizedNasId" : "nasId",
        "nasRequestTimeoutSec" : 12,
        "nasMaxRetry" : 3,
        "nasReconnectPrimaryMin" : 30,
        "calledStaIdType" : "WLAN_BSSID",
        "nasIpType" : "disabled",
        "nasIpUserDefined" : "192.168.1.1",
        "vendorSpecificAttributeProfileId" : "6d767421-d1b7-11e8-8ab9-ba2343155a93"
    },
    "advancedOptions" : {
        "clientIsolationEnabled" : true,
        "clientIsolationUnicastEnabled" : true,
        "clientIsolationMulticastEnabled" : false,
        "clientIsolationAutoVrrpEnabled" : false,
        "clientIsolationWhitelist" : {
            "id" : "b89323e1-3168-11e7-b027-5254009ae3f0",
            "name" : "myWhitelist"
        },
        "priority" : "High",
        "hideSsidEnabled" : true,
        "maxClientsPerRadio" : 12,
        "clientIdleTimeoutSec" : 60,
        "clientLoadBalancingEnabled" : true,
        "proxyARPEnabled" : true,
        "support80211dEnabled" : false,
        "support80211kEnabled" : true,
        "antiSpoofingEnabled" : true,
        "arpRequestRateLimit" : 15,
        "dhcpRequestRateLimit" : 15,
        "forceClientDHCPTimeoutSec" : 5,
        "dhcp82SubOpt1Format" : "SUBOPT1_AP_INFO_LOCATION",
        "unauthClientStatsEnabled" : false,
        "clientFingerprintingEnabled" : true,
        "ofdmOnlyEnabled" : false,
        "bandBalancing" : "UseZoneSetting",
        "bssMinRateMbps" : "Disable",
        "mgmtTxRateMbps" : "2 mbps",
        "avcEnabled" : true,
        "urlFilteringPolicyEnabled" : false,
        "urlFilteringPolicyId" : "",
        "wifiCallingPolicyEnabled" : false,
        "wifiCallingPolicyIds" : [ ],
        "uplinkEnabled" : true,
        "uplinkRate" : 100,
        "downlinkEnabled" : true,
        "downlinkRate" : 200,
        "ratePerSTAUplink" : "650mbps",
        "ratePerSTADownlink" : "1mbps",
        "hdOverheadOptimizeEnable" : false,
        "probeRssiThr" : -85,
        "transientClientMgmtEnable" : true,
        "joinIgnoreTimeout" : 30,
        "joinAcceptTimeout" : 300,
        "joinIgnoreThr" : 10,
        "dropRandomProbesEnabled" : true,
        "authRssiThr" : -85,
        "assocRssiThr" : -85
    },
    "diffServProfile" : {
        "id" : "diffServId",
        "name" : "diffServName"
    },
    "qosMaps" : [ {
        "enable" : true,
        "priority" : 0,
        "low" : 0,
        "high" : 7,
        "excepts" : null
    }, {
        "enable" : true,
        "priority" : 1,
        "low" : 8,
        "high" : 15,
        "excepts" : null
    }, {
        "enable" : true,
        "priority" : 2,
        "low" : 16,
        "high" : 23,
        "excepts" : null
    }, {
        "enable" : true,
        "priority" : 3,
        "low" : 0,
        "high" : 32,
        "excepts" : [ 43, 45, 60 ]
    }, {
        "enable" : true,
        "priority" : 4,
        "low" : 32,
        "high" : 39,
        "excepts" : null
    }, {
        "enable" : true,
        "priority" : 5,
        "low" : 40,
        "high" : 47,
        "excepts" : null
    }, {
        "enable" : true,
        "priority" : 6,
        "low" : 48,
        "high" : 55,
        "excepts" : [ 46 ]
    }, {
        "enable" : true,
        "priority" : 7,
        "low" : 56,
        "high" : 63,
        "excepts" : null
    } ],
    "dnsServerProfile" : {
        "id" : "DNS server profile UUID",
        "name" : "DNS server profile name"
    },
    "dpsk" : {
        "dpskEnabled" : false,
        "length" : 8,
        "dpskType" : "Secure",
        "expiration" : "OneDay",
        "dpskFromType" : "FirstUse"
    },
    "externalDpsk" : {
        "enabled" : true,
        "encryption" : {
            "method" : "WPA2",
            "algorithm" : "AES"
        },
        "authService" : {
            "id" : "authServiceUUID"
        }
    },
    "timeboundWhitelist" : {
        "list" : [ {
            "id" : "OAuth authServiceUUID",
            "name" : "authServiceName"
        } ]
    }
}
‧ Sample : Create a Hotspot (WISPr) WLAN with authenticationOption configurations
{
    "name" : "wlanName",
    "ssid" : "wlanSSID",
    "description" : "wlanDescription",
    "authServiceOrProfile" : {
        "throughController" : true,
        "authenticationOption" : "Local DB"
    },
    "portalServiceProfile" : {
        "id" : "portalServiceUUID",
        "name" : "portalServiceName"
    }
}
Schema
{
    "additionalProperties" : false,
    "properties" : {
        "accessTunnelType" : {
            "description" : "Access tunnel type of the WLAN. APLBO means AP local breakout, and SoftGRE means AP direct SoftGRE tunnel",
            "type" : "string",
            "enum" : [ "APLBO", "RuckusGRE", "SoftGRE" ]
        },
        "accountingServiceOrProfile" : {
            "description" : "Accounting of the WLAN",
            "additionalProperties" : false,
            "properties" : {
                "accountingDelayEnabled" : {
                    "description" : "Indicates whether accounting delay time is enabled",
                    "type" : "boolean"
                },
                "id" : {
                    "description" : "Accounting service or profile ID. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "interimUpdateMin" : {
                    "description" : "Interval (in minutes) for sending interim updates",
                    "maximum" : 1440,
                    "minimum" : 0,
                    "type" : "integer"
                },
                "name" : {
                    "description" : "Accounting service or profile name. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "throughController" : {
                    "description" : "Indicates whether accounting messages were sent through the controller",
                    "type" : "boolean"
                },
                "realmBasedAcct" : {
                    "type" : "boolean"
                },
                "backupAccountingId" : {
                    "description" : "Backup accounting service or profile ID. At least one backupAccountingId or backupAccountingName is required in the request when setting backup accounting service.",
                    "type" : "string"
                },
                "backupAccountingName" : {
                    "description" : "Backup accounting service or profile name. At least one backupAccountingId or backupAccountingName is required in the request when setting backup accounting service.",
                    "type" : "string"
                }
            },
            "type" : "object"
        },
        "advancedOptions" : {
            "description" : "Advanced settings for the WLAN.",
            "additionalProperties" : false,
            "properties" : {
                "avcEnabled" : {
                    "default" : false,
                    "description" : "Indicator of whether AVC support is enabled or disabled",
                    "type" : "boolean"
                },
                "bandBalancing" : {
                    "default" : "UseZoneSetting",
                    "description" : "Indicates whether band balancing is enabled or disabled",
                    "type" : "string",
                    "enum" : [ "Disabled", "UseZoneSetting" ]
                },
                "bssMinRateMbps" : {
                    "description" : "BSS minimum rate (mbps)",
                    "type" : "string",
                    "enum" : [ "Disable", "1 mbps", "2 mbps", "5.5 mbps", "12 mbps", "24 mbps" ],
                    "default" : "Disable"
                },
                "clientFingerprintingEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether client fingerprinting is enabled or disabled",
                    "type" : "boolean"
                },
                "clientIdleTimeoutSec" : {
                    "default" : 120,
                    "description" : "Client idle timeout in seconds",
                    "maximum" : 1000,
                    "minimum" : 60,
                    "type" : "integer"
                },
                "clientIsolationEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether wireless client isolation is enabled or disabled",
                    "type" : "boolean"
                },
                "clientIsolationUnicastEnabled" : {
                    "description" : "Indicates whether isolate unicast of wireless client isolation is enabled or disabled",
                    "type" : "boolean",
                    "default" : true
                },
                "clientIsolationMulticastEnabled" : {
                    "description" : "Indicates whether isolate multicast of wireless client isolation is enabled or disabled",
                    "type" : "boolean"
                },
                "clientIsolationAutoVrrpEnabled" : {
                    "description" : "Indicates whether Automatic support for VRRP of wireless client isolation is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "clientIsolationWhitelist" : {
                    "description" : "Indicates wireless client isolation whitelist",
                    "type" : [ "object", "null" ],
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string"
                        }
                    }
                },
                "clientLoadBalancingEnabled" : {
                    "description" : "Indicates whether Client Load Balancing is enabled or disabled",
                    "type" : "boolean",
                    "default" : true
                },
                "dgafEnabled" : {
                    "description" : "Indicates whether dgaf is enabled or disabled",
                    "type" : "boolean"
                },
                "dhcp82Format" : {
                    "description" : "DHCP Option 82 format. This variable no longer supports from v8_1 and only kept for backward compatibility.",
                    "type" : "string",
                    "enum" : [ "RUCKUS_DEFAULT", "SOFTGRE_CUSTOMIZED" ]
                },
                "dhcpOption82Enabled" : {
                    "default" : false,
                    "description" : "Indicates whether DCHP Option 82 is enabled or disabled. This variable no longer supports from v8_1 and only kept for backward compatibility.",
                    "type" : "boolean"
                },
                "dhcp82SubOpt1Format" : {
                    "description" : "Subopt-1 format",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT1_AP_INFO_LOCATION", "SUBOPT1_AP_INFO", "SUBOPT1_AP_MAC_ESSID_PRIVACYTYPE", "SUBOPT1_AP_MAC_hex", "SUBOPT1_AP_MAC_hex_ESSID", "SUBOPT1_ESSID" ]
                },
                "dhcp82SubOpt2Format" : {
                    "description" : "Subopt-2 format",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT2_CLIENT_MAC", "SUBOPT2_CLIENT_MAC_hex", "SUBOPT2_CLIENT_MAC_hex_ESSID", "SUBOPT2_AP_MAC", "SUBOPT2_AP_MAC_hex", "SUBOPT2_AP_MAC_hex_ESSID" ]
                },
                "dhcp82SubOpt150Format" : {
                    "description" : "Subopt-150 with VLAN-Id",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT150_VLAN_ID" ]
                },
                "dhcp82SubOpt151Format" : {
                    "description" : "Subopt-151 format",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT151_AREA_NAME", "SUBOPT151_ESSID" ]
                },
                "dhcp82SubOpt151AreaName" : {
                    "description" : "Subopt-151 Area Name value",
                    "type" : "string"
                },
                "downlinkEnabled" : {
                    "default" : false,
                    "description" : "SSID Rate Limiting downlink enabled.",
                    "type" : "boolean"
                },
                "downlinkRate" : {
                    "description" : "SSID Rate Limiting downlink.",
                    "type" : "number",
                    "default" : 0.0
                },
                "antiSpoofingEnabled" : {
                    "description" : "Anti-Spoofing enabled",
                    "type" : "boolean",
                    "default" : false
                },
                "arpRequestRateLimit" : {
                    "description" : "ARP packets request rate limit, default value will be 15 if both rate limit not being set.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 100
                },
                "dhcpRequestRateLimit" : {
                    "description" : "DHCP packets request rate limit, default value will be 15 if both rate limit not being set.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 100
                },
                "forceClientDHCPTimeoutSec" : {
                    "default" : 0,
                    "description" : "Force DHCP disconnects the client if the client does not obtain a valid IP address within the timeout peroid. To disable force DHCP, set this value to zero (0).",
                    "type" : "integer",
                    "enum" : [ 0, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15 ]
                },
                "hideSsidEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether the SSID is hidden or broadcast",
                    "type" : "boolean"
                },
                "hs20Onboarding" : {
                    "description" : "Allow WISPr WLAN for Hotspot 2.0 Onboarding",
                    "type" : "boolean",
                    "default" : false
                },
                "maxClientsPerRadio" : {
                    "default" : 100,
                    "description" : "Maximum number of clients per radio",
                    "maximum" : 512,
                    "minimum" : 1,
                    "type" : "integer"
                },
                "mgmtTxRateMbps" : {
                    "description" : "Management TX rate (mbps)",
                    "type" : "string",
                    "enum" : [ "1 mbps", "2 mbps", "5.5 mbps", "6 mbps", "9 mbps", "11 mbps", "12 mbps", "18 mbps", "24 mbps", "36 mbps", "48 mbps", "54 mbps" ],
                    "default" : "2 mbps"
                },
                "ofdmOnlyEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether OFDM only is enabled or disabled",
                    "type" : "boolean"
                },
                "okcEnabled" : {
                    "description" : "Indicator of whether OKC support is enabled or disabled. The default value is true when the WLAN is WPA+AES non open WLAN.",
                    "type" : "boolean"
                },
                "pmkCachingEnabled" : {
                    "description" : "Indicator of whether PKM caching support is enabled or disabled. The default value is true when the WLAN is WPA+AES non open WLAN.",
                    "type" : "boolean"
                },
                "priority" : {
                    "default" : "High",
                    "description" : "Priority of the WLAN",
                    "type" : "string",
                    "enum" : [ "High", "Low" ]
                },
                "proxyARPEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether proxy ARP is enabled or disabled",
                    "type" : "boolean"
                },
                "ndProxyEnabled" : {
                    "description" : "Indicates whether ND Proxy is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "suppressNsEnabled" : {
                    "description" : "Indicates whether supperssNS is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "raProxyEnabled" : {
                    "description" : "Indicates whether RA proxy is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "rsraGuardEnabled" : {
                    "description" : "Indicates whether RS/RA Guard is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "raThrottlingEnabled" : {
                    "description" : "Indicates whether RA Throttling is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "maxAllowedRA" : {
                    "description" : "Max Allowed RAs",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 1440,
                    "default" : 10
                },
                "raInterval" : {
                    "description" : "A timer that RA proxy runs and once receives unsolicited RA checks against the configured time and allow/drop RA based on next timeout",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 256,
                    "default" : 10
                },
                "support80211dEnabled" : {
                    "default" : true,
                    "description" : "Indicates whether support for 802.11d is enabled or disabled",
                    "type" : "boolean"
                },
                "support80211kEnabled" : {
                    "default" : true,
                    "description" : "Indicates whether support for 802.11k is enabled or disabled",
                    "type" : "boolean"
                },
                "unauthClientStatsEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether to send statistics of unauthorized clients or not",
                    "type" : "boolean"
                },
                "uplinkEnabled" : {
                    "default" : false,
                    "description" : "SSID Rate Limiting uplink enabled.",
                    "type" : "boolean"
                },
                "uplinkRate" : {
                    "description" : "SSID Rate Limiting uplink.",
                    "type" : "number",
                    "default" : 0.0
                },
                "ratePerSTAUplink" : {
                    "description" : "UE Rate Limiting uplink.",
                    "type" : "string"
                },
                "ratePerSTADownlink" : {
                    "description" : "UE Rate Limiting downlink.",
                    "type" : "string"
                },
                "dtimInterval" : {
                    "description" : "DTIM Interval",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 255,
                    "default" : 1
                },
                "directedThreshold" : {
                    "description" : "Directed Threshold Setting, Defines the client count at which an AP will stop converting group addressed data traffic to unicast.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 128,
                    "default" : 5
                },
                "flowLogEnabled" : {
                    "description" : "Flow log enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "hdOverheadOptimizeEnable" : {
                    "description" : "Airtime Decongestion enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "probeRssiThr" : {
                    "description" : "Join RSSI threshold.",
                    "type" : "integer",
                    "minimum" : -90,
                    "maximum" : -60,
                    "default" : -85
                },
                "transientClientMgmtEnable" : {
                    "description" : "Transient Client Management enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "joinIgnoreTimeout" : {
                    "description" : "Join wait time.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 60,
                    "default" : 30
                },
                "joinAcceptTimeout" : {
                    "description" : "Join expire time.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 300,
                    "default" : 300
                },
                "joinIgnoreThr" : {
                    "description" : "Join wait threshold.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 50,
                    "default" : 10
                },
                "dropRandomProbesEnabled" : {
                    "description" : "Drop Random Probes enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "authRssiThr" : {
                    "description" : "Auth RSSI threshold.",
                    "type" : "integer",
                    "minimum" : -90,
                    "maximum" : -60
                },
                "assocRssiThr" : {
                    "description" : "Assoc RSSI threshold.",
                    "type" : "integer",
                    "minimum" : -90,
                    "maximum" : -60
                },
                "oceEnabled" : {
                    "description" : "Optimized Connectivity Experience(OCE) enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "oceBroadcastProbeResponseDelay" : {
                    "description" : "Broadcast probe response delay.",
                    "type" : "integer",
                    "minimum" : 8,
                    "maximum" : 120,
                    "default" : 15
                },
                "oceRssiBasedAssociationRejectionThreshold" : {
                    "description" : "RSSI-based association rejection threshold.",
                    "type" : "integer",
                    "minimum" : -90,
                    "maximum" : -60,
                    "default" : -75
                }
            },
            "type" : "object"
        },
        "authServiceOrProfile" : {
            "description" : "Authentication of the WLAN. The hotspot WLAN requires authentication messages to be sent through the controller. The ID or name of the authentication services configured globally is required.",
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "description" : "Identifier of the authentication service or profile. At least one ID or name or authenticationOption is required in the request.",
                    "type" : "string"
                },
                "locationDeliveryEnabled" : {
                    "description" : "RFC5580 location delivery support",
                    "type" : "boolean"
                },
                "realmBasedAuth" : {
                    "type" : "boolean"
                },
                "name" : {
                    "description" : "Name of the authentication service or profile. At least one ID or name or authenticationOption is required in the request. Or could input the 'Always Accept' or 'Local DB'.",
                    "type" : "string"
                },
                "authenticationOption" : {
                    "description" : "Option of the authentication service or profile, At least one ID or name or authenticationOption is required in the request. This only applies to hotspot and guest WLANs.",
                    "type" : "string",
                    "enum" : [ "Local DB", "Guest", "Always Accept", null ]
                },
                "throughController" : {
                    "description" : "Indicates whether authentication messages were sent through the controller or not",
                    "type" : "boolean"
                },
                "backupAuthenticationId" : {
                    "description" : "Identifier of the backup authentication service or profile. At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service.",
                    "type" : "string"
                },
                "backupAuthenticationName" : {
                    "description" : "Name of the backup authentication service or profile. At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service. Or could input the 'Always Accept'.",
                    "type" : "string"
                },
                "backupAuthenticationOption" : {
                    "description" : "Option of the backup authentication service or profile, At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service. This only applies to hotspot WLANs.",
                    "type" : "string",
                    "enum" : [ "Always Accept", null ]
                }
            },
            "type" : "object"
        },
        "bypassCNA" : {
            "description" : "Bypass Capitive Network Assitance",
            "type" : "boolean",
            "default" : false
        },
        "coreTunnelProfile" : {
            "description" : "Core tunnel of the WLAN. This only applies when the access tunnel type is set to RuckusGRE.",
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "description" : "Identifier of the forwarding profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the forwarding profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "type" : {
                    "description" : "Tunnel type",
                    "type" : "string",
                    "enum" : [ "Bridge" ]
                }
            },
            "required" : [ "type" ],
            "type" : "object"
        },
        "defaultUserTrafficProfile" : {
            "description" : "User traffic profile of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "precedenceProfileId" : {
            "description" : "Precedence profile of the WLAN",
            "type" : "string"
        },
        "flexiVpnProfile" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "zoneAffinityId" : {
                    "type" : "string",
                    "description" : "Zone Affinity ID"
                }
            },
            "required" : [ "zoneAffinityId" ]
        },
        "description" : {
            "description" : "Description of the WLAN",
            "type" : [ "string", "null" ],
            "maxLength" : 64
        },
        "devicePolicy" : {
            "description" : "Device policy of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "diffServProfile" : {
            "description" : "DiffServ profile of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "dnsServerProfile" : {
            "description" : "DNS server profile of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "dpsk" : {
            "description" : "DPSK Setting",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "dpskEnabled" : {
                    "description" : "DPSK enabled",
                    "type" : "boolean",
                    "default" : false
                },
                "length" : {
                    "description" : "Length of DPSK key",
                    "type" : "integer",
                    "default" : 62
                },
                "dpskType" : {
                    "description" : "Type of DPSK key",
                    "type" : "string",
                    "enum" : [ "Secure", "KeyboardFriendly", "NumbersOnly" ],
                    "default" : "Secure"
                },
                "expiration" : {
                    "description" : "Expiration of DPSK key",
                    "type" : "string",
                    "enum" : [ "Unlimited", "OneDay", "TwoDays", "OneWeek", "TwoWeeks", "OneMonth", "SixMonths", "OneYear", "TwoYears" ],
                    "default" : "Unlimited"
                },
                "dpskFromType" : {
                    "description" : "Type of expiration start from",
                    "type" : "string",
                    "enum" : [ "CreateTime", "FirstUse" ],
                    "default" : "CreateTime"
                }
            }
        },
        "externalDpsk" : {
            "description" : "External DPSK Enabled",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "enabled" : {
                    "description" : "Enable External DPSK",
                    "type" : "boolean",
                    "default" : false
                },
                "encryption" : {
                    "description" : "Encryption of the WLAN relate to external DPSK",
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "method" : {
                            "description" : "Encryption method",
                            "type" : "string",
                            "enum" : [ "WPA2", "WPA_Mixed", "None" ]
                        },
                        "algorithm" : {
                            "description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
                            "type" : "string",
                            "enum" : [ "AES", "TKIP_AES" ]
                        }
                    }
                },
                "authService" : {
                    "description" : "Autentication of the WLAN relate to external DPSK",
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "description" : "Identifier of the authentication service. At least one ID or name is required in the request.",
                            "type" : "string"
                        },
                        "name" : {
                            "description" : "Name of the authentication service. At least one ID or name is required in the request.",
                            "type" : "string"
                        }
                    }
                }
            },
            "required" : [ "enabled" ]
        },
        "encryption" : {
            "description" : "Encryption of the WLAN",
            "additionalProperties" : false,
            "properties" : {
                "algorithm" : {
                    "description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
                    "type" : "string",
                    "enum" : [ "AES", "TKIP_AES" ]
                },
                "keyInHex" : {
                    "description" : "Key in hex format. This only applies to WEP64 and WEP128.",
                    "type" : "string"
                },
                "keyIndex" : {
                    "description" : "Key index. This only applies to WEP64 and WEP128.",
                    "type" : "integer"
                },
                "method" : {
                    "description" : "Encryption method",
                    "type" : "string",
                    "enum" : [ "WPA2", "WPA_Mixed", "WEP_64", "WEP_128", "None" ],
                    "default" : "None"
                },
                "mfp" : {
                    "description" : "Management frame protection. This only applies to WPA2 + AES",
                    "type" : "string",
                    "enum" : [ "disabled", "capable", "required" ]
                },
                "mobilityDomainId" : {
                    "description" : "mobility Domain Id.",
                    "maximum" : 65535,
                    "minimum" : 1,
                    "type" : "integer"
                },
                "passphrase" : {
                    "description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
                    "type" : "string"
                },
                "support80211rEnabled" : {
                    "description" : "Enable 802.11r Fast BSS Transition, fast Romaing.",
                    "type" : "boolean"
                }
            },
            "required" : [ "method" ],
            "type" : "object"
        },
        "hessid" : {
            "description" : "HESSID of the WLAN",
            "pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$",
            "type" : "string"
        },
        "hotspot20Profile" : {
            "description" : "Hotspot 2.0 operator profile of the WLAN. id or name of the hotspot 2.0 operator profiles within the zone is required.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "l2ACL" : {
            "description" : "Layer 2 ACL of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "macAuth" : {
            "description" : "MAC address authentication settings of the WLAN. This only applies to standard MAC and Hotspot MAC bypass WLAN.",
            "additionalProperties" : false,
            "properties" : {
                "customizedPassword" : {
                    "description" : "User defined password. When this field is set to an empty string, the MAC address is used as password.",
                    "maxLength" : 64,
                    "pattern" : "^([!-;=?-~]([ -;=?-~]){0,62}[!-;=?-~]|[!-;=?-~]{1,1}|\s{0,0})$",
                    "type" : "string"
                },
                "macAuthMacFormat" : {
                    "description" : "MAC address format. The default format is 0010a42319c0 and the 802.1X format is 00-10-A4-23-19-C0.",
                    "type" : "string",
                    "enum" : [ "Default", "802.1X", "UpperColon", "Upper", "LowerDash", "LowerColon" ]
                }
            },
            "type" : "object"
        },
        "name" : {
            "description" : "Name of the WLAN",
            "type" : "string",
            "minLength" : 1,
            "maxLength" : 32
        },
        "operatorRealm" : {
            "description" : "Operator realm, operatorRealm only supports coreTunnelProfile type is PMIP or authServiceOrProfile.locationDeliveryEnabled is true",
            "type" : "string",
            "maxLength" : 255,
            "pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
        },
        "portalServiceProfile" : {
            "description" : "Hotspot portal service of the WLAN. The ID or name of the hotspot portal services within the zone is required.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "qosMaps" : {
            "description" : "Qos map set of the WLAN.",
            "items" : {
                "additionalProperties" : false,
                "properties" : {
                    "enable" : {
                        "description" : "Enabled or disabled",
                        "type" : "boolean"
                    },
                    "excepts" : {
                        "items" : {
                            "maximum" : 63,
                            "minimum" : 0,
                            "type" : "integer"
                        },
                        "type" : [ "array", "null" ]
                    },
                    "high" : {
                        "description" : "DSCP range - high",
                        "maximum" : 255,
                        "minimum" : 0,
                        "type" : [ "integer", "null" ]
                    },
                    "low" : {
                        "description" : "DSCP range - low",
                        "maximum" : 255,
                        "minimum" : 0,
                        "type" : [ "integer", "null" ]
                    },
                    "priority" : {
                        "description" : "Priority",
                        "type" : "integer"
                    }
                },
                "required" : [ "enable", "priority" ],
                "type" : "object"
            },
            "type" : "array"
        },
        "radiusOptions" : {
            "description" : "RADIUS options of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "calledStaIdType" : {
                    "default" : "WLAN_BSSID",
                    "description" : "Called station ID type",
                    "type" : "string",
                    "enum" : [ "AP_MAC", "NONE", "WLAN_BSSID" ]
                },
                "customizedNasId" : {
                    "description" : "User defined NAS ID",
                    "maxLength" : 64,
                    "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                    "type" : "string"
                },
                "nasIdType" : {
                    "default" : "WLAN_BSSID",
                    "description" : "NAS ID type",
                    "type" : "string",
                    "enum" : [ "AP_MAC", "Customized", "WLAN_BSSID" ]
                },
                "nasMaxRetry" : {
                    "default" : 2,
                    "description" : "NAS request maximum retry",
                    "maximum" : 10,
                    "minimum" : 2,
                    "type" : "integer"
                },
                "nasReconnectPrimaryMin" : {
                    "default" : 5,
                    "description" : "NAS reconnect primary time in minutes",
                    "maximum" : 60,
                    "minimum" : 1,
                    "type" : "integer"
                },
                "nasRequestTimeoutSec" : {
                    "default" : 3,
                    "description" : "NAS request timeout in seconds",
                    "maximum" : 20,
                    "minimum" : 2,
                    "type" : "integer"
                },
                "nasIpType" : {
                    "description" : "NAS IP type",
                    "type" : "string",
                    "enum" : [ "disabled", "control", "management", "userDefined" ],
                    "default" : "disabled"
                },
                "nasIpUserDefined" : {
                    "description" : "User-defined NAS IP",
                    "type" : "string",
                    "maxLength" : 45
                },
                "singleSessionIdAcctEnabled" : {
                    "description" : "When Single Accounting Session ID is enabled, APs will maintain one accounting session for client roaming",
                    "type" : "boolean",
                    "default" : false
                },
                "vendorSpecificAttributeProfileId" : {
                    "description" : "Vendor Specific Attribute Profile ID",
                    "type" : "string"
                }
            }
        },
        "schedule" : {
            "description" : "Schedule of the WLAN",
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "description" : "Identifier of the schedule profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the schedule profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "type" : {
                    "description" : "Type of WLAN schedule",
                    "type" : "string",
                    "enum" : [ "AlwaysOn", "AlwaysOff", "Customized" ],
                    "default" : "AlwaysOn"
                }
            },
            "required" : [ "type" ],
            "type" : "object"
        },
        "ssid" : {
            "description" : "SSID of the WLAN",
            "type" : "string",
            "minLength" : 1,
            "maxLength" : 32
        },
        "timeboundWhitelist" : {
            "description" : "Hotspot timeboundWhitelist. The ID Hotspot timeboundWhitelist. The ID of the OAuth Authentication service is required.",
            "additionalProperties" : false,
            "properties" : {
                "firstIndex" : {
                    "type" : "integer"
                },
                "hasMore" : {
                    "type" : "boolean"
                },
                "list" : {
                    "items" : {
                        "type" : [ "object", "null" ],
                        "additionalProperties" : false,
                        "properties" : {
                            "id" : {
                                "type" : "string"
                            },
                            "name" : {
                                "type" : "string"
                            }
                        }
                    },
                    "type" : "array"
                },
                "totalCount" : {
                    "type" : "integer"
                }
            },
            "type" : "object"
        },
        "vlan" : {
            "description" : "VLAN (access and/or core) of the WLAN.",
            "additionalProperties" : false,
            "properties" : {
                "aaaVlanOverride" : {
                    "description" : "Indicates whether the AAA VLAN settings can be overriden or not",
                    "type" : "boolean"
                },
                "accessVlan" : {
                    "description" : "Access VLAN ID",
                    "maximum" : 4094,
                    "minimum" : 1,
                    "type" : "integer",
                    "default" : 1
                },
                "vlanPooling" : {
                    "description" : "Vlan pooling",
                    "type" : [ "object", "null" ],
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string"
                        }
                    }
                }
            },
            "type" : "object"
        },
        "accessTunnelProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "accessIpsecProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "splitTunnelProfileId" : {
            "type" : "string"
        }
    },
    "required" : [ "name", "ssid", "authServiceOrProfile", "portalServiceProfile" ],
    "type" : "object"
}
Response  201
HideShow
Body
{
  "id": "wlanID"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Create - Wechat

POST/v8_1/rkszones/{zoneId}/wlans/wechat

Use this API command to create a new wechat WLAN.

Request
HideShow
Body
{
  "name": "wlanName",
  "ssid": "wlanSSID",
  "description": "wlanDescription",
  "portalServiceProfile": {
    "id": "portalServiceUUID",
    "name": "portalServiceName"
  },
  "accessTunnelType": "RuckusGRE",
  "accessTunnelProfile": {
    "id": "f5b92938-aa4e-4d02-90ea-273799ff689b",
    "name": "Default Tunnel Profile"
  },
  "splitTunnelProfileId": "38119bac-49e1-4410-ab8e-1c1bc88dd770",
  "coreTunnelProfile": {
    "type": "Bridge",
    "id": "forwardingUUID",
    "name": "forwardingName"
  },
  "encryption": {
    "method": "None"
  },
  "operatorRealm": "operator realm",
  "defaultUserTrafficProfile": {
    "id": "userTrafficUUID",
    "name": "userTrafficName"
  },
  "precedenceProfileId": "c514d450-c839-9527-afc9-525400d12345",
  "flexiVpnProfile": {
    "zoneAffinityId": "91fa3fe0-03da-11e7-8d82-0a0027000000"
  },
  "portalDetectionProfileId": "de0fa30c-9565-11e8-9eb6-529269fb1459",
  "schedule": {
    "type": "Customized",
    "id": "ServiceUUID",
    "name": "ServiceName"
  },
  "vlan": {
    "accessVlan": 23,
    "coreQinQEnabled": false,
    "coreSVlan": 1,
    "vlanPooling": null
  },
  "l2ACL": {
    "id": "l2ACLUUID",
    "name": "l2ACLName"
  },
  "devicePolicy": {
    "id": "devicePolicyUUID",
    "name": "devicePolicyName"
  },
  "radiusOptions": {
    "nasIdType": "Customized",
    "customizedNasId": "nasId",
    "nasRequestTimeoutSec": 12,
    "nasMaxRetry": 3,
    "nasReconnectPrimaryMin": 30,
    "calledStaIdType": "WLAN_BSSID",
    "nasIpType": "disabled",
    "nasIpUserDefined": "192.168.1.1",
    "vendorSpecificAttributeProfileId": "6d767421-d1b7-11e8-8ab9-ba2343155a93"
  },
  "advancedOptions": {
    "clientIsolationEnabled": true,
    "clientIsolationUnicastEnabled": true,
    "clientIsolationMulticastEnabled": false,
    "clientIsolationAutoVrrpEnabled": false,
    "clientIsolationWhitelist": {
      "id": "b89323e1-3168-11e7-b027-5254009ae3f0",
      "name": "myWhitelist"
    },
    "priority": "High",
    "hideSsidEnabled": true,
    "maxClientsPerRadio": 12,
    "clientIdleTimeoutSec": 60,
    "clientLoadBalancingEnabled": true,
    "proxyARPEnabled": true,
    "ndProxyEnabled": false,
    "suppressNsEnabled": false,
    "raProxyEnabled": false,
    "rsraGuardEnabled": false,
    "raThrottlingEnabled": false,
    "maxAllowedRA": 10,
    "raInterval": 10,
    "support80211dEnabled": false,
    "support80211kEnabled": true,
    "forceClientDHCPTimeoutSec": 5,
    "dhcp82SubOpt1Format": "SUBOPT1_AP_INFO_LOCATION",
    "unauthClientStatsEnabled": false,
    "clientFingerprintingEnabled": true,
    "ofdmOnlyEnabled": false,
    "bandBalancing": "UseZoneSetting",
    "bssMinRateMbps": "Disable",
    "mgmtTxRateMbps": "2 mbps",
    "avcEnabled": true,
    "urlFilteringPolicyEnabled": false,
    "urlFilteringPolicyId": "",
    "wifiCallingPolicyEnabled": false,
    "wifiCallingPolicyIds": [],
    "uplinkEnabled": true,
    "uplinkRate": 100,
    "downlinkEnabled": true,
    "downlinkRate": 200,
    "ratePerSTAUplink": "650mbps",
    "ratePerSTADownlink": "1mbps"
  },
  "diffServProfile": {
    "id": "diffServId",
    "name": "diffServName"
  },
  "qosMaps": [
    {
      "enable": true,
      "priority": 0,
      "low": 0,
      "high": 7,
      "excepts": null
    },
    {
      "enable": true,
      "priority": 1,
      "low": 8,
      "high": 15,
      "excepts": null
    },
    {
      "enable": true,
      "priority": 2,
      "low": 16,
      "high": 23,
      "excepts": null
    },
    {
      "enable": true,
      "priority": 3,
      "low": 0,
      "high": 32,
      "excepts": [
        43,
        45,
        60
      ]
    },
    {
      "enable": true,
      "priority": 4,
      "low": 32,
      "high": 39,
      "excepts": null
    },
    {
      "enable": true,
      "priority": 5,
      "low": 40,
      "high": 47,
      "excepts": null
    },
    {
      "enable": true,
      "priority": 6,
      "low": 48,
      "high": 55,
      "excepts": [
        46
      ]
    },
    {
      "enable": true,
      "priority": 7,
      "low": 56,
      "high": 63,
      "excepts": null
    }
  ],
  "dnsServerProfile": {
    "id": "DNS server profile UUID",
    "name": "DNS server profile name"
  },
  "dpsk": {
    "dpskEnabled": false,
    "length": 8,
    "dpskType": "Secure",
    "expiration": "OneDay",
    "dpskFromType": "FirstUse"
  },
  "externalDpsk": {
    "enabled": true,
    "encryption": {
      "method": "WPA2",
      "algorithm": "AES"
    },
    "authService": {
      "id": "authServiceUUID"
    }
  }
}
Schema
{
    "additionalProperties" : false,
    "properties" : {
        "accessTunnelType" : {
            "description" : "Access tunnel type of the WLAN. APLBO means AP local breakout, and SoftGRE means AP direct SoftGRE tunnel",
            "type" : "string",
            "enum" : [ "APLBO", "RuckusGRE", "SoftGRE" ]
        },
        "accountingServiceOrProfile" : {
            "description" : "Accounting of the WLAN",
            "additionalProperties" : false,
            "properties" : {
                "accountingDelayEnabled" : {
                    "description" : "Indicates whether accounting delay time is enabled",
                    "type" : "boolean"
                },
                "id" : {
                    "description" : "Accounting service or profile ID. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "interimUpdateMin" : {
                    "description" : "Interval (in minutes) for sending interim updates",
                    "maximum" : 1440,
                    "minimum" : 0,
                    "type" : "integer"
                },
                "name" : {
                    "description" : "Accounting service or profile name. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "throughController" : {
                    "description" : "Indicates whether accounting messages were sent through the controller",
                    "type" : "boolean"
                },
                "realmBasedAcct" : {
                    "type" : "boolean"
                },
                "backupAccountingId" : {
                    "description" : "Backup accounting service or profile ID. At least one backupAccountingId or backupAccountingName is required in the request when setting backup accounting service.",
                    "type" : "string"
                },
                "backupAccountingName" : {
                    "description" : "Backup accounting service or profile name. At least one backupAccountingId or backupAccountingName is required in the request when setting backup accounting service.",
                    "type" : "string"
                }
            },
            "type" : "object"
        },
        "advancedOptions" : {
            "description" : "Advanced settings for the WLAN.",
            "additionalProperties" : false,
            "properties" : {
                "avcEnabled" : {
                    "default" : false,
                    "description" : "Indicator of whether AVC support is enabled or disabled",
                    "type" : "boolean"
                },
                "bandBalancing" : {
                    "default" : "UseZoneSetting",
                    "description" : "Indicates whether band balancing is enabled or disabled",
                    "type" : "string",
                    "enum" : [ "Disabled", "UseZoneSetting" ]
                },
                "bssMinRateMbps" : {
                    "description" : "BSS minimum rate (mbps)",
                    "type" : "string",
                    "enum" : [ "Disable", "1 mbps", "2 mbps", "5.5 mbps", "12 mbps", "24 mbps" ],
                    "default" : "Disable"
                },
                "clientFingerprintingEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether client fingerprinting is enabled or disabled",
                    "type" : "boolean"
                },
                "clientIdleTimeoutSec" : {
                    "default" : 120,
                    "description" : "Client idle timeout in seconds",
                    "maximum" : 1000,
                    "minimum" : 60,
                    "type" : "integer"
                },
                "clientIsolationEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether wireless client isolation is enabled or disabled",
                    "type" : "boolean"
                },
                "clientIsolationUnicastEnabled" : {
                    "description" : "Indicates whether isolate unicast of wireless client isolation is enabled or disabled",
                    "type" : "boolean",
                    "default" : true
                },
                "clientIsolationMulticastEnabled" : {
                    "description" : "Indicates whether isolate multicast of wireless client isolation is enabled or disabled",
                    "type" : "boolean"
                },
                "clientIsolationAutoVrrpEnabled" : {
                    "description" : "Indicates whether Automatic support for VRRP of wireless client isolation is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "clientIsolationWhitelist" : {
                    "description" : "Indicates wireless client isolation whitelist",
                    "type" : [ "object", "null" ],
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string"
                        }
                    }
                },
                "clientLoadBalancingEnabled" : {
                    "description" : "Indicates whether Client Load Balancing is enabled or disabled",
                    "type" : "boolean",
                    "default" : true
                },
                "dgafEnabled" : {
                    "description" : "Indicates whether dgaf is enabled or disabled",
                    "type" : "boolean"
                },
                "dhcp82Format" : {
                    "description" : "DHCP Option 82 format. This variable no longer supports from v8_1 and only kept for backward compatibility.",
                    "type" : "string",
                    "enum" : [ "RUCKUS_DEFAULT", "SOFTGRE_CUSTOMIZED" ]
                },
                "dhcpOption82Enabled" : {
                    "default" : false,
                    "description" : "Indicates whether DCHP Option 82 is enabled or disabled. This variable no longer supports from v8_1 and only kept for backward compatibility.",
                    "type" : "boolean"
                },
                "dhcp82SubOpt1Format" : {
                    "description" : "Subopt-1 format",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT1_AP_INFO_LOCATION", "SUBOPT1_AP_INFO", "SUBOPT1_AP_MAC_ESSID_PRIVACYTYPE", "SUBOPT1_AP_MAC_hex", "SUBOPT1_AP_MAC_hex_ESSID", "SUBOPT1_ESSID" ]
                },
                "dhcp82SubOpt2Format" : {
                    "description" : "Subopt-2 format",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT2_CLIENT_MAC", "SUBOPT2_CLIENT_MAC_hex", "SUBOPT2_CLIENT_MAC_hex_ESSID", "SUBOPT2_AP_MAC", "SUBOPT2_AP_MAC_hex", "SUBOPT2_AP_MAC_hex_ESSID" ]
                },
                "dhcp82SubOpt150Format" : {
                    "description" : "Subopt-150 with VLAN-Id",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT150_VLAN_ID" ]
                },
                "dhcp82SubOpt151Format" : {
                    "description" : "Subopt-151 format",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT151_AREA_NAME", "SUBOPT151_ESSID" ]
                },
                "dhcp82SubOpt151AreaName" : {
                    "description" : "Subopt-151 Area Name value",
                    "type" : "string"
                },
                "downlinkEnabled" : {
                    "default" : false,
                    "description" : "SSID Rate Limiting downlink enabled.",
                    "type" : "boolean"
                },
                "downlinkRate" : {
                    "description" : "SSID Rate Limiting downlink.",
                    "type" : "number",
                    "default" : 0.0
                },
                "antiSpoofingEnabled" : {
                    "description" : "Anti-Spoofing enabled",
                    "type" : "boolean",
                    "default" : false
                },
                "arpRequestRateLimit" : {
                    "description" : "ARP packets request rate limit, default value will be 15 if both rate limit not being set.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 100
                },
                "dhcpRequestRateLimit" : {
                    "description" : "DHCP packets request rate limit, default value will be 15 if both rate limit not being set.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 100
                },
                "forceClientDHCPTimeoutSec" : {
                    "default" : 0,
                    "description" : "Force DHCP disconnects the client if the client does not obtain a valid IP address within the timeout peroid. To disable force DHCP, set this value to zero (0).",
                    "type" : "integer",
                    "enum" : [ 0, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15 ]
                },
                "hideSsidEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether the SSID is hidden or broadcast",
                    "type" : "boolean"
                },
                "hs20Onboarding" : {
                    "description" : "Allow WISPr WLAN for Hotspot 2.0 Onboarding",
                    "type" : "boolean",
                    "default" : false
                },
                "maxClientsPerRadio" : {
                    "default" : 100,
                    "description" : "Maximum number of clients per radio",
                    "maximum" : 512,
                    "minimum" : 1,
                    "type" : "integer"
                },
                "mgmtTxRateMbps" : {
                    "description" : "Management TX rate (mbps)",
                    "type" : "string",
                    "enum" : [ "1 mbps", "2 mbps", "5.5 mbps", "6 mbps", "9 mbps", "11 mbps", "12 mbps", "18 mbps", "24 mbps", "36 mbps", "48 mbps", "54 mbps" ],
                    "default" : "2 mbps"
                },
                "ofdmOnlyEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether OFDM only is enabled or disabled",
                    "type" : "boolean"
                },
                "okcEnabled" : {
                    "description" : "Indicator of whether OKC support is enabled or disabled. The default value is true when the WLAN is WPA+AES non open WLAN.",
                    "type" : "boolean"
                },
                "pmkCachingEnabled" : {
                    "description" : "Indicator of whether PKM caching support is enabled or disabled. The default value is true when the WLAN is WPA+AES non open WLAN.",
                    "type" : "boolean"
                },
                "priority" : {
                    "default" : "High",
                    "description" : "Priority of the WLAN",
                    "type" : "string",
                    "enum" : [ "High", "Low" ]
                },
                "proxyARPEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether proxy ARP is enabled or disabled",
                    "type" : "boolean"
                },
                "ndProxyEnabled" : {
                    "description" : "Indicates whether ND Proxy is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "suppressNsEnabled" : {
                    "description" : "Indicates whether supperssNS is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "raProxyEnabled" : {
                    "description" : "Indicates whether RA proxy is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "rsraGuardEnabled" : {
                    "description" : "Indicates whether RS/RA Guard is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "raThrottlingEnabled" : {
                    "description" : "Indicates whether RA Throttling is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "maxAllowedRA" : {
                    "description" : "Max Allowed RAs",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 1440,
                    "default" : 10
                },
                "raInterval" : {
                    "description" : "A timer that RA proxy runs and once receives unsolicited RA checks against the configured time and allow/drop RA based on next timeout",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 256,
                    "default" : 10
                },
                "support80211dEnabled" : {
                    "default" : true,
                    "description" : "Indicates whether support for 802.11d is enabled or disabled",
                    "type" : "boolean"
                },
                "support80211kEnabled" : {
                    "default" : true,
                    "description" : "Indicates whether support for 802.11k is enabled or disabled",
                    "type" : "boolean"
                },
                "unauthClientStatsEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether to send statistics of unauthorized clients or not",
                    "type" : "boolean"
                },
                "uplinkEnabled" : {
                    "default" : false,
                    "description" : "SSID Rate Limiting uplink enabled.",
                    "type" : "boolean"
                },
                "uplinkRate" : {
                    "description" : "SSID Rate Limiting uplink.",
                    "type" : "number",
                    "default" : 0.0
                },
                "ratePerSTAUplink" : {
                    "description" : "UE Rate Limiting uplink.",
                    "type" : "string"
                },
                "ratePerSTADownlink" : {
                    "description" : "UE Rate Limiting downlink.",
                    "type" : "string"
                },
                "dtimInterval" : {
                    "description" : "DTIM Interval",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 255,
                    "default" : 1
                },
                "directedThreshold" : {
                    "description" : "Directed Threshold Setting, Defines the client count at which an AP will stop converting group addressed data traffic to unicast.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 128,
                    "default" : 5
                },
                "flowLogEnabled" : {
                    "description" : "Flow log enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "hdOverheadOptimizeEnable" : {
                    "description" : "Airtime Decongestion enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "probeRssiThr" : {
                    "description" : "Join RSSI threshold.",
                    "type" : "integer",
                    "minimum" : -90,
                    "maximum" : -60,
                    "default" : -85
                },
                "transientClientMgmtEnable" : {
                    "description" : "Transient Client Management enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "joinIgnoreTimeout" : {
                    "description" : "Join wait time.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 60,
                    "default" : 30
                },
                "joinAcceptTimeout" : {
                    "description" : "Join expire time.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 300,
                    "default" : 300
                },
                "joinIgnoreThr" : {
                    "description" : "Join wait threshold.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 50,
                    "default" : 10
                },
                "dropRandomProbesEnabled" : {
                    "description" : "Drop Random Probes enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "authRssiThr" : {
                    "description" : "Auth RSSI threshold.",
                    "type" : "integer",
                    "minimum" : -90,
                    "maximum" : -60
                },
                "assocRssiThr" : {
                    "description" : "Assoc RSSI threshold.",
                    "type" : "integer",
                    "minimum" : -90,
                    "maximum" : -60
                },
                "oceEnabled" : {
                    "description" : "Optimized Connectivity Experience(OCE) enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "oceBroadcastProbeResponseDelay" : {
                    "description" : "Broadcast probe response delay.",
                    "type" : "integer",
                    "minimum" : 8,
                    "maximum" : 120,
                    "default" : 15
                },
                "oceRssiBasedAssociationRejectionThreshold" : {
                    "description" : "RSSI-based association rejection threshold.",
                    "type" : "integer",
                    "minimum" : -90,
                    "maximum" : -60,
                    "default" : -75
                }
            },
            "type" : "object"
        },
        "authServiceOrProfile" : {
            "description" : "Authentication of the WLAN",
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "description" : "Identifier of the authentication service or profile. At least one ID or name or authenticationOption is required in the request.",
                    "type" : "string"
                },
                "locationDeliveryEnabled" : {
                    "description" : "RFC5580 location delivery support",
                    "type" : "boolean"
                },
                "realmBasedAuth" : {
                    "type" : "boolean"
                },
                "name" : {
                    "description" : "Name of the authentication service or profile. At least one ID or name or authenticationOption is required in the request. Or could input the 'Always Accept' or 'Local DB'.",
                    "type" : "string"
                },
                "authenticationOption" : {
                    "description" : "Option of the authentication service or profile, At least one ID or name or authenticationOption is required in the request. This only applies to hotspot and guest WLANs.",
                    "type" : "string",
                    "enum" : [ "Local DB", "Guest", "Always Accept", null ]
                },
                "throughController" : {
                    "description" : "Indicates whether authentication messages were sent through the controller or not",
                    "type" : "boolean"
                },
                "backupAuthenticationId" : {
                    "description" : "Identifier of the backup authentication service or profile. At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service.",
                    "type" : "string"
                },
                "backupAuthenticationName" : {
                    "description" : "Name of the backup authentication service or profile. At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service. Or could input the 'Always Accept'.",
                    "type" : "string"
                },
                "backupAuthenticationOption" : {
                    "description" : "Option of the backup authentication service or profile, At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service. This only applies to hotspot WLANs.",
                    "type" : "string",
                    "enum" : [ "Always Accept", null ]
                }
            },
            "type" : "object"
        },
        "coreTunnelProfile" : {
            "description" : "Core tunnel of the WLAN. This only applies when the access tunnel type is set to RuckusGRE.",
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "description" : "Identifier of the forwarding profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the forwarding profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "type" : {
                    "description" : "Tunnel type",
                    "type" : "string",
                    "enum" : [ "Bridge" ]
                }
            },
            "required" : [ "type" ],
            "type" : "object"
        },
        "defaultUserTrafficProfile" : {
            "description" : "User traffic profile of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "precedenceProfileId" : {
            "description" : "Precedence profile of the WLAN",
            "type" : "string"
        },
        "flexiVpnProfile" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "zoneAffinityId" : {
                    "type" : "string",
                    "description" : "Zone Affinity ID"
                }
            },
            "required" : [ "zoneAffinityId" ]
        },
        "description" : {
            "description" : "Description of the WLAN",
            "type" : [ "string", "null" ],
            "maxLength" : 64
        },
        "devicePolicy" : {
            "description" : "Device policy of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "diffServProfile" : {
            "description" : "DiffServ profile of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "dnsServerProfile" : {
            "description" : "DNS server profile of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "dpsk" : {
            "description" : "DPSK Setting",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "dpskEnabled" : {
                    "description" : "DPSK enabled",
                    "type" : "boolean",
                    "default" : false
                },
                "length" : {
                    "description" : "Length of DPSK key",
                    "type" : "integer",
                    "default" : 62
                },
                "dpskType" : {
                    "description" : "Type of DPSK key",
                    "type" : "string",
                    "enum" : [ "Secure", "KeyboardFriendly", "NumbersOnly" ],
                    "default" : "Secure"
                },
                "expiration" : {
                    "description" : "Expiration of DPSK key",
                    "type" : "string",
                    "enum" : [ "Unlimited", "OneDay", "TwoDays", "OneWeek", "TwoWeeks", "OneMonth", "SixMonths", "OneYear", "TwoYears" ],
                    "default" : "Unlimited"
                },
                "dpskFromType" : {
                    "description" : "Type of expiration start from",
                    "type" : "string",
                    "enum" : [ "CreateTime", "FirstUse" ],
                    "default" : "CreateTime"
                }
            }
        },
        "externalDpsk" : {
            "description" : "External DPSK Enabled",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "enabled" : {
                    "description" : "Enable External DPSK",
                    "type" : "boolean",
                    "default" : false
                },
                "encryption" : {
                    "description" : "Encryption of the WLAN relate to external DPSK",
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "method" : {
                            "description" : "Encryption method",
                            "type" : "string",
                            "enum" : [ "WPA2", "WPA_Mixed", "None" ]
                        },
                        "algorithm" : {
                            "description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
                            "type" : "string",
                            "enum" : [ "AES", "TKIP_AES" ]
                        }
                    }
                },
                "authService" : {
                    "description" : "Autentication of the WLAN relate to external DPSK",
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "description" : "Identifier of the authentication service. At least one ID or name is required in the request.",
                            "type" : "string"
                        },
                        "name" : {
                            "description" : "Name of the authentication service. At least one ID or name is required in the request.",
                            "type" : "string"
                        }
                    }
                }
            },
            "required" : [ "enabled" ]
        },
        "encryption" : {
            "description" : "Encryption of the WLAN",
            "additionalProperties" : false,
            "properties" : {
                "algorithm" : {
                    "description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
                    "type" : "string",
                    "enum" : [ "AES", "TKIP_AES" ]
                },
                "keyInHex" : {
                    "description" : "Key in hex format. This only applies to WEP64 and WEP128.",
                    "type" : "string"
                },
                "keyIndex" : {
                    "description" : "Key index. This only applies to WEP64 and WEP128.",
                    "type" : "integer"
                },
                "method" : {
                    "description" : "Encryption method",
                    "type" : "string",
                    "enum" : [ "WPA2", "WPA_Mixed", "WEP_64", "WEP_128", "None" ],
                    "default" : "None"
                },
                "mfp" : {
                    "description" : "Management frame protection. This only applies to WPA2 + AES",
                    "type" : "string",
                    "enum" : [ "disabled", "capable", "required" ]
                },
                "mobilityDomainId" : {
                    "description" : "mobility Domain Id.",
                    "maximum" : 65535,
                    "minimum" : 1,
                    "type" : "integer"
                },
                "passphrase" : {
                    "description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
                    "type" : "string"
                },
                "support80211rEnabled" : {
                    "description" : "Enable 802.11r Fast BSS Transition, fast Romaing.",
                    "type" : "boolean"
                }
            },
            "required" : [ "method" ],
            "type" : "object"
        },
        "hessid" : {
            "description" : "HESSID of the WLAN",
            "pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$",
            "type" : "string"
        },
        "hotspot20Profile" : {
            "description" : "Hotspot 2.0 operator profile of the WLAN. id or name of the hotspot 2.0 operator profiles within the zone is required.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "l2ACL" : {
            "description" : "Layer 2 ACL of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "macAuth" : {
            "description" : "MAC address authentication settings of the WLAN. This only applies to standard MAC and Hotspot MAC bypass WLAN.",
            "additionalProperties" : false,
            "properties" : {
                "customizedPassword" : {
                    "description" : "User defined password. When this field is set to an empty string, the MAC address is used as password.",
                    "maxLength" : 64,
                    "pattern" : "^([!-;=?-~]([ -;=?-~]){0,62}[!-;=?-~]|[!-;=?-~]{1,1}|\s{0,0})$",
                    "type" : "string"
                },
                "macAuthMacFormat" : {
                    "description" : "MAC address format. The default format is 0010a42319c0 and the 802.1X format is 00-10-A4-23-19-C0.",
                    "type" : "string",
                    "enum" : [ "Default", "802.1X", "UpperColon", "Upper", "LowerDash", "LowerColon" ]
                }
            },
            "type" : "object"
        },
        "name" : {
            "description" : "Name of the WLAN",
            "type" : "string",
            "minLength" : 1,
            "maxLength" : 32
        },
        "operatorRealm" : {
            "description" : "Operator realm, operatorRealm only supports coreTunnelProfile type is PMIP or authServiceOrProfile.locationDeliveryEnabled is true",
            "type" : "string",
            "maxLength" : 255,
            "pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
        },
        "portalServiceProfile" : {
            "description" : "Wechat portal service of the WLAN. The ID or name of the wechat portal services within the zone is required.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "qosMaps" : {
            "description" : "Qos map set of the WLAN.",
            "items" : {
                "additionalProperties" : false,
                "properties" : {
                    "enable" : {
                        "description" : "Enabled or disabled",
                        "type" : "boolean"
                    },
                    "excepts" : {
                        "items" : {
                            "maximum" : 63,
                            "minimum" : 0,
                            "type" : "integer"
                        },
                        "type" : [ "array", "null" ]
                    },
                    "high" : {
                        "description" : "DSCP range - high",
                        "maximum" : 255,
                        "minimum" : 0,
                        "type" : [ "integer", "null" ]
                    },
                    "low" : {
                        "description" : "DSCP range - low",
                        "maximum" : 255,
                        "minimum" : 0,
                        "type" : [ "integer", "null" ]
                    },
                    "priority" : {
                        "description" : "Priority",
                        "type" : "integer"
                    }
                },
                "required" : [ "enable", "priority" ],
                "type" : "object"
            },
            "type" : "array"
        },
        "radiusOptions" : {
            "description" : "RADIUS options of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "calledStaIdType" : {
                    "default" : "WLAN_BSSID",
                    "description" : "Called station ID type",
                    "type" : "string",
                    "enum" : [ "AP_MAC", "NONE", "WLAN_BSSID" ]
                },
                "customizedNasId" : {
                    "description" : "User defined NAS ID",
                    "maxLength" : 64,
                    "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                    "type" : "string"
                },
                "nasIdType" : {
                    "default" : "WLAN_BSSID",
                    "description" : "NAS ID type",
                    "type" : "string",
                    "enum" : [ "AP_MAC", "Customized", "WLAN_BSSID" ]
                },
                "nasMaxRetry" : {
                    "default" : 2,
                    "description" : "NAS request maximum retry",
                    "maximum" : 10,
                    "minimum" : 2,
                    "type" : "integer"
                },
                "nasReconnectPrimaryMin" : {
                    "default" : 5,
                    "description" : "NAS reconnect primary time in minutes",
                    "maximum" : 60,
                    "minimum" : 1,
                    "type" : "integer"
                },
                "nasRequestTimeoutSec" : {
                    "default" : 3,
                    "description" : "NAS request timeout in seconds",
                    "maximum" : 20,
                    "minimum" : 2,
                    "type" : "integer"
                },
                "nasIpType" : {
                    "description" : "NAS IP type",
                    "type" : "string",
                    "enum" : [ "disabled", "control", "management", "userDefined" ],
                    "default" : "disabled"
                },
                "nasIpUserDefined" : {
                    "description" : "User-defined NAS IP",
                    "type" : "string",
                    "maxLength" : 45
                },
                "singleSessionIdAcctEnabled" : {
                    "description" : "When Single Accounting Session ID is enabled, APs will maintain one accounting session for client roaming",
                    "type" : "boolean",
                    "default" : false
                },
                "vendorSpecificAttributeProfileId" : {
                    "description" : "Vendor Specific Attribute Profile ID",
                    "type" : "string"
                }
            }
        },
        "schedule" : {
            "description" : "Schedule of the WLAN",
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "description" : "Identifier of the schedule profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the schedule profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "type" : {
                    "description" : "Type of WLAN schedule",
                    "type" : "string",
                    "enum" : [ "AlwaysOn", "AlwaysOff", "Customized" ],
                    "default" : "AlwaysOn"
                }
            },
            "required" : [ "type" ],
            "type" : "object"
        },
        "ssid" : {
            "description" : "SSID of the WLAN",
            "type" : "string",
            "minLength" : 1,
            "maxLength" : 32
        },
        "timeboundWhitelist" : {
            "description" : "Hotspot timeboundWhitelist. The ID of the OAuth Authentication service is required.",
            "additionalProperties" : false,
            "properties" : {
                "firstIndex" : {
                    "type" : "integer"
                },
                "hasMore" : {
                    "type" : "boolean"
                },
                "list" : {
                    "items" : {
                        "type" : [ "object", "null" ],
                        "additionalProperties" : false,
                        "properties" : {
                            "id" : {
                                "type" : "string"
                            },
                            "name" : {
                                "type" : "string"
                            }
                        }
                    },
                    "type" : "array"
                },
                "totalCount" : {
                    "type" : "integer"
                }
            },
            "type" : "object"
        },
        "vlan" : {
            "description" : "VLAN (access and/or core) of the WLAN.",
            "additionalProperties" : false,
            "properties" : {
                "aaaVlanOverride" : {
                    "description" : "Indicates whether the AAA VLAN settings can be overriden or not",
                    "type" : "boolean"
                },
                "accessVlan" : {
                    "description" : "Access VLAN ID",
                    "maximum" : 4094,
                    "minimum" : 1,
                    "type" : "integer",
                    "default" : 1
                },
                "vlanPooling" : {
                    "description" : "Vlan pooling",
                    "type" : [ "object", "null" ],
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string"
                        }
                    }
                }
            },
            "type" : "object"
        },
        "accessTunnelProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "accessIpsecProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "splitTunnelProfileId" : {
            "type" : "string"
        }
    },
    "required" : [ "name", "ssid", "portalServiceProfile" ],
    "type" : "object"
}
Response  201
HideShow
Body
{
  "id": "wlanID"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Create - Guest Access

POST/v8_1/rkszones/{zoneId}/wlans/guest

Use this API command to create a new guest access WLAN.

Request
HideShow
Body
‧ Sample : Create a Guest WLAN with default configurations
{
    "name" : "wlanName",
    "ssid" : "wlanSSID",
    "description" : "wlanDescription",
    "authServiceOrProfile" : {
        "throughController" : false,
        "id" : "authServiceUUID",
        "name" : "authServiceName",
        "authenticationOption" : null
    },
    "portalServiceProfile" : {
        "id" : "portalServiceUUID",
        "name" : "portalServiceName"
    },
    "accessTunnelType" : "RuckusGRE",
    "accessTunnelProfile" : {
        "id" : "f5b92938-aa4e-4d02-90ea-273799ff689b",
        "name" : "Default Tunnel Profile"
    },
    "splitTunnelProfileId" : "38119bac-49e1-4410-ab8e-1c1bc88dd770",
    "coreTunnelProfile" : {
        "type" : "Bridge",
        "id" : "forwardingUUID",
        "name" : "forwardingName"
    },
    "encryption" : {
        "method" : "WPA2",
        "algorithm" : "AES",
        "passphrase" : "password",
        "mfp" : "disabled",
        "support80211rEnabled" : true,
        "mobilityDomainId" : 3
    },
    "operatorRealm" : "operator realm",
    "defaultUserTrafficProfile" : {
        "id" : "userTrafficUUID",
        "name" : "userTrafficName"
    },
    "precedenceProfileId" : "c514d450-c839-9527-afc9-525400d12345",
    "flexiVpnProfile" : {
        "zoneAffinityId" : "91fa3fe0-03da-11e7-8d82-0a0027000000"
    },
    "portalDetectionProfileId" : "de0fa30c-9565-11e8-9eb6-529269fb1459",
    "schedule" : {
        "type" : "Customized",
        "id" : "ServiceUUID",
        "name" : "ServiceName"
    },
    "vlan" : {
        "accessVlan" : 23,
        "coreQinQEnabled" : false,
        "coreSVlan" : 1,
        "vlanPooling" : null
    },
    "l2ACL" : {
        "id" : "l2ACLUUID",
        "name" : "l2ACLName"
    },
    "radiusOptions" : {
        "nasIdType" : "Customized",
        "customizedNasId" : "nasId",
        "nasRequestTimeoutSec" : 12,
        "nasMaxRetry" : 3,
        "nasReconnectPrimaryMin" : 30,
        "calledStaIdType" : "WLAN_BSSID",
        "nasIpType" : "disabled",
        "nasIpUserDefined" : "192.168.1.1",
        "vendorSpecificAttributeProfileId" : "6d767421-d1b7-11e8-8ab9-ba2343155a93"
    },
    "advancedOptions" : {
        "clientIsolationEnabled" : true,
        "clientIsolationUnicastEnabled" : true,
        "clientIsolationMulticastEnabled" : false,
        "clientIsolationAutoVrrpEnabled" : false,
        "clientIsolationWhitelist" : {
            "id" : "b89323e1-3168-11e7-b027-5254009ae3f0",
            "name" : "myWhitelist"
        },
        "priority" : "High",
        "hideSsidEnabled" : true,
        "maxClientsPerRadio" : 12,
        "clientIdleTimeoutSec" : 60,
        "clientLoadBalancingEnabled" : true,
        "proxyARPEnabled" : true,
        "ndProxyEnabled" : false,
        "suppressNsEnabled" : false,
        "raProxyEnabled" : false,
        "rsraGuardEnabled" : false,
        "raThrottlingEnabled" : false,
        "maxAllowedRA" : 10,
        "raInterval" : 10,
        "support80211dEnabled" : false,
        "support80211kEnabled" : true,
        "forceClientDHCPTimeoutSec" : 5,
        "dhcp82SubOpt1Format" : "SUBOPT1_AP_INFO_LOCATION",
        "unauthClientStatsEnabled" : false,
        "clientFingerprintingEnabled" : true,
        "ofdmOnlyEnabled" : false,
        "bandBalancing" : "UseZoneSetting",
        "bssMinRateMbps" : "Disable",
        "mgmtTxRateMbps" : "2 mbps",
        "avcEnabled" : true,
        "urlFilteringPolicyEnabled" : false,
        "urlFilteringPolicyId" : "",
        "wifiCallingPolicyEnabled" : false,
        "wifiCallingPolicyIds" : [ ],
        "uplinkEnabled" : true,
        "uplinkRate" : 100,
        "downlinkEnabled" : true,
        "downlinkRate" : 200,
        "ratePerSTAUplink" : "650mbps",
        "ratePerSTADownlink" : "1mbps"
    },
    "diffServProfile" : {
        "id" : "diffServId",
        "name" : "diffServName"
    },
    "qosMaps" : [ {
        "enable" : true,
        "priority" : 0,
        "low" : 0,
        "high" : 7,
        "excepts" : null
    }, {
        "enable" : true,
        "priority" : 1,
        "low" : 8,
        "high" : 15,
        "excepts" : null
    }, {
        "enable" : true,
        "priority" : 2,
        "low" : 16,
        "high" : 23,
        "excepts" : null
    }, {
        "enable" : true,
        "priority" : 3,
        "low" : 0,
        "high" : 32,
        "excepts" : [ 43, 45, 60 ]
    }, {
        "enable" : true,
        "priority" : 4,
        "low" : 32,
        "high" : 39,
        "excepts" : null
    }, {
        "enable" : true,
        "priority" : 5,
        "low" : 40,
        "high" : 47,
        "excepts" : null
    }, {
        "enable" : true,
        "priority" : 6,
        "low" : 48,
        "high" : 55,
        "excepts" : [ 46 ]
    }, {
        "enable" : true,
        "priority" : 7,
        "low" : 56,
        "high" : 63,
        "excepts" : null
    } ],
    "dnsServerProfile" : {
        "id" : "DNS server profile UUID",
        "name" : "DNS server profile name"
    },
    "dpsk" : {
        "dpskEnabled" : false,
        "length" : 8,
        "dpskType" : "Secure",
        "expiration" : "OneDay",
        "dpskFromType" : "FirstUse"
    },
    "externalDpsk" : {
        "enabled" : true,
        "encryption" : {
            "method" : "WPA2",
            "algorithm" : "AES"
        },
        "authService" : {
            "id" : "authServiceUUID"
        }
    }
}
‧ Sample : Create a Guest WLAN with authenticationOption configurations
{
    "name" : "wlanName",
    "ssid" : "wlanSSID",
    "description" : "wlanDescription",
    "authServiceOrProfile" : {
        "throughController" : true,
        "authenticationOption" : "Guest"
    },
    "portalServiceProfile" : {
        "id" : "portalServiceUUID",
        "name" : "portalServiceName"
    }
}
Schema
{
    "additionalProperties" : false,
    "properties" : {
        "accessTunnelType" : {
            "description" : "Access tunnel type of the WLAN. APLBO means AP local breakout, and SoftGRE means AP direct SoftGRE tunnel",
            "type" : "string",
            "enum" : [ "APLBO", "RuckusGRE", "SoftGRE" ]
        },
        "accountingServiceOrProfile" : {
            "description" : "Accounting of the WLAN",
            "additionalProperties" : false,
            "properties" : {
                "accountingDelayEnabled" : {
                    "description" : "Indicates whether accounting delay time is enabled",
                    "type" : "boolean"
                },
                "id" : {
                    "description" : "Accounting service or profile ID. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "interimUpdateMin" : {
                    "description" : "Interval (in minutes) for sending interim updates",
                    "maximum" : 1440,
                    "minimum" : 0,
                    "type" : "integer"
                },
                "name" : {
                    "description" : "Accounting service or profile name. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "throughController" : {
                    "description" : "Indicates whether accounting messages were sent through the controller",
                    "type" : "boolean"
                },
                "realmBasedAcct" : {
                    "type" : "boolean"
                },
                "backupAccountingId" : {
                    "description" : "Backup accounting service or profile ID. At least one backupAccountingId or backupAccountingName is required in the request when setting backup accounting service.",
                    "type" : "string"
                },
                "backupAccountingName" : {
                    "description" : "Backup accounting service or profile name. At least one backupAccountingId or backupAccountingName is required in the request when setting backup accounting service.",
                    "type" : "string"
                }
            },
            "type" : "object"
        },
        "advancedOptions" : {
            "description" : "Advanced settings for the WLAN.",
            "additionalProperties" : false,
            "properties" : {
                "avcEnabled" : {
                    "default" : false,
                    "description" : "Indicator of whether AVC support is enabled or disabled",
                    "type" : "boolean"
                },
                "bandBalancing" : {
                    "default" : "UseZoneSetting",
                    "description" : "Indicates whether band balancing is enabled or disabled",
                    "type" : "string",
                    "enum" : [ "Disabled", "UseZoneSetting" ]
                },
                "bssMinRateMbps" : {
                    "description" : "BSS minimum rate (mbps)",
                    "type" : "string",
                    "enum" : [ "Disable", "1 mbps", "2 mbps", "5.5 mbps", "12 mbps", "24 mbps" ],
                    "default" : "Disable"
                },
                "clientFingerprintingEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether client fingerprinting is enabled or disabled",
                    "type" : "boolean"
                },
                "clientIdleTimeoutSec" : {
                    "default" : 120,
                    "description" : "Client idle timeout in seconds",
                    "maximum" : 1000,
                    "minimum" : 60,
                    "type" : "integer"
                },
                "clientIsolationEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether wireless client isolation is enabled or disabled",
                    "type" : "boolean"
                },
                "clientIsolationUnicastEnabled" : {
                    "description" : "Indicates whether isolate unicast of wireless client isolation is enabled or disabled",
                    "type" : "boolean",
                    "default" : true
                },
                "clientIsolationMulticastEnabled" : {
                    "description" : "Indicates whether isolate multicast of wireless client isolation is enabled or disabled",
                    "type" : "boolean"
                },
                "clientIsolationAutoVrrpEnabled" : {
                    "description" : "Indicates whether Automatic support for VRRP of wireless client isolation is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "clientIsolationWhitelist" : {
                    "description" : "Indicates wireless client isolation whitelist",
                    "type" : [ "object", "null" ],
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string"
                        }
                    }
                },
                "clientLoadBalancingEnabled" : {
                    "description" : "Indicates whether Client Load Balancing is enabled or disabled",
                    "type" : "boolean",
                    "default" : true
                },
                "dgafEnabled" : {
                    "description" : "Indicates whether dgaf is enabled or disabled",
                    "type" : "boolean"
                },
                "dhcp82Format" : {
                    "description" : "DHCP Option 82 format. This variable no longer supports from v8_1 and only kept for backward compatibility.",
                    "type" : "string",
                    "enum" : [ "RUCKUS_DEFAULT", "SOFTGRE_CUSTOMIZED" ]
                },
                "dhcpOption82Enabled" : {
                    "default" : false,
                    "description" : "Indicates whether DCHP Option 82 is enabled or disabled. This variable no longer supports from v8_1 and only kept for backward compatibility.",
                    "type" : "boolean"
                },
                "dhcp82SubOpt1Format" : {
                    "description" : "Subopt-1 format",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT1_AP_INFO_LOCATION", "SUBOPT1_AP_INFO", "SUBOPT1_AP_MAC_ESSID_PRIVACYTYPE", "SUBOPT1_AP_MAC_hex", "SUBOPT1_AP_MAC_hex_ESSID", "SUBOPT1_ESSID" ]
                },
                "dhcp82SubOpt2Format" : {
                    "description" : "Subopt-2 format",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT2_CLIENT_MAC", "SUBOPT2_CLIENT_MAC_hex", "SUBOPT2_CLIENT_MAC_hex_ESSID", "SUBOPT2_AP_MAC", "SUBOPT2_AP_MAC_hex", "SUBOPT2_AP_MAC_hex_ESSID" ]
                },
                "dhcp82SubOpt150Format" : {
                    "description" : "Subopt-150 with VLAN-Id",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT150_VLAN_ID" ]
                },
                "dhcp82SubOpt151Format" : {
                    "description" : "Subopt-151 format",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT151_AREA_NAME", "SUBOPT151_ESSID" ]
                },
                "dhcp82SubOpt151AreaName" : {
                    "description" : "Subopt-151 Area Name value",
                    "type" : "string"
                },
                "downlinkEnabled" : {
                    "default" : false,
                    "description" : "SSID Rate Limiting downlink enabled.",
                    "type" : "boolean"
                },
                "downlinkRate" : {
                    "description" : "SSID Rate Limiting downlink.",
                    "type" : "number",
                    "default" : 0.0
                },
                "antiSpoofingEnabled" : {
                    "description" : "Anti-Spoofing enabled",
                    "type" : "boolean",
                    "default" : false
                },
                "arpRequestRateLimit" : {
                    "description" : "ARP packets request rate limit, default value will be 15 if both rate limit not being set.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 100
                },
                "dhcpRequestRateLimit" : {
                    "description" : "DHCP packets request rate limit, default value will be 15 if both rate limit not being set.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 100
                },
                "forceClientDHCPTimeoutSec" : {
                    "default" : 0,
                    "description" : "Force DHCP disconnects the client if the client does not obtain a valid IP address within the timeout peroid. To disable force DHCP, set this value to zero (0).",
                    "type" : "integer",
                    "enum" : [ 0, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15 ]
                },
                "hideSsidEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether the SSID is hidden or broadcast",
                    "type" : "boolean"
                },
                "hs20Onboarding" : {
                    "description" : "Allow WISPr WLAN for Hotspot 2.0 Onboarding",
                    "type" : "boolean",
                    "default" : false
                },
                "maxClientsPerRadio" : {
                    "default" : 100,
                    "description" : "Maximum number of clients per radio",
                    "maximum" : 512,
                    "minimum" : 1,
                    "type" : "integer"
                },
                "mgmtTxRateMbps" : {
                    "description" : "Management TX rate (mbps)",
                    "type" : "string",
                    "enum" : [ "1 mbps", "2 mbps", "5.5 mbps", "6 mbps", "9 mbps", "11 mbps", "12 mbps", "18 mbps", "24 mbps", "36 mbps", "48 mbps", "54 mbps" ],
                    "default" : "2 mbps"
                },
                "ofdmOnlyEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether OFDM only is enabled or disabled",
                    "type" : "boolean"
                },
                "okcEnabled" : {
                    "description" : "Indicator of whether OKC support is enabled or disabled. The default value is true when the WLAN is WPA+AES non open WLAN.",
                    "type" : "boolean"
                },
                "pmkCachingEnabled" : {
                    "description" : "Indicator of whether PKM caching support is enabled or disabled. The default value is true when the WLAN is WPA+AES non open WLAN.",
                    "type" : "boolean"
                },
                "priority" : {
                    "default" : "High",
                    "description" : "Priority of the WLAN",
                    "type" : "string",
                    "enum" : [ "High", "Low" ]
                },
                "proxyARPEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether proxy ARP is enabled or disabled",
                    "type" : "boolean"
                },
                "ndProxyEnabled" : {
                    "description" : "Indicates whether ND Proxy is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "suppressNsEnabled" : {
                    "description" : "Indicates whether supperssNS is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "raProxyEnabled" : {
                    "description" : "Indicates whether RA proxy is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "rsraGuardEnabled" : {
                    "description" : "Indicates whether RS/RA Guard is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "raThrottlingEnabled" : {
                    "description" : "Indicates whether RA Throttling is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "maxAllowedRA" : {
                    "description" : "Max Allowed RAs",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 1440,
                    "default" : 10
                },
                "raInterval" : {
                    "description" : "A timer that RA proxy runs and once receives unsolicited RA checks against the configured time and allow/drop RA based on next timeout",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 256,
                    "default" : 10
                },
                "support80211dEnabled" : {
                    "default" : true,
                    "description" : "Indicates whether support for 802.11d is enabled or disabled",
                    "type" : "boolean"
                },
                "support80211kEnabled" : {
                    "default" : true,
                    "description" : "Indicates whether support for 802.11k is enabled or disabled",
                    "type" : "boolean"
                },
                "unauthClientStatsEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether to send statistics of unauthorized clients or not",
                    "type" : "boolean"
                },
                "uplinkEnabled" : {
                    "default" : false,
                    "description" : "SSID Rate Limiting uplink enabled.",
                    "type" : "boolean"
                },
                "uplinkRate" : {
                    "description" : "SSID Rate Limiting uplink.",
                    "type" : "number",
                    "default" : 0.0
                },
                "ratePerSTAUplink" : {
                    "description" : "UE Rate Limiting uplink.",
                    "type" : "string"
                },
                "ratePerSTADownlink" : {
                    "description" : "UE Rate Limiting downlink.",
                    "type" : "string"
                },
                "dtimInterval" : {
                    "description" : "DTIM Interval",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 255,
                    "default" : 1
                },
                "directedThreshold" : {
                    "description" : "Directed Threshold Setting, Defines the client count at which an AP will stop converting group addressed data traffic to unicast.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 128,
                    "default" : 5
                },
                "flowLogEnabled" : {
                    "description" : "Flow log enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "hdOverheadOptimizeEnable" : {
                    "description" : "Airtime Decongestion enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "probeRssiThr" : {
                    "description" : "Join RSSI threshold.",
                    "type" : "integer",
                    "minimum" : -90,
                    "maximum" : -60,
                    "default" : -85
                },
                "transientClientMgmtEnable" : {
                    "description" : "Transient Client Management enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "joinIgnoreTimeout" : {
                    "description" : "Join wait time.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 60,
                    "default" : 30
                },
                "joinAcceptTimeout" : {
                    "description" : "Join expire time.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 300,
                    "default" : 300
                },
                "joinIgnoreThr" : {
                    "description" : "Join wait threshold.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 50,
                    "default" : 10
                },
                "dropRandomProbesEnabled" : {
                    "description" : "Drop Random Probes enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "authRssiThr" : {
                    "description" : "Auth RSSI threshold.",
                    "type" : "integer",
                    "minimum" : -90,
                    "maximum" : -60
                },
                "assocRssiThr" : {
                    "description" : "Assoc RSSI threshold.",
                    "type" : "integer",
                    "minimum" : -90,
                    "maximum" : -60
                },
                "oceEnabled" : {
                    "description" : "Optimized Connectivity Experience(OCE) enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "oceBroadcastProbeResponseDelay" : {
                    "description" : "Broadcast probe response delay.",
                    "type" : "integer",
                    "minimum" : 8,
                    "maximum" : 120,
                    "default" : 15
                },
                "oceRssiBasedAssociationRejectionThreshold" : {
                    "description" : "RSSI-based association rejection threshold.",
                    "type" : "integer",
                    "minimum" : -90,
                    "maximum" : -60,
                    "default" : -75
                }
            },
            "type" : "object"
        },
        "authServiceOrProfile" : {
            "description" : "Authentication of the WLAN. Guest WLANs only accept two names: Local DB and Always Accept.",
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "description" : "Identifier of the authentication service or profile. At least one ID or name or authenticationOption is required in the request.",
                    "type" : "string"
                },
                "locationDeliveryEnabled" : {
                    "description" : "RFC5580 location delivery support",
                    "type" : "boolean"
                },
                "realmBasedAuth" : {
                    "type" : "boolean"
                },
                "name" : {
                    "description" : "Name of the authentication service or profile. At least one ID or name or authenticationOption is required in the request. Or could input the 'Always Accept' or 'Local DB'.",
                    "type" : "string"
                },
                "authenticationOption" : {
                    "description" : "Option of the authentication service or profile, At least one ID or name or authenticationOption is required in the request. This only applies to hotspot and guest WLANs.",
                    "type" : "string",
                    "enum" : [ "Local DB", "Guest", "Always Accept", null ]
                },
                "throughController" : {
                    "description" : "Indicates whether authentication messages were sent through the controller or not",
                    "type" : "boolean"
                },
                "backupAuthenticationId" : {
                    "description" : "Identifier of the backup authentication service or profile. At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service.",
                    "type" : "string"
                },
                "backupAuthenticationName" : {
                    "description" : "Name of the backup authentication service or profile. At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service. Or could input the 'Always Accept'.",
                    "type" : "string"
                },
                "backupAuthenticationOption" : {
                    "description" : "Option of the backup authentication service or profile, At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service. This only applies to hotspot WLANs.",
                    "type" : "string",
                    "enum" : [ "Always Accept", null ]
                }
            },
            "type" : "object"
        },
        "bypassCNA" : {
            "description" : "Bypass Capitive Network Assitance",
            "type" : "boolean",
            "default" : false
        },
        "coreTunnelProfile" : {
            "description" : "Core tunnel of the WLAN. This only applies when the access tunnel type is set to RuckusGRE.",
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "description" : "Identifier of the forwarding profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the forwarding profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "type" : {
                    "description" : "Tunnel type",
                    "type" : "string",
                    "enum" : [ "Bridge" ]
                }
            },
            "required" : [ "type" ],
            "type" : "object"
        },
        "defaultUserTrafficProfile" : {
            "description" : "User traffic profile of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "precedenceProfileId" : {
            "description" : "Precedence profile of the WLAN",
            "type" : "string"
        },
        "flexiVpnProfile" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "zoneAffinityId" : {
                    "type" : "string",
                    "description" : "Zone Affinity ID"
                }
            },
            "required" : [ "zoneAffinityId" ]
        },
        "description" : {
            "description" : "Description of the WLAN",
            "type" : [ "string", "null" ],
            "maxLength" : 64
        },
        "devicePolicy" : {
            "description" : "Device policy of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "diffServProfile" : {
            "description" : "DiffServ profile of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "dnsServerProfile" : {
            "description" : "DNS server profile of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "dpsk" : {
            "description" : "DPSK Setting",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "dpskEnabled" : {
                    "description" : "DPSK enabled",
                    "type" : "boolean",
                    "default" : false
                },
                "length" : {
                    "description" : "Length of DPSK key",
                    "type" : "integer",
                    "default" : 62
                },
                "dpskType" : {
                    "description" : "Type of DPSK key",
                    "type" : "string",
                    "enum" : [ "Secure", "KeyboardFriendly", "NumbersOnly" ],
                    "default" : "Secure"
                },
                "expiration" : {
                    "description" : "Expiration of DPSK key",
                    "type" : "string",
                    "enum" : [ "Unlimited", "OneDay", "TwoDays", "OneWeek", "TwoWeeks", "OneMonth", "SixMonths", "OneYear", "TwoYears" ],
                    "default" : "Unlimited"
                },
                "dpskFromType" : {
                    "description" : "Type of expiration start from",
                    "type" : "string",
                    "enum" : [ "CreateTime", "FirstUse" ],
                    "default" : "CreateTime"
                }
            }
        },
        "externalDpsk" : {
            "description" : "External DPSK Enabled",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "enabled" : {
                    "description" : "Enable External DPSK",
                    "type" : "boolean",
                    "default" : false
                },
                "encryption" : {
                    "description" : "Encryption of the WLAN relate to external DPSK",
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "method" : {
                            "description" : "Encryption method",
                            "type" : "string",
                            "enum" : [ "WPA2", "WPA_Mixed", "None" ]
                        },
                        "algorithm" : {
                            "description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
                            "type" : "string",
                            "enum" : [ "AES", "TKIP_AES" ]
                        }
                    }
                },
                "authService" : {
                    "description" : "Autentication of the WLAN relate to external DPSK",
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "description" : "Identifier of the authentication service. At least one ID or name is required in the request.",
                            "type" : "string"
                        },
                        "name" : {
                            "description" : "Name of the authentication service. At least one ID or name is required in the request.",
                            "type" : "string"
                        }
                    }
                }
            },
            "required" : [ "enabled" ]
        },
        "encryption" : {
            "description" : "Encryption of the WLAN",
            "additionalProperties" : false,
            "properties" : {
                "algorithm" : {
                    "description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
                    "type" : "string",
                    "enum" : [ "AES", "TKIP_AES" ]
                },
                "keyInHex" : {
                    "description" : "Key in hex format. This only applies to WEP64 and WEP128.",
                    "type" : "string"
                },
                "keyIndex" : {
                    "description" : "Key index. This only applies to WEP64 and WEP128.",
                    "type" : "integer"
                },
                "method" : {
                    "description" : "Encryption method",
                    "type" : "string",
                    "enum" : [ "WPA2", "WPA_Mixed", "WEP_64", "WEP_128", "None" ],
                    "default" : "None"
                },
                "mfp" : {
                    "description" : "Management frame protection. This only applies to WPA2 + AES",
                    "type" : "string",
                    "enum" : [ "disabled", "capable", "required" ]
                },
                "mobilityDomainId" : {
                    "description" : "mobility Domain Id.",
                    "maximum" : 65535,
                    "minimum" : 1,
                    "type" : "integer"
                },
                "passphrase" : {
                    "description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
                    "type" : "string"
                },
                "support80211rEnabled" : {
                    "description" : "Enable 802.11r Fast BSS Transition, fast Romaing.",
                    "type" : "boolean"
                }
            },
            "required" : [ "method" ],
            "type" : "object"
        },
        "hessid" : {
            "description" : "HESSID of the WLAN",
            "pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$",
            "type" : "string"
        },
        "hotspot20Profile" : {
            "description" : "Hotspot 2.0 operator profile of the WLAN. id or name of the hotspot 2.0 operator profiles within the zone is required.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "l2ACL" : {
            "description" : "Layer 2 ACL of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "macAuth" : {
            "description" : "MAC address authentication settings of the WLAN. This only applies to standard MAC and Hotspot MAC bypass WLAN.",
            "additionalProperties" : false,
            "properties" : {
                "customizedPassword" : {
                    "description" : "User defined password. When this field is set to an empty string, the MAC address is used as password.",
                    "maxLength" : 64,
                    "pattern" : "^([!-;=?-~]([ -;=?-~]){0,62}[!-;=?-~]|[!-;=?-~]{1,1}|\s{0,0})$",
                    "type" : "string"
                },
                "macAuthMacFormat" : {
                    "description" : "MAC address format. The default format is 0010a42319c0 and the 802.1X format is 00-10-A4-23-19-C0.",
                    "type" : "string",
                    "enum" : [ "Default", "802.1X", "UpperColon", "Upper", "LowerDash", "LowerColon" ]
                }
            },
            "type" : "object"
        },
        "name" : {
            "description" : "Name of the WLAN",
            "type" : "string",
            "minLength" : 1,
            "maxLength" : 32
        },
        "operatorRealm" : {
            "description" : "Operator realm, operatorRealm only supports coreTunnelProfile type is PMIP or authServiceOrProfile.locationDeliveryEnabled is true",
            "type" : "string",
            "maxLength" : 255,
            "pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
        },
        "portalServiceProfile" : {
            "description" : "Guest portal service of the WLAN. The ID or name of the guest portal services within the zone is required.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "qosMaps" : {
            "description" : "Qos map set of the WLAN.",
            "items" : {
                "additionalProperties" : false,
                "properties" : {
                    "enable" : {
                        "description" : "Enabled or disabled",
                        "type" : "boolean"
                    },
                    "excepts" : {
                        "items" : {
                            "maximum" : 63,
                            "minimum" : 0,
                            "type" : "integer"
                        },
                        "type" : [ "array", "null" ]
                    },
                    "high" : {
                        "description" : "DSCP range - high",
                        "maximum" : 255,
                        "minimum" : 0,
                        "type" : [ "integer", "null" ]
                    },
                    "low" : {
                        "description" : "DSCP range - low",
                        "maximum" : 255,
                        "minimum" : 0,
                        "type" : [ "integer", "null" ]
                    },
                    "priority" : {
                        "description" : "Priority",
                        "type" : "integer"
                    }
                },
                "required" : [ "enable", "priority" ],
                "type" : "object"
            },
            "type" : "array"
        },
        "radiusOptions" : {
            "description" : "RADIUS options of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "calledStaIdType" : {
                    "default" : "WLAN_BSSID",
                    "description" : "Called station ID type",
                    "type" : "string",
                    "enum" : [ "AP_MAC", "NONE", "WLAN_BSSID" ]
                },
                "customizedNasId" : {
                    "description" : "User defined NAS ID",
                    "maxLength" : 64,
                    "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                    "type" : "string"
                },
                "nasIdType" : {
                    "default" : "WLAN_BSSID",
                    "description" : "NAS ID type",
                    "type" : "string",
                    "enum" : [ "AP_MAC", "Customized", "WLAN_BSSID" ]
                },
                "nasMaxRetry" : {
                    "default" : 2,
                    "description" : "NAS request maximum retry",
                    "maximum" : 10,
                    "minimum" : 2,
                    "type" : "integer"
                },
                "nasReconnectPrimaryMin" : {
                    "default" : 5,
                    "description" : "NAS reconnect primary time in minutes",
                    "maximum" : 60,
                    "minimum" : 1,
                    "type" : "integer"
                },
                "nasRequestTimeoutSec" : {
                    "default" : 3,
                    "description" : "NAS request timeout in seconds",
                    "maximum" : 20,
                    "minimum" : 2,
                    "type" : "integer"
                },
                "nasIpType" : {
                    "description" : "NAS IP type",
                    "type" : "string",
                    "enum" : [ "disabled", "control", "management", "userDefined" ],
                    "default" : "disabled"
                },
                "nasIpUserDefined" : {
                    "description" : "User-defined NAS IP",
                    "type" : "string",
                    "maxLength" : 45
                },
                "singleSessionIdAcctEnabled" : {
                    "description" : "When Single Accounting Session ID is enabled, APs will maintain one accounting session for client roaming",
                    "type" : "boolean",
                    "default" : false
                },
                "vendorSpecificAttributeProfileId" : {
                    "description" : "Vendor Specific Attribute Profile ID",
                    "type" : "string"
                }
            }
        },
        "schedule" : {
            "description" : "Schedule of the WLAN",
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "description" : "Identifier of the schedule profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the schedule profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "type" : {
                    "description" : "Type of WLAN schedule",
                    "type" : "string",
                    "enum" : [ "AlwaysOn", "AlwaysOff", "Customized" ],
                    "default" : "AlwaysOn"
                }
            },
            "required" : [ "type" ],
            "type" : "object"
        },
        "ssid" : {
            "description" : "SSID of the WLAN",
            "type" : "string",
            "minLength" : 1,
            "maxLength" : 32
        },
        "timeboundWhitelist" : {
            "description" : "Hotspot timeboundWhitelist. The ID of the OAuth Authentication service is required.",
            "additionalProperties" : false,
            "properties" : {
                "firstIndex" : {
                    "type" : "integer"
                },
                "hasMore" : {
                    "type" : "boolean"
                },
                "list" : {
                    "items" : {
                        "type" : [ "object", "null" ],
                        "additionalProperties" : false,
                        "properties" : {
                            "id" : {
                                "type" : "string"
                            },
                            "name" : {
                                "type" : "string"
                            }
                        }
                    },
                    "type" : "array"
                },
                "totalCount" : {
                    "type" : "integer"
                }
            },
            "type" : "object"
        },
        "vlan" : {
            "description" : "VLAN (access and/or core) of the WLAN.",
            "additionalProperties" : false,
            "properties" : {
                "aaaVlanOverride" : {
                    "description" : "Indicates whether the AAA VLAN settings can be overriden or not",
                    "type" : "boolean"
                },
                "accessVlan" : {
                    "description" : "Access VLAN ID",
                    "maximum" : 4094,
                    "minimum" : 1,
                    "type" : "integer",
                    "default" : 1
                },
                "vlanPooling" : {
                    "description" : "Vlan pooling",
                    "type" : [ "object", "null" ],
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string"
                        }
                    }
                }
            },
            "type" : "object"
        },
        "accessTunnelProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "accessIpsecProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "splitTunnelProfileId" : {
            "type" : "string"
        }
    },
    "required" : [ "name", "ssid", "authServiceOrProfile", "portalServiceProfile" ],
    "type" : "object"
}
Response  201
HideShow
Body
{
  "id": "wlanID"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Create - Web Auth

POST/v8_1/rkszones/{zoneId}/wlans/webauth

Use this API command to creates new web authentication WLAN.

Request
HideShow
Body
{
  "name": "wlanName",
  "ssid": "wlanSSID",
  "description": "wlanDescription",
  "authServiceOrProfile": {
    "throughController": false,
    "id": "authServiceUUID",
    "name": "authServiceName",
    "authenticationOption": null
  },
  "portalServiceProfile": {
    "id": "portalServiceUUID",
    "name": "portalServiceName"
  },
  "accessTunnelType": "RuckusGRE",
  "accessTunnelProfile": {
    "id": "f5b92938-aa4e-4d02-90ea-273799ff689b",
    "name": "Default Tunnel Profile"
  },
  "splitTunnelProfileId": "38119bac-49e1-4410-ab8e-1c1bc88dd770",
  "coreTunnelProfile": {
    "type": "Bridge",
    "id": "forwardingUUID",
    "name": "forwardingName"
  },
  "encryption": {
    "method": "WPA2",
    "algorithm": "AES",
    "passphrase": "password",
    "mfp": "disabled",
    "support80211rEnabled": true,
    "mobilityDomainId": 3
  },
  "operatorRealm": "operator realm",
  "defaultUserTrafficProfile": {
    "id": "userTrafficUUID",
    "name": "userTrafficName"
  },
  "precedenceProfileId": "c514d450-c839-9527-afc9-525400d12345",
  "flexiVpnProfile": {
    "zoneAffinityId": "91fa3fe0-03da-11e7-8d82-0a0027000000"
  },
  "portalDetectionProfileId": "de0fa30c-9565-11e8-9eb6-529269fb1459",
  "schedule": {
    "type": "Customized",
    "id": "ServiceUUID",
    "name": "ServiceName"
  },
  "vlan": {
    "accessVlan": 23,
    "coreQinQEnabled": false,
    "coreSVlan": 1,
    "vlanPooling": null
  },
  "l2ACL": {
    "id": "l2ACLUUID",
    "name": "l2ACLName"
  },
  "radiusOptions": {
    "nasIdType": "Customized",
    "customizedNasId": "nasId",
    "nasRequestTimeoutSec": 12,
    "nasMaxRetry": 3,
    "nasReconnectPrimaryMin": 30,
    "calledStaIdType": "WLAN_BSSID",
    "nasIpType": "disabled",
    "nasIpUserDefined": "192.168.1.1",
    "vendorSpecificAttributeProfileId": "6d767421-d1b7-11e8-8ab9-ba2343155a93"
  },
  "advancedOptions": {
    "clientIsolationEnabled": true,
    "clientIsolationUnicastEnabled": true,
    "clientIsolationMulticastEnabled": false,
    "clientIsolationAutoVrrpEnabled": false,
    "clientIsolationWhitelist": {
      "id": "b89323e1-3168-11e7-b027-5254009ae3f0",
      "name": "myWhitelist"
    },
    "priority": "High",
    "hideSsidEnabled": true,
    "maxClientsPerRadio": 12,
    "clientIdleTimeoutSec": 60,
    "clientLoadBalancingEnabled": true,
    "proxyARPEnabled": true,
    "ndProxyEnabled": false,
    "suppressNsEnabled": false,
    "raProxyEnabled": false,
    "rsraGuardEnabled": false,
    "raThrottlingEnabled": false,
    "maxAllowedRA": 10,
    "raInterval": 10,
    "support80211dEnabled": false,
    "support80211kEnabled": true,
    "forceClientDHCPTimeoutSec": 5,
    "dhcp82SubOpt1Format": "SUBOPT1_AP_INFO_LOCATION",
    "unauthClientStatsEnabled": false,
    "clientFingerprintingEnabled": true,
    "ofdmOnlyEnabled": false,
    "bandBalancing": "UseZoneSetting",
    "bssMinRateMbps": "Disable",
    "mgmtTxRateMbps": "2 mbps",
    "avcEnabled": true,
    "urlFilteringPolicyEnabled": false,
    "urlFilteringPolicyId": "",
    "wifiCallingPolicyEnabled": false,
    "wifiCallingPolicyIds": [],
    "uplinkEnabled": true,
    "uplinkRate": 100,
    "downlinkEnabled": true,
    "downlinkRate": 200,
    "ratePerSTAUplink": "650mbps",
    "ratePerSTADownlink": "1mbps"
  },
  "diffServProfile": {
    "id": "diffServId",
    "name": "diffServName"
  },
  "qosMaps": [
    {
      "enable": true,
      "priority": 0,
      "low": 0,
      "high": 7,
      "excepts": null
    },
    {
      "enable": true,
      "priority": 1,
      "low": 8,
      "high": 15,
      "excepts": null
    },
    {
      "enable": true,
      "priority": 2,
      "low": 16,
      "high": 23,
      "excepts": null
    },
    {
      "enable": true,
      "priority": 3,
      "low": 0,
      "high": 32,
      "excepts": [
        43,
        45,
        60
      ]
    },
    {
      "enable": true,
      "priority": 4,
      "low": 32,
      "high": 39,
      "excepts": null
    },
    {
      "enable": true,
      "priority": 5,
      "low": 40,
      "high": 47,
      "excepts": null
    },
    {
      "enable": true,
      "priority": 6,
      "low": 48,
      "high": 55,
      "excepts": [
        46
      ]
    },
    {
      "enable": true,
      "priority": 7,
      "low": 56,
      "high": 63,
      "excepts": null
    }
  ],
  "dnsServerProfile": {
    "id": "DNS server profile UUID",
    "name": "DNS server profile name"
  },
  "dpsk": {
    "dpskEnabled": false,
    "length": 8,
    "dpskType": "Secure",
    "expiration": "OneDay",
    "dpskFromType": "FirstUse"
  },
  "externalDpsk": {
    "enabled": true,
    "encryption": {
      "method": "WPA2",
      "algorithm": "AES"
    },
    "authService": {
      "id": "authServiceUUID"
    }
  }
}
Schema
{
    "additionalProperties" : false,
    "properties" : {
        "accessTunnelType" : {
            "description" : "Access tunnel type of the WLAN. APLBO means AP local breakout, and SoftGRE means AP direct SoftGRE tunnel",
            "type" : "string",
            "enum" : [ "APLBO", "RuckusGRE", "SoftGRE" ]
        },
        "accountingServiceOrProfile" : {
            "description" : "Accounting of the WLAN",
            "additionalProperties" : false,
            "properties" : {
                "accountingDelayEnabled" : {
                    "description" : "Indicates whether accounting delay time is enabled",
                    "type" : "boolean"
                },
                "id" : {
                    "description" : "Accounting service or profile ID. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "interimUpdateMin" : {
                    "description" : "Interval (in minutes) for sending interim updates",
                    "maximum" : 1440,
                    "minimum" : 0,
                    "type" : "integer"
                },
                "name" : {
                    "description" : "Accounting service or profile name. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "throughController" : {
                    "description" : "Indicates whether accounting messages were sent through the controller",
                    "type" : "boolean"
                },
                "realmBasedAcct" : {
                    "type" : "boolean"
                },
                "backupAccountingId" : {
                    "description" : "Backup accounting service or profile ID. At least one backupAccountingId or backupAccountingName is required in the request when setting backup accounting service.",
                    "type" : "string"
                },
                "backupAccountingName" : {
                    "description" : "Backup accounting service or profile name. At least one backupAccountingId or backupAccountingName is required in the request when setting backup accounting service.",
                    "type" : "string"
                }
            },
            "type" : "object"
        },
        "advancedOptions" : {
            "description" : "Advanced settings for the WLAN.",
            "additionalProperties" : false,
            "properties" : {
                "avcEnabled" : {
                    "default" : false,
                    "description" : "Indicator of whether AVC support is enabled or disabled",
                    "type" : "boolean"
                },
                "bandBalancing" : {
                    "default" : "UseZoneSetting",
                    "description" : "Indicates whether band balancing is enabled or disabled",
                    "type" : "string",
                    "enum" : [ "Disabled", "UseZoneSetting" ]
                },
                "bssMinRateMbps" : {
                    "description" : "BSS minimum rate (mbps)",
                    "type" : "string",
                    "enum" : [ "Disable", "1 mbps", "2 mbps", "5.5 mbps", "12 mbps", "24 mbps" ],
                    "default" : "Disable"
                },
                "clientFingerprintingEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether client fingerprinting is enabled or disabled",
                    "type" : "boolean"
                },
                "clientIdleTimeoutSec" : {
                    "default" : 120,
                    "description" : "Client idle timeout in seconds",
                    "maximum" : 1000,
                    "minimum" : 60,
                    "type" : "integer"
                },
                "clientIsolationEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether wireless client isolation is enabled or disabled",
                    "type" : "boolean"
                },
                "clientIsolationUnicastEnabled" : {
                    "description" : "Indicates whether isolate unicast of wireless client isolation is enabled or disabled",
                    "type" : "boolean",
                    "default" : true
                },
                "clientIsolationMulticastEnabled" : {
                    "description" : "Indicates whether isolate multicast of wireless client isolation is enabled or disabled",
                    "type" : "boolean"
                },
                "clientIsolationAutoVrrpEnabled" : {
                    "description" : "Indicates whether Automatic support for VRRP of wireless client isolation is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "clientIsolationWhitelist" : {
                    "description" : "Indicates wireless client isolation whitelist",
                    "type" : [ "object", "null" ],
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string"
                        }
                    }
                },
                "clientLoadBalancingEnabled" : {
                    "description" : "Indicates whether Client Load Balancing is enabled or disabled",
                    "type" : "boolean",
                    "default" : true
                },
                "dgafEnabled" : {
                    "description" : "Indicates whether dgaf is enabled or disabled",
                    "type" : "boolean"
                },
                "dhcp82Format" : {
                    "description" : "DHCP Option 82 format. This variable no longer supports from v8_1 and only kept for backward compatibility.",
                    "type" : "string",
                    "enum" : [ "RUCKUS_DEFAULT", "SOFTGRE_CUSTOMIZED" ]
                },
                "dhcpOption82Enabled" : {
                    "default" : false,
                    "description" : "Indicates whether DCHP Option 82 is enabled or disabled. This variable no longer supports from v8_1 and only kept for backward compatibility.",
                    "type" : "boolean"
                },
                "dhcp82SubOpt1Format" : {
                    "description" : "Subopt-1 format",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT1_AP_INFO_LOCATION", "SUBOPT1_AP_INFO", "SUBOPT1_AP_MAC_ESSID_PRIVACYTYPE", "SUBOPT1_AP_MAC_hex", "SUBOPT1_AP_MAC_hex_ESSID", "SUBOPT1_ESSID" ]
                },
                "dhcp82SubOpt2Format" : {
                    "description" : "Subopt-2 format",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT2_CLIENT_MAC", "SUBOPT2_CLIENT_MAC_hex", "SUBOPT2_CLIENT_MAC_hex_ESSID", "SUBOPT2_AP_MAC", "SUBOPT2_AP_MAC_hex", "SUBOPT2_AP_MAC_hex_ESSID" ]
                },
                "dhcp82SubOpt150Format" : {
                    "description" : "Subopt-150 with VLAN-Id",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT150_VLAN_ID" ]
                },
                "dhcp82SubOpt151Format" : {
                    "description" : "Subopt-151 format",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT151_AREA_NAME", "SUBOPT151_ESSID" ]
                },
                "dhcp82SubOpt151AreaName" : {
                    "description" : "Subopt-151 Area Name value",
                    "type" : "string"
                },
                "downlinkEnabled" : {
                    "default" : false,
                    "description" : "SSID Rate Limiting downlink enabled.",
                    "type" : "boolean"
                },
                "downlinkRate" : {
                    "description" : "SSID Rate Limiting downlink.",
                    "type" : "number",
                    "default" : 0.0
                },
                "antiSpoofingEnabled" : {
                    "description" : "Anti-Spoofing enabled",
                    "type" : "boolean",
                    "default" : false
                },
                "arpRequestRateLimit" : {
                    "description" : "ARP packets request rate limit, default value will be 15 if both rate limit not being set.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 100
                },
                "dhcpRequestRateLimit" : {
                    "description" : "DHCP packets request rate limit, default value will be 15 if both rate limit not being set.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 100
                },
                "forceClientDHCPTimeoutSec" : {
                    "default" : 0,
                    "description" : "Force DHCP disconnects the client if the client does not obtain a valid IP address within the timeout peroid. To disable force DHCP, set this value to zero (0).",
                    "type" : "integer",
                    "enum" : [ 0, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15 ]
                },
                "hideSsidEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether the SSID is hidden or broadcast",
                    "type" : "boolean"
                },
                "hs20Onboarding" : {
                    "description" : "Allow WISPr WLAN for Hotspot 2.0 Onboarding",
                    "type" : "boolean",
                    "default" : false
                },
                "maxClientsPerRadio" : {
                    "default" : 100,
                    "description" : "Maximum number of clients per radio",
                    "maximum" : 512,
                    "minimum" : 1,
                    "type" : "integer"
                },
                "mgmtTxRateMbps" : {
                    "description" : "Management TX rate (mbps)",
                    "type" : "string",
                    "enum" : [ "1 mbps", "2 mbps", "5.5 mbps", "6 mbps", "9 mbps", "11 mbps", "12 mbps", "18 mbps", "24 mbps", "36 mbps", "48 mbps", "54 mbps" ],
                    "default" : "2 mbps"
                },
                "ofdmOnlyEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether OFDM only is enabled or disabled",
                    "type" : "boolean"
                },
                "okcEnabled" : {
                    "description" : "Indicator of whether OKC support is enabled or disabled. The default value is true when the WLAN is WPA+AES non open WLAN.",
                    "type" : "boolean"
                },
                "pmkCachingEnabled" : {
                    "description" : "Indicator of whether PKM caching support is enabled or disabled. The default value is true when the WLAN is WPA+AES non open WLAN.",
                    "type" : "boolean"
                },
                "priority" : {
                    "default" : "High",
                    "description" : "Priority of the WLAN",
                    "type" : "string",
                    "enum" : [ "High", "Low" ]
                },
                "proxyARPEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether proxy ARP is enabled or disabled",
                    "type" : "boolean"
                },
                "ndProxyEnabled" : {
                    "description" : "Indicates whether ND Proxy is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "suppressNsEnabled" : {
                    "description" : "Indicates whether supperssNS is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "raProxyEnabled" : {
                    "description" : "Indicates whether RA proxy is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "rsraGuardEnabled" : {
                    "description" : "Indicates whether RS/RA Guard is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "raThrottlingEnabled" : {
                    "description" : "Indicates whether RA Throttling is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "maxAllowedRA" : {
                    "description" : "Max Allowed RAs",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 1440,
                    "default" : 10
                },
                "raInterval" : {
                    "description" : "A timer that RA proxy runs and once receives unsolicited RA checks against the configured time and allow/drop RA based on next timeout",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 256,
                    "default" : 10
                },
                "support80211dEnabled" : {
                    "default" : true,
                    "description" : "Indicates whether support for 802.11d is enabled or disabled",
                    "type" : "boolean"
                },
                "support80211kEnabled" : {
                    "default" : true,
                    "description" : "Indicates whether support for 802.11k is enabled or disabled",
                    "type" : "boolean"
                },
                "unauthClientStatsEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether to send statistics of unauthorized clients or not",
                    "type" : "boolean"
                },
                "uplinkEnabled" : {
                    "default" : false,
                    "description" : "SSID Rate Limiting uplink enabled.",
                    "type" : "boolean"
                },
                "uplinkRate" : {
                    "description" : "SSID Rate Limiting uplink.",
                    "type" : "number",
                    "default" : 0.0
                },
                "ratePerSTAUplink" : {
                    "description" : "UE Rate Limiting uplink.",
                    "type" : "string"
                },
                "ratePerSTADownlink" : {
                    "description" : "UE Rate Limiting downlink.",
                    "type" : "string"
                },
                "dtimInterval" : {
                    "description" : "DTIM Interval",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 255,
                    "default" : 1
                },
                "directedThreshold" : {
                    "description" : "Directed Threshold Setting, Defines the client count at which an AP will stop converting group addressed data traffic to unicast.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 128,
                    "default" : 5
                },
                "flowLogEnabled" : {
                    "description" : "Flow log enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "hdOverheadOptimizeEnable" : {
                    "description" : "Airtime Decongestion enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "probeRssiThr" : {
                    "description" : "Join RSSI threshold.",
                    "type" : "integer",
                    "minimum" : -90,
                    "maximum" : -60,
                    "default" : -85
                },
                "transientClientMgmtEnable" : {
                    "description" : "Transient Client Management enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "joinIgnoreTimeout" : {
                    "description" : "Join wait time.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 60,
                    "default" : 30
                },
                "joinAcceptTimeout" : {
                    "description" : "Join expire time.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 300,
                    "default" : 300
                },
                "joinIgnoreThr" : {
                    "description" : "Join wait threshold.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 50,
                    "default" : 10
                },
                "dropRandomProbesEnabled" : {
                    "description" : "Drop Random Probes enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "authRssiThr" : {
                    "description" : "Auth RSSI threshold.",
                    "type" : "integer",
                    "minimum" : -90,
                    "maximum" : -60
                },
                "assocRssiThr" : {
                    "description" : "Assoc RSSI threshold.",
                    "type" : "integer",
                    "minimum" : -90,
                    "maximum" : -60
                },
                "oceEnabled" : {
                    "description" : "Optimized Connectivity Experience(OCE) enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "oceBroadcastProbeResponseDelay" : {
                    "description" : "Broadcast probe response delay.",
                    "type" : "integer",
                    "minimum" : 8,
                    "maximum" : 120,
                    "default" : 15
                },
                "oceRssiBasedAssociationRejectionThreshold" : {
                    "description" : "RSSI-based association rejection threshold.",
                    "type" : "integer",
                    "minimum" : -90,
                    "maximum" : -60,
                    "default" : -75
                }
            },
            "type" : "object"
        },
        "authServiceOrProfile" : {
            "description" : "Authentication of the WLAN. If authentication messages are sent through the controller, the ID or name of the global authentication profiles is required. If authentication messages are not sent through the controller, the ID or name of the authentication services configured within the zone is required.",
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "description" : "Identifier of the authentication service or profile. At least one ID or name or authenticationOption is required in the request.",
                    "type" : "string"
                },
                "locationDeliveryEnabled" : {
                    "description" : "RFC5580 location delivery support",
                    "type" : "boolean"
                },
                "realmBasedAuth" : {
                    "type" : "boolean"
                },
                "name" : {
                    "description" : "Name of the authentication service or profile. At least one ID or name or authenticationOption is required in the request. Or could input the 'Always Accept' or 'Local DB'.",
                    "type" : "string"
                },
                "authenticationOption" : {
                    "description" : "Option of the authentication service or profile, At least one ID or name or authenticationOption is required in the request. This only applies to hotspot and guest WLANs.",
                    "type" : "string",
                    "enum" : [ "Local DB", "Guest", "Always Accept", null ]
                },
                "throughController" : {
                    "description" : "Indicates whether authentication messages were sent through the controller or not",
                    "type" : "boolean"
                },
                "backupAuthenticationId" : {
                    "description" : "Identifier of the backup authentication service or profile. At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service.",
                    "type" : "string"
                },
                "backupAuthenticationName" : {
                    "description" : "Name of the backup authentication service or profile. At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service. Or could input the 'Always Accept'.",
                    "type" : "string"
                },
                "backupAuthenticationOption" : {
                    "description" : "Option of the backup authentication service or profile, At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service. This only applies to hotspot WLANs.",
                    "type" : "string",
                    "enum" : [ "Always Accept", null ]
                }
            },
            "type" : "object"
        },
        "bypassCNA" : {
            "description" : "Bypass Capitive Network Assitance",
            "type" : "boolean",
            "default" : false
        },
        "coreTunnelProfile" : {
            "description" : "Core tunnel of the WLAN. This only applies when the access tunnel type is set to RuckusGRE.",
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "description" : "Identifier of the forwarding profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the forwarding profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "type" : {
                    "description" : "Tunnel type",
                    "type" : "string",
                    "enum" : [ "Bridge" ]
                }
            },
            "required" : [ "type" ],
            "type" : "object"
        },
        "defaultUserTrafficProfile" : {
            "description" : "User traffic profile of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "precedenceProfileId" : {
            "description" : "Precedence profile of the WLAN",
            "type" : "string"
        },
        "flexiVpnProfile" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "zoneAffinityId" : {
                    "type" : "string",
                    "description" : "Zone Affinity ID"
                }
            },
            "required" : [ "zoneAffinityId" ]
        },
        "description" : {
            "description" : "Description of the WLAN",
            "type" : [ "string", "null" ],
            "maxLength" : 64
        },
        "devicePolicy" : {
            "description" : "Device policy of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "diffServProfile" : {
            "description" : "DiffServ profile of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "dnsServerProfile" : {
            "description" : "DNS server profile of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "dpsk" : {
            "description" : "DPSK Setting",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "dpskEnabled" : {
                    "description" : "DPSK enabled",
                    "type" : "boolean",
                    "default" : false
                },
                "length" : {
                    "description" : "Length of DPSK key",
                    "type" : "integer",
                    "default" : 62
                },
                "dpskType" : {
                    "description" : "Type of DPSK key",
                    "type" : "string",
                    "enum" : [ "Secure", "KeyboardFriendly", "NumbersOnly" ],
                    "default" : "Secure"
                },
                "expiration" : {
                    "description" : "Expiration of DPSK key",
                    "type" : "string",
                    "enum" : [ "Unlimited", "OneDay", "TwoDays", "OneWeek", "TwoWeeks", "OneMonth", "SixMonths", "OneYear", "TwoYears" ],
                    "default" : "Unlimited"
                },
                "dpskFromType" : {
                    "description" : "Type of expiration start from",
                    "type" : "string",
                    "enum" : [ "CreateTime", "FirstUse" ],
                    "default" : "CreateTime"
                }
            }
        },
        "externalDpsk" : {
            "description" : "External DPSK Enabled",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "enabled" : {
                    "description" : "Enable External DPSK",
                    "type" : "boolean",
                    "default" : false
                },
                "encryption" : {
                    "description" : "Encryption of the WLAN relate to external DPSK",
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "method" : {
                            "description" : "Encryption method",
                            "type" : "string",
                            "enum" : [ "WPA2", "WPA_Mixed", "None" ]
                        },
                        "algorithm" : {
                            "description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
                            "type" : "string",
                            "enum" : [ "AES", "TKIP_AES" ]
                        }
                    }
                },
                "authService" : {
                    "description" : "Autentication of the WLAN relate to external DPSK",
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "description" : "Identifier of the authentication service. At least one ID or name is required in the request.",
                            "type" : "string"
                        },
                        "name" : {
                            "description" : "Name of the authentication service. At least one ID or name is required in the request.",
                            "type" : "string"
                        }
                    }
                }
            },
            "required" : [ "enabled" ]
        },
        "encryption" : {
            "description" : "Encryption of the WLAN",
            "additionalProperties" : false,
            "properties" : {
                "algorithm" : {
                    "description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
                    "type" : "string",
                    "enum" : [ "AES", "TKIP_AES" ]
                },
                "keyInHex" : {
                    "description" : "Key in hex format. This only applies to WEP64 and WEP128.",
                    "type" : "string"
                },
                "keyIndex" : {
                    "description" : "Key index. This only applies to WEP64 and WEP128.",
                    "type" : "integer"
                },
                "method" : {
                    "description" : "Encryption method",
                    "type" : "string",
                    "enum" : [ "WPA2", "WPA_Mixed", "WEP_64", "WEP_128", "None" ],
                    "default" : "None"
                },
                "mfp" : {
                    "description" : "Management frame protection. This only applies to WPA2 + AES",
                    "type" : "string",
                    "enum" : [ "disabled", "capable", "required" ]
                },
                "mobilityDomainId" : {
                    "description" : "mobility Domain Id.",
                    "maximum" : 65535,
                    "minimum" : 1,
                    "type" : "integer"
                },
                "passphrase" : {
                    "description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
                    "type" : "string"
                },
                "support80211rEnabled" : {
                    "description" : "Enable 802.11r Fast BSS Transition, fast Romaing.",
                    "type" : "boolean"
                }
            },
            "required" : [ "method" ],
            "type" : "object"
        },
        "hessid" : {
            "description" : "HESSID of the WLAN",
            "pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$",
            "type" : "string"
        },
        "hotspot20Profile" : {
            "description" : "Hotspot 2.0 operator profile of the WLAN. id or name of the hotspot 2.0 operator profiles within the zone is required.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "l2ACL" : {
            "description" : "Layer 2 ACL of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "macAuth" : {
            "description" : "MAC address authentication settings of the WLAN. This only applies to standard MAC and Hotspot MAC bypass WLAN.",
            "additionalProperties" : false,
            "properties" : {
                "customizedPassword" : {
                    "description" : "User defined password. When this field is set to an empty string, the MAC address is used as password.",
                    "maxLength" : 64,
                    "pattern" : "^([!-;=?-~]([ -;=?-~]){0,62}[!-;=?-~]|[!-;=?-~]{1,1}|\s{0,0})$",
                    "type" : "string"
                },
                "macAuthMacFormat" : {
                    "description" : "MAC address format. The default format is 0010a42319c0 and the 802.1X format is 00-10-A4-23-19-C0.",
                    "type" : "string",
                    "enum" : [ "Default", "802.1X", "UpperColon", "Upper", "LowerDash", "LowerColon" ]
                }
            },
            "type" : "object"
        },
        "name" : {
            "description" : "Name of the WLAN",
            "type" : "string",
            "minLength" : 1,
            "maxLength" : 32
        },
        "operatorRealm" : {
            "description" : "Operator realm, operatorRealm only supports coreTunnelProfile type is PMIP or authServiceOrProfile.locationDeliveryEnabled is true",
            "type" : "string",
            "maxLength" : 255,
            "pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
        },
        "portalServiceProfile" : {
            "description" : "Web authorizationn portal service of the WLAN. The ID or name of the guest portal services within the zone is required.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "qosMaps" : {
            "description" : "Qos map set of the WLAN.",
            "items" : {
                "additionalProperties" : false,
                "properties" : {
                    "enable" : {
                        "description" : "Enabled or disabled",
                        "type" : "boolean"
                    },
                    "excepts" : {
                        "items" : {
                            "maximum" : 63,
                            "minimum" : 0,
                            "type" : "integer"
                        },
                        "type" : [ "array", "null" ]
                    },
                    "high" : {
                        "description" : "DSCP range - high",
                        "maximum" : 255,
                        "minimum" : 0,
                        "type" : [ "integer", "null" ]
                    },
                    "low" : {
                        "description" : "DSCP range - low",
                        "maximum" : 255,
                        "minimum" : 0,
                        "type" : [ "integer", "null" ]
                    },
                    "priority" : {
                        "description" : "Priority",
                        "type" : "integer"
                    }
                },
                "required" : [ "enable", "priority" ],
                "type" : "object"
            },
            "type" : "array"
        },
        "radiusOptions" : {
            "description" : "RADIUS options of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "calledStaIdType" : {
                    "default" : "WLAN_BSSID",
                    "description" : "Called station ID type",
                    "type" : "string",
                    "enum" : [ "AP_MAC", "NONE", "WLAN_BSSID" ]
                },
                "customizedNasId" : {
                    "description" : "User defined NAS ID",
                    "maxLength" : 64,
                    "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                    "type" : "string"
                },
                "nasIdType" : {
                    "default" : "WLAN_BSSID",
                    "description" : "NAS ID type",
                    "type" : "string",
                    "enum" : [ "AP_MAC", "Customized", "WLAN_BSSID" ]
                },
                "nasMaxRetry" : {
                    "default" : 2,
                    "description" : "NAS request maximum retry",
                    "maximum" : 10,
                    "minimum" : 2,
                    "type" : "integer"
                },
                "nasReconnectPrimaryMin" : {
                    "default" : 5,
                    "description" : "NAS reconnect primary time in minutes",
                    "maximum" : 60,
                    "minimum" : 1,
                    "type" : "integer"
                },
                "nasRequestTimeoutSec" : {
                    "default" : 3,
                    "description" : "NAS request timeout in seconds",
                    "maximum" : 20,
                    "minimum" : 2,
                    "type" : "integer"
                },
                "nasIpType" : {
                    "description" : "NAS IP type",
                    "type" : "string",
                    "enum" : [ "disabled", "control", "management", "userDefined" ],
                    "default" : "disabled"
                },
                "nasIpUserDefined" : {
                    "description" : "User-defined NAS IP",
                    "type" : "string",
                    "maxLength" : 45
                },
                "singleSessionIdAcctEnabled" : {
                    "description" : "When Single Accounting Session ID is enabled, APs will maintain one accounting session for client roaming",
                    "type" : "boolean",
                    "default" : false
                },
                "vendorSpecificAttributeProfileId" : {
                    "description" : "Vendor Specific Attribute Profile ID",
                    "type" : "string"
                }
            }
        },
        "schedule" : {
            "description" : "Schedule of the WLAN",
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "description" : "Identifier of the schedule profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the schedule profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "type" : {
                    "description" : "Type of WLAN schedule",
                    "type" : "string",
                    "enum" : [ "AlwaysOn", "AlwaysOff", "Customized" ],
                    "default" : "AlwaysOn"
                }
            },
            "required" : [ "type" ],
            "type" : "object"
        },
        "ssid" : {
            "description" : "SSID of the WLAN",
            "type" : "string",
            "minLength" : 1,
            "maxLength" : 32
        },
        "timeboundWhitelist" : {
            "description" : "Hotspot timeboundWhitelist. The ID of the OAuth Authentication service is required.",
            "additionalProperties" : false,
            "properties" : {
                "firstIndex" : {
                    "type" : "integer"
                },
                "hasMore" : {
                    "type" : "boolean"
                },
                "list" : {
                    "items" : {
                        "type" : [ "object", "null" ],
                        "additionalProperties" : false,
                        "properties" : {
                            "id" : {
                                "type" : "string"
                            },
                            "name" : {
                                "type" : "string"
                            }
                        }
                    },
                    "type" : "array"
                },
                "totalCount" : {
                    "type" : "integer"
                }
            },
            "type" : "object"
        },
        "vlan" : {
            "description" : "VLAN (access and/or core) of the WLAN.",
            "additionalProperties" : false,
            "properties" : {
                "aaaVlanOverride" : {
                    "description" : "Indicates whether the AAA VLAN settings can be overriden or not",
                    "type" : "boolean"
                },
                "accessVlan" : {
                    "description" : "Access VLAN ID",
                    "maximum" : 4094,
                    "minimum" : 1,
                    "type" : "integer",
                    "default" : 1
                },
                "vlanPooling" : {
                    "description" : "Vlan pooling",
                    "type" : [ "object", "null" ],
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string"
                        }
                    }
                }
            },
            "type" : "object"
        },
        "accessTunnelProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "accessIpsecProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "splitTunnelProfileId" : {
            "type" : "string"
        }
    },
    "required" : [ "name", "ssid", "authServiceOrProfile", "portalServiceProfile" ],
    "type" : "object"
}
Response  201
HideShow
Body
{
  "id": "wlanID"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Create - Hotspot 2.0

POST/v8_1/rkszones/{zoneId}/wlans/hotspot20

Use this API command to create a new Hotspot 2.0 access WLAN.

Request
HideShow
Body
{
  "name": "wlanName",
  "ssid": "wlanSSID",
  "description": "wlanDescription",
  "hotspot20Profile": {
    "id": "hotspot20ServiceUUID",
    "name": "hotspot20ServiceName"
  },
  "accessTunnelType": "RuckusGRE",
  "accessTunnelProfile": {
    "id": "f5b92938-aa4e-4d02-90ea-273799ff689b",
    "name": "Default Tunnel Profile"
  },
  "splitTunnelProfileId": "38119bac-49e1-4410-ab8e-1c1bc88dd770",
  "coreTunnelProfile": {
    "type": "Bridge",
    "id": "forwardingUUID",
    "name": "forwardingName"
  },
  "encryption": {
    "method": "WPA2",
    "algorithm": "AES",
    "mfp": "disabled",
    "support80211rEnabled": true,
    "mobilityDomainId": 3
  },
  "operatorRealm": "operator realm",
  "defaultUserTrafficProfile": {
    "id": "userTrafficUUID",
    "name": "userTrafficName"
  },
  "precedenceProfileId": "c514d450-c839-9527-afc9-525400d12345",
  "portalDetectionProfileId": "de0fa30c-9565-11e8-9eb6-529269fb1459",
  "schedule": {
    "type": "Customized",
    "id": "ServiceUUID",
    "name": "ServiceName"
  },
  "vlan": {
    "accessVlan": 23,
    "aaaVlanOverride": true,
    "coreQinQEnabled": false,
    "coreSVlan": 1,
    "vlanPooling": null
  },
  "l2ACL": {
    "id": "l2ACLUUID",
    "name": "l2ACLName"
  },
  "devicePolicy": {
    "id": "devicePolicyUUID",
    "name": "devicePolicyName"
  },
  "radiusOptions": {
    "nasIdType": "Customized",
    "customizedNasId": "nasId",
    "nasRequestTimeoutSec": 12,
    "nasMaxRetry": 3,
    "nasReconnectPrimaryMin": 30,
    "calledStaIdType": "WLAN_BSSID",
    "nasIpType": "disabled",
    "nasIpUserDefined": "192.168.1.1",
    "vendorSpecificAttributeProfileId": "6d767421-d1b7-11e8-8ab9-ba2343155a93"
  },
  "advancedOptions": {
    "clientIsolationEnabled": true,
    "clientIsolationUnicastEnabled": true,
    "clientIsolationMulticastEnabled": false,
    "clientIsolationAutoVrrpEnabled": false,
    "clientIsolationWhitelist": {
      "id": "b89323e1-3168-11e7-b027-5254009ae3f0",
      "name": "myWhitelist"
    },
    "priority": "High",
    "hideSsidEnabled": true,
    "maxClientsPerRadio": 12,
    "clientIdleTimeoutSec": 60,
    "clientLoadBalancingEnabled": true,
    "proxyARPEnabled": true,
    "ndProxyEnabled": false,
    "suppressNsEnabled": false,
    "raProxyEnabled": false,
    "rsraGuardEnabled": false,
    "raThrottlingEnabled": false,
    "maxAllowedRA": 10,
    "raInterval": 10,
    "support80211dEnabled": false,
    "support80211kEnabled": true,
    "forceClientDHCPTimeoutSec": 5,
    "dhcp82SubOpt1Format": "SUBOPT1_AP_INFO_LOCATION",
    "unauthClientStatsEnabled": false,
    "clientFingerprintingEnabled": true,
    "ofdmOnlyEnabled": false,
    "bandBalancing": "UseZoneSetting",
    "bssMinRateMbps": "Disable",
    "mgmtTxRateMbps": "2 mbps",
    "avcEnabled": true,
    "urlFilteringPolicyEnabled": false,
    "urlFilteringPolicyId": "",
    "wifiCallingPolicyEnabled": false,
    "wifiCallingPolicyIds": [],
    "uplinkEnabled": true,
    "uplinkRate": 100,
    "downlinkEnabled": true,
    "downlinkRate": 200,
    "ratePerSTAUplink": "650mbps",
    "ratePerSTADownlink": "1mbps"
  },
  "diffServProfile": {
    "id": "diffServId",
    "name": "diffServName"
  },
  "qosMaps": [
    {
      "enable": true,
      "priority": 0,
      "low": 0,
      "high": 7,
      "excepts": null
    },
    {
      "enable": true,
      "priority": 1,
      "low": 8,
      "high": 15,
      "excepts": null
    },
    {
      "enable": true,
      "priority": 2,
      "low": 16,
      "high": 23,
      "excepts": null
    },
    {
      "enable": true,
      "priority": 3,
      "low": 0,
      "high": 32,
      "excepts": [
        43,
        45,
        60
      ]
    },
    {
      "enable": true,
      "priority": 4,
      "low": 32,
      "high": 39,
      "excepts": null
    },
    {
      "enable": true,
      "priority": 5,
      "low": 40,
      "high": 47,
      "excepts": null
    },
    {
      "enable": true,
      "priority": 6,
      "low": 48,
      "high": 55,
      "excepts": [
        46
      ]
    },
    {
      "enable": true,
      "priority": 7,
      "low": 56,
      "high": 63,
      "excepts": null
    }
  ],
  "dnsServerProfile": {
    "id": "DNS server profile UUID",
    "name": "DNS server profile name"
  },
  "dpsk": {
    "dpskEnabled": false,
    "length": 8,
    "dpskType": "Secure",
    "expiration": "OneDay",
    "dpskFromType": "FirstUse"
  },
  "externalDpsk": {
    "enabled": true,
    "encryption": {
      "method": "WPA2",
      "algorithm": "AES"
    },
    "authService": {
      "id": "authServiceUUID"
    }
  }
}
Schema
{
    "additionalProperties" : false,
    "properties" : {
        "accessTunnelType" : {
            "description" : "Access tunnel type of the WLAN. APLBO means AP local breakout, and SoftGRE means AP direct SoftGRE tunnel",
            "type" : "string",
            "enum" : [ "APLBO", "RuckusGRE", "SoftGRE" ]
        },
        "accountingServiceOrProfile" : {
            "description" : "Accounting of the WLAN",
            "additionalProperties" : false,
            "properties" : {
                "accountingDelayEnabled" : {
                    "description" : "Indicates whether accounting delay time is enabled",
                    "type" : "boolean"
                },
                "id" : {
                    "description" : "Accounting service or profile ID. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "interimUpdateMin" : {
                    "description" : "Interval (in minutes) for sending interim updates",
                    "maximum" : 1440,
                    "minimum" : 0,
                    "type" : "integer"
                },
                "name" : {
                    "description" : "Accounting service or profile name. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "throughController" : {
                    "description" : "Indicates whether accounting messages were sent through the controller",
                    "type" : "boolean"
                },
                "realmBasedAcct" : {
                    "type" : "boolean"
                },
                "backupAccountingId" : {
                    "description" : "Backup accounting service or profile ID. At least one backupAccountingId or backupAccountingName is required in the request when setting backup accounting service.",
                    "type" : "string"
                },
                "backupAccountingName" : {
                    "description" : "Backup accounting service or profile name. At least one backupAccountingId or backupAccountingName is required in the request when setting backup accounting service.",
                    "type" : "string"
                }
            },
            "type" : "object"
        },
        "advancedOptions" : {
            "description" : "Advanced settings for the WLAN.",
            "additionalProperties" : false,
            "properties" : {
                "avcEnabled" : {
                    "default" : false,
                    "description" : "Indicator of whether AVC support is enabled or disabled",
                    "type" : "boolean"
                },
                "bandBalancing" : {
                    "default" : "UseZoneSetting",
                    "description" : "Indicates whether band balancing is enabled or disabled",
                    "type" : "string",
                    "enum" : [ "Disabled", "UseZoneSetting" ]
                },
                "bssMinRateMbps" : {
                    "description" : "BSS minimum rate (mbps)",
                    "type" : "string",
                    "enum" : [ "Disable", "1 mbps", "2 mbps", "5.5 mbps", "12 mbps", "24 mbps" ],
                    "default" : "Disable"
                },
                "clientFingerprintingEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether client fingerprinting is enabled or disabled",
                    "type" : "boolean"
                },
                "clientIdleTimeoutSec" : {
                    "default" : 120,
                    "description" : "Client idle timeout in seconds",
                    "maximum" : 1000,
                    "minimum" : 60,
                    "type" : "integer"
                },
                "clientIsolationEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether wireless client isolation is enabled or disabled",
                    "type" : "boolean"
                },
                "clientIsolationUnicastEnabled" : {
                    "description" : "Indicates whether isolate unicast of wireless client isolation is enabled or disabled",
                    "type" : "boolean",
                    "default" : true
                },
                "clientIsolationMulticastEnabled" : {
                    "description" : "Indicates whether isolate multicast of wireless client isolation is enabled or disabled",
                    "type" : "boolean"
                },
                "clientIsolationAutoVrrpEnabled" : {
                    "description" : "Indicates whether Automatic support for VRRP of wireless client isolation is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "clientIsolationWhitelist" : {
                    "description" : "Indicates wireless client isolation whitelist",
                    "type" : [ "object", "null" ],
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string"
                        }
                    }
                },
                "clientLoadBalancingEnabled" : {
                    "description" : "Indicates whether Client Load Balancing is enabled or disabled",
                    "type" : "boolean",
                    "default" : true
                },
                "dgafEnabled" : {
                    "description" : "Indicates whether dgaf is enabled or disabled",
                    "type" : "boolean"
                },
                "dhcp82Format" : {
                    "description" : "DHCP Option 82 format. This variable no longer supports from v8_1 and only kept for backward compatibility.",
                    "type" : "string",
                    "enum" : [ "RUCKUS_DEFAULT", "SOFTGRE_CUSTOMIZED" ]
                },
                "dhcpOption82Enabled" : {
                    "default" : false,
                    "description" : "Indicates whether DCHP Option 82 is enabled or disabled. This variable no longer supports from v8_1 and only kept for backward compatibility.",
                    "type" : "boolean"
                },
                "dhcp82SubOpt1Format" : {
                    "description" : "Subopt-1 format",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT1_AP_INFO_LOCATION", "SUBOPT1_AP_INFO", "SUBOPT1_AP_MAC_ESSID_PRIVACYTYPE", "SUBOPT1_AP_MAC_hex", "SUBOPT1_AP_MAC_hex_ESSID", "SUBOPT1_ESSID" ]
                },
                "dhcp82SubOpt2Format" : {
                    "description" : "Subopt-2 format",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT2_CLIENT_MAC", "SUBOPT2_CLIENT_MAC_hex", "SUBOPT2_CLIENT_MAC_hex_ESSID", "SUBOPT2_AP_MAC", "SUBOPT2_AP_MAC_hex", "SUBOPT2_AP_MAC_hex_ESSID" ]
                },
                "dhcp82SubOpt150Format" : {
                    "description" : "Subopt-150 with VLAN-Id",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT150_VLAN_ID" ]
                },
                "dhcp82SubOpt151Format" : {
                    "description" : "Subopt-151 format",
                    "type" : "string",
                    "enum" : [ "NONE", "SUBOPT151_AREA_NAME", "SUBOPT151_ESSID" ]
                },
                "dhcp82SubOpt151AreaName" : {
                    "description" : "Subopt-151 Area Name value",
                    "type" : "string"
                },
                "downlinkEnabled" : {
                    "default" : false,
                    "description" : "SSID Rate Limiting downlink enabled.",
                    "type" : "boolean"
                },
                "downlinkRate" : {
                    "description" : "SSID Rate Limiting downlink.",
                    "type" : "number",
                    "default" : 0.0
                },
                "antiSpoofingEnabled" : {
                    "description" : "Anti-Spoofing enabled",
                    "type" : "boolean",
                    "default" : false
                },
                "arpRequestRateLimit" : {
                    "description" : "ARP packets request rate limit, default value will be 15 if both rate limit not being set.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 100
                },
                "dhcpRequestRateLimit" : {
                    "description" : "DHCP packets request rate limit, default value will be 15 if both rate limit not being set.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 100
                },
                "forceClientDHCPTimeoutSec" : {
                    "default" : 0,
                    "description" : "Force DHCP disconnects the client if the client does not obtain a valid IP address within the timeout peroid. To disable force DHCP, set this value to zero (0).",
                    "type" : "integer",
                    "enum" : [ 0, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15 ]
                },
                "hideSsidEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether the SSID is hidden or broadcast",
                    "type" : "boolean"
                },
                "hs20Onboarding" : {
                    "description" : "Allow WISPr WLAN for Hotspot 2.0 Onboarding",
                    "type" : "boolean",
                    "default" : false
                },
                "maxClientsPerRadio" : {
                    "default" : 100,
                    "description" : "Maximum number of clients per radio",
                    "maximum" : 512,
                    "minimum" : 1,
                    "type" : "integer"
                },
                "mgmtTxRateMbps" : {
                    "description" : "Management TX rate (mbps)",
                    "type" : "string",
                    "enum" : [ "1 mbps", "2 mbps", "5.5 mbps", "6 mbps", "9 mbps", "11 mbps", "12 mbps", "18 mbps", "24 mbps", "36 mbps", "48 mbps", "54 mbps" ],
                    "default" : "2 mbps"
                },
                "ofdmOnlyEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether OFDM only is enabled or disabled",
                    "type" : "boolean"
                },
                "okcEnabled" : {
                    "description" : "Indicator of whether OKC support is enabled or disabled. The default value is true when the WLAN is WPA+AES non open WLAN.",
                    "type" : "boolean"
                },
                "pmkCachingEnabled" : {
                    "description" : "Indicator of whether PKM caching support is enabled or disabled. The default value is true when the WLAN is WPA+AES non open WLAN.",
                    "type" : "boolean"
                },
                "priority" : {
                    "default" : "High",
                    "description" : "Priority of the WLAN",
                    "type" : "string",
                    "enum" : [ "High", "Low" ]
                },
                "proxyARPEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether proxy ARP is enabled or disabled",
                    "type" : "boolean"
                },
                "ndProxyEnabled" : {
                    "description" : "Indicates whether ND Proxy is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "suppressNsEnabled" : {
                    "description" : "Indicates whether supperssNS is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "raProxyEnabled" : {
                    "description" : "Indicates whether RA proxy is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "rsraGuardEnabled" : {
                    "description" : "Indicates whether RS/RA Guard is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "raThrottlingEnabled" : {
                    "description" : "Indicates whether RA Throttling is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "maxAllowedRA" : {
                    "description" : "Max Allowed RAs",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 1440,
                    "default" : 10
                },
                "raInterval" : {
                    "description" : "A timer that RA proxy runs and once receives unsolicited RA checks against the configured time and allow/drop RA based on next timeout",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 256,
                    "default" : 10
                },
                "support80211dEnabled" : {
                    "default" : true,
                    "description" : "Indicates whether support for 802.11d is enabled or disabled",
                    "type" : "boolean"
                },
                "support80211kEnabled" : {
                    "default" : true,
                    "description" : "Indicates whether support for 802.11k is enabled or disabled",
                    "type" : "boolean"
                },
                "unauthClientStatsEnabled" : {
                    "default" : false,
                    "description" : "Indicates whether to send statistics of unauthorized clients or not",
                    "type" : "boolean"
                },
                "uplinkEnabled" : {
                    "default" : false,
                    "description" : "SSID Rate Limiting uplink enabled.",
                    "type" : "boolean"
                },
                "uplinkRate" : {
                    "description" : "SSID Rate Limiting uplink.",
                    "type" : "number",
                    "default" : 0.0
                },
                "ratePerSTAUplink" : {
                    "description" : "UE Rate Limiting uplink.",
                    "type" : "string"
                },
                "ratePerSTADownlink" : {
                    "description" : "UE Rate Limiting downlink.",
                    "type" : "string"
                },
                "dtimInterval" : {
                    "description" : "DTIM Interval",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 255,
                    "default" : 1
                },
                "directedThreshold" : {
                    "description" : "Directed Threshold Setting, Defines the client count at which an AP will stop converting group addressed data traffic to unicast.",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 128,
                    "default" : 5
                },
                "flowLogEnabled" : {
                    "description" : "Flow log enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "hdOverheadOptimizeEnable" : {
                    "description" : "Airtime Decongestion enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "probeRssiThr" : {
                    "description" : "Join RSSI threshold.",
                    "type" : "integer",
                    "minimum" : -90,
                    "maximum" : -60,
                    "default" : -85
                },
                "transientClientMgmtEnable" : {
                    "description" : "Transient Client Management enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "joinIgnoreTimeout" : {
                    "description" : "Join wait time.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 60,
                    "default" : 30
                },
                "joinAcceptTimeout" : {
                    "description" : "Join expire time.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 300,
                    "default" : 300
                },
                "joinIgnoreThr" : {
                    "description" : "Join wait threshold.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 50,
                    "default" : 10
                },
                "dropRandomProbesEnabled" : {
                    "description" : "Drop Random Probes enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "authRssiThr" : {
                    "description" : "Auth RSSI threshold.",
                    "type" : "integer",
                    "minimum" : -90,
                    "maximum" : -60
                },
                "assocRssiThr" : {
                    "description" : "Assoc RSSI threshold.",
                    "type" : "integer",
                    "minimum" : -90,
                    "maximum" : -60
                },
                "oceEnabled" : {
                    "description" : "Optimized Connectivity Experience(OCE) enabled.",
                    "type" : "boolean",
                    "default" : false
                },
                "oceBroadcastProbeResponseDelay" : {
                    "description" : "Broadcast probe response delay.",
                    "type" : "integer",
                    "minimum" : 8,
                    "maximum" : 120,
                    "default" : 15
                },
                "oceRssiBasedAssociationRejectionThreshold" : {
                    "description" : "RSSI-based association rejection threshold.",
                    "type" : "integer",
                    "minimum" : -90,
                    "maximum" : -60,
                    "default" : -75
                }
            },
            "type" : "object"
        },
        "authServiceOrProfile" : {
            "description" : "Authentication of the WLAN",
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "description" : "Identifier of the authentication service or profile. At least one ID or name or authenticationOption is required in the request.",
                    "type" : "string"
                },
                "locationDeliveryEnabled" : {
                    "description" : "RFC5580 location delivery support",
                    "type" : "boolean"
                },
                "realmBasedAuth" : {
                    "type" : "boolean"
                },
                "name" : {
                    "description" : "Name of the authentication service or profile. At least one ID or name or authenticationOption is required in the request. Or could input the 'Always Accept' or 'Local DB'.",
                    "type" : "string"
                },
                "authenticationOption" : {
                    "description" : "Option of the authentication service or profile, At least one ID or name or authenticationOption is required in the request. This only applies to hotspot and guest WLANs.",
                    "type" : "string",
                    "enum" : [ "Local DB", "Guest", "Always Accept", null ]
                },
                "throughController" : {
                    "description" : "Indicates whether authentication messages were sent through the controller or not",
                    "type" : "boolean"
                },
                "backupAuthenticationId" : {
                    "description" : "Identifier of the backup authentication service or profile. At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service.",
                    "type" : "string"
                },
                "backupAuthenticationName" : {
                    "description" : "Name of the backup authentication service or profile. At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service. Or could input the 'Always Accept'.",
                    "type" : "string"
                },
                "backupAuthenticationOption" : {
                    "description" : "Option of the backup authentication service or profile, At least one backupAuthenticationId or backupAuthenticationName or backupAuthenticationOption is required in the request when setting backup authentication service. This only applies to hotspot WLANs.",
                    "type" : "string",
                    "enum" : [ "Always Accept", null ]
                }
            },
            "type" : "object"
        },
        "coreTunnelProfile" : {
            "description" : "Core tunnel of the WLAN. This only applies when the access tunnel type is set to RuckusGRE.",
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "description" : "Identifier of the forwarding profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the forwarding profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "type" : {
                    "description" : "Tunnel type",
                    "type" : "string",
                    "enum" : [ "Bridge" ]
                }
            },
            "required" : [ "type" ],
            "type" : "object"
        },
        "defaultUserTrafficProfile" : {
            "description" : "User traffic profile of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "precedenceProfileId" : {
            "description" : "Precedence profile of the WLAN",
            "type" : "string"
        },
        "description" : {
            "description" : "Description of the WLAN",
            "type" : [ "string", "null" ],
            "maxLength" : 64
        },
        "devicePolicy" : {
            "description" : "Device policy of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "diffServProfile" : {
            "description" : "DiffServ profile of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "dnsServerProfile" : {
            "description" : "DNS server profile of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "dpsk" : {
            "description" : "DPSK Setting",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "dpskEnabled" : {
                    "description" : "DPSK enabled",
                    "type" : "boolean",
                    "default" : false
                },
                "length" : {
                    "description" : "Length of DPSK key",
                    "type" : "integer",
                    "default" : 62
                },
                "dpskType" : {
                    "description" : "Type of DPSK key",
                    "type" : "string",
                    "enum" : [ "Secure", "KeyboardFriendly", "NumbersOnly" ],
                    "default" : "Secure"
                },
                "expiration" : {
                    "description" : "Expiration of DPSK key",
                    "type" : "string",
                    "enum" : [ "Unlimited", "OneDay", "TwoDays", "OneWeek", "TwoWeeks", "OneMonth", "SixMonths", "OneYear", "TwoYears" ],
                    "default" : "Unlimited"
                },
                "dpskFromType" : {
                    "description" : "Type of expiration start from",
                    "type" : "string",
                    "enum" : [ "CreateTime", "FirstUse" ],
                    "default" : "CreateTime"
                }
            }
        },
        "externalDpsk" : {
            "description" : "External DPSK Enabled",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "enabled" : {
                    "description" : "Enable External DPSK",
                    "type" : "boolean",
                    "default" : false
                },
                "encryption" : {
                    "description" : "Encryption of the WLAN relate to external DPSK",
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "method" : {
                            "description" : "Encryption method",
                            "type" : "string",
                            "enum" : [ "WPA2", "WPA_Mixed", "None" ]
                        },
                        "algorithm" : {
                            "description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
                            "type" : "string",
                            "enum" : [ "AES", "TKIP_AES" ]
                        }
                    }
                },
                "authService" : {
                    "description" : "Autentication of the WLAN relate to external DPSK",
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "description" : "Identifier of the authentication service. At least one ID or name is required in the request.",
                            "type" : "string"
                        },
                        "name" : {
                            "description" : "Name of the authentication service. At least one ID or name is required in the request.",
                            "type" : "string"
                        }
                    }
                }
            },
            "required" : [ "enabled" ]
        },
        "encryption" : {
            "description" : "Encryption of the WLAN",
            "additionalProperties" : false,
            "properties" : {
                "algorithm" : {
                    "description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
                    "type" : "string",
                    "enum" : [ "AES", "TKIP_AES" ]
                },
                "keyInHex" : {
                    "description" : "Key in hex format. This only applies to WEP64 and WEP128.",
                    "type" : "string"
                },
                "keyIndex" : {
                    "description" : "Key index. This only applies to WEP64 and WEP128.",
                    "type" : "integer"
                },
                "method" : {
                    "description" : "Encryption method",
                    "type" : "string",
                    "enum" : [ "WPA2", "WPA_Mixed", "WEP_64", "WEP_128", "None" ],
                    "default" : "None"
                },
                "mfp" : {
                    "description" : "Management frame protection. This only applies to WPA2 + AES",
                    "type" : "string",
                    "enum" : [ "disabled", "capable", "required" ]
                },
                "mobilityDomainId" : {
                    "description" : "mobility Domain Id.",
                    "maximum" : 65535,
                    "minimum" : 1,
                    "type" : "integer"
                },
                "passphrase" : {
                    "description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
                    "type" : "string"
                },
                "support80211rEnabled" : {
                    "description" : "Enable 802.11r Fast BSS Transition, fast Romaing.",
                    "type" : "boolean"
                }
            },
            "required" : [ "method" ],
            "type" : "object"
        },
        "hessid" : {
            "description" : "HESSID of the WLAN",
            "pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$",
            "type" : "string"
        },
        "hotspot20Profile" : {
            "description" : "Hotspot 2.0 operator profile of the WLAN. The ID or name of the Hotspot 2.0 operator profiles within the zone is required.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "l2ACL" : {
            "description" : "Layer 2 ACL of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "macAuth" : {
            "description" : "MAC address authentication settings of the WLAN. This only applies to standard MAC and Hotspot MAC bypass WLAN.",
            "additionalProperties" : false,
            "properties" : {
                "customizedPassword" : {
                    "description" : "User defined password. When this field is set to an empty string, the MAC address is used as password.",
                    "maxLength" : 64,
                    "pattern" : "^([!-;=?-~]([ -;=?-~]){0,62}[!-;=?-~]|[!-;=?-~]{1,1}|\s{0,0})$",
                    "type" : "string"
                },
                "macAuthMacFormat" : {
                    "description" : "MAC address format. The default format is 0010a42319c0 and the 802.1X format is 00-10-A4-23-19-C0.",
                    "type" : "string",
                    "enum" : [ "Default", "802.1X", "UpperColon", "Upper", "LowerDash", "LowerColon" ]
                }
            },
            "type" : "object"
        },
        "name" : {
            "description" : "Name of the WLAN",
            "type" : "string",
            "minLength" : 1,
            "maxLength" : 32
        },
        "operatorRealm" : {
            "description" : "Operator realm, operatorRealm only supports coreTunnelProfile type is PMIP or authServiceOrProfile.locationDeliveryEnabled is true",
            "type" : "string",
            "maxLength" : 255,
            "pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
        },
        "portalServiceProfile" : {
            "description" : "Portal service of the WLAN. This only applies to hotspot, hotspot MAC bypass, guest and web auth WLANs.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "qosMaps" : {
            "description" : "Qos map set of the WLAN.",
            "items" : {
                "additionalProperties" : false,
                "properties" : {
                    "enable" : {
                        "description" : "Enabled or disabled",
                        "type" : "boolean"
                    },
                    "excepts" : {
                        "items" : {
                            "maximum" : 63,
                            "minimum" : 0,
                            "type" : "integer"
                        },
                        "type" : [ "array", "null" ]
                    },
                    "high" : {
                        "description" : "DSCP range - high",
                        "maximum" : 255,
                        "minimum" : 0,
                        "type" : [ "integer", "null" ]
                    },
                    "low" : {
                        "description" : "DSCP range - low",
                        "maximum" : 255,
                        "minimum" : 0,
                        "type" : [ "integer", "null" ]
                    },
                    "priority" : {
                        "description" : "Priority",
                        "type" : "integer"
                    }
                },
                "required" : [ "enable", "priority" ],
                "type" : "object"
            },
            "type" : "array"
        },
        "radiusOptions" : {
            "description" : "RADIUS options of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "calledStaIdType" : {
                    "default" : "WLAN_BSSID",
                    "description" : "Called station ID type",
                    "type" : "string",
                    "enum" : [ "AP_MAC", "NONE", "WLAN_BSSID" ]
                },
                "customizedNasId" : {
                    "description" : "User defined NAS ID",
                    "maxLength" : 64,
                    "pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
                    "type" : "string"
                },
                "nasIdType" : {
                    "default" : "WLAN_BSSID",
                    "description" : "NAS ID type",
                    "type" : "string",
                    "enum" : [ "AP_MAC", "Customized", "WLAN_BSSID" ]
                },
                "nasMaxRetry" : {
                    "default" : 2,
                    "description" : "NAS request maximum retry",
                    "maximum" : 10,
                    "minimum" : 2,
                    "type" : "integer"
                },
                "nasReconnectPrimaryMin" : {
                    "default" : 5,
                    "description" : "NAS reconnect primary time in minutes",
                    "maximum" : 60,
                    "minimum" : 1,
                    "type" : "integer"
                },
                "nasRequestTimeoutSec" : {
                    "default" : 3,
                    "description" : "NAS request timeout in seconds",
                    "maximum" : 20,
                    "minimum" : 2,
                    "type" : "integer"
                },
                "nasIpType" : {
                    "description" : "NAS IP type",
                    "type" : "string",
                    "enum" : [ "disabled", "control", "management", "userDefined" ],
                    "default" : "disabled"
                },
                "nasIpUserDefined" : {
                    "description" : "User-defined NAS IP",
                    "type" : "string",
                    "maxLength" : 45
                },
                "singleSessionIdAcctEnabled" : {
                    "description" : "When Single Accounting Session ID is enabled, APs will maintain one accounting session for client roaming",
                    "type" : "boolean",
                    "default" : false
                },
                "vendorSpecificAttributeProfileId" : {
                    "description" : "Vendor Specific Attribute Profile ID",
                    "type" : "string"
                }
            }
        },
        "schedule" : {
            "description" : "Schedule of the WLAN",
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "description" : "Identifier of the schedule profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the schedule profile. At least one ID or name is required in the request.",
                    "type" : "string"
                },
                "type" : {
                    "description" : "Type of WLAN schedule",
                    "type" : "string",
                    "enum" : [ "AlwaysOn", "AlwaysOff", "Customized" ],
                    "default" : "AlwaysOn"
                }
            },
            "required" : [ "type" ],
            "type" : "object"
        },
        "ssid" : {
            "description" : "SSID of the WLAN",
            "type" : "string",
            "minLength" : 1,
            "maxLength" : 32
        },
        "timeboundWhitelist" : {
            "description" : "Hotspot timeboundWhitelist. The ID of the OAuth Authentication service is required.",
            "additionalProperties" : false,
            "properties" : {
                "firstIndex" : {
                    "type" : "integer"
                },
                "hasMore" : {
                    "type" : "boolean"
                },
                "list" : {
                    "items" : {
                        "type" : [ "object", "null" ],
                        "additionalProperties" : false,
                        "properties" : {
                            "id" : {
                                "type" : "string"
                            },
                            "name" : {
                                "type" : "string"
                            }
                        }
                    },
                    "type" : "array"
                },
                "totalCount" : {
                    "type" : "integer"
                }
            },
            "type" : "object"
        },
        "vlan" : {
            "description" : "VLAN (access and/or core) of the WLAN.",
            "additionalProperties" : false,
            "properties" : {
                "aaaVlanOverride" : {
                    "description" : "Indicates whether the AAA VLAN settings can be overriden or not",
                    "type" : "boolean"
                },
                "accessVlan" : {
                    "description" : "Access VLAN ID",
                    "maximum" : 4094,
                    "minimum" : 1,
                    "type" : "integer",
                    "default" : 1
                },
                "vlanPooling" : {
                    "description" : "Vlan pooling",
                    "type" : [ "object", "null" ],
                    "additionalProperties" : false,
                    "properties" : {
                        "id" : {
                            "type" : "string"
                        },
                        "name" : {
                            "type" : "string"
                        }
                    }
                }
            },
            "type" : "object"
        },
        "accessTunnelProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "accessIpsecProfile" : {
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "splitTunnelProfileId" : {
            "type" : "string"
        }
    },
    "required" : [ "name", "ssid", "hotspot20Profile" ],
    "type" : "object"
}
Response  201
HideShow
Body
{
  "id": "wlanID"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Disable Accounting

DELETE/v8_1/rkszones/{zoneId}/wlans/{id}/accountingServiceOrProfile

Use this API command to disable the accounting of a WLAN.

Response  204

Disable Layer 2 ACL

DELETE/v8_1/rkszones/{zoneId}/wlans/{id}/l2ACL

Use this API command to disable the layer 2 access control list (ACL) configuration of a WLAN.

Response  204

Disable Device Policy

DELETE/v8_1/rkszones/{zoneId}/wlans/{id}/devicePolicy

Use this API command to disable the device policy of a WLAN.

Response  204

Disable DiffServ Profile

DELETE/v8_1/rkszones/{zoneId}/wlans/{id}/diffServProfile

Use this API command to disable the DiffServ profile of a WLAN.

Response  204

Disable Qos Map Set

DELETE/v8_1/rkszones/{zoneId}/wlans/{id}/qosMaps

Use this API command to disable Qos Map Set of a WLAN.

Response  204

Disable DNS server profile

DELETE/v8_1/rkszones/{zoneId}/wlans/{id}/dnsServerProfile

Use this API command to disable DNS server profile of a WLAN.

Response  204

WLAN Scheduler

Create

POST/v8_1/rkszones/{zoneId}/wlanSchedulers

Use this API command to create a new WLAN schedule.

Request
HideShow
Body
{
  "name": "wlanSchedulerName",
  "description": "wlanSchedulerDescription",
  "sun": [
    "00:15-01:15",
    "07:00-08:30",
    "10:45-12:00"
  ],
  "mon": [
    "00:00-01:15",
    "13:00-14:00"
  ],
  "tue": [
    "00:15-01:15"
  ],
  "wed": [
    "00:15-01:15"
  ],
  "thu": [
    "00:15-01:15"
  ],
  "fri": [
    "00:15-01:15"
  ],
  "sat": [
    "23:45-24:00"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "description": "Name of the WLAN schedule",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "Description of the WLAN schedule",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "sun": {
      "description": "Schedules on Sunday",
      "type": "array",
      "items": {
        "type": "string",
        "pattern": "^([0-1][0-9]|2[0-3]):(00|15|30|45)-(([0-1][0-9]|2[0-3]):(00|15|30|45)|24:00)$"
      }
    },
    "mon": {
      "description": "Schedules on Monday",
      "type": "array",
      "items": {
        "type": "string",
        "pattern": "^([0-1][0-9]|2[0-3]):(00|15|30|45)-(([0-1][0-9]|2[0-3]):(00|15|30|45)|24:00)$"
      }
    },
    "tue": {
      "description": "Schedules on Tuesday",
      "type": "array",
      "items": {
        "type": "string",
        "pattern": "^([0-1][0-9]|2[0-3]):(00|15|30|45)-(([0-1][0-9]|2[0-3]):(00|15|30|45)|24:00)$"
      }
    },
    "wed": {
      "description": "Schedules on Wednesday",
      "type": "array",
      "items": {
        "type": "string",
        "pattern": "^([0-1][0-9]|2[0-3]):(00|15|30|45)-(([0-1][0-9]|2[0-3]):(00|15|30|45)|24:00)$"
      }
    },
    "thu": {
      "description": "Schedules on Thursday",
      "type": "array",
      "items": {
        "type": "string",
        "pattern": "^([0-1][0-9]|2[0-3]):(00|15|30|45)-(([0-1][0-9]|2[0-3]):(00|15|30|45)|24:00)$"
      }
    },
    "fri": {
      "description": "Schedules on Friday",
      "type": "array",
      "items": {
        "type": "string",
        "pattern": "^([0-1][0-9]|2[0-3]):(00|15|30|45)-(([0-1][0-9]|2[0-3]):(00|15|30|45)|24:00)$"
      }
    },
    "sat": {
      "description": "Schedules on Saturday",
      "type": "array",
      "items": {
        "type": "string",
        "pattern": "^([0-1][0-9]|2[0-3]):(00|15|30|45)-(([0-1][0-9]|2[0-3]):(00|15|30|45)|24:00)$"
      }
    }
  },
  "required": [
    "name"
  ]
}
Response  201
HideShow
Body
{
  "id": "wlanSchedulerUUID"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Retrieve

GET/v8_1/rkszones/{zoneId}/wlanSchedulers/{id}

Use this API command to retrieve a WLAN schedule.

Response  200
HideShow
Body
{
  "id": "wlanSchedulerUUID",
  "zoneId": "zoneUUID",
  "name": "wlanSchedulerName",
  "description": "wlanSchedulerDescription",
  "sun": [
    "00:15-01:15",
    "07:00-08:30",
    "10:45-12:00"
  ],
  "mon": [
    "00:00-01:15",
    "13:00-14:00"
  ],
  "tue": [
    "00:15-01:15"
  ],
  "wed": [
    "00:15-01:15",
    "07:00-08:30",
    "10:45-12:00"
  ],
  "thu": [
    "00:15-01:15"
  ],
  "fri": [
    "00:15-01:15"
  ],
  "sat": [
    "23:45-24:00"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "Identifier of the WLAN schedule",
      "type": "string"
    },
    "zoneId": {
      "description": "Identifier of the zone to which the WLAN schedule belongs",
      "type": "string"
    },
    "name": {
      "description": "Name of the WLAN schedule",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "Description of the WLAN schedule",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "sun": {
      "description": "Schedules on Sunday",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "mon": {
      "description": "Schedules on Monday",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "tue": {
      "description": "Schedules on Tuesday",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "wed": {
      "description": "Schedules on Wednesday",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "thu": {
      "description": "Schedules on Thursday",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "fri": {
      "description": "Schedules on Friday",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "sat": {
      "description": "Schedules on Saturday",
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}

Retrieve List

GET/v8_1/rkszones/{zoneId}/wlanSchedulers

Use this API command to retrieve the list of WLAN schedule from a zone.

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

Response  200
HideShow
Body
{
  "totalCount": 2,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "id": "wlanSchedulerUUID",
      "name": "wlanSchedulerName",
      "description": "wlanSchedulerDescription",
      "sun": [
        "00:15-01:15",
        "07:00-08:30",
        "10:45-12:00"
      ],
      "mon": [
        "00:00-01:15",
        "13:00-14:00"
      ],
      "tue": [
        "00:15-01:15"
      ],
      "wed": [
        "00:15-01:15",
        "07:00-08:30",
        "10:45-12:00"
      ],
      "thu": [
        "00:15-01:15"
      ],
      "fri": [
        "00:15-01:15"
      ],
      "sat": [
        "23:45-24:00"
      ]
    },
    {
      "id": "wlanSchedulerUUID2",
      "name": "wlanSchedulerName2",
      "description": "wlanSchedulerDescription2",
      "sun": [
        "00:15-01:15",
        "07:00-08:30",
        "10:45-12:00"
      ],
      "mon": [
        "00:00-01:15",
        "13:00-14:00"
      ],
      "tue": [
        "00:15-01:15"
      ],
      "wed": [
        "00:15-01:15",
        "07:00-08:30",
        "10:45-12:00"
      ],
      "thu": [
        "16:15-17:15"
      ],
      "fri": [
        "00:30-03:15"
      ],
      "sat": [
        "23:45-24:00"
      ]
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "Identifier of the WLAN schedule",
            "type": "string"
          },
          "zoneId": {
            "description": "Identifier of the zone to which the WLAN schedule belongs",
            "type": "string"
          },
          "name": {
            "description": "Name of the WLAN schedule",
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
          },
          "description": {
            "description": "Description of the WLAN schedule",
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64
          },
          "sun": {
            "description": "Schedules on Sunday",
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "mon": {
            "description": "Schedules on Monday",
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "tue": {
            "description": "Schedules on Tuesday",
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "wed": {
            "description": "Schedules on Wednesday",
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "thu": {
            "description": "Schedules on Thursday",
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "fri": {
            "description": "Schedules on Friday",
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "sat": {
            "description": "Schedules on Saturday",
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      }
    }
  }
}

Modify

PATCH/v8_1/rkszones/{zoneId}/wlanSchedulers/{id}

Use this API command to modify the basic information of a WLAN schedule.

Request
HideShow
Body
{
  "name": "wlanSchedulerName",
  "description": "wlanSchedulerDescription",
  "sun": [
    "00:15-01:15",
    "07:00-08:30",
    "10:45-12:00"
  ],
  "mon": [
    "00:00-01:15",
    "13:00-14:00"
  ],
  "tue": [
    "00:15-01:15"
  ],
  "wed": [
    "00:15-01:15",
    "07:00-08:30",
    "10:45-12:00"
  ],
  "thu": [
    "00:15-01:15"
  ],
  "fri": [
    "00:15-01:15"
  ],
  "sat": [
    "23:45-24:00"
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "description": "Name of the WLAN schedule",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "Description of the WLAN schedule",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "sun": {
      "description": "Schedules on Sunday",
      "type": "array",
      "items": {
        "type": "string",
        "pattern": "^([0-1][0-9]|2[0-3]):(00|15|30|45)-(([0-1][0-9]|2[0-3]):(00|15|30|45)|24:00)$"
      }
    },
    "mon": {
      "description": "Schedules on Monday",
      "type": "array",
      "items": {
        "type": "string",
        "pattern": "^([0-1][0-9]|2[0-3]):(00|15|30|45)-(([0-1][0-9]|2[0-3]):(00|15|30|45)|24:00)$"
      }
    },
    "tue": {
      "description": "Schedules on Tuesday",
      "type": "array",
      "items": {
        "type": "string",
        "pattern": "^([0-1][0-9]|2[0-3]):(00|15|30|45)-(([0-1][0-9]|2[0-3]):(00|15|30|45)|24:00)$"
      }
    },
    "wed": {
      "description": "schedules on Wednesday",
      "type": "array",
      "items": {
        "type": "string",
        "pattern": "^([0-1][0-9]|2[0-3]):(00|15|30|45)-(([0-1][0-9]|2[0-3]):(00|15|30|45)|24:00)$"
      }
    },
    "thu": {
      "description": "Schedules on Thursday",
      "type": "array",
      "items": {
        "type": "string",
        "pattern": "^([0-1][0-9]|2[0-3]):(00|15|30|45)-(([0-1][0-9]|2[0-3]):(00|15|30|45)|24:00)$"
      }
    },
    "fri": {
      "description": "Schedules on Friday",
      "type": "array",
      "items": {
        "type": "string",
        "pattern": "^([0-1][0-9]|2[0-3]):(00|15|30|45)-(([0-1][0-9]|2[0-3]):(00|15|30|45)|24:00)$"
      }
    },
    "sat": {
      "description": "Schedules on Saturday",
      "type": "array",
      "items": {
        "type": "string",
        "pattern": "^([0-1][0-9]|2[0-3]):(00|15|30|45)-(([0-1][0-9]|2[0-3]):(00|15|30|45)|24:00)$"
      }
    }
  }
}
Response  204

Modify Schedules On Sunday

PATCH/v8_1/rkszones/{zoneId}/wlanSchedulers/{id}/sun

Use this API command to modify schedules on Sunday.

Request
HideShow
Body
[
  "00:15-01:15",
  "07:00-08:30",
  "10:45-12:00"
]
Schema
{
  "description": "Schedules on Sunday",
  "type": "array",
  "items": {
    "type": "string",
    "pattern": "^([0-1][0-9]|2[0-3]):(00|15|30|45)-(([0-1][0-9]|2[0-3]):(00|15|30|45)|24:00)$"
  }
}
Response  204

Modify Schedules On Monday

PATCH/v8_1/rkszones/{zoneId}/wlanSchedulers/{id}/mon

Use this API command to modify schedules on Monday.

Request
HideShow
Body
[
  "00:00-01:15",
  "13:00-14:00"
]
Schema
{
  "description": "Schedules on Monday",
  "type": "array",
  "items": {
    "type": "string",
    "pattern": "^([0-1][0-9]|2[0-3]):(00|15|30|45)-(([0-1][0-9]|2[0-3]):(00|15|30|45)|24:00)$"
  }
}
Response  204

Modify Schedule On Tuesday

PATCH/v8_1/rkszones/{zoneId}/wlanSchedulers/{id}/tue

Use this API command to modify schedules on Tuesday.

Request
HideShow
Body
[
  "00:15-01:15"
]
Schema
{
  "description": "Schedules on Tuesday",
  "type": "array",
  "items": {
    "type": "string",
    "pattern": "^([0-1][0-9]|2[0-3]):(00|15|30|45)-(([0-1][0-9]|2[0-3]):(00|15|30|45)|24:00)$"
  }
}
Response  204

Modify Schedule On Wednesday

PATCH/v8_1/rkszones/{zoneId}/wlanSchedulers/{id}/wed

Use this API command to modify schedules on Wednesday.

Request
HideShow
Body
[
  "00:15-01:15",
  "07:00-08:30",
  "10:45-12:00"
]
Schema
{
  "description": "schedules on Wednesday",
  "type": "array",
  "items": {
    "type": "string",
    "pattern": "^([0-1][0-9]|2[0-3]):(00|15|30|45)-(([0-1][0-9]|2[0-3]):(00|15|30|45)|24:00)$"
  }
}
Response  204

Modify Schedules On Thursday

PATCH/v8_1/rkszones/{zoneId}/wlanSchedulers/{id}/thu

Use this API command to modify schedules on Thursday.

Request
HideShow
Body
[
  "00:15-01:15"
]
Schema
{
  "description": "Schedules on Thursday",
  "type": "array",
  "items": {
    "type": "string",
    "pattern": "^([0-1][0-9]|2[0-3]):(00|15|30|45)-(([0-1][0-9]|2[0-3]):(00|15|30|45)|24:00)$"
  }
}
Response  204

Modify Schedules On Friday

PATCH/v8_1/rkszones/{zoneId}/wlanSchedulers/{id}/fri

Use this API command to modify schedules on Friday.

Request
HideShow
Body
[
  "00:15-01:15"
]
Schema
{
  "description": "Schedules on Friday",
  "type": "array",
  "items": {
    "type": "string",
    "pattern": "^([0-1][0-9]|2[0-3]):(00|15|30|45)-(([0-1][0-9]|2[0-3]):(00|15|30|45)|24:00)$"
  }
}
Response  204

Modify Schedules On Saturday

PATCH/v8_1/rkszones/{zoneId}/wlanSchedulers/{id}/sat

Use this API command to modify schedules on Saturday.

Request
HideShow
Body
[
  "23:45-24:00"
]
Schema
{
  "description": "Schedules on Saturday",
  "type": "array",
  "items": {
    "type": "string",
    "pattern": "^([0-1][0-9]|2[0-3]):(00|15|30|45)-(([0-1][0-9]|2[0-3]):(00|15|30|45)|24:00)$"
  }
}
Response  204

Delete

DELETE/v8_1/rkszones/{zoneId}/wlanSchedulers/{id}

Use this API command to delete a WLAN schedule.

Response  204

Zone AAA

Create - RADIUS

POST/v8_1/rkszones/{zoneId}/aaa/radius

Use this API command to create a new radius server of a zone.

URI Parameters
HideShow
forAccounting
string (optional) 

radius server for accounting type. default: false.

Request
HideShow
Body
{
  "name": "RADIUSServerName",
  "primary": {
    "ip": "192.168.1.1",
    "port": 1812,
    "sharedSecret": "sharedSecret"
  },
  "standbyServerEnabled": false
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "description": "Name of the RADIUS server",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "Description of the RADIUS server",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "primary": {
      "description": "Primary RADIUS server",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "ip": {
          "description": "Server IP",
          "type": "string"
        },
        "port": {
          "description": "Server port",
          "type": "integer",
          "minimum": 1,
          "maximum": 65535
        },
        "sharedSecret": {
          "description": "Server shared secrect",
          "type": "string"
        }
      },
      "required": [
        "ip",
        "port",
        "sharedSecret"
      ]
    },
    "secondary": {
      "description": "Secondary RADIUS server",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "ip": {
          "description": "Server IP",
          "type": "string"
        },
        "port": {
          "description": "Server port",
          "type": "integer",
          "minimum": 1,
          "maximum": 65535
        },
        "sharedSecret": {
          "description": "Server shared secrect",
          "type": "string"
        }
      },
      "required": [
        "ip",
        "port",
        "sharedSecret"
      ]
    },
    "standbyPrimary": {
      "description": "Primary RADIUS server for standby cluster",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "ip": {
          "description": "Server IP",
          "type": "string"
        },
        "port": {
          "description": "Server port",
          "type": "integer",
          "minimum": 1,
          "maximum": 65535
        },
        "sharedSecret": {
          "description": "Server shared secrect",
          "type": "string"
        }
      },
      "required": [
        "ip",
        "port",
        "sharedSecret"
      ]
    },
    "mappings": {
      "type": "array",
      "description": "Group attribute and user traffic profile mapping",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "description": "User traffic profile mapping",
        "properties": {
          "groupAttr": {
            "type": "string",
            "description": "Group attribute"
          },
          "userRole": {
            "type": "object",
            "additionalProperties": false,
            "description": "Identity user role",
            "properties": {
              "id": {
                "type": "string",
                "description": "Identity user role UUID"
              },
              "name": {
                "description": "Identity user role name",
                "type": "string",
                "minLength": 2,
                "maxLength": 64,
                "pattern": "^[!-~]([ -~]){0,62}[!-~]$"
              }
            }
          }
        },
        "required": [
          "groupAttr",
          "userRole"
        ]
      }
    },
    "standbyServerEnabled": {
      "description": "StandbyCluster different AAA Settings Enabled",
      "type": "boolean",
      "default": false
    }
  },
  "required": [
    "name",
    "primary"
  ]
}
Response  201
HideShow
Body
{
  "id": "RADIUSServerUUID"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Retrieve List - RADIUS

GET/v8_1/rkszones/{zoneId}/aaa/radius

Use this API command to retrieve a list of radius servers of a zone.

Response  200
HideShow
Body
{
  "totalCount": 1,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "id": "RADIUSServerUUID",
      "mvnoId": "userMVNOId",
      "zoneId": "zoneUUID",
      "name": "RADIUSServerName",
      "description": "RADIUSServerDescription",
      "primary": {
        "ip": "192.168.1.1",
        "port": 1812,
        "sharedSecret": "sharedSecret"
      },
      "secondary": {
        "ip": "192.168.1.2",
        "port": 1812,
        "sharedSecret": "sharedSecret"
      },
      "mappings": [
        {
          "id": "73587760-6589-11e4-800c-0026b9f85aaf",
          "groupAttr": "abc",
          "userRole": {
            "id": "a4c288b0-63cf-11e4-a18a-080027b147d4",
            "name": "identity user role name",
            "userTrafficProfile": {
              "id": "9474cc20-63cf-11e4-a18a-080027b147d4",
              "name": "rapheal-usertraffic-profile"
            }
          }
        },
        {
          "id": "735e6ad0-6589-11e4-800c-0026b9f85aaf",
          "groupAttr": "*",
          "userRole": {
            "id": "9ac45fd6-a87b-4eef-87d7-b759fed376c5",
            "name": "identity user role name",
            "userTrafficProfile": {
              "id": "03ec5340-60a4-11e4-87fc-080027b147d4",
              "name": "System Default"
            }
          }
        }
      ]
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "Identifier of the RADIUS server",
            "type": "string"
          },
          "zoneId": {
            "description": "Identifier of the zone which the RADIUS server belongs to",
            "type": "string"
          },
          "mvnoId": {
            "description": "Tenant UUID",
            "type": "string"
          },
          "name": {
            "description": "Name of the RADIUS server",
            "type": "string"
          },
          "description": {
            "description": "Description of the RADIUS server",
            "type": "string"
          },
          "primary": {
            "description": "Primary RADIUS server",
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "ip": {
                "description": "Server IP",
                "type": "string"
              },
              "port": {
                "description": "Server port",
                "type": "integer",
                "minimum": 1,
                "maximum": 65535
              },
              "sharedSecret": {
                "description": "Server shared secrect",
                "type": "string"
              }
            },
            "required": [
              "ip",
              "port",
              "sharedSecret"
            ]
          },
          "secondary": {
            "description": "Secondary RADIUS server",
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "ip": {
                "description": "Server IP",
                "type": "string"
              },
              "port": {
                "description": "Server port",
                "type": "integer",
                "minimum": 1,
                "maximum": 65535
              },
              "sharedSecret": {
                "description": "Server shared secrect",
                "type": "string"
              }
            },
            "required": [
              "ip",
              "port",
              "sharedSecret"
            ]
          },
          "standbyPrimary": {
            "description": "Primary RADIUS server for standby cluster",
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "ip": {
                "description": "Server IP",
                "type": "string"
              },
              "port": {
                "description": "Server port",
                "type": "integer",
                "minimum": 1,
                "maximum": 65535
              },
              "sharedSecret": {
                "description": "Server shared secrect",
                "type": "string"
              }
            },
            "required": [
              "ip",
              "port",
              "sharedSecret"
            ]
          },
          "mappings": {
            "type": "array",
            "description": "Group attribute and user traffic profile mapping",
            "items": {
              "type": "object",
              "additionalProperties": false,
              "description": "User traffic profile mapping",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Group attribute mapping UUID"
                },
                "groupAttr": {
                  "type": "string",
                  "description": "Group attribute"
                },
                "userRole": {
                  "type": "object",
                  "additionalProperties": false,
                  "description": "Identity user role",
                  "properties": {
                    "id": {
                      "type": "string",
                      "description": "Identity user role UUID"
                    },
                    "name": {
                      "description": "Identity user role name",
                      "type": "string",
                      "minLength": 2,
                      "maxLength": 64,
                      "pattern": "^[!-~]([ -~]){0,62}[!-~]$"
                    },
                    "userTrafficProfile": {
                      "type": "object",
                      "description": "Identity user role",
                      "properties": {
                        "id": {
                          "type": "string",
                          "description": "User traffic profile UUID"
                        },
                        "name": {
                          "type": "string",
                          "description": "User traffic profile name"
                        }
                      }
                    }
                  }
                }
              },
              "required": [
                "groupAttr",
                "userRole"
              ]
            }
          },
          "standbyServerEnabled": {
            "description": "StandbyCluster different AAA Settings Enabled",
            "type": "boolean"
          }
        }
      }
    }
  }
}

Retrieve - RADIUS

GET/v8_1/rkszones/{zoneId}/aaa/radius/{id}

Use this API command to retrieve a radius server of a zone.

Response  200
HideShow
Body
{
  "id": "RADIUSServerUUID",
  "mvnoId": "userMVNOId",
  "zoneId": "zoneUUID",
  "name": "RADIUSServerName",
  "description": "RADIUSServerDescription",
  "primary": {
    "ip": "192.168.1.1",
    "port": 1812,
    "sharedSecret": "sharedSecret"
  },
  "secondary": {
    "ip": "192.168.1.2",
    "port": 1812,
    "sharedSecret": "sharedSecret"
  },
  "standbyPrimary": {
    "ip": "192.168.2.1",
    "port": 1812,
    "sharedSecret": "abc"
  },
  "mappings": [
    {
      "id": "73587760-6589-11e4-800c-0026b9f85aaf",
      "groupAttr": "abc",
      "userRole": {
        "id": "a4c288b0-63cf-11e4-a18a-080027b147d4",
        "name": "identity user role name",
        "userTrafficProfile": {
          "id": "9474cc20-63cf-11e4-a18a-080027b147d4",
          "name": "rapheal-usertraffic-profile"
        }
      }
    },
    {
      "id": "735e6ad0-6589-11e4-800c-0026b9f85aaf",
      "groupAttr": "*",
      "userRole": {
        "id": "9ac45fd6-a87b-4eef-87d7-b759fed376c5",
        "name": "identity user role name",
        "userTrafficProfile": {
          "id": "03ec5340-60a4-11e4-87fc-080027b147d4",
          "name": "System Default"
        }
      }
    }
  ],
  "standbyServerEnabled": true
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "Identifier of the RADIUS server",
      "type": "string"
    },
    "zoneId": {
      "description": "Identifier of the zone which the RADIUS server belongs to",
      "type": "string"
    },
    "mvnoId": {
      "description": "Tenant UUID",
      "type": "string"
    },
    "name": {
      "description": "Name of the RADIUS server",
      "type": "string"
    },
    "description": {
      "description": "Description of the RADIUS server",
      "type": "string"
    },
    "primary": {
      "description": "Primary RADIUS server",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "ip": {
          "description": "Server IP",
          "type": "string"
        },
        "port": {
          "description": "Server port",
          "type": "integer",
          "minimum": 1,
          "maximum": 65535
        },
        "sharedSecret": {
          "description": "Server shared secrect",
          "type": "string"
        }
      },
      "required": [
        "ip",
        "port",
        "sharedSecret"
      ]
    },
    "secondary": {
      "description": "Secondary RADIUS server",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "ip": {
          "description": "Server IP",
          "type": "string"
        },
        "port": {
          "description": "Server port",
          "type": "integer",
          "minimum": 1,
          "maximum": 65535
        },
        "sharedSecret": {
          "description": "Server shared secrect",
          "type": "string"
        }
      },
      "required": [
        "ip",
        "port",
        "sharedSecret"
      ]
    },
    "standbyPrimary": {
      "description": "Primary RADIUS server for standby cluster",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "ip": {
          "description": "Server IP",
          "type": "string"
        },
        "port": {
          "description": "Server port",
          "type": "integer",
          "minimum": 1,
          "maximum": 65535
        },
        "sharedSecret": {
          "description": "Server shared secrect",
          "type": "string"
        }
      },
      "required": [
        "ip",
        "port",
        "sharedSecret"
      ]
    },
    "mappings": {
      "type": "array",
      "description": "Group attribute and user traffic profile mapping",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "description": "User traffic profile mapping",
        "properties": {
          "id": {
            "type": "string",
            "description": "Group attribute mapping UUID"
          },
          "groupAttr": {
            "type": "string",
            "description": "Group attribute"
          },
          "userRole": {
            "type": "object",
            "additionalProperties": false,
            "description": "Identity user role",
            "properties": {
              "id": {
                "type": "string",
                "description": "Identity user role UUID"
              },
              "name": {
                "description": "Identity user role name",
                "type": "string",
                "minLength": 2,
                "maxLength": 64,
                "pattern": "^[!-~]([ -~]){0,62}[!-~]$"
              },
              "userTrafficProfile": {
                "type": "object",
                "description": "Identity user role",
                "properties": {
                  "id": {
                    "type": "string",
                    "description": "User traffic profile UUID"
                  },
                  "name": {
                    "type": "string",
                    "description": "User traffic profile name"
                  }
                }
              }
            }
          }
        },
        "required": [
          "groupAttr",
          "userRole"
        ]
      }
    },
    "standbyServerEnabled": {
      "description": "StandbyCluster different AAA Settings Enabled",
      "type": "boolean"
    }
  }
}

Modify Entire - RADIUS

PUT/v8_1/rkszones/{zoneId}/aaa/radius/{id}

Use this API command to modify the basic information on radius server of a zone by complete attributes.

Request
HideShow
Body
{
  "name": "RADIUSServerName",
  "description": "RADIUSServerDescription",
  "primary": {
    "ip": "192.168.1.1",
    "port": 1812,
    "sharedSecret": "abc"
  },
  "secondary": {
    "ip": "192.168.1.2",
    "port": 1812,
    "sharedSecret": "sharedSecret"
  },
  "standbyPrimary": {
    "ip": "192.168.2.1",
    "port": 1812,
    "sharedSecret": "abc"
  },
  "mappings": [
    {
      "groupAttr": "newGroupAttr",
      "userRole": {
        "id": "identity user role UUID"
      }
    },
    {
      "groupAttr": "*",
      "userRole": {
        "name": "identity user role name"
      }
    }
  ],
  "standbyServerEnabled": true
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "description": "Name of the RADIUS server",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "Description of the RADIUS server",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "primary": {
      "description": "Primary RADIUS server",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "ip": {
          "description": "Server IP",
          "type": "string"
        },
        "port": {
          "description": "Server port",
          "type": "integer",
          "minimum": 1,
          "maximum": 65535
        },
        "sharedSecret": {
          "description": "Server shared secrect",
          "type": "string"
        }
      },
      "required": [
        "ip",
        "port",
        "sharedSecret"
      ]
    },
    "secondary": {
      "description": "Secondary RADIUS server",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "ip": {
          "description": "Server IP",
          "type": "string"
        },
        "port": {
          "description": "Server port",
          "type": "integer",
          "minimum": 1,
          "maximum": 65535
        },
        "sharedSecret": {
          "description": "Server shared secrect",
          "type": "string"
        }
      },
      "required": [
        "ip",
        "port",
        "sharedSecret"
      ]
    },
    "standbyPrimary": {
      "description": "Primary RADIUS server for standby cluster",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "ip": {
          "description": "Server IP",
          "type": "string"
        },
        "port": {
          "description": "Server port",
          "type": "integer",
          "minimum": 1,
          "maximum": 65535
        },
        "sharedSecret": {
          "description": "Server shared secrect",
          "type": "string"
        }
      },
      "required": [
        "ip",
        "port",
        "sharedSecret"
      ]
    },
    "mappings": {
      "type": "array",
      "description": "Group attribute and user traffic profile mapping",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "description": "User traffic profile mapping",
        "properties": {
          "groupAttr": {
            "type": "string",
            "description": "Group attribute"
          },
          "userRole": {
            "type": "object",
            "additionalProperties": false,
            "description": "Identity user role",
            "properties": {
              "id": {
                "type": "string",
                "description": "Identity user role UUID"
              },
              "name": {
                "description": "Identity user role name",
                "type": "string",
                "minLength": 2,
                "maxLength": 64,
                "pattern": "^[!-~]([ -~]){0,62}[!-~]$"
              }
            }
          }
        },
        "required": [
          "groupAttr",
          "userRole"
        ]
      }
    },
    "standbyServerEnabled": {
      "description": "StandbyCluster different AAA Settings Enabled",
      "type": "boolean"
    }
  }
}
Response  204

Modify - RADIUS

PATCH/v8_1/rkszones/{zoneId}/aaa/radius/{id}

Use this API command to modify the basic information on radius server of a zone.

Request
HideShow
Body
{
  "name": "RADIUSServerName",
  "description": "RADIUSServerDescription",
  "primary": {
    "ip": "192.168.1.1",
    "port": 1812,
    "sharedSecret": "abc"
  },
  "secondary": {
    "ip": "192.168.1.2",
    "port": 1812,
    "sharedSecret": "sharedSecret"
  },
  "standbyPrimary": {
    "ip": "192.168.2.1",
    "port": 1812,
    "sharedSecret": "abc"
  },
  "mappings": [
    {
      "groupAttr": "newGroupAttr",
      "userRole": {
        "id": "identity user role UUID"
      }
    },
    {
      "groupAttr": "*",
      "userRole": {
        "name": "identity user role name"
      }
    }
  ],
  "standbyServerEnabled": true
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "description": "Name of the RADIUS server",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "Description of the RADIUS server",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "primary": {
      "description": "Primary RADIUS server",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "ip": {
          "description": "Server IP",
          "type": "string"
        },
        "port": {
          "description": "Server port",
          "type": "integer",
          "minimum": 1,
          "maximum": 65535
        },
        "sharedSecret": {
          "description": "Server shared secrect",
          "type": "string"
        }
      },
      "required": [
        "ip",
        "port",
        "sharedSecret"
      ]
    },
    "secondary": {
      "description": "Secondary RADIUS server",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "ip": {
          "description": "Server IP",
          "type": "string"
        },
        "port": {
          "description": "Server port",
          "type": "integer",
          "minimum": 1,
          "maximum": 65535
        },
        "sharedSecret": {
          "description": "Server shared secrect",
          "type": "string"
        }
      },
      "required": [
        "ip",
        "port",
        "sharedSecret"
      ]
    },
    "standbyPrimary": {
      "description": "Primary RADIUS server for standby cluster",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "ip": {
          "description": "Server IP",
          "type": "string"
        },
        "port": {
          "description": "Server port",
          "type": "integer",
          "minimum": 1,
          "maximum": 65535
        },
        "sharedSecret": {
          "description": "Server shared secrect",
          "type": "string"
        }
      },
      "required": [
        "ip",
        "port",
        "sharedSecret"
      ]
    },
    "mappings": {
      "type": "array",
      "description": "Group attribute and user traffic profile mapping",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "description": "User traffic profile mapping",
        "properties": {
          "groupAttr": {
            "type": "string",
            "description": "Group attribute"
          },
          "userRole": {
            "type": "object",
            "additionalProperties": false,
            "description": "Identity user role",
            "properties": {
              "id": {
                "type": "string",
                "description": "Identity user role UUID"
              },
              "name": {
                "description": "Identity user role name",
                "type": "string",
                "minLength": 2,
                "maxLength": 64,
                "pattern": "^[!-~]([ -~]){0,62}[!-~]$"
              }
            }
          }
        },
        "required": [
          "groupAttr",
          "userRole"
        ]
      }
    },
    "standbyServerEnabled": {
      "description": "StandbyCluster different AAA Settings Enabled",
      "type": "boolean"
    }
  }
}
Response  204

Modify - Primary Server of RADIUS

PATCH/v8_1/rkszones/{zoneId}/aaa/radius/{id}/primary

Use this API command to modify primary server on radius server of a zone.

Request
HideShow
Body
{
  "ip": "192.168.1.1",
  "port": 1812,
  "sharedSecret": "abc"
}
Schema
{
  "description": "Primary RADIUS server",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "ip": {
      "description": "Server IP",
      "type": "string"
    },
    "port": {
      "description": "Server port",
      "type": "integer",
      "minimum": 1,
      "maximum": 65535
    },
    "sharedSecret": {
      "description": "Server shared secrect",
      "type": "string"
    }
  },
  "required": [
    "ip",
    "port",
    "sharedSecret"
  ]
}
Response  204

Modify - Secondary Server of RADIUS

PATCH/v8_1/rkszones/{zoneId}/aaa/radius/{id}/secondary

Use this API command to modify secondary server on radius server of a zone.

Request
HideShow
Body
{
  "ip": "192.168.1.2",
  "port": 1812,
  "sharedSecret": "sharedSecret"
}
Schema
{
  "description": "Secondary RADIUS server",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "ip": {
      "description": "Server IP",
      "type": "string"
    },
    "port": {
      "description": "Server port",
      "type": "integer",
      "minimum": 1,
      "maximum": 65535
    },
    "sharedSecret": {
      "description": "Server shared secrect",
      "type": "string"
    }
  },
  "required": [
    "ip",
    "port",
    "sharedSecret"
  ]
}
Response  204

Delete - RADIUS

DELETE/v8_1/rkszones/{zoneId}/aaa/radius/{id}

Use this API command to delete a radius server of a zone.

Response  204

Disable Secondary Server - RADIUS

DELETE/v8_1/rkszones/{zoneId}/aaa/radius/{id}/secondary

Use this API command to disable secondary server on radius server of a zone.

Response  204

Retrieve List - ActiveDirectory

GET/v8_1/rkszones/{zoneId}/aaa/ad

Use this API command to retrieve a list of active directory servers of a zone.

Response  200
HideShow
Body
{
  "totalCount": 1,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "id": "a49bf7dd-be4a-45fb-abd6-bc15dcd697c2",
      "mvnoId": "839f87c6-d116-497e-afce-aa8157abd30c",
      "zoneId": "3c7fd7f4-68bd-4957-a698-a1a810888959",
      "name": "activeDirectoryServerName",
      "description": null,
      "ip": "192.168.1.1",
      "port": 389,
      "windowsDomainName": null,
      "adminDomainName": null,
      "password": "",
      "globalCatalogEnabled": false,
      "mappings": [
        {
          "id": "c7608860-6afd-11e4-b9bb-08002716c79f",
          "groupAttr": "*",
          "userRole": {
            "id": "636431d6-c06e-4692-a28f-3914afc2a817",
            "name": "identity user role name",
            "userTrafficProfile": {
              "id": "fbde8510-6972-11e4-926e-08002716c79f",
              "name": "System Default"
            }
          }
        }
      ]
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "Identifier of the active directory server",
            "type": "string"
          },
          "zoneId": {
            "description": "Identifier of the zone which the active directory server belongs to",
            "type": "string"
          },
          "mvnoId": {
            "description": "Tenant UUID",
            "type": "string"
          },
          "name": {
            "description": "Name of the active directory server",
            "type": "string"
          },
          "description": {
            "description": "Description of the active directory server",
            "type": "string"
          },
          "ip": {
            "description": "IP address",
            "type": "string"
          },
          "port": {
            "description": "Port",
            "type": "integer"
          },
          "windowsDomainName": {
            "description": "Windows domain name",
            "type": "string"
          },
          "adminDomainName": {
            "description": "Admin domain name",
            "type": "string"
          },
          "password": {
            "description": "Admin password",
            "type": "string"
          },
          "globalCatalogEnabled": {
            "description": "Enable global catalog support",
            "type": "boolean"
          },
          "mappings": {
            "type": "array",
            "description": "Group attribute and user traffic profile mapping",
            "items": {
              "type": "object",
              "additionalProperties": false,
              "description": "User traffic profile mapping",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Group attribute mapping UUID"
                },
                "groupAttr": {
                  "type": "string",
                  "description": "Group attribute"
                },
                "userRole": {
                  "type": "object",
                  "additionalProperties": false,
                  "description": "Identity user role",
                  "properties": {
                    "id": {
                      "type": "string",
                      "description": "Identity user role UUID"
                    },
                    "name": {
                      "description": "Identity user role name",
                      "type": "string",
                      "minLength": 2,
                      "maxLength": 64,
                      "pattern": "^[!-~]([ -~]){0,62}[!-~]$"
                    },
                    "userTrafficProfile": {
                      "type": "object",
                      "description": "Identity user role",
                      "properties": {
                        "id": {
                          "type": "string",
                          "description": "User traffic profile UUID"
                        },
                        "name": {
                          "type": "string",
                          "description": "User traffic profile name"
                        }
                      }
                    }
                  }
                }
              },
              "required": [
                "groupAttr",
                "userRole"
              ]
            }
          },
          "standbyServerEnabled": {
            "description": "StandbyCluster different AAA Settings Enabled",
            "type": "boolean"
          },
          "standbyIp": {
            "description": "IP address - Standby Cluster settings",
            "type": "string"
          },
          "standbyPort": {
            "description": "Port - Standby Cluster settings",
            "type": "integer"
          },
          "standbyWindowsDomainName": {
            "description": "Windows domain name - Standby Cluster settings",
            "type": "string"
          },
          "standbyAdminDomainName": {
            "description": "Admin domain name - Standby Cluster settings",
            "type": "string"
          },
          "standbyPassword": {
            "description": "Admin password - Standby Cluster settings",
            "type": "string"
          },
          "standbyGlobalCatalogEnabled": {
            "description": "Enable global catalog support - Standby Cluster settings",
            "type": "boolean"
          }
        }
      }
    }
  }
}

Retrieve - ActiveDirectory

GET/v8_1/rkszones/{zoneId}/aaa/ad/{id}

Use this API command to retrieve an active directory server of a zone.

Response  200
HideShow
Body
{
  "id": "a49bf7dd-be4a-45fb-abd6-bc15dcd697c2",
  "mvnoId": "839f87c6-d116-497e-afce-aa8157abd30c",
  "zoneId": "3c7fd7f4-68bd-4957-a698-a1a810888959",
  "name": "activeDirectoryServerName",
  "description": null,
  "ip": "192.168.1.1",
  "port": 389,
  "windowsDomainName": null,
  "adminDomainName": null,
  "password": "",
  "globalCatalogEnabled": false,
  "mappings": [
    {
      "id": "c7608860-6afd-11e4-b9bb-08002716c79f",
      "groupAttr": "*",
      "userRole": {
        "id": "636431d6-c06e-4692-a28f-3914afc2a817",
        "name": "identity user role name",
        "userTrafficProfile": {
          "id": "fbde8510-6972-11e4-926e-08002716c79f",
          "name": "System Default"
        }
      }
    }
  ],
  "standbyServerEnabled": true,
  "standbyIp": "2.2.2.2",
  "standbyPort": 389,
  "standbyWindowsDomainName": "dc=domain,dc=ruckuswireless,dc=com",
  "standbyGlobalCatalogEnabled": true,
  "standbyPassword": "admin",
  "standbyAdminDomainName": "uid=admin, dc=ldap, dc=com"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "Identifier of the active directory server",
      "type": "string"
    },
    "zoneId": {
      "description": "Identifier of the zone which the active directory server belongs to",
      "type": "string"
    },
    "mvnoId": {
      "description": "Tenant UUID",
      "type": "string"
    },
    "name": {
      "description": "Name of the active directory server",
      "type": "string"
    },
    "description": {
      "description": "Description of the active directory server",
      "type": "string"
    },
    "ip": {
      "description": "IP address",
      "type": "string"
    },
    "port": {
      "description": "Port",
      "type": "integer"
    },
    "windowsDomainName": {
      "description": "Windows domain name",
      "type": "string"
    },
    "adminDomainName": {
      "description": "Admin domain name",
      "type": "string"
    },
    "password": {
      "description": "Admin password",
      "type": "string"
    },
    "globalCatalogEnabled": {
      "description": "Enable global catalog support",
      "type": "boolean"
    },
    "mappings": {
      "type": "array",
      "description": "Group attribute and user traffic profile mapping",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "description": "User traffic profile mapping",
        "properties": {
          "id": {
            "type": "string",
            "description": "Group attribute mapping UUID"
          },
          "groupAttr": {
            "type": "string",
            "description": "Group attribute"
          },
          "userRole": {
            "type": "object",
            "additionalProperties": false,
            "description": "Identity user role",
            "properties": {
              "id": {
                "type": "string",
                "description": "Identity user role UUID"
              },
              "name": {
                "description": "Identity user role name",
                "type": "string",
                "minLength": 2,
                "maxLength": 64,
                "pattern": "^[!-~]([ -~]){0,62}[!-~]$"
              },
              "userTrafficProfile": {
                "type": "object",
                "description": "Identity user role",
                "properties": {
                  "id": {
                    "type": "string",
                    "description": "User traffic profile UUID"
                  },
                  "name": {
                    "type": "string",
                    "description": "User traffic profile name"
                  }
                }
              }
            }
          }
        },
        "required": [
          "groupAttr",
          "userRole"
        ]
      }
    },
    "standbyServerEnabled": {
      "description": "StandbyCluster different AAA Settings Enabled",
      "type": "boolean"
    },
    "standbyIp": {
      "description": "IP address - Standby Cluster settings",
      "type": "string"
    },
    "standbyPort": {
      "description": "Port - Standby Cluster settings",
      "type": "integer"
    },
    "standbyWindowsDomainName": {
      "description": "Windows domain name - Standby Cluster settings",
      "type": "string"
    },
    "standbyAdminDomainName": {
      "description": "Admin domain name - Standby Cluster settings",
      "type": "string"
    },
    "standbyPassword": {
      "description": "Admin password - Standby Cluster settings",
      "type": "string"
    },
    "standbyGlobalCatalogEnabled": {
      "description": "Enable global catalog support - Standby Cluster settings",
      "type": "boolean"
    }
  }
}

Create - ActiveDirectory

POST/v8_1/rkszones/{zoneId}/aaa/ad

Use this API command to create a new active directory server of a zone.

Request
HideShow
Body
{
  "name": "activeDirectoryServerName",
  "ip": "192.168.1.1",
  "port": 389,
  "globalCatalogEnabled": false,
  "windowsDomainName": "dc=domain,dc=ruckuswireless,dc=com",
  "standbyServerEnabled": true,
  "standbyIp": "2.2.2.2",
  "standbyPort": 389,
  "standbyWindowsDomainName": "dc=domain,dc=ruckuswireless,dc=com",
  "standbyGlobalCatalogEnabled": true,
  "standbyPassword": "admin",
  "standbyAdminDomainName": "uid=admin, dc=ldap, dc=com"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "description": "Name of the active directory server",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "Description of the active directory server",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "ip": {
      "description": "IP address",
      "type": "string"
    },
    "port": {
      "description": "Port",
      "type": "integer",
      "minimum": 1,
      "maximum": 65535,
      "default": 389
    },
    "windowsDomainName": {
      "description": "Windows domain name",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64,
      "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$"
    },
    "adminDomainName": {
      "description": "Admin domain name",
      "type": "string",
      "minLength": 2,
      "maxLength": 64,
      "pattern": "^[!-~]([ -~]){0,62}[!-~]$"
    },
    "password": {
      "description": "Admin password",
      "type": "string"
    },
    "globalCatalogEnabled": {
      "description": "Enable global catalog support",
      "type": "boolean"
    },
    "mappings": {
      "type": "array",
      "description": "Group attribute and user traffic profile mapping",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "description": "User traffic profile mapping",
        "properties": {
          "groupAttr": {
            "type": "string",
            "description": "Group attribute"
          },
          "userRole": {
            "type": "object",
            "additionalProperties": false,
            "description": "Identity user role",
            "properties": {
              "id": {
                "type": "string",
                "description": "Identity user role UUID"
              },
              "name": {
                "description": "Identity user role name",
                "type": "string",
                "minLength": 2,
                "maxLength": 64,
                "pattern": "^[!-~]([ -~]){0,62}[!-~]$"
              }
            }
          }
        },
        "required": [
          "groupAttr",
          "userRole"
        ]
      }
    },
    "standbyServerEnabled": {
      "description": "StandbyCluster different AAA Settings Enabled",
      "type": "boolean",
      "default": false
    },
    "standbyIp": {
      "description": "IP address - Standby Cluster settings",
      "type": "string"
    },
    "standbyPort": {
      "description": "Port - Standby Cluster settings",
      "type": "integer"
    },
    "standbyWindowsDomainName": {
      "description": "Windows domain name - Standby Cluster settings",
      "type": "string"
    },
    "standbyAdminDomainName": {
      "description": "Admin domain name - Standby Cluster settings",
      "type": "string"
    },
    "standbyPassword": {
      "description": "Admin password - Standby Cluster settings",
      "type": "string"
    },
    "standbyGlobalCatalogEnabled": {
      "description": "Enable global catalog support - Standby Cluster settings",
      "type": "boolean"
    }
  },
  "required": [
    "name",
    "ip",
    "port",
    "globalCatalogEnabled"
  ]
}
Response  201
HideShow
Body
{
  "id": "RADIUSServerUUID"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Modify Entire - ActiveDirectory

PUT/v8_1/rkszones/{zoneId}/aaa/ad/{id}

Use this API command to modify the basic information on active directory server of a zone by complete attributes.

Request
HideShow
Body
{
  "name": "new name",
  "ip": "192.168.1.2",
  "port": 3268,
  "globalCatalogEnabled": true,
  "adminDomainName": "[email protected]",
  "password": "admin",
  "mappings": [
    {
      "groupAttr": "newGroupAttr",
      "userRole": {
        "id": "identity user role UUID"
      }
    },
    {
      "groupAttr": "*",
      "userRole": {
        "name": "identity user role name"
      }
    }
  ],
  "standbyServerEnabled": false
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "description": "Name of the active directory server",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "Description of the active directory server",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "ip": {
      "description": "IP address",
      "type": "string"
    },
    "port": {
      "description": "Port",
      "type": "integer",
      "minimum": 1,
      "maximum": 65535
    },
    "windowsDomainName": {
      "description": "Windows domain name",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64,
      "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$"
    },
    "adminDomainName": {
      "description": "Admin domain name",
      "type": "string",
      "minLength": 2,
      "maxLength": 64,
      "pattern": "^[!-~]([ -~]){0,62}[!-~]$"
    },
    "password": {
      "description": "Admin password",
      "type": "string"
    },
    "globalCatalogEnabled": {
      "description": "Enable global catalog support",
      "type": "boolean"
    },
    "mappings": {
      "type": "array",
      "description": "Group attribute and user traffic profile mapping",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "description": "User traffic profile mapping",
        "properties": {
          "groupAttr": {
            "type": "string",
            "description": "Group attribute"
          },
          "userRole": {
            "type": "object",
            "additionalProperties": false,
            "description": "Identity user role",
            "properties": {
              "id": {
                "type": "string",
                "description": "Identity user role UUID"
              },
              "name": {
                "description": "Identity user role name",
                "type": "string",
                "minLength": 2,
                "maxLength": 64,
                "pattern": "^[!-~]([ -~]){0,62}[!-~]$"
              }
            }
          }
        },
        "required": [
          "groupAttr",
          "userRole"
        ]
      }
    },
    "standbyServerEnabled": {
      "description": "StandbyCluster different AAA Settings Enabled",
      "type": "boolean"
    },
    "standbyIp": {
      "description": "IP address - Standby Cluster settings",
      "type": "string"
    },
    "standbyPort": {
      "description": "Port - Standby Cluster settings",
      "type": "integer"
    },
    "standbyWindowsDomainName": {
      "description": "Windows domain name - Standby Cluster settings",
      "type": "string"
    },
    "standbyAdminDomainName": {
      "description": "Admin domain name - Standby Cluster settings",
      "type": "string"
    },
    "standbyPassword": {
      "description": "Admin password - Standby Cluster settings",
      "type": "string"
    },
    "standbyGlobalCatalogEnabled": {
      "description": "Enable global catalog support - Standby Cluster settings",
      "type": "boolean"
    }
  }
}
Response  204

Modify - ActiveDirectory

PATCH/v8_1/rkszones/{zoneId}/aaa/ad/{id}

Use this API command to modify the basic information on active directory server of a zone.

Request
HideShow
Body
{
  "name": "new name",
  "ip": "192.168.1.2",
  "port": 3268,
  "globalCatalogEnabled": true,
  "adminDomainName": "[email protected]",
  "password": "admin",
  "mappings": [
    {
      "groupAttr": "newGroupAttr",
      "userRole": {
        "id": "identity user role UUID"
      }
    },
    {
      "groupAttr": "*",
      "userRole": {
        "name": "identity user role name"
      }
    }
  ],
  "standbyServerEnabled": false
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "description": "Name of the active directory server",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "Description of the active directory server",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "ip": {
      "description": "IP address",
      "type": "string"
    },
    "port": {
      "description": "Port",
      "type": "integer",
      "minimum": 1,
      "maximum": 65535
    },
    "windowsDomainName": {
      "description": "Windows domain name",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64,
      "pattern": "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$"
    },
    "adminDomainName": {
      "description": "Admin domain name",
      "type": "string",
      "minLength": 2,
      "maxLength": 64,
      "pattern": "^[!-~]([ -~]){0,62}[!-~]$"
    },
    "password": {
      "description": "Admin password",
      "type": "string"
    },
    "globalCatalogEnabled": {
      "description": "Enable global catalog support",
      "type": "boolean"
    },
    "mappings": {
      "type": "array",
      "description": "Group attribute and user traffic profile mapping",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "description": "User traffic profile mapping",
        "properties": {
          "groupAttr": {
            "type": "string",
            "description": "Group attribute"
          },
          "userRole": {
            "type": "object",
            "additionalProperties": false,
            "description": "Identity user role",
            "properties": {
              "id": {
                "type": "string",
                "description": "Identity user role UUID"
              },
              "name": {
                "description": "Identity user role name",
                "type": "string",
                "minLength": 2,
                "maxLength": 64,
                "pattern": "^[!-~]([ -~]){0,62}[!-~]$"
              }
            }
          }
        },
        "required": [
          "groupAttr",
          "userRole"
        ]
      }
    },
    "standbyServerEnabled": {
      "description": "StandbyCluster different AAA Settings Enabled",
      "type": "boolean"
    },
    "standbyIp": {
      "description": "IP address - Standby Cluster settings",
      "type": "string"
    },
    "standbyPort": {
      "description": "Port - Standby Cluster settings",
      "type": "integer"
    },
    "standbyWindowsDomainName": {
      "description": "Windows domain name - Standby Cluster settings",
      "type": "string"
    },
    "standbyAdminDomainName": {
      "description": "Admin domain name - Standby Cluster settings",
      "type": "string"
    },
    "standbyPassword": {
      "description": "Admin password - Standby Cluster settings",
      "type": "string"
    },
    "standbyGlobalCatalogEnabled": {
      "description": "Enable global catalog support - Standby Cluster settings",
      "type": "boolean"
    }
  }
}
Response  204

Delete - ActiveDirectory

DELETE/v8_1/rkszones/{zoneId}/aaa/ad/{id}

Use this API command to delete an active directory server of a zone.

Response  204

Retrieve List - LDAP

GET/v8_1/rkszones/{zoneId}/aaa/ldap

Use this API command to retrieve a list of LDAP servers of a zone.

Response  200
HideShow
Body
{
  "totalCount": 1,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "id": "32fb8816-60e7-46df-876b-038c655278d4",
      "mvnoId": "839f87c6-d116-497e-afce-aa8157abd30c",
      "zoneId": "3c7fd7f4-68bd-4957-a698-a1a810888959",
      "name": "rapheal-ldap",
      "description": "",
      "ip": "1.1.1.1",
      "port": 389,
      "baseDomainName": "dc=ldap",
      "adminDomainName": "ibm",
      "password": "admin",
      "keyAttribute": "uid",
      "searchFilter": "objectClass=*",
      "mappings": [
        {
          "id": "afa788e0-6afd-11e4-b9bb-08002716c79f",
          "groupAttr": "*",
          "userRole": {
            "id": "636431d6-c06e-4692-a28f-3914afc2a817",
            "name": "identity user role name",
            "userTrafficProfile": {
              "id": "fbde8510-6972-11e4-926e-08002716c79f",
              "name": "System Default"
            }
          }
        },
        {
          "id": "afaa4800-6afd-11e4-b9bb-08002716c79f",
          "groupAttr": "abcd",
          "userRole": {
            "id": "636431d6-c06e-4692-a28f-3914afc2a817",
            "name": "identity user role name",
            "userTrafficProfile": {
              "id": "fbde8510-6972-11e4-926e-08002716c79f",
              "name": "System Default"
            }
          }
        }
      ]
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "Identifier of the LDAP server",
            "type": "string"
          },
          "zoneId": {
            "description": "Identifier of the zone which the LDAP server belongs to",
            "type": "string"
          },
          "mvnoId": {
            "description": "Tenant UUID",
            "type": "string"
          },
          "name": {
            "description": "Name of the LDAP server",
            "type": "string"
          },
          "description": {
            "description": "Description of the LDAP server",
            "type": "string"
          },
          "ip": {
            "description": "IP address",
            "type": "string"
          },
          "port": {
            "description": "Port",
            "type": "integer"
          },
          "baseDomainName": {
            "description": "Base domain name",
            "type": "string"
          },
          "adminDomainName": {
            "description": "Admin domain name",
            "type": "string"
          },
          "password": {
            "description": "Admin password",
            "type": "string"
          },
          "keyAttribute": {
            "description": "Key attribute",
            "type": "string"
          },
          "searchFilter": {
            "description": "Search filter",
            "type": "string"
          },
          "mappings": {
            "type": "array",
            "description": "Group attribute and user traffic profile mapping",
            "items": {
              "type": "object",
              "additionalProperties": false,
              "description": "User traffic profile mapping",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Group attribute mapping UUID"
                },
                "groupAttr": {
                  "type": "string",
                  "description": "Group attribute"
                },
                "userRole": {
                  "type": "object",
                  "additionalProperties": false,
                  "description": "Identity user role",
                  "properties": {
                    "id": {
                      "type": "string",
                      "description": "Identity user role UUID"
                    },
                    "name": {
                      "description": "Identity user role name",
                      "type": "string",
                      "minLength": 2,
                      "maxLength": 64,
                      "pattern": "^[!-~]([ -~]){0,62}[!-~]$"
                    },
                    "userTrafficProfile": {
                      "type": "object",
                      "description": "Identity user role",
                      "properties": {
                        "id": {
                          "type": "string",
                          "description": "User traffic profile UUID"
                        },
                        "name": {
                          "type": "string",
                          "description": "User traffic profile name"
                        }
                      }
                    }
                  }
                }
              },
              "required": [
                "groupAttr",
                "userRole"
              ]
            }
          },
          "standbyServerEnabled": {
            "description": "StandbyCluster different AAA Settings Enabled",
            "type": "boolean"
          },
          "standbyIp": {
            "description": "IP address - Standby Cluster settings ",
            "type": "string"
          },
          "standbyPort": {
            "description": "Port - Standby Cluster settings ",
            "type": "integer"
          },
          "standbyBaseDomainName": {
            "description": "Base domain name - Standby Cluster settings ",
            "type": "string"
          },
          "standbyAdminDomainName": {
            "description": "Admin domain name - Standby Cluster settings ",
            "type": "string"
          },
          "standbyPassword": {
            "description": "Admin password - Standby Cluster settings ",
            "type": "string"
          },
          "standbyKeyAttribute": {
            "description": "Key attribute - Standby Cluster settings ",
            "type": "string"
          },
          "standbySearchFilter": {
            "description": "Search filter - Standby Cluster settings ",
            "type": "string"
          }
        }
      }
    }
  }
}

Retrieve - LDAP

GET/v8_1/rkszones/{zoneId}/aaa/ldap/{id}

Use this API command to retrieve a LDAP server of a zone.

Response  200
HideShow
Body
{
  "id": "32fb8816-60e7-46df-876b-038c655278d4",
  "mvnoId": "839f87c6-d116-497e-afce-aa8157abd30c",
  "zoneId": "3c7fd7f4-68bd-4957-a698-a1a810888959",
  "name": "rapheal-ldap",
  "description": "",
  "ip": "1.1.1.1",
  "port": 389,
  "baseDomainName": "dc=ldap",
  "adminDomainName": "ibm",
  "password": "admin",
  "keyAttribute": "uid",
  "searchFilter": "objectClass=*",
  "mappings": [
    {
      "id": "afa788e0-6afd-11e4-b9bb-08002716c79f",
      "groupAttr": "*",
      "userRole": {
        "id": "636431d6-c06e-4692-a28f-3914afc2a817",
        "name": "identity user role name",
        "userTrafficProfile": {
          "id": "fbde8510-6972-11e4-926e-08002716c79f",
          "name": "System Default"
        }
      }
    },
    {
      "id": "afaa4800-6afd-11e4-b9bb-08002716c79f",
      "groupAttr": "abcd",
      "userRole": {
        "id": "636431d6-c06e-4692-a28f-3914afc2a817",
        "name": "identity user role name",
        "userTrafficProfile": {
          "id": "fbde8510-6972-11e4-926e-08002716c79f",
          "name": "System Default"
        }
      }
    }
  ],
  "standbyServerEnabled": true,
  "standbyIp": "2.2.2.2",
  "standbyPort": 389,
  "standbyBaseDomainName": "dc=ldap",
  "standbyAdminDomainName": "uid=admin, dc=ldap, dc=com",
  "standbyPassword": "admin",
  "standbyKeyAttribute": "uid",
  "standbySearchFilter": "objectClass=*"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "Identifier of the LDAP server",
      "type": "string"
    },
    "zoneId": {
      "description": "Identifier of the zone which the LDAP server belongs to",
      "type": "string"
    },
    "mvnoId": {
      "description": "Tenant UUID",
      "type": "string"
    },
    "name": {
      "description": "Name of the LDAP server",
      "type": "string"
    },
    "description": {
      "description": "Description of the LDAP server",
      "type": "string"
    },
    "ip": {
      "description": "IP address",
      "type": "string"
    },
    "port": {
      "description": "Port",
      "type": "integer"
    },
    "baseDomainName": {
      "description": "Base domain name",
      "type": "string"
    },
    "adminDomainName": {
      "description": "Admin domain name",
      "type": "string"
    },
    "password": {
      "description": "Admin password",
      "type": "string"
    },
    "keyAttribute": {
      "description": "Key attribute",
      "type": "string"
    },
    "searchFilter": {
      "description": "Search filter",
      "type": "string"
    },
    "mappings": {
      "type": "array",
      "description": "Group attribute and user traffic profile mapping",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "description": "User traffic profile mapping",
        "properties": {
          "id": {
            "type": "string",
            "description": "Group attribute mapping UUID"
          },
          "groupAttr": {
            "type": "string",
            "description": "Group attribute"
          },
          "userRole": {
            "type": "object",
            "additionalProperties": false,
            "description": "Identity user role",
            "properties": {
              "id": {
                "type": "string",
                "description": "Identity user role UUID"
              },
              "name": {
                "description": "Identity user role name",
                "type": "string",
                "minLength": 2,
                "maxLength": 64,
                "pattern": "^[!-~]([ -~]){0,62}[!-~]$"
              },
              "userTrafficProfile": {
                "type": "object",
                "description": "Identity user role",
                "properties": {
                  "id": {
                    "type": "string",
                    "description": "User traffic profile UUID"
                  },
                  "name": {
                    "type": "string",
                    "description": "User traffic profile name"
                  }
                }
              }
            }
          }
        },
        "required": [
          "groupAttr",
          "userRole"
        ]
      }
    },
    "standbyServerEnabled": {
      "description": "StandbyCluster different AAA Settings Enabled",
      "type": "boolean"
    },
    "standbyIp": {
      "description": "IP address - Standby Cluster settings ",
      "type": "string"
    },
    "standbyPort": {
      "description": "Port - Standby Cluster settings ",
      "type": "integer"
    },
    "standbyBaseDomainName": {
      "description": "Base domain name - Standby Cluster settings ",
      "type": "string"
    },
    "standbyAdminDomainName": {
      "description": "Admin domain name - Standby Cluster settings ",
      "type": "string"
    },
    "standbyPassword": {
      "description": "Admin password - Standby Cluster settings ",
      "type": "string"
    },
    "standbyKeyAttribute": {
      "description": "Key attribute - Standby Cluster settings ",
      "type": "string"
    },
    "standbySearchFilter": {
      "description": "Search filter - Standby Cluster settings ",
      "type": "string"
    }
  }
}

Create - LDAP

POST/v8_1/rkszones/{zoneId}/aaa/ldap

Use this API command to create a new LDAP server of a zone.

Request
HideShow
Body
{
  "name": "rapheal-ldap",
  "ip": "1.1.1.2",
  "port": 389,
  "baseDomainName": "dc=ldap",
  "adminDomainName": "ibm",
  "password": "admin",
  "keyAttribute": "uid",
  "searchFilter": "objectClass=*",
  "standbyServerEnabled": true,
  "standbyIp": "2.2.2.2",
  "standbyPort": 389,
  "standbyBaseDomainName": "dc=ldap",
  "standbyAdminDomainName": "uid=admin, dc=ldap, dc=com",
  "standbyPassword": "admin",
  "standbyKeyAttribute": "uid",
  "standbySearchFilter": "objectClass=*"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "description": "Name of the LDAP server",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "Description of the LDAP server",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "ip": {
      "description": "IP address",
      "type": "string"
    },
    "port": {
      "description": "Port",
      "type": "integer",
      "minimum": 1,
      "maximum": 65535,
      "default": 389
    },
    "baseDomainName": {
      "description": "Base domain name",
      "type": "string",
      "minLength": 2,
      "maxLength": 64,
      "pattern": "^[!-~]([ -~]){0,62}[!-~]$"
    },
    "adminDomainName": {
      "description": "Admin domain name",
      "type": "string",
      "minLength": 2,
      "maxLength": 128,
      "pattern": "^[!-~]([ -~]){0,126}[!-~]$"
    },
    "password": {
      "description": "Admin password",
      "type": "string"
    },
    "keyAttribute": {
      "description": "Key attribute",
      "type": "string",
      "minLength": 2,
      "maxLength": 64,
      "pattern": "^[!-~]([ -~]){0,62}[!-~]$"
    },
    "searchFilter": {
      "description": "Search filter",
      "type": "string",
      "minLength": 2,
      "maxLength": 64,
      "pattern": "^[!-~]([ -~]){0,62}[!-~]$"
    },
    "mappings": {
      "type": "array",
      "description": "Group attribute and user traffic profile mapping",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "description": "User traffic profile mapping",
        "properties": {
          "groupAttr": {
            "type": "string",
            "description": "Group attribute"
          },
          "userRole": {
            "type": "object",
            "additionalProperties": false,
            "description": "Identity user role",
            "properties": {
              "id": {
                "type": "string",
                "description": "Identity user role UUID"
              },
              "name": {
                "description": "Identity user role name",
                "type": "string",
                "minLength": 2,
                "maxLength": 64,
                "pattern": "^[!-~]([ -~]){0,62}[!-~]$"
              }
            }
          }
        },
        "required": [
          "groupAttr",
          "userRole"
        ]
      }
    },
    "standbyServerEnabled": {
      "description": "StandbyCluster different AAA Settings Enabled",
      "type": "boolean",
      "default": false
    },
    "standbyIp": {
      "description": "IP address - Standby Cluster settings ",
      "type": "string"
    },
    "standbyPort": {
      "description": "Port - Standby Cluster settings ",
      "type": "integer"
    },
    "standbyBaseDomainName": {
      "description": "Base domain name - Standby Cluster settings ",
      "type": "string"
    },
    "standbyAdminDomainName": {
      "description": "Admin domain name - Standby Cluster settings ",
      "type": "string"
    },
    "standbyPassword": {
      "description": "Admin password - Standby Cluster settings ",
      "type": "string"
    },
    "standbyKeyAttribute": {
      "description": "Key attribute - Standby Cluster settings ",
      "type": "string"
    },
    "standbySearchFilter": {
      "description": "Search filter - Standby Cluster settings ",
      "type": "string"
    }
  },
  "required": [
    "name",
    "ip",
    "port",
    "baseDomainName",
    "adminDomainName",
    "password",
    "keyAttribute",
    "searchFilter"
  ]
}
Response  201
HideShow
Body
{
  "id": "RADIUSServerUUID"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Modify Entire - LDAP

PUT/v8_1/rkszones/{zoneId}/aaa/ldap/{id}

Use this API command to modify the basic information on LDAP server of a zone by complete attributes.

Request
HideShow
Body
{
  "name": "rapheal-ldap2",
  "ip": "1.1.1.22",
  "port": 389,
  "baseDomainName": "dc=ldap",
  "adminDomainName": "ibm",
  "password": "admin",
  "keyAttribute": "uid",
  "searchFilter": "objectClass=*",
  "mappings": [
    {
      "groupAttr": "newGroupAttr",
      "userRole": {
        "id": "identity user role UUID"
      }
    },
    {
      "groupAttr": "*",
      "userRole": {
        "name": "identity user role name"
      }
    }
  ],
  "standbyServerEnabled": true,
  "standbyIp": "2.2.2.2",
  "standbyPort": 389,
  "standbyBaseDomainName": "dc=ldap",
  "standbyAdminDomainName": "uid=admin, dc=ldap, dc=com",
  "standbyPassword": "admin",
  "standbyKeyAttribute": "uid",
  "standbySearchFilter": "objectClass=*"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "description": "Name of the LDAP server",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "Description of the LDAP server",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "ip": {
      "description": "IP address",
      "type": "string"
    },
    "port": {
      "description": "Port",
      "type": "integer",
      "minimum": 1,
      "maximum": 65535
    },
    "baseDomainName": {
      "description": "Base domain name",
      "type": "string",
      "minLength": 2,
      "maxLength": 64,
      "pattern": "^[!-~]([ -~]){0,62}[!-~]$"
    },
    "adminDomainName": {
      "description": "Admin domain name",
      "type": "string",
      "minLength": 2,
      "maxLength": 128,
      "pattern": "^[!-~]([ -~]){0,126}[!-~]$"
    },
    "password": {
      "description": "Admin password",
      "type": "string"
    },
    "keyAttribute": {
      "description": "Key attribute",
      "type": "string",
      "minLength": 2,
      "maxLength": 64,
      "pattern": "^[!-~]([ -~]){0,62}[!-~]$"
    },
    "searchFilter": {
      "description": "Search filter",
      "type": "string",
      "minLength": 2,
      "maxLength": 64,
      "pattern": "^[!-~]([ -~]){0,62}[!-~]$"
    },
    "mappings": {
      "type": "array",
      "description": "Group attribute and user traffic profile mapping",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "description": "User traffic profile mapping",
        "properties": {
          "groupAttr": {
            "type": "string",
            "description": "Group attribute"
          },
          "userRole": {
            "type": "object",
            "additionalProperties": false,
            "description": "Identity user role",
            "properties": {
              "id": {
                "type": "string",
                "description": "Identity user role UUID"
              },
              "name": {
                "description": "Identity user role name",
                "type": "string",
                "minLength": 2,
                "maxLength": 64,
                "pattern": "^[!-~]([ -~]){0,62}[!-~]$"
              }
            }
          }
        },
        "required": [
          "groupAttr",
          "userRole"
        ]
      }
    },
    "standbyServerEnabled": {
      "description": "StandbyCluster different AAA Settings Enabled",
      "type": "boolean"
    },
    "standbyIp": {
      "description": "IP address - Standby Cluster settings ",
      "type": "string"
    },
    "standbyPort": {
      "description": "Port - Standby Cluster settings ",
      "type": "integer"
    },
    "standbyBaseDomainName": {
      "description": "Base domain name - Standby Cluster settings ",
      "type": "string"
    },
    "standbyAdminDomainName": {
      "description": "Admin domain name - Standby Cluster settings ",
      "type": "string"
    },
    "standbyPassword": {
      "description": "Admin password - Standby Cluster settings ",
      "type": "string"
    },
    "standbyKeyAttribute": {
      "description": "Key attribute - Standby Cluster settings ",
      "type": "string"
    },
    "standbySearchFilter": {
      "description": "Search filter - Standby Cluster settings ",
      "type": "string"
    }
  }
}
Response  204

Modify - LDAP

PATCH/v8_1/rkszones/{zoneId}/aaa/ldap/{id}

Use this API command to modify the basic information on LDAP server of a zone.

Request
HideShow
Body
{
  "name": "rapheal-ldap2",
  "ip": "1.1.1.22",
  "port": 389,
  "baseDomainName": "dc=ldap",
  "adminDomainName": "ibm",
  "password": "admin",
  "keyAttribute": "uid",
  "searchFilter": "objectClass=*",
  "mappings": [
    {
      "groupAttr": "newGroupAttr",
      "userRole": {
        "id": "identity user role UUID"
      }
    },
    {
      "groupAttr": "*",
      "userRole": {
        "name": "identity user role name"
      }
    }
  ],
  "standbyServerEnabled": true,
  "standbyIp": "2.2.2.2",
  "standbyPort": 389,
  "standbyBaseDomainName": "dc=ldap",
  "standbyAdminDomainName": "uid=admin, dc=ldap, dc=com",
  "standbyPassword": "admin",
  "standbyKeyAttribute": "uid",
  "standbySearchFilter": "objectClass=*"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "description":