Back to top

Virtual SmartZone - Essentials Public API Reference Guide

Overview

This reference guide describes the public APIs supported by the SmartCell Gateway (SCG) 200. 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, Please try it for free.
Installed Smart Zone Software Release and link to https://{host}:8443/wsg/apiDoc/openapi for the detail.
You can get the usage at https://swagger.io/, use the Swagger tools to meet your needs.

Version Matrix

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

VSZ-E Version API Version
5.1.2 v6_0 v6_1 v7_0 v8_0 v8_1 v8_2

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/East-Saskatchewan
Canada/EasternCanada/MountainCanada/Newfoundland
Canada/PacificCanada/SaskatchewanCanada/Yukon
Chile/ContinentalChile/EasterIslandCuba
EETEST5EDTEgypt
EireEurope/AmsterdamEurope/Andorra
Europe/AstrakhanEurope/AthensEurope/Belfast
Europe/BelgradeEurope/BerlinEurope/Bratislava
Europe/BrusselsEurope/BucharestEurope/Budapest
Europe/BusingenEurope/ChisinauEurope/Copenhagen
Europe/DublinEurope/GibraltarEurope/Guernsey
Europe/HelsinkiEurope/Isle_of_ManEurope/Istanbul
Europe/JerseyEurope/KaliningradEurope/Kiev
Europe/KirovEurope/LisbonEurope/Ljubljana
Europe/LondonEurope/LuxembourgEurope/Madrid
Europe/MaltaEurope/MariehamnEurope/Minsk
Europe/MonacoEurope/MoscowEurope/Nicosia
Europe/OsloEurope/ParisEurope/Podgorica
Europe/PragueEurope/RigaEurope/Rome
Europe/SamaraEurope/San_MarinoEurope/Sarajevo
Europe/SaratovEurope/SimferopolEurope/Skopje
Europe/SofiaEurope/StockholmEurope/Tallinn
Europe/TiraneEurope/TiraspolEurope/Ulyanovsk
Europe/UzhgorodEurope/VaduzEurope/Vatican
Europe/ViennaEurope/VilniusEurope/Volgograd
Europe/WarsawEurope/ZagrebEurope/Zaporozhye
Europe/ZurichGBGB-Eire
GMTGMT0Greenwich
HongkongIcelandIndian/Antananarivo
Indian/ChagosIndian/ChristmasIndian/Cocos
Indian/ComoroIndian/KerguelenIndian/Mahe
Indian/MaldivesIndian/MauritiusIndian/Mayotte
Indian/ReunionIranIsrael
JamaicaKwajaleinLibya
METMST7MDTMexico/BajaNorte
Mexico/BajaSurMexico/GeneralNZ
NZ-CHATNavajoPRC
PST8PDTPacific/ApiaPacific/Auckland
Pacific/BougainvillePacific/ChathamPacific/Chuuk
Pacific/EasterPacific/EfatePacific/Enderbury
Pacific/FakaofoPacific/FijiPacific/Funafuti
Pacific/GalapagosPacific/GambierPacific/Guadalcanal
Pacific/GuamPacific/HonoluluPacific/Johnston
Pacific/KiritimatiPacific/KosraePacific/Kwajalein
Pacific/MajuroPacific/MarquesasPacific/Midway
Pacific/NauruPacific/NiuePacific/Norfolk
Pacific/NoumeaPacific/Pago_PagoPacific/Palau
Pacific/PitcairnPacific/PohnpeiPacific/Ponape
Pacific/Port_MoresbyPacific/RarotongaPacific/Saipan
Pacific/SamoaPacific/TahitiPacific/Tarawa
Pacific/TongatapuPacific/TrukPacific/Wake
Pacific/WallisPacific/YapPoland
PortugalROKTurkey
UCTUS/AlaskaUS/Aleutian
US/ArizonaUS/CentralUS/East-Indiana
US/EasternUS/HawaiiUS/Indiana-Starke
US/MichiganUS/MountainUS/Pacific
US/Pacific-NewUS/SamoaUTC
UniversalW-SUWET
ZuluESTHST
MSTACTAET
AGTARTAST
BETBSTCAT
CNTCSTCTT
EATECTIET
ISTJSTMIT
NETNSTPLT
PNTPRTPST
SSTVST

Usage for Query Criteria

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

What’s New

  • API

    • Rogue Client
      • Query Rogue Client List
    • Bonjour Gateway Policies
      • Modify Enable
    • System
      • Modify security setting
      • Retrieve security setting
      • Create AP Mac OUI.
      • Update AP Mac OUI.
      • Delete AP Mac OUI.
      • Retrieve a list of AP Mac OUIs.
  • Properties

    • AP Group
      • Retrieve
        • monitoringEnabled, apGroupRoguePolicy, rogueScanFreq
      • Retrieve Default AP Group
        • monitoringEnabled, apGroupRoguePolicy, rogueScanFreq
      • Modify
        • monitoringEnabled, apGroupRoguePolicy, rogueScanFreq
      • Create
        • monitoringEnabled, apGroupRoguePolicy, rogueScanFreq
    • Account Security
      • Get the account security profile by id
        • attemptsLockEnabled, attemptsLockoutTimes, attemptsLockoutPeriod, passwordComplexityEnabled, minimumPasswordLifetimeEnabled
      • Modify
        • attemptsLockEnabled, attemptsLockoutTimes, attemptsLockoutPeriod, passwordComplexityEnabled, minimumPasswordLifetimeEnabled
      • Modify the account security profile
        • attemptsLockEnabled, attemptsLockoutTimes, attemptsLockoutPeriod, passwordComplexityEnabled, minimumPasswordLifetimeEnabled
      • Create the account security profile.
        • attemptsLockEnabled, attemptsLockoutTimes, attemptsLockoutPeriod, passwordComplexityEnabled, minimumPasswordLifetimeEnabled
    • Access Point Operational
      • Retrieve Operational Information
        • ipv6Type, ipv6
    • DP Network
      • Retrieve
        • interfaceMode, primaryInterface, ipv6PrimaryInterface, secondaryInterface, staticRoute, keepConfig, isDataCenter
    • SCG User
      • Update SCG user
        • passwordComplexityEnabled, minimumPasswordLifetimeEnabled
      • Get SCG user
        • passwordComplexityEnabled, minimumPasswordLifetimeEnabled
      • Add SCG user
        • passwordComplexityEnabled, minimumPasswordLifetimeEnabled
    • Ruckus Wireless AP Zone
      • Create Zone of IPv6
        • awsVenue
      • Create Zone of Dual
        • awsVenue
      • Create Zone
        • awsVenue
    • System
      • Get Settings of System
        • apMacOUIEnabled
      • Modify System Time
        • secondaryNtpServer, secondaryAuthenticationKey
      • Modify Settings of System
        • apMacOUIEnabled
      • Retrieve System Time
        • secondaryNtpServer, secondaryAuthenticationKey

What’s Deprecated

  • API
    • Wireless Client
      • Retrieve Client List
    • System
      • Modify CAPTCHA

API Information

Retrieve API information

GET/apiInfo

Use this API command to retrieve API information.

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

Logon

Service Ticket

  • Logon

POST/v8_2/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_2/serviceTicket

Use this API command to log off of the controller.

URI Parameters
HideShow
serviceTicket
string (required) 
Response  200

Session ID

  • Retrieve

GET/v8_2/session

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

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

  • Logon

POST/v8_2/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_2/session

Use this API command to log off of the controller.

Response  200

Session Management

Retrieve

GET/v8_2/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 Mesh Configuration

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

Retrieve AP Model

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

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

Response  200
HideShow
Body
{
  "ledStatusEnabled": true,
  "lacp": {
    "keepApSetting": false,
    "enabled": true
  },
  "lldp": {
    "enabled": true,
    "advertiseIntervalInSec": 30,
    "holdTimeInSec": 120,
    "managementIPTLVEnabled": false
  },
  "cellularSettings": {
    "mobileAPName": "internet",
    "mobileAPName2": "internet",
    "simCardUsage": 0,
    "select3g4g": 0,
    "select3g4g2": 0,
    "dataRoaming": 1,
    "dataRoaming2": 1,
    "wanConnection": 0,
    "wanRecoveryTimer": 60
  },
  "ledMode": null,
  "internalHeaterEnabled": null,
  "poeOutPortEnabled": null,
  "usbPowerEnable": true,
  "poeModeSetting": "Auto",
  "poeTxChain": 2,
  "radioBand": null,
  "externalAntenna24": null,
  "externalAntenna50": null,
  "lanPorts": [
    {
      "portName": "LAN1",
      "enabled": false,
      "ethPortProfile": null
    },
    {
      "portName": "LAN2",
      "enabled": true,
      "ethPortProfile": {
        "id": "0",
        "name": "Default Trunk Port"
      }
    },
    {
      "portName": "LAN3",
      "enabled": true,
      "ethPortProfile": {
        "id": "1",
        "name": "Default Access Port"
      }
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "ledStatusEnabled": {
      "type": [
        "boolean",
        "null"
      ]
    },
    "lldp": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "enabled": {
          "type": "boolean",
          "default": true
        },
        "advertiseIntervalInSec": {
          "type": [
            "integer",
            "null"
          ],
          "minimum": 1,
          "maximum": 300
        },
        "holdTimeInSec": {
          "type": [
            "integer",
            "null"
          ],
          "minimum": 60,
          "maximum": 1200
        },
        "managementIPTLVEnabled": {
          "type": [
            "boolean",
            "null"
          ]
        }
      },
      "required": [
        "enabled"
      ]
    },
    "lacp": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "keepApSetting": {
          "type": "boolean"
        },
        "enabled": {
          "type": "boolean"
        }
      }
    },
    "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"
        ]
      }
    }
  }
}

Retrieve AP Model Common Attribute

GET/v8_2/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": "integer",
      "format": "int64"
    },
    "poeModeCaps": {
      "type": "string"
    }
  }
}

Retrieve AP Firmware List

GET/v8_2/rkszones/{zoneId}/apFirmware

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

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

Get Available GRE Tunnel Profiles.

GET/v8_2/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_2/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 List

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

Retrieve

GET/v8_2/rkszones/{id}

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

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

Create Zone of IPv6

POST/v8_2/rkszones/ipv6

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

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

Create Zone of Dual

POST/v8_2/rkszones/dual

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

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

Create Zone

POST/v8_2/rkszones

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

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

Modify entire zone

PUT/v8_2/rkszones/{id}

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

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

Modify AP Model

PUT/v8_2/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": {
    "keepApSetting": false,
    "enabled": true
  },
  "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": {
        "keepApSetting": {
          "type": "boolean"
        },
        "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

Change AP Firmware

PUT/v8_2/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

Modify

PATCH/v8_2/rkszones/{id}

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

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

Clear Mesh Configuration

DELETE/v8_2/rkszones/{id}/mesh

Use this API command to disable mesh networking.

Response  204

Disable Syslog

DELETE/v8_2/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_2/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_2/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_2/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_2/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_2/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_2/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_2/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_2/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_2/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_2/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_2/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_2/rkszones/{id}/altitude

Use this API command to disable altitude configuration of zone.

Response  204

Clear AP SNMP Options

DELETE/v8_2/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_2/rkszones/{id}/recoverySsid

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

Response  204

Follow System Time Zone

DELETE/v8_2/rkszones/{id}/timezone

Use this API command to reset the time zone with system time zone of a zone.

Response  204

Delete IPsec Profiles

DELETE/v8_2/rkszones/{id}/softGreTunnelProflies

Use this API command to Delete IPsec profiles.

Response  204

Delete IPsec Profiles

DELETE/v8_2/rkszones/{id}/ipsecProfiles

Use this API command to Delete IPsec profiles.

Response  204

Delete

DELETE/v8_2/rkszones/{id}

Use this API command to delete a zone.

Response  204

AP Group

Retrieve

GET/v8_2/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,
  "monitoringEnabled": false,
  "rogueScanFreq": "LOW"
}
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",
      "minLength": 0,
      "maxLength": 64,
      "pattern": "^[!-~]([ -~]){0,63}[!-~]$"
    },
    "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"
          }
        }
      }
    },
    "monitoringEnabled": {
      "description": "Set AP group as monitoring group.",
      "type": "boolean"
    },
    "apGroupRoguePolicy": {
      "description": "Override Rogue AP policy ID (only for monitoring group).",
      "type": "string"
    },
    "rogueScanFreq": {
      "description": "Set rogue scan frequency (only for monitoring group).",
      "type": "string",
      "enum": [
        "LOW",
        "MEDIUM",
        "HIGH"
      ]
    }
  },
  "required": [
    "name"
  ]
}

Retrieve Default AP Group

GET/v8_2/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,
  "monitoringEnabled": false,
  "rogueScanFreq": "LOW"
}
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",
      "minLength": 0,
      "maxLength": 64,
      "pattern": "^[!-~]([ -~]){0,63}[!-~]$"
    },
    "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"
          }
        }
      }
    },
    "monitoringEnabled": {
      "description": "Set AP group as monitoring group.",
      "type": "boolean"
    },
    "apGroupRoguePolicy": {
      "description": "Override Rogue AP policy ID (only for monitoring group).",
      "type": "string"
    },
    "rogueScanFreq": {
      "description": "Set rogue scan frequency (only for monitoring group).",
      "type": "string",
      "enum": [
        "LOW",
        "MEDIUM",
        "HIGH"
      ]
    }
  },
  "required": [
    "name"
  ]
}

Retrieve AP Model

GET/v8_2/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": {
    "keepApSetting": false,
    "enabled": true
  },
  "lldp": {
    "enabled": true,
    "advertiseIntervalInSec": 30,
    "holdTimeInSec": 120,
    "managementIPTLVEnabled": false
  },
  "cellularSettings": {
    "mobileAPName": "internet",
    "mobileAPName2": "internet",
    "simCardUsage": 0,
    "select3g4g": 0,
    "select3g4g2": 0,
    "dataRoaming": 1,
    "dataRoaming2": 1,
    "wanConnection": 0,
    "wanRecoveryTimer": 60
  },
  "ledMode": null,
  "internalHeaterEnabled": null,
  "poeOutPortEnabled": null,
  "usbPowerEnable": true,
  "poeModeSetting": "Auto",
  "poeTxChain": 2,
  "radioBand": null,
  "externalAntenna24": null,
  "externalAntenna50": null,
  "lanPorts": [
    {
      "portName": "LAN1",
      "enabled": false,
      "ethPortProfile": null
    },
    {
      "portName": "LAN2",
      "enabled": true,
      "ethPortProfile": {
        "id": "0",
        "name": "Default Trunk Port"
      }
    },
    {
      "portName": "LAN3",
      "enabled": true,
      "ethPortProfile": {
        "id": "1",
        "name": "Default Access Port"
      }
    }
  ]
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "ledStatusEnabled": {
      "type": [
        "boolean",
        "null"
      ]
    },
    "lldp": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "enabled": {
          "type": "boolean",
          "default": true
        },
        "advertiseIntervalInSec": {
          "type": [
            "integer",
            "null"
          ],
          "minimum": 1,
          "maximum": 300
        },
        "holdTimeInSec": {
          "type": [
            "integer",
            "null"
          ],
          "minimum": 60,
          "maximum": 1200
        },
        "managementIPTLVEnabled": {
          "type": [
            "boolean",
            "null"
          ]
        }
      },
      "required": [
        "enabled"
      ]
    },
    "lacp": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "keepApSetting": {
          "type": "boolean"
        },
        "enabled": {
          "type": "boolean"
        }
      }
    },
    "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"
        ]
      }
    }
  }
}

Retrieve List

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

Add Member

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

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

Response  201

Add Member List

POST/v8_2/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

Create

POST/v8_2/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
  },
  "monitoringEnabled": false,
  "rogueScanFreq": "LOW"
}
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",
      "minLength": 0,
      "maxLength": 64,
      "pattern": "^[!-~]([ -~]){0,63}[!-~]$"
    },
    "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"
          }
        }
      }
    },
    "monitoringEnabled": {
      "description": "Set AP group as monitoring group.",
      "type": "boolean"
    },
    "apGroupRoguePolicy": {
      "description": "Override Rogue AP policy ID (only for monitoring group).",
      "type": "string"
    },
    "rogueScanFreq": {
      "description": "Set rogue scan frequency (only for monitoring group).",
      "type": "string",
      "enum": [
        "LOW",
        "MEDIUM",
        "HIGH"
      ]
    }
  },
  "required": [
    "name"
  ]
}
Response  201
HideShow
Body
{
  "id": "apGroupUUID"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Override AP Model

PUT/v8_2/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": {
    "keepApSetting": false,
    "enabled": true
  },
  "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": {
        "keepApSetting": {
          "type": "boolean"
        },
        "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

Modify

PATCH/v8_2/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": ""
    }
  ],
  "monitoringEnabled": false,
  "rogueScanFreq": "LOW"
}
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",
      "minLength": 0,
      "maxLength": 64,
      "pattern": "^[!-~]([ -~]){0,63}[!-~]$"
    },
    "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"
          }
        }
      }
    },
    "monitoringEnabled": {
      "description": "Set AP group as monitoring group.",
      "type": "boolean"
    },
    "apGroupRoguePolicy": {
      "description": "Override Rogue AP policy ID (only for monitoring group).",
      "type": "string"
    },
    "rogueScanFreq": {
      "description": "Set rogue scan frequency (only for monitoring group).",
      "type": "string",
      "enum": [
        "LOW",
        "MEDIUM",
        "HIGH"
      ]
    }
  }
}
Response  204

Delete

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

Use this API command to delete an AP group.

Response  204

Disable Location Override

DELETE/v8_2/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_2/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_2/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_2/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_2/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_2/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_2/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_2/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_2/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_2/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_2/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_2/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_2/rkszones/{zoneId}/apgroups/{id}/channelEvaluationInterval

Disable Channel Evaluation Interval Override of an AP group.

Response  204

Disable AP Management Vlan Override

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

Disable AP Management Vlan Override of an AP group.

Response  204

Disable Altitude of ApGroup

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

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

Response  204

Disable Radio 2.4G TxPower Override

DELETE/v8_2/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_2/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_2/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_2/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_2/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_2/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_2/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_2/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_2/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_2/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_2/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_2/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_2/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_2/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_2/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_2/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_2/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_2/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_2/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

Remove Member

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

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

Response  204

Disable Override AP Model

DELETE/v8_2/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

Retrieve

GET/v8_2/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": {
      "keepApSetting": false,
      "enabled": true
    },
    "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",
            "description" : "Administrative state of the AP. A locked AP will not provide any WLAN services.",
            "type" : "string",
            "enum" : [ "Locked", "Unlocked" ]
        },
        "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"
                }
            }
        },
        "apGroupId" : {
            "type" : "string"
        },
        "apMgmtVlan" : {
            "description" : "ap Management Vlan",
            "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" : {
            "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
                }
            }
        },
        "awsVenue" : {
            "description" : "Venue code",
            "type" : "string"
        },
        "bonjourGateway" : {
            "description" : "Bonjour gateway of the AP.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "channelEvaluationInterval" : {
            "default" : 600,
            "description" : "channel evaluation Interval of the AP",
            "maximum" : 3600,
            "minimum" : 60,
            "type" : "integer"
        },
        "clientAdmissionControl24" : {
            "description" : "Client admission control configuration of 2.4GHz radio of the AP.",
            "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" : "Client admission control configuration of 5GHz radio of the AP.",
            "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" : {
            "description" : "Description of the AP",
            "type" : [ "string", "null" ],
            "maxLength" : 64
        },
        "gpsSource" : {
            "description" : "GPS Source of the AP",
            "type" : "string",
            "enum" : [ "GPS", "MANUAL" ]
        },
        "latitude" : {
            "description" : "Latitude coordinate (in decimal format) of the AP",
            "type" : "number"
        },
        "location" : {
            "description" : "Location of the AP. It is a text description to indicate the location of the AP.",
            "type" : "string"
        },
        "locationAdditionalInfo" : {
            "description" : "Location additional info of the AP. This is a text description that indicates the location additional info of the AP.",
            "type" : "string",
            "pattern" : "^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
        },
        "login" : {
            "description" : "Logon credentials for the AP. These logon credentials will override the logon credentials specified at the zone level or AP group level.",
            "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" : {
            "description" : "Longitude coordinate (in decimal format) of the AP",
            "type" : "number"
        },
        "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])$"
        },
        "meshOptions" : {
            "description" : "mesh options",
            "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" : {
            "description" : "Model name of the AP",
            "type" : "string"
        },
        "name" : {
            "description" : "Name of the AP",
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 64,
            "pattern" : "^[!-~]((?!\$\()[ -_a-~]){0,62}[!-~]$"
        },
        "network" : {
            "description" : "Network settings ipv4 of the AP.",
            "additionalProperties" : false,
            "properties" : {
                "gateway" : {
                    "description" : "Gateway of the AP",
                    "type" : "string"
                },
                "ip" : {
                    "description" : "IP address of the AP",
                    "type" : "string"
                },
                "ipType" : {
                    "description" : "Indicates how the AP's IP address was obtained. An AP's IP address can be statically or dynamically assigned or kept unchanged.",
                    "type" : "string",
                    "enum" : [ "Dynamic", "Keep", "Static" ]
                },
                "netmask" : {
                    "description" : "Netmask of the AP's subnet",
                    "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" : {
                    "description" : "Primary DNS server address of the AP",
                    "type" : "string"
                },
                "secondaryDns" : {
                    "description" : "Secondary DNS server address of the AP",
                    "type" : "string"
                }
            },
            "type" : "object"
        },
        "networkIpv6" : {
            "description" : "Network settings ipv6 of the AP.",
            "additionalProperties" : false,
            "properties" : {
                "gateway" : {
                    "description" : "Gateway of the AP",
                    "type" : "string"
                },
                "ip" : {
                    "description" : "IP address of the AP",
                    "type" : "string"
                },
                "ipType" : {
                    "description" : "Indicates how the AP's IP address was obtained. An AP's IP address can be statically or dynamically assigned or kept unchanged.",
                    "type" : "string",
                    "enum" : [ "Dynamic", "Keep", "Static" ]
                },
                "primaryDns" : {
                    "description" : "Primary DNS server address of the AP",
                    "type" : "string"
                },
                "secondaryDns" : {
                    "description" : "Secondary DNS server address of the AP",
                    "type" : "string"
                }
            },
            "type" : "object"
        },
        "provisionChecklist" : {
            "description" : "Provision checklist of the AP. This field indicates the steps that have been completed in the AP provisioning process.",
            "type" : "string"
        },
        "serial" : {
            "description" : "Serial number of the AP",
            "type" : "string"
        },
        "smartMonitor" : {
            "description" : "Smart monitor of the AP.",
            "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" : {
            "description" : "Model specific configuration of the AP",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "ledStatusEnabled" : {
                    "type" : [ "boolean", "null" ]
                },
                "lldp" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "enabled" : {
                            "type" : "boolean",
                            "default" : true
                        },
                        "advertiseIntervalInSec" : {
                            "type" : [ "integer", "null" ],
                            "minimum" : 1,
                            "maximum" : 300
                        },
                        "holdTimeInSec" : {
                            "type" : [ "integer", "null" ],
                            "minimum" : 60,
                            "maximum" : 1200
                        },
                        "managementIPTLVEnabled" : {
                            "type" : [ "boolean", "null" ]
                        }
                    },
                    "required" : [ "enabled" ]
                },
                "lacp" : {
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "keepApSetting" : {
                            "type" : "boolean"
                        },
                        "enabled" : {
                            "type" : "boolean"
                        }
                    }
                },
                "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" : {
            "description" : "Syslog configuration of the AP. This configuration will override the syslog configuration at the zone level or AP group level.",
            "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" : {
            "description" : "Venue profile configuration of the AP.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "wifi24" : {
            "description" : "2.4GHz radio configuration of the AP. This configuration will override the radio 2.4GHz configuration at the zone level or AP group level.",
            "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" : "5GHz radio configuration. This configuration will override the 5GHz radio configuration at the zone level or AP group level.",
            "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"
                    }
                },
                "availableChannelRange" : {
                    "description" : "available channel range options",
                    "type" : "array",
                    "items" : {
                        "type" : "integer"
                    }
                }
            }
        },
        "protectionMode24" : {
            "description" : "AP 2.4GHz Protection mode configuration of the AP.",
            "type" : "string",
            "enum" : [ "NONE", "CTS_ONLY", "RTS_CTS" ],
            "default" : "RTS_CTS"
        },
        "wlanGroup24" : {
            "description" : "WLAN group of 2.4GHz radio. This configuration will override the WLAN group of the 2.4GHz radio at the zone level or AP group level.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "description" : "Identifier of the WLAN group",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the WLAN group",
                    "type" : "string"
                }
            }
        },
        "wlanGroup50" : {
            "description" : "WLAN group of 5GHz radio. This configuration will override the WLAN group of the 5GHz radio at the zone level or AP group level.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "description" : "Identifier of the WLAN group",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the WLAN group",
                    "type" : "string"
                }
            }
        },
        "wlanService24Enabled" : {
            "description" : "WLAN service enabled or disabled on 2.4GHz radio",
            "type" : "boolean"
        },
        "wlanService50Enabled" : {
            "description" : "WLAN service enabled or disabled on 5GHz radio",
            "type" : "boolean"
        },
        "zoneId" : {
            "description" : "Identifier of the AP group to which the AP belongs",
            "type" : "string"
        },
        "recoverySsid" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "recoverySsidEnabled" : {
                    "description" : "recovery ssid enable/disable",
                    "type" : "boolean"
                }
            }
        },
        "rogueApReportThreshold" : {
            "type" : "integer"
        },
        "rogueApAggressivenessMode" : {
            "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"
                    }
                }
            }
        }
    },
    "type" : "object"
}

Retrieve AP Picture

GET/v8_2/aps/{apMac}/picture

Use this API command to retrieve the current AP picture.

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

Download AP support log

GET/v8_2/aps/{apMac}/supportLog

Use this API command to download AP support log.

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

Retrieve List

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

Query Zero Touch Unapproved AP list

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

Upload AP Picture

POST/v8_2/aps/{apMac}/picture

Use this API command to upload a new AP picture.

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

Create

POST/v8_2/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
{
    "additionalProperties" : false,
    "properties" : {
        "administrativeState" : {
            "default" : "Unlocked",
            "description" : "Administrative state of the AP. A locked AP will not provide any WLAN services.",
            "type" : "string",
            "enum" : [ "Locked", "Unlocked" ]
        },
        "apGroupId" : {
            "description" : "Identifier of the AP group to which the AP belongs. If the AP belongs to the default AP group, this property is not needed.",
            "type" : "string"
        },
        "awsVenue" : {
            "description" : "Venue code",
            "type" : "string"
        },
        "description" : {
            "description" : "Description of the AP",
            "type" : [ "string", "null" ],
            "maxLength" : 64
        },
        "gpsSource" : {
            "description" : "GPS Source of the AP",
            "type" : "string",
            "enum" : [ "GPS", "MANUAL" ]
        },
        "latitude" : {
            "description" : "Latitude coordinate (in decimal format) of the AP",
            "type" : "number"
        },
        "location" : {
            "description" : "Location of the AP. This is a free format text description that indicates the location of the AP.",
            "type" : "string"
        },
        "longitude" : {
            "description" : "Longitude coordinate (in decimal format) of the AP",
            "type" : "number"
        },
        "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])$"
        },
        "model" : {
            "description" : "Model name of the AP",
            "type" : "string"
        },
        "name" : {
            "description" : "Name of the AP",
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 64,
            "pattern" : "^[!-~]((?!\$\()[ -_a-~]){0,62}[!-~]$"
        },
        "provisionChecklist" : {
            "description" : "Provision checklist of the AP. This field indicates the steps that have been completed in the AP provisioning process.",
            "type" : "string"
        },
        "serial" : {
            "description" : "Serial number of the AP",
            "type" : "string"
        },
        "zoneId" : {
            "description" : "Identifier of the zone to which the AP belongs",
            "type" : "string"
        }
    },
    "required" : [ "mac", "zoneId" ],
    "type" : "object"
}
Response  201

Modify Specific

PUT/v8_2/aps/{apMac}/specific

Use this API command to modify specific configuration.

Request
HideShow
Body
{
  "ledStatusEnabled": false,
  "lacp": {
    "keepApSetting": false,
    "enabled": true
  },
  "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": {
        "keepApSetting": {
          "type": "boolean"
        },
        "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

Reboot

PUT/v8_2/aps/{apMac}/reboot

reboot an access point.

Response  204

Update Zero Touch Unapproved AP

PUT/v8_2/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

Modify

PATCH/v8_2/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" : {
            "description" : "Administrative state of the AP. A locked AP will not provide any WLAN services.",
            "type" : "string",
            "enum" : [ "Locked", "Unlocked" ]
        },
        "altitude" : {
            "description" : "GPS Altitude",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "altitudeUnit" : {
                    "description" : "altitude unit",
                    "type" : "string",
                    "enum" : [ "meters", "floor" ]
                },
                "altitudeValue" : {
                    "description" : "altitude value",
                    "type" : "integer"
                }
            }
        },
        "apGroupId" : {
            "description" : "Identifier of the AP group to which the AP belongs",
            "type" : "string"
        },
        "apMgmtVlan" : {
            "description" : "ap Management Vlan",
            "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" : {
            "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
                }
            }
        },
        "awsVenue" : {
            "description" : "Venue code",
            "type" : "string"
        },
        "bonjourGateway" : {
            "description" : "Bonjour gateway of the AP.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "channelEvaluationInterval" : {
            "description" : "channel evaluation Interval of the AP",
            "maximum" : 3600,
            "minimum" : 60,
            "type" : "integer"
        },
        "clientAdmissionControl24" : {
            "description" : "Client admission control configuration of 2.4GHz radio of the AP.",
            "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" : "Client admission control configuration of 5GHz radio of the AP.",
            "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" : {
            "description" : "Description of the AP",
            "type" : [ "string", "null" ],
            "maxLength" : 64
        },
        "gpsSource" : {
            "description" : "GPS Source of the AP",
            "type" : "string",
            "enum" : [ "GPS", "MANUAL" ]
        },
        "latitude" : {
            "description" : "Latitude coordinate (in decimal format) of the AP",
            "type" : "number"
        },
        "location" : {
            "description" : "Location of the AP. This is a text description that indicates the location of the AP.",
            "type" : "string"
        },
        "locationAdditionalInfo" : {
            "description" : "Location additional info of the AP. This is a text description that indicates the location additional info of the AP.",
            "type" : "string",
            "pattern" : "^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
        },
        "login" : {
            "description" : "Logon credentials for the AP. These logon credentials will override the logon credentials specified at the zone level or AP group level.",
            "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" : {
            "description" : "Longitude coordinate (in decimal format) of the AP",
            "type" : "number"
        },
        "meshOptions" : {
            "description" : "mesh options",
            "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" : {
            "description" : "Model name of the AP",
            "type" : "string"
        },
        "name" : {
            "description" : "Name of the AP",
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 64,
            "pattern" : "^[!-~]((?!\$\()[ -_a-~]){0,62}[!-~]$"
        },
        "network" : {
            "description" : "Network settings ipv4 of the AP.",
            "additionalProperties" : false,
            "properties" : {
                "gateway" : {
                    "description" : "Gateway of the AP",
                    "type" : "string"
                },
                "ip" : {
                    "description" : "IP address of the AP",
                    "type" : "string"
                },
                "ipType" : {
                    "description" : "Indicates how the AP's IP address was obtained. An AP's IP address can be statically or dynamically assigned or kept unchanged.",
                    "type" : "string",
                    "enum" : [ "Dynamic", "Keep", "Static" ]
                },
                "netmask" : {
                    "description" : "Netmask of the AP's subnet",
                    "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" : {
                    "description" : "Primary DNS server address of the AP",
                    "type" : "string"
                },
                "secondaryDns" : {
                    "description" : "Secondary DNS server address of the AP",
                    "type" : "string"
                }
            },
            "type" : "object"
        },
        "networkIpv6" : {
            "description" : "Network settings ipv6 of the AP.",
            "additionalProperties" : false,
            "properties" : {
                "gateway" : {
                    "description" : "Gateway of the AP",
                    "type" : "string"
                },
                "ip" : {
                    "description" : "IP address of the AP",
                    "type" : "string"
                },
                "ipType" : {
                    "description" : "Indicates how the AP's IP address was obtained. An AP's IP address can be statically or dynamically assigned or kept unchanged.",
                    "type" : "string",
                    "enum" : [ "Dynamic", "Keep", "Static" ]
                },
                "primaryDns" : {
                    "description" : "Primary DNS server address of the AP",
                    "type" : "string"
                },
                "secondaryDns" : {
                    "description" : "Secondary DNS server address of the AP",
                    "type" : "string"
                }
            },
            "type" : "object"
        },
        "provisionChecklist" : {
            "description" : "Provision checklist of the AP. This field indicates the steps that have been completed in the AP provisioning process.",
            "type" : "string"
        },
        "serial" : {
            "description" : "Serial number of the AP",
            "type" : "string"
        },
        "smartMonitor" : {
            "description" : "Smart monitor of the AP.",
            "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" : {
            "description" : "Syslog configuration of the AP. This configuration will override the syslog configuration at the zone level or AP group level.",
            "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" : {
            "description" : "Venue profile configuration of the AP.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "wifi24" : {
            "description" : "2.4GHz radio configuration of the AP. This configuration will override the radio 2.4GHz configuration at the zone level or AP group level.",
            "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" : "5GHz radio configuration. This configuration will override the 5GHz radio configuration at the zone level or AP group level.",
            "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" : {
            "description" : "AP 2.4GHz Protection mode configuration of the AP.",
            "type" : "string",
            "enum" : [ "NONE", "CTS_ONLY", "RTS_CTS" ]
        },
        "wlanGroup24" : {
            "description" : "WLAN group of 2.4GHz radio. This configuration will override the WLAN group of the 2.4GHz radio at the zone level or AP group level.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "description" : "Identifier of the WLAN group",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the WLAN group",
                    "type" : "string"
                }
            }
        },
        "wlanGroup50" : {
            "description" : "WLAN group of 5GHz radio. This configuration will override the WLAN group of the 5GHz radio at the zone level or AP group level.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "description" : "Identifier of the WLAN group",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Name of the WLAN group",
                    "type" : "string"
                }
            }
        },
        "wlanService24Enabled" : {
            "description" : "WLAN service enabled or disabled on 2.4GHz radio",
            "type" : "boolean"
        },
        "wlanService50Enabled" : {
            "description" : "WLAN service enabled or disabled on 5GHz radio",
            "type" : "boolean"
        },
        "zoneId" : {
            "description" : "Identifier of the zone to which the AP belongs",
            "type" : "string"
        },
        "recoverySsid" : {
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "recoverySsidEnabled" : {
                    "description" : "recovery ssid enable/disable",
                    "type" : "boolean"
                }
            }
        },
        "rogueApReportThreshold" : {
            "type" : "integer"
        },
        "rogueApAggressivenessMode" : {
            "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"
                    }
                }
            }
        }
    },
    "type" : "object"
}
Response  204

Disable Login Override

DELETE/v8_2/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_2/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_2/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_2/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_2/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_2/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_2/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_2/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_2/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_2/aps/{apMac}/apMgmtVlan

Disable AP Management Vlan Override of an AP.

Response  204

Disable Altitude Override

DELETE/v8_2/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

Disable Location Override

DELETE/v8_2/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_2/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_2/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_2/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_2/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_2/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_2/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_2/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_2/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_2/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_2/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_2/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_2/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_2/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_2/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

Disable AP Management GPS Cooordinates

DELETE/v8_2/aps/{apMac}/gpsCoordinates

Disable AP Management GPS Cooordinates of an AP.

Response  204

Disable Mesh Options

DELETE/v8_2/aps/{apMac}/meshOptions

Use this API command to disable mesh options.

Response  204

Disable Specific Override

DELETE/v8_2/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_2/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_2/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_2/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_2/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_2/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_2/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_2/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_2/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_2/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

Delete AP Picture

DELETE/v8_2/aps/{apMac}/picture

Use this API command to delete an AP picture.

Response  204

Delete

DELETE/v8_2/aps/{apMac}

Use this API command to delete an access point.

Response  204

Access Point Operational

Retrieve Operational Information

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

This API provide detailed AP status and configuration, therefore it was designed for single AP information retrieving. If you need to retrieve large number of ap states, please use “POST://query/ap” (refer to the “Query APs” section of the category “Access Point Operational”).

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" : {
            "description" : "Administrative state of the AP. A locked AP will not provide any WLAN services.",
            "type" : "string",
            "enum" : [ "Locked", "Unlocked" ]
        },
        "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"
                }
            }
        },
        "apGroupId" : {
            "description" : "Identifier of the AP group to which the AP belongs",
            "type" : "string"
        },
        "approvedTime" : {
            "description" : "Timestamp when the AP was approved by the controller",
            "type" : "integer",
            "format" : "int64"
        },
        "clientCount" : {
            "description" : "Number of clients on the AP",
            "type" : "integer"
        },
        "configState" : {
            "description" : "State of the AP configuration.",
            "type" : "string",
            "enum" : [ "completed", "configApplied", "configFailed", "fwApplied", "fwDownloaded", "fwFailed", "newConfig" ]
        },
        "connectionState" : {
            "description" : "Connection state of the AP (value: 'Discovery','Connect','Rebooting','Disconnect','Provisioned')",
            "type" : "string"
        },
        "countryCode" : {
            "description" : "Country code of the AP",
            "type" : "string"
        },
        "cpId" : {
            "description" : "Identifier of the control plane to which the AP is currently connected",
            "type" : "string"
        },
        "description" : {
            "description" : "Description of the AP",
            "type" : [ "string", "null" ],
            "maxLength" : 64
        },
        "dpId" : {
            "description" : "Identifier of the data plane to which the AP is currently connected",
            "type" : "string"
        },
        "externalIp" : {
            "description" : "External IP address of the AP. This is only applicable when the AP is behind a NAT server.",
            "type" : "string"
        },
        "externalPort" : {
            "description" : "External port number of the AP. This is only applicable when the AP is behind a NAT server.",
            "type" : "integer"
        },
        "ip" : {
            "description" : "IP address of the AP",
            "type" : "string"
        },
        "ipType" : {
            "description" : "Indicates how the AP's IP address was obtained. The AP's IP address can be statically or dynamically assigned or kept unchanged.",
            "type" : "string",
            "enum" : [ "Dynamic", "Keep", "Static" ]
        },
        "ipv6Type" : {
            "description" : "Indicates how the AP's IP address was obtained. The AP's IP address can be statically or automatically assigned or kept unchanged.",
            "type" : "string",
            "enum" : [ "Static", "Autoconfig", "Keep" ]
        },
        "ipv6" : {
            "description" : "IP address of the AP",
            "type" : "string"
        },
        "isCriticalAP" : {
            "description" : "Indicates critical APs. Critical AP are APs that were tagged by the controller based on predefined rules.",
            "type" : "boolean"
        },
        "lastSeenTime" : {
            "description" : "Timestamp of the last successful communication with the AP",
            "type" : "integer",
            "format" : "int64"
        },
        "latitude" : {
            "description" : "Latitude coordinate (in decimal format) of the AP",
            "type" : "number"
        },
        "location" : {
            "description" : "Location of the AP. This is a text description that indicates the location of the AP.",
            "type" : "string"
        },
        "locationAdditionalInfo" : {
            "description" : "Location additional info of the AP. This is a text description that indicates the location additional info of the AP.",
            "type" : "string",
            "pattern" : "^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
        },
        "longitude" : {
            "description" : "Longitude coordinate (in decimal format) of the AP",
            "type" : "number"
        },
        "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])$"
        },
        "managementVlan" : {
            "description" : "Management vlan on the AP",
            "type" : "integer"
        },
        "meshHop" : {
            "description" : "Number of mesh hops of the AP. This is only applicable to mesh APs.",
            "type" : "integer"
        },
        "meshRole" : {
            "description" : "Mesh role of the AP",
            "type" : "string",
            "enum" : [ "Disabled", "Down", "Map", "Root", "Undefined", "eMap" ]
        },
        "model" : {
            "description" : "Model name of the AP",
            "type" : "string"
        },
        "name" : {
            "description" : "Name of the AP",
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 64,
            "pattern" : "^[!-~]((?!\$\()[ -_a-~]){0,62}[!-~]$"
        },
        "provisionMethod" : {
            "description" : "Provisioning method of the AP. Discovered indicates that the AP contacted the controller using discovery and the AP did not have pre-existing record on the controller. Preprovision indicates that the AP was provisioned to the controller before AP made the first contact. Swap indicates that the AP was provisioned to be a replacement of an existing AP.",
            "type" : "string",
            "enum" : [ "Discovered", "Preprovision", "Swap" ]
        },
        "provisionStage" : {
            "description" : "Provisioning stage of the AP. This indicates the stage at which the AP is at in the provisioning process. (value: 'Waiting for Registration','Pre-Provision AP Joined','Waiting for Swap In;Waiting for registration','Waiting for Swap In;Swap In AP Joined','Swapped In;Waiting for registration','Swapped In','Waiting for Swap Out','Swapped Out','Waiting for Swap In, the other AP was deleted','Swapped In, the other AP was deleted','Waiting for Swap Out, the other AP was deleted','Swapped Out, the other AP was deleted')",
            "type" : "string"
        },
        "registrationState" : {
            "description" : "Registration state of the AP",
            "type" : "string"
        },
        "serial" : {
            "description" : "Serial number of the AP",
            "type" : "string"
        },
        "uptime" : {
            "description" : "Uptime of the AP since it was last rebooted (unit:second)",
            "type" : "integer",
            "format" : "int64"
        },
        "version" : {
            "description" : "Firmware version of the AP",
            "type" : "string",
            "pattern" : "^\d+\.\d+\.\d+\.\d+\.\d+$"
        },
        "wifi24Channel" : {
            "description" : "2.4GHz radio channel number that the AP is currently using",
            "type" : "string"
        },
        "wifi50Channel" : {
            "description" : "5GHZ radio channel number that the AP is currently using",
            "type" : "string"
        },
        "zoneId" : {
            "description" : "Identifier of the zone to which the AP belongs",
            "type" : "string"
        }
    },
    "type" : "object"
}

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",
      "format": "int64"
    },
    "majorCount": {
      "description": "Major alarm count",
      "type": "integer",
      "format": "int64"
    },
    "minorCount": {
      "description": "Minor alarm count",
      "type": "integer",
      "format": "int64"
    },
    "warningCount": {
      "description": "Warning alarm count",
      "type": "integer",
      "format": "int64"
    }
  }
}

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",
      "format": "int64"
    },
    "majorCount": {
      "description": "Major event count",
      "type": "integer",
      "format": "int64"
    },
    "minorCount": {
      "description": "Minor event count",
      "type": "integer",
      "format": "int64"
    },
    "warningCount": {
      "description": "Warning event count",
      "type": "integer",
      "format": "int64"
    },
    "informationalCount": {
      "description": "Informational event count",
      "type": "integer",
      "format": "int64"
    },
    "debugCount": {
      "description": "Debug event count",
      "type": "integer",
      "format": "int64"
    }
  }
}

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",
            "format": "int64"
          },
          "acknowledgedTime": {
            "description": "Time the alarm was acknowledged",
            "type": "integer",
            "format": "int64"
          }
        }
      }
    }
  }
}

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

type
string (optional) 

Query type, valid value is AND or OR. Default: AND

value
array (optional) 

Vague value to search. Could be a list of value, like value=ABC&value=CD in the parameter.

order
string (optional) 

Value of order parameter.

direction
string (optional) 

Direction of order parameter, valid value id ASC or DESC. Default: DESC

fixSearch
key & value (optional) 

fixSearch is not mean real query key. It is for other fix search parameters to search, like key1=value1&key2=value2

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

Retrieve Mesh Neighbor AP List

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

AP packet capture

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

Switchover AP

POST/v8_2/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 indoorMap List

POST/v8_2/query/indoorMap

Query indoorMap with specified filters. 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",
              "CATEGORY",
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "BLADE",
              "SYNCEDSTATUS",
              "REGISTRATIONSTATE",
              "STATUS",
              "SWITCH_GROUP"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraFilters": {
      "description": "\"AND\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "CLIENTIPV6ADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "Type",
              "RogueMac",
              "SSID",
              "ALARMSTATE",
              "DEVICENAME",
              "SWITCH",
              "ZoneAffinityProfileId",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "Specified feature required information",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "type": "string",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "includeUserClickNode": {
          "description": "Can be used when group tree rendering needs include user clicked node.",
          "type": "boolean"
        }
      }
    },
    "extraTimeRange": {
      "description": "Specified data time range of selection",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "interval": {
          "description": "time interval in second",
          "type": "integer",
          "format": "int64"
        },
        "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": 3,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "tenantId": "839f87c6-d116-497e-afce-aa8157abd30c",
      "name": "testMap",
      "description": "",
      "imageFileName": "^B7DD96DBDEDD273F0AE10E2BC49F394D6F6A972EA001F73854^pimgptestMap.png",
      "address": "apg1map",
      "longitude": 121.56999969482422,
      "latitude": 25.06999969482422,
      "apGroupId": "0f7acc6c-1777-4c05-8b9c-2f88df5bad4b",
      "zoneId": "c8fb596b-a87c-4d97-a18c-df21d5bae631",
      "domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
      "groupType": "APGROUP",
      "scale": {
        "a": {
          "x": 411,
          "y": 187.390625
        },
        "b": {
          "x": 356,
          "y": 189.390625
        },
        "distance": 11,
        "unit": "MM"
      },
      "apCount": 0
    }
  ],
  "extra": {
    "rbacMetadata": [
      {
        "AP_CATEGORY": "FULL_ACCESS"
      },
      {
        "AP_CATEGORY": "FULL_ACCESS"
      },
      {
        "AP_CATEGORY": "FULL_ACCESS"
      }
    ]
  }
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "description": "Total indoor maps count",
      "type": "integer"
    },
    "hasMore": {
      "description": "Indicates whether there are more indoor maps after the list that is currently displayed",
      "type": "boolean"
    },
    "firstIndex": {
      "description": "Index of the first indoorMapList returned out of the complete indoor maps list",
      "type": "integer"
    },
    "extra": {
      "description": "extra information for indoor map",
      "type": "object",
      "properties": {
        "rbacMetadata": {
          "type": "array",
          "items": {
            "additionalProperties": {
              "type": "string"
            },
            "properties": {}
          }
        }
      }
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "id",
            "type": "string"
          },
          "key": {
            "description": "id",
            "type": "string"
          },
          "zoneId": {
            "description": "zoneId",
            "type": "string"
          },
          "apCount": {
            "description": "AP count in this indoor map",
            "type": "number"
          },
          "name": {
            "description": "name",
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
          },
          "description": {
            "description": "description",
            "type": [
              "string",
              "null"
            ],
            "maxLength": 64
          },
          "address": {
            "description": "address",
            "type": "string"
          },
          "imageFileName": {
            "description": "imageFileName",
            "type": "string"
          },
          "latitude": {
            "description": "latitude",
            "type": "number"
          },
          "longitude": {
            "description": "longitude",
            "type": "number"
          },
          "groupType": {
            "description": "group Type",
            "type": "string",
            "enum": [
              "SYSTEM",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP"
            ]
          },
          "domainId": {
            "description": "domainId",
            "type": "string"
          },
          "tenantId": {
            "description": "tenantId",
            "type": "string"
          },
          "scale": {
            "description": "scale",
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "a": {
                "description": "point a",
                "type": "object",
                "additionalProperties": false,
                "properties": {
                  "x": {
                    "description": "x",
                    "type": "number"
                  },
                  "y": {
                    "description": "y",
                    "type": "number"
                  }
                }
              },
              "b": {
                "description": "point b",
                "type": "object",
                "additionalProperties": false,
                "properties": {
                  "x": {
                    "description": "x",
                    "type": "number"
                  },
                  "y": {
                    "description": "y",
                    "type": "number"
                  }
                }
              },
              "distance": {
                "description": "distance",
                "type": "number"
              },
              "unit": {
                "description": "unit",
                "type": "string",
                "enum": [
                  "MM",
                  "CM",
                  "M",
                  "Foot",
                  "Yard"
                ]
              }
            }
          },
          "apGroupId": {
            "description": "apGroupId",
            "type": "string"
          }
        },
        "required": [
          "name",
          "description",
          "groupType"
        ]
      }
    }
  }
}

Query Rogue AP List

POST/v8_2/query/roguesInfoList

Use this API command to retrieve a list of rogue access points. Please click the link for the usage of Query Criteria.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "d0d495e1-de50-40e3-8d09-e4bbeb4b4722"
    }
  ]
}
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",
              "CATEGORY",
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "BLADE",
              "SYNCEDSTATUS",
              "REGISTRATIONSTATE",
              "STATUS",
              "SWITCH_GROUP"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraFilters": {
      "description": "\"AND\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "CLIENTIPV6ADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "Type",
              "RogueMac",
              "SSID",
              "ALARMSTATE",
              "DEVICENAME",
              "SWITCH",
              "ZoneAffinityProfileId",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "Specified feature required information",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "type": "string",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "includeUserClickNode": {
          "description": "Can be used when group tree rendering needs include user clicked node.",
          "type": "boolean"
        }
      }
    },
    "extraTimeRange": {
      "description": "Specified data time range of selection",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "interval": {
          "description": "time interval in second",
          "type": "integer",
          "format": "int64"
        },
        "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
{
  "rawDataTotalCount": 100,
  "totalCount": 10,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "detectedByAP": [
        {
          "apMac": "FF:FF:FF:FF:FF:FF",
          "apName": "Dummy AP",
          "rssi": "64",
          "rogueType": "Rogue",
          "lastDetected": 1470717826622,
          "zoneName": "Zone1",
          "mainDetector": true
        }
      ],
      "channel": 11,
      "rogueMac": "DD:DD:DD:DD:DD:DD",
      "encryption": "WPA",
      "radio": "54",
      "lastDetected": 1470717826622,
      "ssid": "Dummy SSID",
      "type": "AD_HOC",
      "rogueAPMac": "EE:EE:EE:EE:EE:EE"
    },
    {
      "detectedByAP": [
        {
          "apMac": "FF:FF:FF:FF:FF:FF",
          "apName": "Dummy AP",
          "rssi": "64",
          "lastDetected": 1470717826622
        }
      ],
      "channel": 11,
      "rogueMac": "DD:DD:DD:DD:DD:DD",
      "encryption": "WPA",
      "radio": "54",
      "lastDetected": 1470717826622,
      "ssid": "Dummy SSID",
      "type": "AD_HOC",
      "rogueAPMac": "EE:EE:EE:EE:EE:EE"
    }
  ],
  "extra": null
}
Schema
{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "rawDataTotalCount" : {
            "description" : "Total Rogue APs count.",
            "type" : "integer"
        },
        "totalCount" : {
            "description" : "Total Rogue APs count in this response.",
            "type" : "integer"
        },
        "extra" : {
            "description" : "Any additional response data.",
            "type" : "object"
        },
        "hasMore" : {
            "description" : "Indicator of whether there are more Rogue AP after the current displayed list",
            "type" : "boolean"
        },
        "firstIndex" : {
            "description" : "Index of the first Rogue AP returned out of the complete Rogue AP list",
            "type" : "integer"
        },
        "list" : {
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "detectedByAP" : {
                        "description" : "The list of the AP found this Rogue AP.",
                        "type" : "array",
                        "items" : {
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "apMac" : {
                                    "description" : "AP MAC of the rogue AP",
                                    "type" : "string",
                                    "pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
                                },
                                "apName" : {
                                    "description" : "Name of the rogue AP",
                                    "type" : "string",
                                    "minLength" : 2,
                                    "maxLength" : 64,
                                    "pattern" : "^[!-~]((?!\$\()[ -_a-~]){0,62}[!-~]$"
                                },
                                "rssi" : {
                                    "description" : "RSSI of the rogue AP",
                                    "type" : "string"
                                },
                                "lastDetected" : {
                                    "description" : "Timestamp of the AP",
                                    "type" : "integer"
                                },
                                "zoneName" : {
                                    "description" : "Zone name",
                                    "type" : "string"
                                },
                                "rogueType" : {
                                    "description" : "Rogue type",
                                    "type" : "string"
                                },
                                "mainDetector" : {
                                    "description" : "To identify whether this is main instance for UI",
                                    "type" : "boolean"
                                }
                            }
                        }
                    },
                    "channel" : {
                        "description" : "Channel of the rogue AP",
                        "type" : "integer"
                    },
                    "rogueMac" : {
                        "description" : "Rogue MAC of the rogue AP",
                        "type" : "string",
                        "pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
                    },
                    "encryption" : {
                        "description" : "Encryption of the rogue AP",
                        "type" : "string"
                    },
                    "radio" : {
                        "description" : "Radio of the rogue AP",
                        "type" : "string"
                    },
                    "lastDetected" : {
                        "description" : "Timestamp of the rogue AP",
                        "type" : "integer",
                        "format" : "int64"
                    },
                    "ssid" : {
                        "description" : "SSID of the rogue AP",
                        "type" : "string"
                    },
                    "type" : {
                        "description" : "Type of the rogue AP",
                        "type" : "string"
                    },
                    "rogueAPMac" : {
                        "description" : "Rogue AP MAC of the rogue AP",
                        "type" : "string",
                        "pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
                    },
                    "classification" : {
                        "description" : "Rogue classification by policy",
                        "type" : "string"
                    },
                    "matchResult" : {
                        "description" : "What policy and rule matched when system doing classification by rogue policy",
                        "type" : "string"
                    }
                }
            }
        }
    }
}

Retrieve AP Wlan list with BSSID information by QueryCriteria

POST/v8_2/query/ap/wlan

Use this API command to retrieve AP Wlan list with BSSID information by QueryCriteria 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",
              "CATEGORY",
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "BLADE",
              "SYNCEDSTATUS",
              "REGISTRATIONSTATE",
              "STATUS",
              "SWITCH_GROUP"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraFilters": {
      "description": "\"AND\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "CLIENTIPV6ADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "Type",
              "RogueMac",
              "SSID",
              "ALARMSTATE",
              "DEVICENAME",
              "SWITCH",
              "ZoneAffinityProfileId",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "Specified feature required information",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "type": "string",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "includeUserClickNode": {
          "description": "Can be used when group tree rendering needs include user clicked node.",
          "type": "boolean"
        }
      }
    },
    "extraTimeRange": {
      "description": "Specified data time range of selection",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "interval": {
          "description": "time interval in second",
          "type": "integer",
          "format": "int64"
        },
        "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
{
  "rawDataTotalCount": 1,
  "totalCount": 1,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "apMac": "38:FF:36:12:F1:90",
      "deviceName": "RuckusAP",
      "wlanBssids": [
        {
          "wlanName": "wlanA",
          "bssid": "38:FF:36:12:F1:98",
          "wlanId": 1,
          "radioId": 0
        },
        {
          "wlanName": "wlanB",
          "bssid": "38:FF:36:52:F1:98",
          "wlanId": 2,
          "radioId": 0
        },
        {
          "wlanName": "wlanC",
          "bssid": "38:FF:36:92:F1:98",
          "wlanId": 3,
          "radioId": 0
        },
        {
          "wlanName": "wlanD",
          "bssid": "38:FF:36:D2:F1:98",
          "wlanId": 4,
          "radioId": 0
        },
        {
          "wlanName": "wlanE",
          "bssid": "38:FF:36:12:F1:99",
          "wlanId": 5,
          "radioId": 0
        },
        {
          "wlanName": "wlanF",
          "bssid": "38:FF:36:52:F1:99",
          "wlanId": 6,
          "radioId": 0
        },
        {
          "wlanName": "wlanG",
          "bssid": "38:FF:36:92:F1:99",
          "wlanId": 7,
          "radioId": 0
        },
        {
          "wlanName": "wlanA",
          "bssid": "38:FF:36:12:F1:9C",
          "wlanId": 1,
          "radioId": 1
        },
        {
          "wlanName": "wlanB",
          "bssid": "38:FF:36:52:F1:9C",
          "wlanId": 2,
          "radioId": 1
        },
        {
          "wlanName": "wlanC",
          "bssid": "38:FF:36:92:F1:9C",
          "wlanId": 3,
          "radioId": 1
        },
        {
          "wlanName": "wlanD",
          "bssid": "38:FF:36:D2:F1:9C",
          "wlanId": 4,
          "radioId": 1
        },
        {
          "wlanName": "wlanE",
          "bssid": "38:FF:36:12:F1:9D",
          "wlanId": 5,
          "radioId": 1
        },
        {
          "wlanName": "wlanF",
          "bssid": "38:FF:36:52:F1:9D",
          "wlanId": 6,
          "radioId": 1
        },
        {
          "wlanName": "wlanG",
          "bssid": "38:FF:36:92:F1:9D",
          "wlanId": 7,
          "radioId": 1
        }
      ]
    }
  ],
  "extra": null
}
Schema
{
  "additionalProperties": false,
  "type": "object",
  "properties": {
    "firstIndex": {
      "description": "Index of first index in current page",
      "type": "integer"
    },
    "hasMore": {
      "description": "Has more data or not",
      "type": "boolean"
    },
    "totalCount": {
      "description": "Total matched AP count",
      "type": "integer"
    },
    "extra": {
      "description": "extra information",
      "type": "object",
      "properties": {
        "rbacMetadata": {
          "type": "array",
          "items": {
            "additionalProperties": {
              "type": "string"
            },
            "properties": {}
          }
        }
      }
    },
    "list": {
      "type": "array",
      "items": {
        "additionalProperties": false,
        "type": "object",
        "properties": {
          "apMac": {
            "type": "string"
          },
          "deviceName": {
            "type": "string"
          },
          "wlanBssids": {
            "type": "array",
            "items": {
              "additionalProperties": false,
              "type": "object",
              "properties": {
                "wlanName": {
                  "type": "string"
                },
                "bssid": {
                  "type": "string"
                },
                "wlanId": {
                  "type": "integer"
                },
                "radioId": {
                  "type": "integer"
                }
              }
            }
          }
        }
      }
    }
  }
}

Query APs

POST/v8_2/query/ap

Query APs with specified filters 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",
              "CATEGORY",
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "BLADE",
              "SYNCEDSTATUS",
              "REGISTRATIONSTATE",
              "STATUS",
              "SWITCH_GROUP"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraFilters": {
      "description": "\"AND\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "CLIENTIPV6ADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "Type",
              "RogueMac",
              "SSID",
              "ALARMSTATE",
              "DEVICENAME",
              "SWITCH",
              "ZoneAffinityProfileId",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "Specified feature required information",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "type": "string",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "includeUserClickNode": {
          "description": "Can be used when group tree rendering needs include user clicked node.",
          "type": "boolean"
        }
      }
    },
    "extraTimeRange": {
      "description": "Specified data time range of selection",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "interval": {
          "description": "time interval in second",
          "type": "integer",
          "format": "int64"
        },
        "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": 9,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "deviceName": "AP001",
      "description": "Description",
      "status": "Online",
      "alerts": 0,
      "ip": null,
      "ipv6Address": null,
      "txRx": null,
      "noise24G": null,
      "noise5G": null,
      "airtime24G": null,
      "airtime5G": null,
      "latency24G": null,
      "latency50G": null,
      "capacity": null,
      "capacity24G": null,
      "capacity50G": null,
      "connectionFailure": null,
      "model": null,
      "apMac": "AB:CD:00:00:00:00",
      "channel24G": null,
      "channel5G": null,
      "meshRole": "DISABLED",
      "meshMode": "Auto",
      "zoneName": null,
      "apGroupName": null,
      "extIp": "10.10.10.33",
      "extPort": "4000",
      "firmwareVersion": null,
      "serial": null,
      "retry24G": null,
      "retry5G": null,
      "configurationStatus": null,
      "lastSeen": null,
      "numClients": 0,
      "numClients24G": 0,
      "numClients5G": 0,
      "tx": null,
      "rx": null,
      "location": null,
      "wlanGroup24Id": null,
      "wlanGroup50Id": null,
      "wlanGroup24Name": null,
      "wlanGroup50Name": null,
      "enabledBonjourGateway": false,
      "controlBladeName": null,
      "lbsStatus": null,
      "administrativeState": "Unlocked",
      "registrationState": "Approved",
      "provisionMethod": "ProvisionMethod1",
      "provisionStage": "PRE_AP_JOIN",
      "registrationTime": 1484720659798,
      "managementVlan": null,
      "configOverride": false,
      "indoorMapId": "66479bc8-44c7-4f6b-b741-d4056b0305a7",
      "apGroupId": "c9e43dad-cbcb-4f75-a804-2680ea4c0e80",
      "indoorMapXy": {
        "x": 368.4700012207031,
        "y": 108.5
      },
      "indoorMapName": "DemoMap",
      "indoorMapLocation": "350 W Java Dr Sunnyvale, CA 94089",
      "deviceGps": null,
      "connectionStatus": "Connect",
      "zoneId": "76c3b5a0-d809-4fb1-8535-5c200e5341d1",
      "zoneFirmwareVersion": "3.5.0.102.79",
      "domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
      "domainName": null,
      "dpIp": null,
      "controlBladeId": null,
      "isCriticalAp": false,
      "crashDump": null,
      "cableModemSupported": null,
      "cableModemResetSupported": null,
      "swapInMac": null,
      "swapOutMac": null,
      "isOverallHealthStatusFlagged": false,
      "isLatency24GFlagged": false,
      "isCapacity24GFlagged": false,
      "isConnectionFailure24GFlagged": false,
      "isLatency50GFlagged": false,
      "isCapacity50GFlagged": false,
      "isConnectionFailure50GFlagged": false,
      "isConnectionTotalCountFlagged": false,
      "isConnectionFailureFlagged": false,
      "isAirtimeUtilization24GFlagged": false,
      "isAirtimeUtilization50GFlagged": false,
      "supportFips": false,
      "fipsEnabled": false,
      "eirp24G": 20,
      "eirp50G": 24,
      "uptime": 123,
      "ipsecRxBytes": 0,
      "ipsecRxDropPkts": 0,
      "ipsecRxIdleTime": 0,
      "ipsecRxPkts": 0,
      "ipsecSessionTime": 0,
      "ipsecTxBytes": 0,
      "ipsecTxDropPkts": 0,
      "ipsecTxIdleTime": 0,
      "ipsecTxPkts": 0,
      "ipType": "IPV4"
    },
    {
      "deviceName": "AP002",
      "description": "Description",
      "status": "Online",
      "alerts": 0,
      "ip": null,
      "ipv6Address": null,
      "txRx": null,
      "noise24G": null,
      "noise5G": null,
      "airtime24G": null,
      "airtime5G": null,
      "latency24G": null,
      "latency50G": null,
      "capacity": null,
      "capacity24G": null,
      "capacity50G": null,
      "connectionFailure": null,
      "model": null,
      "apMac": "AB:CD:00:00:00:01",
      "channel24G": null,
      "channel5G": null,
      "meshRole": "DISABLED",
      "meshMode": "Auto",
      "zoneName": null,
      "apGroupName": null,
      "extIp": "10.10.10.22",
      "extPort": "2000",
      "firmwareVersion": null,
      "serial": null,
      "retry24G": null,
      "retry5G": null,
      "configurationStatus": null,
      "lastSeen": null,
      "numClients": 0,
      "numClients24G": 0,
      "numClients5G": 0,
      "tx": null,
      "rx": null,
      "location": null,
      "wlanGroup24Id": null,
      "wlanGroup50Id": null,
      "wlanGroup24Name": null,
      "wlanGroup50Name": null,
      "enabledBonjourGateway": false,
      "controlBladeName": null,
      "lbsStatus": null,
      "administrativeState": "Unlocked",
      "registrationState": "Approved",
      "provisionMethod": "ProvisionMethod2",
      "provisionStage": "PRE_AP_JOIN",
      "registrationTime": 1484720660065,
      "managementVlan": null,
      "configOverride": false,
      "indoorMapId": "66479bc8-44c7-4f6b-b741-d4056b0305a7",
      "apGroupId": "c9e43dad-cbcb-4f75-a804-2680ea4c0e80",
      "indoorMapXy": {
        "x": 651.5499877929688,
        "y": 273.9100036621094
      },
      "indoorMapName": "DemoMap",
      "indoorMapLocation": "350 W Java Dr Sunnyvale, CA 94089",
      "deviceGps": null,
      "connectionStatus": "Connect",
      "zoneId": "76c3b5a0-d809-4fb1-8535-5c200e5341d1",
      "zoneFirmwareVersion": "3.5.0.102.79",
      "domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
      "domainName": null,
      "dpIp": null,
      "controlBladeId": null,
      "isCriticalAp": false,
      "crashDump": null,
      "cableModemSupported": null,
      "cableModemResetSupported": null,
      "swapInMac": null,
      "swapOutMac": null,
      "isOverallHealthStatusFlagged": false,
      "isLatency24GFlagged": false,
      "isCapacity24GFlagged": false,
      "isConnectionFailure24GFlagged": false,
      "isLatency50GFlagged": false,
      "isCapacity50GFlagged": false,
      "isConnectionFailure50GFlagged": false,
      "isConnectionTotalCountFlagged": false,
      "isConnectionFailureFlagged": false,
      "isAirtimeUtilization24GFlagged": false,
      "isAirtimeUtilization50GFlagged": false,
      "supportFips": false,
      "fipsEnabled": false,
      "eirp24G": 20,
      "eirp50G": 24,
      "uptime": 123,
      "ipsecRxBytes": 0,
      "ipsecRxDropPkts": 0,
      "ipsecRxIdleTime": 0,
      "ipsecRxPkts": 0,
      "ipsecSessionTime": 0,
      "ipsecTxBytes": 0,
      "ipsecTxDropPkts": 0,
      "ipsecTxIdleTime": 0,
      "ipsecTxPkts": 0,
      "monitoringEnabled": false,
      "ipType": "IPV4"
    },
    {
      "deviceName": "AP005",
      "description": "Description",
      "status": "Offline",
      "alerts": 0,
      "ip": null,
      "ipv6Address": null,
      "txRx": null,
      "noise24G": null,
      "noise5G": null,
      "airtime24G": null,
      "airtime5G": null,
      "latency24G": null,
      "latency50G": null,
      "capacity": null,
      "capacity24G": null,
      "capacity50G": null,
      "connectionFailure": null,
      "model": null,
      "apMac": "AB:CD:00:00:00:04",
      "channel24G": null,
      "channel5G": null,
      "meshRole": "DISABLED",
      "meshMode": "Auto",
      "zoneName": null,
      "apGroupName": null,
      "extIp": "10.10.10.1",
      "extPort": "4000",
      "firmwareVersion": null,
      "serial": null,
      "retry24G": null,
      "retry5G": null,
      "configurationStatus": null,
      "lastSeen": null,
      "numClients": 0,
      "numClients24G": 0,
      "numClients5G": 0,
      "tx": null,
      "rx": null,
      "location": null,
      "wlanGroup24Id": null,
      "wlanGroup50Id": null,
      "wlanGroup24Name": null,
      "wlanGroup50Name": null,
      "enabledBonjourGateway": false,
      "controlBladeName": null,
      "lbsStatus": null,
      "administrativeState": "Unlocked",
      "registrationState": "Approved",
      "provisionMethod": "ProvisionMethod1",
      "provisionStage": "PRE_AP_JOIN",
      "registrationTime": 1484720660327,
      "managementVlan": null,
      "configOverride": false,
      "indoorMapId": null,
      "apGroupId": "2d01323d-6224-4de5-995b-e3311c767a74",
      "indoorMapXy": null,
      "indoorMapName": null,
      "indoorMapLocation": null,
      "deviceGps": null,
      "connectionStatus": "Disconnect",
      "zoneId": "76c3b5a0-d809-4fb1-8535-5c200e5341d1",
      "zoneFirmwareVersion": "3.5.0.102.79",
      "domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
      "domainName": null,
      "dpIp": null,
      "controlBladeId": null,
      "isCriticalAp": false,
      "crashDump": null,
      "cableModemSupported": null,
      "cableModemResetSupported": null,
      "swapInMac": null,
      "swapOutMac": null,
      "isOverallHealthStatusFlagged": false,
      "isLatency24GFlagged": false,
      "isCapacity24GFlagged": false,
      "isConnectionFailure24GFlagged": false,
      "isLatency50GFlagged": false,
      "isCapacity50GFlagged": false,
      "isConnectionFailure50GFlagged": false,
      "isConnectionTotalCountFlagged": false,
      "isConnectionFailureFlagged": false,
      "isAirtimeUtilization24GFlagged": false,
      "isAirtimeUtilization50GFlagged": false,
      "supportFips": false,
      "fipsEnabled": false,
      "eirp24G": 20,
      "eirp50G": 24,
      "uptime": 123,
      "ipsecRxBytes": 0,
      "ipsecRxDropPkts": 0,
      "ipsecRxIdleTime": 0,
      "ipsecRxPkts": 0,
      "ipsecSessionTime": 0,
      "ipsecTxBytes": 0,
      "ipsecTxDropPkts": 0,
      "ipsecTxIdleTime": 0,
      "ipsecTxPkts": 0,
      "monitoringEnabled": false,
      "ipType": "IPV4"
    },
    {
      "deviceName": "AP006",
      "description": "Description",
      "status": "Offline",
      "alerts": 0,
      "ip": null,
      "ipv6Address": null,
      "txRx": null,
      "noise24G": null,
      "noise5G": null,
      "airtime24G": null,
      "airtime5G": null,
      "latency24G": null,
      "latency50G": null,
      "capacity": null,
      "capacity24G": null,
      "capacity50G": null,
      "connectionFailure": null,
      "model": null,
      "apMac": "AB:CD:00:00:00:05",
      "channel24G": null,
      "channel5G": null,
      "meshRole": "DISABLED",
      "meshMode": "Auto",
      "zoneName": null,
      "apGroupName": null,
      "extIp": "10.10.10.22",
      "extPort": "3000",
      "firmwareVersion": null,
      "serial": null,
      "retry24G": null,
      "retry5G": null,
      "configurationStatus": null,
      "lastSeen": null,
      "numClients": 0,
      "numClients24G": 0,
      "numClients5G": 0,
      "tx": null,
      "rx": null,
      "location": null,
      "wlanGroup24Id": null,
      "wlanGroup50Id": null,
      "wlanGroup24Name": null,
      "wlanGroup50Name": null,
      "enabledBonjourGateway": false,
      "controlBladeName": null,
      "lbsStatus": null,
      "administrativeState": "Unlocked",
      "registrationState": "Approved",
      "provisionMethod": "ProvisionMethod1",
      "provisionStage": "PRE_AP_JOIN",
      "registrationTime": 1484720660388,
      "managementVlan": null,
      "configOverride": false,
      "indoorMapId": null,
      "apGroupId": "2d01323d-6224-4de5-995b-e3311c767a74",
      "indoorMapXy": null,
      "indoorMapName": null,
      "indoorMapLocation": null,
      "deviceGps": null,
      "connectionStatus": "Disconnect",
      "zoneId": "76c3b5a0-d809-4fb1-8535-5c200e5341d1",
      "zoneFirmwareVersion": "3.5.0.102.79",
      "domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
      "domainName": null,
      "dpIp": null,
      "controlBladeId": null,
      "isCriticalAp": false,
      "crashDump": null,
      "cableModemSupported": null,
      "cableModemResetSupported": null,
      "swapInMac": null,
      "swapOutMac": null,
      "isOverallHealthStatusFlagged": false,
      "isLatency24GFlagged": false,
      "isCapacity24GFlagged": false,
      "isConnectionFailure24GFlagged": false,
      "isLatency50GFlagged": false,
      "isCapacity50GFlagged": false,
      "isConnectionFailure50GFlagged": false,
      "isConnectionTotalCountFlagged": false,
      "isConnectionFailureFlagged": false,
      "isAirtimeUtilization24GFlagged": false,
      "isAirtimeUtilization50GFlagged": false,
      "supportFips": false,
      "fipsEnabled": false,
      "eirp24G": 20,
      "eirp50G": 24,
      "uptime": 123,
      "ipsecRxBytes": 0,
      "ipsecRxDropPkts": 0,
      "ipsecRxIdleTime": 0,
      "ipsecRxPkts": 0,
      "ipsecSessionTime": 0,
      "ipsecTxBytes": 0,
      "ipsecTxDropPkts": 0,
      "ipsecTxIdleTime": 0,
      "ipsecTxPkts": 0,
      "monitoringEnabled": false,
      "ipType": "IPV4"
    },
    {
      "deviceName": "AP007",
      "description": "Description",
      "status": "Online",
      "alerts": 0,
      "ip": null,
      "ipv6Address": null,
      "txRx": null,
      "noise24G": null,
      "noise5G": null,
      "airtime24G": null,
      "airtime5G": null,
      "latency24G": null,
      "latency50G": null,
      "capacity": null,
      "capacity24G": null,
      "capacity50G": null,
      "connectionFailure": null,
      "model": null,
      "apMac": "AB:CD:00:00:00:06",
      "channel24G": null,
      "channel5G": null,
      "meshRole": "DISABLED",
      "meshMode": "Auto",
      "zoneName": null,
      "apGroupName": null,
      "extIp": "10.10.10.1",
      "extPort": "3000",
      "firmwareVersion": null,
      "serial": null,
      "retry24G": null,
      "retry5G": null,
      "configurationStatus": null,
      "lastSeen": null,
      "numClients": 0,
      "numClients24G": 0,
      "numClients5G": 0,
      "tx": null,
      "rx": null,
      "location": null,
      "wlanGroup24Id": null,
      "wlanGroup50Id": null,
      "wlanGroup24Name": null,
      "wlanGroup50Name": null,
      "enabledBonjourGateway": false,
      "controlBladeName": null,
      "lbsStatus": null,
      "administrativeState": "Unlocked",
      "registrationState": "Approved",
      "provisionMethod": "ProvisionMethod1",
      "provisionStage": "PRE_AP_JOIN",
      "registrationTime": 1484720660452,
      "managementVlan": null,
      "configOverride": false,
      "indoorMapId": null,
      "apGroupId": "4db7c545-4b1d-49f1-857e-8b271ae9af42",
      "indoorMapXy": null,
      "indoorMapName": null,
      "indoorMapLocation": null,
      "deviceGps": null,
      "connectionStatus": "Connect",
      "zoneId": "76c3b5a0-d809-4fb1-8535-5c200e5341d1",
      "zoneFirmwareVersion": "3.5.0.102.79",
      "domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
      "domainName": null,
      "dpIp": null,
      "controlBladeId": null,
      "isCriticalAp": false,
      "crashDump": null,
      "cableModemSupported": null,
      "cableModemResetSupported": null,
      "swapInMac": null,
      "swapOutMac": null,
      "isOverallHealthStatusFlagged": false,
      "isLatency24GFlagged": false,
      "isCapacity24GFlagged": false,
      "isConnectionFailure24GFlagged": false,
      "isLatency50GFlagged": false,
      "isCapacity50GFlagged": false,
      "isConnectionFailure50GFlagged": false,
      "isConnectionTotalCountFlagged": false,
      "isConnectionFailureFlagged": false,
      "isAirtimeUtilization24GFlagged": false,
      "isAirtimeUtilization50GFlagged": false,
      "supportFips": false,
      "fipsEnabled": false,
      "eirp24G": 20,
      "eirp50G": 24,
      "uptime": 123,
      "ipsecRxBytes": 0,
      "ipsecRxDropPkts": 0,
      "ipsecRxIdleTime": 0,
      "ipsecRxPkts": 0,
      "ipsecSessionTime": 0,
      "ipsecTxBytes": 0,
      "ipsecTxDropPkts": 0,
      "ipsecTxIdleTime": 0,
      "ipsecTxPkts": 0,
      "monitoringEnabled": false,
      "ipType": "IPV4"
    },
    {
      "deviceName": "AP008",
      "description": "Description",
      "status": "Online",
      "alerts": 0,
      "ip": null,
      "ipv6Address": null,
      "txRx": null,
      "noise24G": null,
      "noise5G": null,
      "airtime24G": null,
      "airtime5G": null,
      "latency24G": null,
      "latency50G": null,
      "capacity": null,
      "capacity24G": null,
      "capacity50G": null,
      "connectionFailure": null,
      "model": null,
      "apMac": "AB:CD:00:00:00:07",
      "channel24G": null,
      "channel5G": null,
      "meshRole": "DISABLED",
      "meshMode": "Auto",
      "zoneName": null,
      "apGroupName": null,
      "extIp": "10.10.10.22",
      "extPort": "3000",
      "firmwareVersion": null,
      "serial": null,
      "retry24G": null,
      "retry5G": null,
      "configurationStatus": null,
      "lastSeen": null,
      "numClients": 0,
      "numClients24G": 0,
      "numClients5G": 0,
      "tx": null,
      "rx": null,
      "location": null,
      "wlanGroup24Id": null,
      "wlanGroup50Id": null,
      "wlanGroup24Name": null,
      "wlanGroup50Name": null,
      "enabledBonjourGateway": false,
      "controlBladeName": null,
      "lbsStatus": null,
      "administrativeState": "Unlocked",
      "registrationState": "Approved",
      "provisionMethod": "ProvisionMethod2",
      "provisionStage": "PRE_AP_JOIN",
      "registrationTime": 1484720660514,
      "managementVlan": null,
      "configOverride": false,
      "indoorMapId": null,
      "apGroupId": "4db7c545-4b1d-49f1-857e-8b271ae9af42",
      "indoorMapXy": null,
      "indoorMapName": null,
      "indoorMapLocation": null,
      "deviceGps": null,
      "connectionStatus": "Connect",
      "zoneId": "76c3b5a0-d809-4fb1-8535-5c200e5341d1",
      "zoneFirmwareVersion": "3.5.0.102.79",
      "domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
      "domainName": null,
      "dpIp": null,
      "controlBladeId": null,
      "isCriticalAp": false,
      "crashDump": null,
      "cableModemSupported": null,
      "cableModemResetSupported": null,
      "swapInMac": null,
      "swapOutMac": null,
      "isOverallHealthStatusFlagged": false,
      "isLatency24GFlagged": false,
      "isCapacity24GFlagged": false,
      "isConnectionFailure24GFlagged": false,
      "isLatency50GFlagged": false,
      "isCapacity50GFlagged": false,
      "isConnectionFailure50GFlagged": false,
      "isConnectionTotalCountFlagged": false,
      "isConnectionFailureFlagged": false,
      "isAirtimeUtilization24GFlagged": false,
      "isAirtimeUtilization50GFlagged": false,
      "supportFips": false,
      "fipsEnabled": false,
      "eirp24G": 20,
      "eirp50G": 24,
      "uptime": 123,
      "ipsecRxBytes": 0,
      "ipsecRxDropPkts": 0,
      "ipsecRxIdleTime": 0,
      "ipsecRxPkts": 0,
      "ipsecSessionTime": 0,
      "ipsecTxBytes": 0,
      "ipsecTxDropPkts": 0,
      "ipsecTxIdleTime": 0,
      "ipsecTxPkts": 0,
      "monitoringEnabled": false,
      "ipType": "IPV4"
    },
    {
      "deviceName": "AP009",
      "description": "Description",
      "status": "Online",
      "alerts": 0,
      "ip": null,
      "ipv6Address": null,
      "txRx": null,
      "noise24G": null,
      "noise5G": null,
      "airtime24G": null,
      "airtime5G": null,
      "latency24G": null,
      "latency50G": null,
      "capacity": null,
      "capacity24G": null,
      "capacity50G": null,
      "connectionFailure": null,
      "model": null,
      "apMac": "AB:CD:00:00:00:08",
      "channel24G": null,
      "channel5G": null,
      "meshRole": "DISABLED",
      "meshMode": "Auto",
      "zoneName": null,
      "apGroupName": null,
      "extIp": "10.10.10.1",
      "extPort": "2000",
      "firmwareVersion": null,
      "serial": null,
      "retry24G": null,
      "retry5G": null,
      "configurationStatus": null,
      "lastSeen": null,
      "numClients": 0,
      "numClients24G": 0,
      "numClients5G": 0,
      "tx": null,
      "rx": null,
      "location": null,
      "wlanGroup24Id": null,
      "wlanGroup50Id": null,
      "wlanGroup24Name": null,
      "wlanGroup50Name": null,
      "enabledBonjourGateway": false,
      "controlBladeName": null,
      "lbsStatus": null,
      "administrativeState": "Unlocked",
      "registrationState": "Approved",
      "provisionMethod": "ProvisionMethod2",
      "provisionStage": "PRE_AP_JOIN",
      "registrationTime": 1484720660583,
      "managementVlan": null,
      "configOverride": false,
      "indoorMapId": null,
      "apGroupId": "4db7c545-4b1d-49f1-857e-8b271ae9af42",
      "indoorMapXy": null,
      "indoorMapName": null,
      "indoorMapLocation": null,
      "deviceGps": null,
      "connectionStatus": "Connect",
      "zoneId": "76c3b5a0-d809-4fb1-8535-5c200e5341d1",
      "zoneFirmwareVersion": "3.5.0.102.79",
      "domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
      "domainName": null,
      "dpIp": null,
      "controlBladeId": null,
      "isCriticalAp": false,
      "crashDump": null,
      "cableModemSupported": null,
      "cableModemResetSupported": null,
      "swapInMac": null,
      "swapOutMac": null,
      "isOverallHealthStatusFlagged": false,
      "isLatency24GFlagged": false,
      "isCapacity24GFlagged": false,
      "isConnectionFailure24GFlagged": false,
      "isLatency50GFlagged": false,
      "isCapacity50GFlagged": false,
      "isConnectionFailure50GFlagged": false,
      "isConnectionTotalCountFlagged": false,
      "isConnectionFailureFlagged": false,
      "isAirtimeUtilization24GFlagged": false,
      "isAirtimeUtilization50GFlagged": false,
      "supportFips": false,
      "fipsEnabled": false,
      "eirp24G": 20,
      "eirp50G": 24,
      "uptime": 123,
      "ipsecRxBytes": 0,
      "ipsecRxDropPkts": 0,
      "ipsecRxIdleTime": 0,
      "ipsecRxPkts": 0,
      "ipsecSessionTime": 0,
      "ipsecTxBytes": 0,
      "ipsecTxDropPkts": 0,
      "ipsecTxIdleTime": 0,
      "ipsecTxPkts": 0,
      "monitoringEnabled": false,
      "ipType": "IPV4"
    },
    {
      "deviceName": "AP054",
      "description": "iYip7ido",
      "status": "Online",
      "alerts": 0,
      "ip": null,
      "ipv6Address": null,
      "txRx": null,
      "noise24G": null,
      "noise5G": null,
      "airtime24G": null,
      "airtime5G": null,
      "latency24G": null,
      "latency50G": null,
      "capacity": null,
      "capacity24G": null,
      "capacity50G": null,
      "connectionFailure": null,
      "model": null,
      "apMac": "AB:CD:00:00:00:35",
      "channel24G": null,
      "channel5G": null,
      "meshRole": "DISABLED",
      "meshMode": "Auto",
      "zoneName": null,
      "apGroupName": null,
      "extIp": null,
      "extPort": null,
      "firmwareVersion": null,
      "serial": null,
      "retry24G": null,
      "retry5G": null,
      "configurationStatus": null,
      "lastSeen": null,
      "numClients": 0,
      "numClients24G": 0,
      "numClients5G": 0,
      "tx": null,
      "rx": null,
      "location": null,
      "wlanGroup24Id": null,
      "wlanGroup50Id": null,
      "wlanGroup24Name": null,
      "wlanGroup50Name": null,
      "enabledBonjourGateway": false,
      "controlBladeName": null,
      "lbsStatus": null,
      "administrativeState": "Unlocked",
      "registrationState": "Approved",
      "provisionMethod": null,
      "provisionStage": "PRE_AP_JOIN",
      "registrationTime": 1484720663315,
      "managementVlan": null,
      "configOverride": false,
      "indoorMapId": null,
      "apGroupId": "df9a60ae-a69a-4a3f-a5b5-fa2657ae8494",
      "indoorMapXy": null,
      "indoorMapName": null,
      "indoorMapLocation": null,
      "deviceGps": null,
      "connectionStatus": "Connect",
      "zoneId": "76c3b5a0-d809-4fb1-8535-5c200e5341d1",
      "zoneFirmwareVersion": "3.5.0.102.79",
      "domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
      "domainName": null,
      "dpIp": null,
      "controlBladeId": null,
      "isCriticalAp": false,
      "crashDump": null,
      "cableModemSupported": null,
      "cableModemResetSupported": null,
      "swapInMac": null,
      "swapOutMac": null,
      "isOverallHealthStatusFlagged": false,
      "isLatency24GFlagged": false,
      "isCapacity24GFlagged": false,
      "isConnectionFailure24GFlagged": false,
      "isLatency50GFlagged": false,
      "isCapacity50GFlagged": false,
      "isConnectionFailure50GFlagged": false,
      "isConnectionTotalCountFlagged": false,
      "isConnectionFailureFlagged": false,
      "isAirtimeUtilization24GFlagged": false,
      "isAirtimeUtilization50GFlagged": false,
      "supportFips": false,
      "fipsEnabled": false,
      "eirp24G": 20,
      "eirp50G": 24,
      "uptime": 123,
      "ipsecRxBytes": 0,
      "ipsecRxDropPkts": 0,
      "ipsecRxIdleTime": 0,
      "ipsecRxPkts": 0,
      "ipsecSessionTime": 0,
      "ipsecTxBytes": 0,
      "ipsecTxDropPkts": 0,
      "ipsecTxIdleTime": 0,
      "ipsecTxPkts": 0,
      "monitoringEnabled": false,
      "ipType": "IPV4"
    },
    {
      "deviceName": "AP055",
      "description": "llEtjoXe",
      "status": "Online",
      "alerts": 0,
      "ip": null,
      "ipv6Address": null,
      "txRx": null,
      "noise24G": null,
      "noise5G": null,
      "airtime24G": null,
      "airtime5G": null,
      "latency24G": null,
      "latency50G": null,
      "capacity": null,
      "capacity24G": null,
      "capacity50G": null,
      "connectionFailure": null,
      "model": null,
      "apMac": "AB:CD:00:00:00:36",
      "channel24G": null,
      "channel5G": null,
      "meshRole": "DISABLED",
      "meshMode": "Auto",
      "zoneName": null,
      "apGroupName": null,
      "extIp": null,
      "extPort": null,
      "firmwareVersion": null,
      "serial": null,
      "retry24G": null,
      "retry5G": null,
      "configurationStatus": null,
      "lastSeen": null,
      "numClients": 0,
      "numClients24G": 0,
      "numClients5G": 0,
      "tx": null,
      "rx": null,
      "location": null,
      "wlanGroup24Id": null,
      "wlanGroup50Id": null,
      "wlanGroup24Name": null,
      "wlanGroup50Name": null,
      "enabledBonjourGateway": false,
      "controlBladeName": null,
      "lbsStatus": null,
      "administrativeState": "Unlocked",
      "registrationState": "Approved",
      "provisionMethod": null,
      "provisionStage": "PRE_AP_JOIN",
      "registrationTime": 1484720663357,
      "managementVlan": null,
      "configOverride": false,
      "indoorMapId": null,
      "apGroupId": "df9a60ae-a69a-4a3f-a5b5-fa2657ae8494",
      "indoorMapXy": null,
      "indoorMapName": null,
      "indoorMapLocation": null,
      "deviceGps": null,
      "connectionStatus": "Connect",
      "zoneId": "76c3b5a0-d809-4fb1-8535-5c200e5341d1",
      "zoneFirmwareVersion": "3.5.0.102.79",
      "domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
      "domainName": null,
      "dpIp": null,
      "controlBladeId": null,
      "isCriticalAp": false,
      "crashDump": null,
      "cableModemSupported": null,
      "cableModemResetSupported": null,
      "swapInMac": null,
      "swapOutMac": null,
      "isOverallHealthStatusFlagged": false,
      "isLatency24GFlagged": false,
      "isCapacity24GFlagged": false,
      "isConnectionFailure24GFlagged": false,
      "isLatency50GFlagged": false,
      "isCapacity50GFlagged": false,
      "isConnectionFailure50GFlagged": false,
      "isConnectionTotalCountFlagged": false,
      "isConnectionFailureFlagged": false,
      "isAirtimeUtilization24GFlagged": false,
      "isAirtimeUtilization50GFlagged": false,
      "supportFips": false,
      "fipsEnabled": false,
      "eirp24G": 20,
      "eirp50G": 24,
      "uptime": 123,
      "ipsecRxBytes": 0,
      "ipsecRxDropPkts": 0,
      "ipsecRxIdleTime": 0,
      "ipsecRxPkts": 0,
      "ipsecSessionTime": 0,
      "ipsecTxBytes": 0,
      "ipsecTxDropPkts": 0,
      "ipsecTxIdleTime": 0,
      "ipsecTxPkts": 0,
      "monitoringEnabled": false,
      "ipType": "IPV4",
      "cellularWanInterface": "wwan0",
      "cellularConnectionStatus": "4G",
      "cellularSignalStrength": "-59 dBm",
      "cellularIMSISIM0": 310260142336966,
      "cellularIMSISIM1": 310460142336964,
      "cellularICCIDSIM0": 8901260145723369000,
      "cellularICCIDSIM1": 4501550134727369000,
      "cellularIsSIM0Present": "YES",
      "cellularIsSIM1Present": "YES",
      "cellularTxBytesSIM0": 1423446,
      "cellularTxBytesSIM1": 1356763,
      "cellularRxBytesSIM0": 1356722,
      "cellularRxBytesSIM1": 1758743,
      "cellularActiveSim": "SIM1",
      "cellularIPaddress": "1.1.1.1",
      "cellularSubnetMask": "255.255.255.0",
      "cellularDefaultGateway": "100.255.62.125",
      "cellularOperator": "T-Mobile",
      "cellular3G4GChannel": 2300,
      "cellularCountry": "US",
      "cellularRadioUptime": 1345234,
      "cellularGpsHistory": [
        {
          "timestamp": 1539851273,
          "latitude": 25.07757,
          "longitude": 121.570908
        },
        {
          "timestamp": 1539851293,
          "latitude": 25.07757,
          "longitude": 121.570908
        }
      ]
    }
  ],
  "extra": {
    "rbacMetadata": [
      {
        "AP_CATEGORY": "FULL_ACCESS"
      },
      {
        "AP_CATEGORY": "FULL_ACCESS"
      },
      {
        "AP_CATEGORY": "FULL_ACCESS"
      },
      {
        "AP_CATEGORY": "FULL_ACCESS"
      },
      {
        "AP_CATEGORY": "FULL_ACCESS"
      },
      {
        "AP_CATEGORY": "FULL_ACCESS"
      },
      {
        "AP_CATEGORY": "FULL_ACCESS"
      },
      {
        "AP_CATEGORY": "FULL_ACCESS"
      },
      {
        "AP_CATEGORY": "FULL_ACCESS"
      }
    ]
  }
}
Schema
{
  "additionalProperties": false,
  "type": "object",
  "properties": {
    "firstIndex": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "totalCount": {
      "type": "integer"
    },
    "extra": {
      "description": "extra information for AP list",
      "type": "object",
      "properties": {
        "rbacMetadata": {
          "type": "array",
          "items": {
            "additionalProperties": {
              "type": "string"
            },
            "properties": {}
          }
        }
      }
    },
    "list": {
      "type": "array",
      "items": {
        "additionalProperties": false,
        "type": "object",
        "properties": {
          "registrationTime": {
            "type": "integer",
            "format": "int64"
          },
          "tx": {
            "type": "integer",
            "format": "int64"
          },
          "indoorMapId": {
            "type": "string"
          },
          "channel24G": {
            "type": "string"
          },
          "channel24gValue": {
            "type": "integer",
            "format": "int64"
          },
          "configOverride": {
            "type": "boolean"
          },
          "deviceName": {
            "type": "string"
          },
          "enabledBonjourGateway": {
            "type": "boolean"
          },
          "numClients24G": {
            "type": "integer",
            "format": "int64"
          },
          "dataBladeName": {
            "type": "string"
          },
          "retry24G": {
            "type": "integer",
            "format": "int64"
          },
          "airtime24G": {
            "type": "integer",
            "format": "int64"
          },
          "noise5G": {
            "type": "integer",
            "format": "int64"
          },
          "model": {
            "type": "string"
          },
          "numClients": {
            "type": "integer",
            "format": "int64"
          },
          "capacity24G": {
            "type": "integer"
          },
          "firmwareVersion": {
            "type": "string"
          },
          "provisionMethod": {
            "type": "string"
          },
          "latency24G": {
            "type": "integer",
            "format": "int64"
          },
          "retry5G": {
            "type": "integer",
            "format": "int64"
          },
          "ip": {
            "type": "string"
          },
          "apMac": {
            "type": "string"
          },
          "noise24G": {
            "type": "integer",
            "format": "int64"
          },
          "lastSeen": {
            "type": "integer",
            "format": "int64"
          },
          "configurationStatus": {
            "type": "string"
          },
          "airtime5G": {
            "type": "integer",
            "format": "int64"
          },
          "alerts": {
            "type": "integer",
            "format": "int64"
          },
          "lbsStatus": {
            "type": "string"
          },
          "status": {
            "type": "string",
            "enum": [
              "Online",
              "Offline",
              "Flagged"
            ]
          },
          "numClients5G": {
            "type": "integer",
            "format": "int64"
          },
          "ipv6Address": {
            "type": "string"
          },
          "capacity50G": {
            "type": "integer"
          },
          "wlanGroup24Name": {
            "type": "string"
          },
          "rx": {
            "type": "integer",
            "format": "int64"
          },
          "connectionFailure": {
            "type": "number"
          },
          "description": {
            "type": "string"
          },
          "capacity": {
            "type": "integer"
          },
          "meshRole": {
            "type": "string"
          },
          "channel5G": {
            "type": "string"
          },
          "channel50gValue": {
            "type": "integer",
            "format": "int64"
          },
          "managementVlan": {
            "type": "integer"
          },
          "wlanGroup50Name": {
            "type": "string"
          },
          "wlanGroup24Id": {
            "type": "string"
          },
          "controlBladeName": {
            "type": "string"
          },
          "zoneName": {
            "type": "string"
          },
          "txRx": {
            "type": "integer",
            "format": "int64"
          },
          "meshMode": {
            "type": "string"
          },
          "extPort": {
            "type": "string"
          },
          "administrativeState": {
            "type": "string"
          },
          "apGroupName": {
            "type": "string"
          },
          "latency50G": {
            "type": "integer",
            "format": "int64"
          },
          "indoorMapXy": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "x": {
                "type": "number"
              },
              "y": {
                "type": "number"
              }
            }
          },
          "apGroupId": {
            "type": "string"
          },
          "extIp": {
            "type": "string"
          },
          "airtime": {
            "type": "integer"
          },
          "provisionStage": {
            "type": "string"
          },
          "indoorMapName": {
            "type": "string"
          },
          "indoorMapLocation": {
            "type": "string"
          },
          "deviceGps": {
            "type": "string"
          },
          "serial": {
            "type": "string"
          },
          "location": {
            "type": "string"
          },
          "wlanGroup50Id": {
            "type": "string"
          },
          "registrationState": {
            "type": "string"
          },
          "zoneId": {
            "type": "string"
          },
          "zoneFirmwareVersion": {
            "type": "string"
          },
          "zoneAffinityProfileName": {
            "type": "string"
          },
          "connectionStatus": {
            "type": "string"
          },
          "domainId": {
            "type": "string"
          },
          "domainName": {
            "type": "string"
          },
          "dpIp": {
            "type": "string"
          },
          "controlBladeId": {
            "type": "string"
          },
          "isCriticalAp": {
            "type": "boolean"
          },
          "crashDump": {
            "type": "integer"
          },
          "cableModemSupported": {
            "type": "boolean"
          },
          "cableModemResetSupported": {
            "type": "boolean"
          },
          "swapInMac": {
            "type": "string"
          },
          "swapOutMac": {
            "type": "string"
          },
          "packetCaptureState": {
            "type": "string"
          },
          "isOverallHealthStatusFlagged": {
            "type": "boolean"
          },
          "isLatency24GFlagged": {
            "type": "boolean"
          },
          "isCapacity24GFlagged": {
            "type": "boolean"
          },
          "isConnectionFailure24GFlagged": {
            "type": "boolean"
          },
          "isLatency50GFlagged": {
            "type": "boolean"
          },
          "isCapacity50GFlagged": {
            "type": "boolean"
          },
          "isConnectionFailure50GFlagged": {
            "type": "boolean"
          },
          "isConnectionTotalCountFlagged": {
            "type": "boolean"
          },
          "isConnectionFailureFlagged": {
            "type": "boolean"
          },
          "isAirtimeUtilization24GFlagged": {
            "type": "boolean"
          },
          "isAirtimeUtilization50GFlagged": {
            "type": "boolean"
          },
          "eirp24G": {
            "type": "integer"
          },
          "eirp50G": {
            "type": "integer"
          },
          "supportFips": {
            "type": "boolean"
          },
          "fipsEnabled": {
            "type": "boolean"
          },
          "uptime": {
            "type": "integer"
          },
          "ipsecSessionTime": {
            "type": "integer",
            "format": "int64"
          },
          "ipsecTxPkts": {
            "type": "integer",
            "format": "int64"
          },
          "ipsecRxPkts": {
            "type": "integer",
            "format": "int64"
          },
          "ipsecTxBytes": {
            "type": "integer",
            "format": "int64"
          },
          "ipsecRxBytes": {
            "type": "integer",
            "format": "int64"
          },
          "ipsecTxDropPkts": {
            "type": "integer",
            "format": "int64"
          },
          "ipsecRxDropPkts": {
            "type": "integer",
            "format": "int64"
          },
          "ipsecTxIdleTime": {
            "type": "integer",
            "format": "int64"
          },
          "ipsecRxIdleTime": {
            "type": "integer",
            "format": "int64"
          },
          "ipType": {
            "type": "string"
          },
          "ipv6Type": {
            "type": "string"
          },
          "cellularWanInterface": {
            "type": "string"
          },
          "cellularConnectionStatus": {
            "type": "string"
          },
          "cellularSignalStrength": {
            "type": "string"
          },
          "cellularIMSISIM0": {
            "type": "string"
          },
          "cellularIMSISIM1": {
            "type": "string"
          },
          "cellularICCIDSIM0": {
            "type": "string"
          },
          "cellularICCIDSIM1": {
            "type": "string"
          },
          "cellularIsSIM0Present": {
            "type": "string"
          },
          "cellularIsSIM1Present": {
            "type": "string"
          },
          "cellularTxBytesSIM0": {
            "type": "integer",
            "format": "int64"
          },
          "cellularTxBytesSIM1": {
            "type": "integer",
            "format": "int64"
          },
          "cellularRxBytesSIM0": {
            "type": "integer",
            "format": "int64"
          },
          "cellularRxBytesSIM1": {
            "type": "integer",
            "format": "int64"
          },
          "cellularActiveSim": {
            "type": "string"
          },
          "cellularIPaddress": {
            "type": "string"
          },
          "cellularSubnetMask": {
            "type": "string"
          },
          "cellularDefaultGateway": {
            "type": "string"
          },
          "cellularOperator": {
            "type": "string"
          },
          "cellular3G4GChannel": {
            "type": "integer"
          },
          "cellularCountry": {
            "type": "string"
          },
          "cellularRadioUptime": {
            "type": "integer"
          },
          "cellularGpsHistory": {
            "type": "array",
            "items": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "timestamp": {
                  "type": "integer"
                },
                "latitude": {
                  "type": "string"
                },
                "longitude": {
                  "type": "string"
                }
              }
            }
          },
          "medianTxRadioMCSRate24G": {
            "type": "integer",
            "format": "int64"
          },
          "medianTxRadioMCSRate50G": {
            "type": "integer",
            "format": "int64"
          },
          "medianRxRadioMCSRate24G": {
            "type": "integer",
            "format": "int64"
          },
          "medianRxRadioMCSRate50G": {
            "type": "integer",
            "format": "int64"
          },
          "monitoringEnabled": {
            "type": "boolean"
          }
        }
      }
    }
  }
}

Query Mesh Topology

POST/v8_2/query/mesh/topology

Use this API command to retrieve a list of topology on zone. Please click the link for the usage of Query Criteria.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "d0d495e1-de50-40e3-8d09-e4bbeb4b4722"
    }
  ]
}
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",
              "CATEGORY",
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "BLADE",
              "SYNCEDSTATUS",
              "REGISTRATIONSTATE",
              "STATUS",
              "SWITCH_GROUP"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraFilters": {
      "description": "\"AND\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "CLIENTIPV6ADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "Type",
              "RogueMac",
              "SSID",
              "ALARMSTATE",
              "DEVICENAME",
              "SWITCH",
              "ZoneAffinityProfileId",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "Specified feature required information",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "type": "string",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "includeUserClickNode": {
          "description": "Can be used when group tree rendering needs include user clicked node.",
          "type": "boolean"
        }
      }
    },
    "extraTimeRange": {
      "description": "Specified data time range of selection",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "interval": {
          "description": "time interval in second",
          "type": "integer",
          "format": "int64"
        },
        "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
{
  "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"
                }
              }
            }
          }
        }
      }
    }
  }
}

Query Mesh Topology by AP MAC

POST/v8_2/query/mesh/{apMac}/topology

Use this API command to retrieve a list of topology on mesh AP. Please click the link for the usage of Query Criteria.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "d0d495e1-de50-40e3-8d09-e4bbeb4b4722"
    }
  ]
}
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",
              "CATEGORY",
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "BLADE",
              "SYNCEDSTATUS",
              "REGISTRATIONSTATE",
              "STATUS",
              "SWITCH_GROUP"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraFilters": {
      "description": "\"AND\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "CLIENTIPV6ADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "Type",
              "RogueMac",
              "SSID",
              "ALARMSTATE",
              "DEVICENAME",
              "SWITCH",
              "ZoneAffinityProfileId",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "Specified feature required information",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "type": "string",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "includeUserClickNode": {
          "description": "Can be used when group tree rendering needs include user clicked node.",
          "type": "boolean"
        }
      }
    },
    "extraTimeRange": {
      "description": "Specified data time range of selection",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "interval": {
          "description": "time interval in second",
          "type": "integer",
          "format": "int64"
        },
        "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
[
  {
    "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
  }
]
Schema
{
  "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"
            }
          }
        }
      }
    }
  }
}

Query Mesh Neighbor AP List

POST/v8_2/query/mesh/{apMac}/neighbor

Use this API command to retrieve a list of neighbor access points on mesh AP. Please click the link for the usage of Query Criteria.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "d0d495e1-de50-40e3-8d09-e4bbeb4b4722"
    }
  ]
}
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",
              "CATEGORY",
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "BLADE",
              "SYNCEDSTATUS",
              "REGISTRATIONSTATE",
              "STATUS",
              "SWITCH_GROUP"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraFilters": {
      "description": "\"AND\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "CLIENTIPV6ADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "Type",
              "RogueMac",
              "SSID",
              "ALARMSTATE",
              "DEVICENAME",
              "SWITCH",
              "ZoneAffinityProfileId",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "Specified feature required information",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "type": "string",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "includeUserClickNode": {
          "description": "Can be used when group tree rendering needs include user clicked node.",
          "type": "boolean"
        }
      }
    },
    "extraTimeRange": {
      "description": "Specified data time range of selection",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "interval": {
          "description": "time interval in second",
          "type": "integer",
          "format": "int64"
        },
        "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
{
  "rawDataTotalCount": 100,
  "totalCount": 10,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "apMac": "AB:CD:00:00:00:02",
      "apName": "AP003",
      "ipAddress": "192.168.0.234",
      "externalIPAddress": "10.10.10.1:2000",
      "apModel": "R500",
      "apFirmware": "3.5.0.102.79",
      "channel": "108(a/g)",
      "connectionStatus": "Disconnect",
      "rssi": 56
    }
  ],
  "extra": null
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "rawDataTotalCount": {
      "description": "MeshNeighborInfos count.",
      "type": "integer"
    },
    "totalCount": {
      "description": "MeshNeighborInfos count in this response.",
      "type": "integer"
    },
    "extra": {
      "description": "Any additional response data.",
      "type": "object"
    },
    "hasMore": {
      "description": "Indicator of whether there are more MeshNeighborInfo after the current displayed list",
      "type": "boolean"
    },
    "firstIndex": {
      "description": "Index of the first MeshNeighborInfo 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 neighbor AP",
            "type": "string"
          },
          "apName": {
            "description": "The name of the neighbor AP",
            "type": "string"
          },
          "ipAddress": {
            "description": "The IP of the neighbor AP",
            "type": "string"
          },
          "externalIPAddress": {
            "description": "The external IP of the neighbor AP",
            "type": "string"
          },
          "apModel": {
            "description": "The model of the neighbor AP",
            "type": "string"
          },
          "apFirmware": {
            "description": "The firmware of the neighbor AP",
            "type": "string"
          },
          "channel": {
            "description": "The channel of the neighbor AP",
            "type": "string"
          },
          "connectionStatus": {
            "description": "The connection status of the neighbor AP",
            "type": "string"
          },
          "rssi": {
            "description": "The RSSI of the neighbor AP",
            "type": "integer"
          },
          "zoneName": {
            "description": "The zone name of the neighbor AP",
            "type": "string"
          }
        }
      }
    }
  }
}

AP packet capture startStreaming

POST/v8_2/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_2/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 download

POST/v8_2/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 stop

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

Use this API to stop AP packet capture or streaming

Response  200

WLAN Group

Retrieve List

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

Retrieve

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

Create

POST/v8_2/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"
    }
  }
}

Add Member

POST/v8_2/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

PATCH/v8_2/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

Modify Member

PATCH/v8_2/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

Delete

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

Use this API command to delete a WLAN group.

Response  204

Disable Member VLAN Override

DELETE/v8_2/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_2/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_2/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_2/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
{
  "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",
            "type": "string"
          },
          "mvnoId": {
            "description": "Tenant UUID",
            "type": "string"
          },
          "zoneId": {
            "description": "Zone ID",
            "type": "string"
          },
          "name": {
            "description": "Name of the WLAN",
            "type": "string"
          },
          "ssid": {
            "description": "SSID of the WLAN",
            "type": "string"
          }
        }
      }
    }
  }
}

Retrieve

GET/v8_2/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": {
    "id": "acctingServiceUUID",
    "name": "acctingServiceName",
    "throughController": false,
    "realmBasedAcct": false,
    "interimUpdateMin": 10,
    "accountingDelayEnabled": 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",
  "flexiVpnProfile": {
    "zoneAffinityId": "91fa3fe0-03da-11e7-8d82-0a0027000000"
  },
  "portalDetectionProfileId": "de0fa30c-9565-11e8-9eb6-529269fb1459",
  "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",
    "singleSessionIdAcctEnabled": false,
    "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",
    "hs20Onboarding": false,
    "avcEnabled": true,
    "bandBalancing": "UseZoneSetting",
    "dtimInterval": 1,
    "directedThreshold": 5,
    "urlFilteringPolicyEnabled": false,
    "urlFilteringPolicyId": "",
    "wifiCallingPolicyEnabled": false,
    "wifiCallingPolicyIds": [],
    "enableRadiusBasedDhcpNat": false,
    "hdOverheadOptimizeEnable": false,
    "probeRssiThr": -85,
    "transientClientMgmtEnable": true,
    "joinIgnoreTimeout": 30,
    "joinAcceptTimeout": 300,
    "joinIgnoreThr": 10,
    "authRssiThr": -85,
    "assocRssiThr": -85
  },
  "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"
                },
                "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", "RADIUS_DHCP", "RADIUS_NAT", "RADIUS_DHCP_NAT", "RADIUS_NAT_RUCKUS", "RADIUS_NAT_SOFTGRE", "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"
                },
                "dhcp82SubOptRadiusFormat" : {
                    "description" : "Radius DHCP/NAT option 82 Format",
                    "type" : "string",
                    "enum" : [ "NONE", "RUCKUS_DEFAULT", "RADIUS_DHCP", "RADIUS_NAT", "RADIUS_DHCP_NAT", "RADIUS_NAT_RUCKUS", "RADIUS_NAT_SOFTGRE", "SOFTGRE_CUSTOMIZED" ]
                },
                "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
                },
                "urlFilteringPolicyEnabled" : {
                    "description" : "Indicator of whether URL Filtering is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "urlFilteringPolicyId" : {
                    "description" : "The URL Filtering policy ID.",
                    "type" : "string"
                },
                "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
                },
                "enableRadiusBasedDhcpNat" : {
                    "type" : "boolean",
                    "default" : false
                },
                "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",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "throughController" : {
                    "description" : "Indicates whether authentication messages were sent through the controller or not",
                    "type" : "boolean"
                },
                "realmBasedAuth" : {
                    "type" : "boolean"
                },
                "id" : {
                    "description" : "Identifier of the authentication service or profile. At least one ID or name or authenticationOption is required in the request.",
                    "type" : "string"
                },
                "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", "null" ],
                    "enum" : [ "Local DB", "Guest", "Always Accept", null ]
                },
                "locationDeliveryEnabled" : {
                    "description" : "RFC5580 location delivery support",
                    "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", "null" ],
                    "enum" : [ "Always Accept", null ]
                }
            }
        },
        "awsExtNasIPEnable" : {
            "description" : "Aws ExtNasIP Enable for CALEA",
            "type" : "boolean"
        },
        "awsVenueEnable" : {
            "description" : "Aws Venue Enable for CALEA",
            "type" : "boolean"
        },
        "bypassCNA" : {
            "description" : "Bypass Capitive Network Assitance",
            "type" : "boolean"
        },
        "caleaEnabled" : {
            "description" : "DP CALEA Server Enabled",
            "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" : [ "L2oGRE", "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" : {
            "description" : "Flexi-VPN profile of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "zoneAffinityId" : {
                    "type" : "string",
                    "description" : "Zone Affinity ID"
                }
            },
            "required" : [ "zoneAffinityId" ]
        },
        "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"
                }
            }
        },
        "dpTunnelNatEnabled" : {
            "description" : "DP Tunnel NAT Enabled",
            "type" : "boolean"
        },
        "dpTunnelDhcpEnabled" : {
            "description" : "DP Tunnel DHCP Enabled",
            "type" : "boolean"
        },
        "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",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "method" : {
                    "description" : "Encryption method",
                    "type" : "string",
                    "enum" : [ "WPA2", "WPA_Mixed", "WEP_64", "WEP_128", "None" ],
                    "default" : "None"
                },
                "algorithm" : {
                    "description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
                    "type" : "string",
                    "enum" : [ "AES", "TKIP_AES" ]
                },
                "passphrase" : {
                    "description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
                    "type" : "string"
                },
                "mfp" : {
                    "description" : "Management frame protection. This only applies to WPA2 + AES",
                    "type" : "string",
                    "enum" : [ "disabled", "capable", "required" ]
                },
                "keyIndex" : {
                    "description" : "Key index. This only applies to WEP64 and WEP128.",
                    "type" : "integer"
                },
                "keyInHex" : {
                    "description" : "Key in hex format. This only applies to WEP64 and WEP128.",
                    "type" : "string"
                },
                "support80211rEnabled" : {
                    "description" : "Enable 802.11r Fast BSS Transition, fast Romaing.",
                    "type" : "boolean"
                },
                "mobilityDomainId" : {
                    "description" : "mobility Domain Id.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 65535
                }
            },
            "required" : [ "method" ]
        },
        "hessid" : {
            "description" : "HESSID of the WLAN",
            "type" : "string",
            "pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$"
        },
        "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",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "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" ]
                },
                "customizedPassword" : {
                    "description" : "User defined password. When this field is set to an empty string, the MAC address is used as password.",
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : "^([!-;=?-~]([ -;=?-~]){0,62}[!-;=?-~]|[!-;=?-~]{1,1}|\s{0,0})$"
                }
            }
        },
        "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" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "enable" : {
                        "description" : "Enabled or disabled",
                        "type" : "boolean"
                    },
                    "priority" : {
                        "description" : "Priority",
                        "type" : "integer"
                    },
                    "low" : {
                        "description" : "DSCP range - low",
                        "type" : [ "integer", "null" ],
                        "minimum" : 0,
                        "maximum" : 255
                    },
                    "high" : {
                        "description" : "DSCP range - high",
                        "type" : [ "integer", "null" ],
                        "minimum" : 0,
                        "maximum" : 255
                    },
                    "excepts" : {
                        "type" : [ "array", "null" ],
                        "items" : {
                            "type" : "integer",
                            "minimum" : 0,
                            "maximum" : 63
                        }
                    }
                },
                "required" : [ "enable", "priority" ]
            },
            "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", "AP_GROUP" ]
                },
                "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", "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.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "type" : {
                    "description" : "Type of WLAN schedule",
                    "type" : "string",
                    "enum" : [ "AlwaysOn", "AlwaysOff", "Customized" ],
                    "default" : "AlwaysOn"
                },
                "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"
                }
            },
            "required" : [ "type" ]
        },
        "ssid" : {
            "description" : "SSID of the WLAN",
            "type" : "string"
        },
        "type" : {
            "description" : "Type of the WLAN",
            "type" : "string",
            "enum" : [ "Standard_Open", "Standard_8021X", "Standard_Mac", "Hotspot", "Hotspot_MacByPass", "Guest", "WebAuth", "Hotspot20", "Hotspot20_Open", "Hotspot20_OSEN" ]
        },
        "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"
        },
        "portalDetectionProfileId" : {
            "type" : "string"
        }
    },
    "type" : "object"
}

Create - 802.1X

POST/v8_2/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
{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "name" : {
            "description" : "Name of the WLAN",
            "type" : "string",
            "minLength" : 1,
            "maxLength" : 32
        },
        "ssid" : {
            "description" : "SSID of the WLAN",
            "type" : "string",
            "minLength" : 1,
            "maxLength" : 32
        },
        "hessid" : {
            "description" : "HESSID of the WLAN",
            "type" : "string",
            "pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$"
        },
        "description" : {
            "description" : "Description of the WLAN",
            "type" : [ "string", "null" ],
            "maxLength" : 64
        },
        "caleaEnabled" : {
            "description" : "DP CALEA Server Enabled",
            "type" : "boolean"
        },
        "dpTunnelNatEnabled" : {
            "description" : "DP Tunnel NAT Enabled",
            "type" : "boolean"
        },
        "dpTunnelDhcpEnabled" : {
            "description" : "DP Tunnel DHCP Enabled",
            "type" : "boolean"
        },
        "awsExtNasIPEnable" : {
            "description" : "Aws ExtNasIP Enable for CALEA",
            "type" : "boolean"
        },
        "awsVenueEnable" : {
            "description" : "Aws Venue Enable for CALEA",
            "type" : "boolean"
        },
        "accessTunnelType" : {
            "description" : "Access tunnel type of the WLAN. APLBO means AP local breakout, RuckusGRE means RuckusGRE tunnel to the data plane, and SoftGRE means AP direct SoftGRE tunnel",
            "type" : "string",
            "enum" : [ "APLBO", "RuckusGRE", "SoftGRE" ]
        },
        "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" : [ "L2oGRE", "Bridge" ]
                }
            },
            "required" : [ "type" ],
            "type" : "object"
        },
        "macAuth" : {
            "description" : "MAC address authentication settings of the WLAN. This only applies to standard MAC and Hotspot MAC bypass WLAN.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "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" ]
                },
                "customizedPassword" : {
                    "description" : "User defined password. When this field is set to an empty string, the MAC address is used as password.",
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : "^([!-;=?-~]([ -;=?-~]){0,62}[!-;=?-~]|[!-;=?-~]{1,1}|\s{0,0})$"
                }
            }
        },
        "encryption" : {
            "description" : "Encryption of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "method" : {
                    "description" : "Encryption method",
                    "type" : "string",
                    "enum" : [ "WPA2", "WPA_Mixed", "WEP_64", "WEP_128", "None" ],
                    "default" : "None"
                },
                "algorithm" : {
                    "description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
                    "type" : "string",
                    "enum" : [ "AES", "TKIP_AES" ]
                },
                "passphrase" : {
                    "description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
                    "type" : "string"
                },
                "mfp" : {
                    "description" : "Management frame protection. This only applies to WPA2 + AES",
                    "type" : "string",
                    "enum" : [ "disabled", "capable", "required" ]
                },
                "keyIndex" : {
                    "description" : "Key index. This only applies to WEP64 and WEP128.",
                    "type" : "integer"
                },
                "keyInHex" : {
                    "description" : "Key in hex format. This only applies to WEP64 and WEP128.",
                    "type" : "string"
                },
                "support80211rEnabled" : {
                    "description" : "Enable 802.11r Fast BSS Transition, fast Romaing.",
                    "type" : "boolean"
                },
                "mobilityDomainId" : {
                    "description" : "mobility Domain Id.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 65535
                }
            },
            "required" : [ "method" ]
        },
        "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.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "throughController" : {
                    "description" : "Indicates whether authentication messages were sent through the controller or not",
                    "type" : "boolean"
                },
                "realmBasedAuth" : {
                    "type" : "boolean"
                },
                "id" : {
                    "description" : "Identifier of the authentication service or profile. At least one ID or name or authenticationOption is required in the request.",
                    "type" : "string"
                },
                "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", "null" ],
                    "enum" : [ "Local DB", "Guest", "Always Accept", null ]
                },
                "locationDeliveryEnabled" : {
                    "description" : "RFC5580 location delivery support",
                    "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", "null" ],
                    "enum" : [ "Always Accept", null ]
                }
            }
        },
        "operatorRealm" : {
            "description" : "Operator realm, operatorRealm only supports coreTunnelProfile type is authServiceOrProfile.locationDeliveryEnabled is true",
            "type" : "string",
            "maxLength" : 255,
            "pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
        },
        "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"
                },
                "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"
        },
        "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"
                }
            }
        },
        "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"
                }
            }
        },
        "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"
        },
        "schedule" : {
            "description" : "Schedule of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "type" : {
                    "description" : "Type of WLAN schedule",
                    "type" : "string",
                    "enum" : [ "AlwaysOn", "AlwaysOff", "Customized" ],
                    "default" : "AlwaysOn"
                },
                "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"
                }
            },
            "required" : [ "type" ]
        },
        "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"
        },
        "l2ACL" : {
            "description" : "Layer 2 ACL of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "devicePolicy" : {
            "description" : "Device policy of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "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", "AP_GROUP" ]
                },
                "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", "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"
                }
            }
        },
        "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", "RADIUS_DHCP", "RADIUS_NAT", "RADIUS_DHCP_NAT", "RADIUS_NAT_RUCKUS", "RADIUS_NAT_SOFTGRE", "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"
                },
                "dhcp82SubOptRadiusFormat" : {
                    "description" : "Radius DHCP/NAT option 82 Format",
                    "type" : "string",
                    "enum" : [ "NONE", "RUCKUS_DEFAULT", "RADIUS_DHCP", "RADIUS_NAT", "RADIUS_DHCP_NAT", "RADIUS_NAT_RUCKUS", "RADIUS_NAT_SOFTGRE", "SOFTGRE_CUSTOMIZED" ]
                },
                "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
                },
                "urlFilteringPolicyEnabled" : {
                    "description" : "Indicator of whether URL Filtering is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "urlFilteringPolicyId" : {
                    "description" : "The URL Filtering policy ID.",
                    "type" : "string"
                },
                "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
                },
                "enableRadiusBasedDhcpNat" : {
                    "type" : "boolean",
                    "default" : false
                },
                "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"
        },
        "diffServProfile" : {
            "description" : "DiffServ profile of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "qosMaps" : {
            "description" : "Qos map set of the WLAN.",
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "enable" : {
                        "description" : "Enabled or disabled",
                        "type" : "boolean"
                    },
                    "priority" : {
                        "description" : "Priority",
                        "type" : "integer"
                    },
                    "low" : {
                        "description" : "DSCP range - low",
                        "type" : [ "integer", "null" ],
                        "minimum" : 0,
                        "maximum" : 255
                    },
                    "high" : {
                        "description" : "DSCP range - high",
                        "type" : [ "integer", "null" ],
                        "minimum" : 0,
                        "maximum" : 255
                    },
                    "excepts" : {
                        "type" : [ "array", "null" ],
                        "items" : {
                            "type" : "integer",
                            "minimum" : 0,
                            "maximum" : 63
                        }
                    }
                },
                "required" : [ "enable", "priority" ]
            }
        },
        "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" ]
                        },
                        "passphrase" : {
                            "description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
                            "type" : "string"
                        }
                    }
                },
                "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" ]
        },
        "dnsServerProfile" : {
            "description" : "DNS server profile of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "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"
        },
        "portalDetectionProfileId" : {
            "type" : "string"
        }
    },
    "required" : [ "name", "ssid", "authServiceOrProfile" ]
}
Response  201
HideShow
Body
{
  "id": "wlanID"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Create - 802.1X with MAC Address

POST/v8_2/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
{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "name" : {
            "description" : "Name of the WLAN",
            "type" : "string",
            "minLength" : 1,
            "maxLength" : 32
        },
        "ssid" : {
            "description" : "SSID of the WLAN",
            "type" : "string",
            "minLength" : 1,
            "maxLength" : 32
        },
        "hessid" : {
            "description" : "HESSID of the WLAN",
            "type" : "string",
            "pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$"
        },
        "description" : {
            "description" : "Description of the WLAN",
            "type" : [ "string", "null" ],
            "maxLength" : 64
        },
        "caleaEnabled" : {
            "description" : "DP CALEA Server Enabled",
            "type" : "boolean"
        },
        "dpTunnelNatEnabled" : {
            "description" : "DP Tunnel NAT Enabled",
            "type" : "boolean"
        },
        "dpTunnelDhcpEnabled" : {
            "description" : "DP Tunnel DHCP Enabled",
            "type" : "boolean"
        },
        "awsExtNasIPEnable" : {
            "description" : "Aws ExtNasIP Enable for CALEA",
            "type" : "boolean"
        },
        "awsVenueEnable" : {
            "description" : "Aws Venue Enable for CALEA",
            "type" : "boolean"
        },
        "accessTunnelType" : {
            "description" : "Access tunnel type of the WLAN. APLBO means AP local breakout, RuckusGRE means RuckusGRE tunnel to the data plane, and SoftGRE means AP direct SoftGRE tunnel",
            "type" : "string",
            "enum" : [ "APLBO", "RuckusGRE", "SoftGRE" ]
        },
        "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" : [ "L2oGRE", "Bridge" ]
                }
            },
            "required" : [ "type" ],
            "type" : "object"
        },
        "macAuth" : {
            "description" : "MAC address authentication settings of the WLAN. This only applies to standard MAC and Hotspot MAC bypass WLAN.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "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" ]
                },
                "customizedPassword" : {
                    "description" : "User defined password. When this field is set to an empty string, the MAC address is used as password.",
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : "^([!-;=?-~]([ -;=?-~]){0,62}[!-;=?-~]|[!-;=?-~]{1,1}|\s{0,0})$"
                }
            }
        },
        "encryption" : {
            "description" : "Encryption of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "method" : {
                    "description" : "Encryption method",
                    "type" : "string",
                    "enum" : [ "WPA2", "WPA_Mixed", "WEP_64", "WEP_128", "None" ],
                    "default" : "None"
                },
                "algorithm" : {
                    "description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
                    "type" : "string",
                    "enum" : [ "AES", "TKIP_AES" ]
                },
                "passphrase" : {
                    "description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
                    "type" : "string"
                },
                "mfp" : {
                    "description" : "Management frame protection. This only applies to WPA2 + AES",
                    "type" : "string",
                    "enum" : [ "disabled", "capable", "required" ]
                },
                "keyIndex" : {
                    "description" : "Key index. This only applies to WEP64 and WEP128.",
                    "type" : "integer"
                },
                "keyInHex" : {
                    "description" : "Key in hex format. This only applies to WEP64 and WEP128.",
                    "type" : "string"
                },
                "support80211rEnabled" : {
                    "description" : "Enable 802.11r Fast BSS Transition, fast Romaing.",
                    "type" : "boolean"
                },
                "mobilityDomainId" : {
                    "description" : "mobility Domain Id.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 65535
                }
            },
            "required" : [ "method" ]
        },
        "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.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "throughController" : {
                    "description" : "Indicates whether authentication messages were sent through the controller or not",
                    "type" : "boolean"
                },
                "realmBasedAuth" : {
                    "type" : "boolean"
                },
                "id" : {
                    "description" : "Identifier of the authentication service or profile. At least one ID or name or authenticationOption is required in the request.",
                    "type" : "string"
                },
                "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", "null" ],
                    "enum" : [ "Local DB", "Guest", "Always Accept", null ]
                },
                "locationDeliveryEnabled" : {
                    "description" : "RFC5580 location delivery support",
                    "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", "null" ],
                    "enum" : [ "Always Accept", null ]
                }
            }
        },
        "operatorRealm" : {
            "description" : "Operator realm, operatorRealm only supports coreTunnelProfile type is authServiceOrProfile.locationDeliveryEnabled is true",
            "type" : "string",
            "maxLength" : 255,
            "pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
        },
        "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"
                },
                "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"
        },
        "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"
                }
            }
        },
        "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"
                }
            }
        },
        "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"
        },
        "schedule" : {
            "description" : "Schedule of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "type" : {
                    "description" : "Type of WLAN schedule",
                    "type" : "string",
                    "enum" : [ "AlwaysOn", "AlwaysOff", "Customized" ],
                    "default" : "AlwaysOn"
                },
                "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"
                }
            },
            "required" : [ "type" ]
        },
        "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"
        },
        "l2ACL" : {
            "description" : "Layer 2 ACL of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "devicePolicy" : {
            "description" : "Device policy of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "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", "AP_GROUP" ]
                },
                "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", "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"
                }
            }
        },
        "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", "RADIUS_DHCP", "RADIUS_NAT", "RADIUS_DHCP_NAT", "RADIUS_NAT_RUCKUS", "RADIUS_NAT_SOFTGRE", "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"
                },
                "dhcp82SubOptRadiusFormat" : {
                    "description" : "Radius DHCP/NAT option 82 Format",
                    "type" : "string",
                    "enum" : [ "NONE", "RUCKUS_DEFAULT", "RADIUS_DHCP", "RADIUS_NAT", "RADIUS_DHCP_NAT", "RADIUS_NAT_RUCKUS", "RADIUS_NAT_SOFTGRE", "SOFTGRE_CUSTOMIZED" ]
                },
                "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
                },
                "urlFilteringPolicyEnabled" : {
                    "description" : "Indicator of whether URL Filtering is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "urlFilteringPolicyId" : {
                    "description" : "The URL Filtering policy ID.",
                    "type" : "string"
                },
                "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
                },
                "enableRadiusBasedDhcpNat" : {
                    "type" : "boolean",
                    "default" : false
                },
                "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"
        },
        "diffServProfile" : {
            "description" : "DiffServ profile of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "qosMaps" : {
            "description" : "Qos map set of the WLAN.",
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "enable" : {
                        "description" : "Enabled or disabled",
                        "type" : "boolean"
                    },
                    "priority" : {
                        "description" : "Priority",
                        "type" : "integer"
                    },
                    "low" : {
                        "description" : "DSCP range - low",
                        "type" : [ "integer", "null" ],
                        "minimum" : 0,
                        "maximum" : 255
                    },
                    "high" : {
                        "description" : "DSCP range - high",
                        "type" : [ "integer", "null" ],
                        "minimum" : 0,
                        "maximum" : 255
                    },
                    "excepts" : {
                        "type" : [ "array", "null" ],
                        "items" : {
                            "type" : "integer",
                            "minimum" : 0,
                            "maximum" : 63
                        }
                    }
                },
                "required" : [ "enable", "priority" ]
            }
        },
        "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" ]
                        },
                        "passphrase" : {
                            "description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
                            "type" : "string"
                        }
                    }
                },
                "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" ]
        },
        "dnsServerProfile" : {
            "description" : "DNS server profile of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "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"
        },
        "portalDetectionProfileId" : {
            "type" : "string"
        }
    },
    "required" : [ "name", "ssid", "authServiceOrProfile" ]
}
Response  201
HideShow
Body
{
  "id": "wlanID"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Create - Wechat

POST/v8_2/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
{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "name" : {
            "description" : "Name of the WLAN",
            "type" : "string",
            "minLength" : 1,
            "maxLength" : 32
        },
        "ssid" : {
            "description" : "SSID of the WLAN",
            "type" : "string",
            "minLength" : 1,
            "maxLength" : 32
        },
        "hessid" : {
            "description" : "HESSID of the WLAN",
            "type" : "string",
            "pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$"
        },
        "description" : {
            "description" : "Description of the WLAN",
            "type" : [ "string", "null" ],
            "maxLength" : 64
        },
        "caleaEnabled" : {
            "description" : "DP CALEA Server Enabled",
            "type" : "boolean"
        },
        "dpTunnelNatEnabled" : {
            "description" : "DP Tunnel NAT Enabled",
            "type" : "boolean"
        },
        "dpTunnelDhcpEnabled" : {
            "description" : "DP Tunnel DHCP Enabled",
            "type" : "boolean"
        },
        "awsExtNasIPEnable" : {
            "description" : "Aws ExtNasIP Enable for CALEA",
            "type" : "boolean"
        },
        "awsVenueEnable" : {
            "description" : "Aws Venue Enable for CALEA",
            "type" : "boolean"
        },
        "accessTunnelType" : {
            "description" : "Access tunnel type of the WLAN. APLBO means AP local breakout, RuckusGRE means RuckusGRE tunnel to the data plane, and SoftGRE means AP direct SoftGRE tunnel",
            "type" : "string",
            "enum" : [ "APLBO", "RuckusGRE", "SoftGRE" ]
        },
        "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" : [ "L2oGRE", "Bridge" ]
                }
            },
            "required" : [ "type" ],
            "type" : "object"
        },
        "macAuth" : {
            "description" : "MAC address authentication settings of the WLAN. This only applies to standard MAC and Hotspot MAC bypass WLAN.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "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" ]
                },
                "customizedPassword" : {
                    "description" : "User defined password. When this field is set to an empty string, the MAC address is used as password.",
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : "^([!-;=?-~]([ -;=?-~]){0,62}[!-;=?-~]|[!-;=?-~]{1,1}|\s{0,0})$"
                }
            }
        },
        "encryption" : {
            "description" : "Encryption of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "method" : {
                    "description" : "Encryption method",
                    "type" : "string",
                    "enum" : [ "WPA2", "WPA_Mixed", "WEP_64", "WEP_128", "None" ],
                    "default" : "None"
                },
                "algorithm" : {
                    "description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
                    "type" : "string",
                    "enum" : [ "AES", "TKIP_AES" ]
                },
                "passphrase" : {
                    "description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
                    "type" : "string"
                },
                "mfp" : {
                    "description" : "Management frame protection. This only applies to WPA2 + AES",
                    "type" : "string",
                    "enum" : [ "disabled", "capable", "required" ]
                },
                "keyIndex" : {
                    "description" : "Key index. This only applies to WEP64 and WEP128.",
                    "type" : "integer"
                },
                "keyInHex" : {
                    "description" : "Key in hex format. This only applies to WEP64 and WEP128.",
                    "type" : "string"
                },
                "support80211rEnabled" : {
                    "description" : "Enable 802.11r Fast BSS Transition, fast Romaing.",
                    "type" : "boolean"
                },
                "mobilityDomainId" : {
                    "description" : "mobility Domain Id.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 65535
                }
            },
            "required" : [ "method" ]
        },
        "authServiceOrProfile" : {
            "description" : "Authentication of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "throughController" : {
                    "description" : "Indicates whether authentication messages were sent through the controller or not",
                    "type" : "boolean"
                },
                "realmBasedAuth" : {
                    "type" : "boolean"
                },
                "id" : {
                    "description" : "Identifier of the authentication service or profile. At least one ID or name or authenticationOption is required in the request.",
                    "type" : "string"
                },
                "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", "null" ],
                    "enum" : [ "Local DB", "Guest", "Always Accept", null ]
                },
                "locationDeliveryEnabled" : {
                    "description" : "RFC5580 location delivery support",
                    "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", "null" ],
                    "enum" : [ "Always Accept", null ]
                }
            }
        },
        "operatorRealm" : {
            "description" : "Operator realm, operatorRealm only supports coreTunnelProfile type is authServiceOrProfile.locationDeliveryEnabled is true",
            "type" : "string",
            "maxLength" : 255,
            "pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
        },
        "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"
                },
                "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"
        },
        "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"
                }
            }
        },
        "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"
                }
            }
        },
        "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" : {
            "description" : "Flexi-VPN profile of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "zoneAffinityId" : {
                    "type" : "string",
                    "description" : "Zone Affinity ID"
                }
            },
            "required" : [ "zoneAffinityId" ]
        },
        "schedule" : {
            "description" : "Schedule of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "type" : {
                    "description" : "Type of WLAN schedule",
                    "type" : "string",
                    "enum" : [ "AlwaysOn", "AlwaysOff", "Customized" ],
                    "default" : "AlwaysOn"
                },
                "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"
                }
            },
            "required" : [ "type" ]
        },
        "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"
        },
        "l2ACL" : {
            "description" : "Layer 2 ACL of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "devicePolicy" : {
            "description" : "Device policy of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "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", "AP_GROUP" ]
                },
                "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", "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"
                }
            }
        },
        "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", "RADIUS_DHCP", "RADIUS_NAT", "RADIUS_DHCP_NAT", "RADIUS_NAT_RUCKUS", "RADIUS_NAT_SOFTGRE", "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"
                },
                "dhcp82SubOptRadiusFormat" : {
                    "description" : "Radius DHCP/NAT option 82 Format",
                    "type" : "string",
                    "enum" : [ "NONE", "RUCKUS_DEFAULT", "RADIUS_DHCP", "RADIUS_NAT", "RADIUS_DHCP_NAT", "RADIUS_NAT_RUCKUS", "RADIUS_NAT_SOFTGRE", "SOFTGRE_CUSTOMIZED" ]
                },
                "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
                },
                "urlFilteringPolicyEnabled" : {
                    "description" : "Indicator of whether URL Filtering is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "urlFilteringPolicyId" : {
                    "description" : "The URL Filtering policy ID.",
                    "type" : "string"
                },
                "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
                },
                "enableRadiusBasedDhcpNat" : {
                    "type" : "boolean",
                    "default" : false
                },
                "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"
        },
        "diffServProfile" : {
            "description" : "DiffServ profile of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "qosMaps" : {
            "description" : "Qos map set of the WLAN.",
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "enable" : {
                        "description" : "Enabled or disabled",
                        "type" : "boolean"
                    },
                    "priority" : {
                        "description" : "Priority",
                        "type" : "integer"
                    },
                    "low" : {
                        "description" : "DSCP range - low",
                        "type" : [ "integer", "null" ],
                        "minimum" : 0,
                        "maximum" : 255
                    },
                    "high" : {
                        "description" : "DSCP range - high",
                        "type" : [ "integer", "null" ],
                        "minimum" : 0,
                        "maximum" : 255
                    },
                    "excepts" : {
                        "type" : [ "array", "null" ],
                        "items" : {
                            "type" : "integer",
                            "minimum" : 0,
                            "maximum" : 63
                        }
                    }
                },
                "required" : [ "enable", "priority" ]
            }
        },
        "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" ]
                        },
                        "passphrase" : {
                            "description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
                            "type" : "string"
                        }
                    }
                },
                "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" ]
        },
        "dnsServerProfile" : {
            "description" : "DNS server profile of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "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"
        },
        "portalDetectionProfileId" : {
            "type" : "string"
        }
    },
    "required" : [ "name", "ssid", "portalServiceProfile" ]
}
Response  201
HideShow
Body
{
  "id": "wlanID"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Create - Standard Open

POST/v8_2/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
{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "name" : {
            "description" : "Name of the WLAN",
            "type" : "string",
            "minLength" : 1,
            "maxLength" : 32
        },
        "ssid" : {
            "description" : "SSID of the WLAN",
            "type" : "string",
            "minLength" : 1,
            "maxLength" : 32
        },
        "hessid" : {
            "description" : "HESSID of the WLAN",
            "type" : "string",
            "pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$"
        },
        "description" : {
            "description" : "Description of the WLAN",
            "type" : [ "string", "null" ],
            "maxLength" : 64
        },
        "caleaEnabled" : {
            "description" : "DP CALEA Server Enabled",
            "type" : "boolean"
        },
        "dpTunnelNatEnabled" : {
            "description" : "DP Tunnel NAT Enabled",
            "type" : "boolean"
        },
        "dpTunnelDhcpEnabled" : {
            "description" : "DP Tunnel DHCP Enabled",
            "type" : "boolean"
        },
        "awsExtNasIPEnable" : {
            "description" : "Aws ExtNasIP Enable for CALEA",
            "type" : "boolean"
        },
        "awsVenueEnable" : {
            "description" : "Aws Venue Enable for CALEA",
            "type" : "boolean"
        },
        "accessTunnelType" : {
            "description" : "Access tunnel type of the WLAN. APLBO means AP local breakout, RuckusGRE means RuckusGRE tunnel to the data plane, and SoftGRE means AP direct SoftGRE tunnel",
            "type" : "string",
            "enum" : [ "APLBO", "RuckusGRE", "SoftGRE" ],
            "default" : "APLBO"
        },
        "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" : [ "L2oGRE", "Bridge" ]
                }
            },
            "required" : [ "type" ],
            "type" : "object"
        },
        "macAuth" : {
            "description" : "MAC address authentication settings of the WLAN. This only applies to standard MAC and Hotspot MAC bypass WLAN.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "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" ]
                },
                "customizedPassword" : {
                    "description" : "User defined password. When this field is set to an empty string, the MAC address is used as password.",
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : "^([!-;=?-~]([ -;=?-~]){0,62}[!-;=?-~]|[!-;=?-~]{1,1}|\s{0,0})$"
                }
            }
        },
        "encryption" : {
            "description" : "Encryption of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "method" : {
                    "description" : "Encryption method",
                    "type" : "string",
                    "enum" : [ "WPA2", "WPA_Mixed", "WEP_64", "WEP_128", "None" ],
                    "default" : "None"
                },
                "algorithm" : {
                    "description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
                    "type" : "string",
                    "enum" : [ "AES", "TKIP_AES" ]
                },
                "passphrase" : {
                    "description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
                    "type" : "string"
                },
                "mfp" : {
                    "description" : "Management frame protection. This only applies to WPA2 + AES",
                    "type" : "string",
                    "enum" : [ "disabled", "capable", "required" ]
                },
                "keyIndex" : {
                    "description" : "Key index. This only applies to WEP64 and WEP128.",
                    "type" : "integer"
                },
                "keyInHex" : {
                    "description" : "Key in hex format. This only applies to WEP64 and WEP128.",
                    "type" : "string"
                },
                "support80211rEnabled" : {
                    "description" : "Enable 802.11r Fast BSS Transition, fast Romaing.",
                    "type" : "boolean"
                },
                "mobilityDomainId" : {
                    "description" : "mobility Domain Id.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 65535
                }
            },
            "required" : [ "method" ]
        },
        "authServiceOrProfile" : {
            "description" : "Authentication of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "throughController" : {
                    "description" : "Indicates whether authentication messages were sent through the controller or not",
                    "type" : "boolean"
                },
                "realmBasedAuth" : {
                    "type" : "boolean"
                },
                "id" : {
                    "description" : "Identifier of the authentication service or profile. At least one ID or name or authenticationOption is required in the request.",
                    "type" : "string"
                },
                "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", "null" ],
                    "enum" : [ "Local DB", "Guest", "Always Accept", null ]
                },
                "locationDeliveryEnabled" : {
                    "description" : "RFC5580 location delivery support",
                    "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", "null" ],
                    "enum" : [ "Always Accept", null ]
                }
            }
        },
        "operatorRealm" : {
            "description" : "Operator realm, operatorRealm only supports coreTunnelProfile type is authServiceOrProfile.locationDeliveryEnabled is true",
            "type" : "string",
            "maxLength" : 255,
            "pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
        },
        "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"
                },
                "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"
        },
        "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"
                }
            }
        },
        "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"
                }
            }
        },
        "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" : {
            "description" : "Flexi-VPN profile of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "zoneAffinityId" : {
                    "type" : "string",
                    "description" : "Zone Affinity ID"
                }
            },
            "required" : [ "zoneAffinityId" ]
        },
        "schedule" : {
            "description" : "Schedule of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "type" : {
                    "description" : "Type of WLAN schedule",
                    "type" : "string",
                    "enum" : [ "AlwaysOn", "AlwaysOff", "Customized" ],
                    "default" : "AlwaysOn"
                },
                "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"
                }
            },
            "required" : [ "type" ]
        },
        "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"
        },
        "l2ACL" : {
            "description" : "Layer 2 ACL of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "devicePolicy" : {
            "description" : "Device policy of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "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", "AP_GROUP" ]
                },
                "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", "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"
                }
            }
        },
        "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", "RADIUS_DHCP", "RADIUS_NAT", "RADIUS_DHCP_NAT", "RADIUS_NAT_RUCKUS", "RADIUS_NAT_SOFTGRE", "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"
                },
                "dhcp82SubOptRadiusFormat" : {
                    "description" : "Radius DHCP/NAT option 82 Format",
                    "type" : "string",
                    "enum" : [ "NONE", "RUCKUS_DEFAULT", "RADIUS_DHCP", "RADIUS_NAT", "RADIUS_DHCP_NAT", "RADIUS_NAT_RUCKUS", "RADIUS_NAT_SOFTGRE", "SOFTGRE_CUSTOMIZED" ]
                },
                "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
                },
                "urlFilteringPolicyEnabled" : {
                    "description" : "Indicator of whether URL Filtering is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "urlFilteringPolicyId" : {
                    "description" : "The URL Filtering policy ID.",
                    "type" : "string"
                },
                "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
                },
                "enableRadiusBasedDhcpNat" : {
                    "type" : "boolean",
                    "default" : false
                },
                "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"
        },
        "diffServProfile" : {
            "description" : "DiffServ profile of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "qosMaps" : {
            "description" : "Qos map set of the WLAN.",
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "enable" : {
                        "description" : "Enabled or disabled",
                        "type" : "boolean"
                    },
                    "priority" : {
                        "description" : "Priority",
                        "type" : "integer"
                    },
                    "low" : {
                        "description" : "DSCP range - low",
                        "type" : [ "integer", "null" ],
                        "minimum" : 0,
                        "maximum" : 255
                    },
                    "high" : {
                        "description" : "DSCP range - high",
                        "type" : [ "integer", "null" ],
                        "minimum" : 0,
                        "maximum" : 255
                    },
                    "excepts" : {
                        "type" : [ "array", "null" ],
                        "items" : {
                            "type" : "integer",
                            "minimum" : 0,
                            "maximum" : 63
                        }
                    }
                },
                "required" : [ "enable", "priority" ]
            }
        },
        "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" ]
                        },
                        "passphrase" : {
                            "description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
                            "type" : "string"
                        }
                    }
                },
                "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" ]
        },
        "dnsServerProfile" : {
            "description" : "DNS server profile of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "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"
        },
        "portalDetectionProfileId" : {
            "type" : "string"
        }
    },
    "required" : [ "name", "ssid" ]
}
Response  201
HideShow
Body
{
  "id": "wlanID"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Create - MAC Auth

POST/v8_2/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
{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "name" : {
            "description" : "Name of the WLAN",
            "type" : "string",
            "minLength" : 1,
            "maxLength" : 32
        },
        "ssid" : {
            "description" : "SSID of the WLAN",
            "type" : "string",
            "minLength" : 1,
            "maxLength" : 32
        },
        "hessid" : {
            "description" : "HESSID of the WLAN",
            "type" : "string",
            "pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$"
        },
        "description" : {
            "description" : "Description of the WLAN",
            "type" : [ "string", "null" ],
            "maxLength" : 64
        },
        "caleaEnabled" : {
            "description" : "DP CALEA Server Enabled",
            "type" : "boolean"
        },
        "dpTunnelNatEnabled" : {
            "description" : "DP Tunnel NAT Enabled",
            "type" : "boolean"
        },
        "dpTunnelDhcpEnabled" : {
            "description" : "DP Tunnel DHCP Enabled",
            "type" : "boolean"
        },
        "awsExtNasIPEnable" : {
            "description" : "Aws ExtNasIP Enable for CALEA",
            "type" : "boolean"
        },
        "awsVenueEnable" : {
            "description" : "Aws Venue Enable for CALEA",
            "type" : "boolean"
        },
        "accessTunnelType" : {
            "description" : "Access tunnel type of the WLAN. APLBO means AP local breakout, RuckusGRE means RuckusGRE tunnel to the data plane, and SoftGRE means AP direct SoftGRE tunnel",
            "type" : "string",
            "enum" : [ "APLBO", "RuckusGRE", "SoftGRE" ]
        },
        "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" : [ "L2oGRE", "Bridge" ]
                }
            },
            "required" : [ "type" ],
            "type" : "object"
        },
        "macAuth" : {
            "description" : "MAC address authentication settings of the WLAN. This only applies to standard MAC and Hotspot MAC bypass WLAN.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "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" ]
                },
                "customizedPassword" : {
                    "description" : "User defined password. When this field is set to an empty string, the MAC address is used as password.",
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : "^([!-;=?-~]([ -;=?-~]){0,62}[!-;=?-~]|[!-;=?-~]{1,1}|\s{0,0})$"
                }
            }
        },
        "encryption" : {
            "description" : "Encryption of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "method" : {
                    "description" : "Encryption method",
                    "type" : "string",
                    "enum" : [ "WPA2", "WPA_Mixed", "WEP_64", "WEP_128", "None" ],
                    "default" : "None"
                },
                "algorithm" : {
                    "description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
                    "type" : "string",
                    "enum" : [ "AES", "TKIP_AES" ]
                },
                "passphrase" : {
                    "description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
                    "type" : "string"
                },
                "mfp" : {
                    "description" : "Management frame protection. This only applies to WPA2 + AES",
                    "type" : "string",
                    "enum" : [ "disabled", "capable", "required" ]
                },
                "keyIndex" : {
                    "description" : "Key index. This only applies to WEP64 and WEP128.",
                    "type" : "integer"
                },
                "keyInHex" : {
                    "description" : "Key in hex format. This only applies to WEP64 and WEP128.",
                    "type" : "string"
                },
                "support80211rEnabled" : {
                    "description" : "Enable 802.11r Fast BSS Transition, fast Romaing.",
                    "type" : "boolean"
                },
                "mobilityDomainId" : {
                    "description" : "mobility Domain Id.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 65535
                }
            },
            "required" : [ "method" ]
        },
        "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.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "throughController" : {
                    "description" : "Indicates whether authentication messages were sent through the controller or not",
                    "type" : "boolean"
                },
                "realmBasedAuth" : {
                    "type" : "boolean"
                },
                "id" : {
                    "description" : "Identifier of the authentication service or profile. At least one ID or name or authenticationOption is required in the request.",
                    "type" : "string"
                },
                "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", "null" ],
                    "enum" : [ "Local DB", "Guest", "Always Accept", null ]
                },
                "locationDeliveryEnabled" : {
                    "description" : "RFC5580 location delivery support",
                    "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", "null" ],
                    "enum" : [ "Always Accept", null ]
                }
            }
        },
        "operatorRealm" : {
            "description" : "Operator realm, operatorRealm only supports coreTunnelProfile type is authServiceOrProfile.locationDeliveryEnabled is true",
            "type" : "string",
            "maxLength" : 255,
            "pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
        },
        "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"
                },
                "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"
        },
        "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"
                }
            }
        },
        "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"
                }
            }
        },
        "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"
        },
        "schedule" : {
            "description" : "Schedule of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "type" : {
                    "description" : "Type of WLAN schedule",
                    "type" : "string",
                    "enum" : [ "AlwaysOn", "AlwaysOff", "Customized" ],
                    "default" : "AlwaysOn"
                },
                "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"
                }
            },
            "required" : [ "type" ]
        },
        "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"
        },
        "l2ACL" : {
            "description" : "Layer 2 ACL of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "devicePolicy" : {
            "description" : "Device policy of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "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", "AP_GROUP" ]
                },
                "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", "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"
                }
            }
        },
        "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", "RADIUS_DHCP", "RADIUS_NAT", "RADIUS_DHCP_NAT", "RADIUS_NAT_RUCKUS", "RADIUS_NAT_SOFTGRE", "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"
                },
                "dhcp82SubOptRadiusFormat" : {
                    "description" : "Radius DHCP/NAT option 82 Format",
                    "type" : "string",
                    "enum" : [ "NONE", "RUCKUS_DEFAULT", "RADIUS_DHCP", "RADIUS_NAT", "RADIUS_DHCP_NAT", "RADIUS_NAT_RUCKUS", "RADIUS_NAT_SOFTGRE", "SOFTGRE_CUSTOMIZED" ]
                },
                "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
                },
                "urlFilteringPolicyEnabled" : {
                    "description" : "Indicator of whether URL Filtering is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "urlFilteringPolicyId" : {
                    "description" : "The URL Filtering policy ID.",
                    "type" : "string"
                },
                "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
                },
                "enableRadiusBasedDhcpNat" : {
                    "type" : "boolean",
                    "default" : false
                },
                "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"
        },
        "diffServProfile" : {
            "description" : "DiffServ profile of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "qosMaps" : {
            "description" : "Qos map set of the WLAN.",
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "enable" : {
                        "description" : "Enabled or disabled",
                        "type" : "boolean"
                    },
                    "priority" : {
                        "description" : "Priority",
                        "type" : "integer"
                    },
                    "low" : {
                        "description" : "DSCP range - low",
                        "type" : [ "integer", "null" ],
                        "minimum" : 0,
                        "maximum" : 255
                    },
                    "high" : {
                        "description" : "DSCP range - high",
                        "type" : [ "integer", "null" ],
                        "minimum" : 0,
                        "maximum" : 255
                    },
                    "excepts" : {
                        "type" : [ "array", "null" ],
                        "items" : {
                            "type" : "integer",
                            "minimum" : 0,
                            "maximum" : 63
                        }
                    }
                },
                "required" : [ "enable", "priority" ]
            }
        },
        "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" ]
                        },
                        "passphrase" : {
                            "description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
                            "type" : "string"
                        }
                    }
                },
                "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" ]
        },
        "dnsServerProfile" : {
            "description" : "DNS server profile of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "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"
        },
        "portalDetectionProfileId" : {
            "type" : "string"
        }
    },
    "required" : [ "name", "ssid", "authServiceOrProfile" ]
}
Response  201
HideShow
Body
{
  "id": "wlanID"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Create - Hotspot

POST/v8_2/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,
        "backupAuthenticationId" : "otherAuthServiceUUID",
        "backupAuthenticationOption" : null
    },
    "accountingServiceOrProfile" : {
        "id" : "acctingServiceUUID",
        "name" : "acctingServiceName",
        "throughController" : false,
        "realmBasedAcct" : false,
        "interimUpdateMin" : 10,
        "accountingDelayEnabled" : false,
        "backupAccountingId" : "otherAccountingServiceUUID",
        "backupAccountingName" : "otherAccountingServiceName"
    },
    "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"
    },
    "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"
        }
    }
}
‧ Sample : Create a Hotspot (WISPr) WLAN allows Hotspot 2.0 Onboarding
{
    "name" : "wlanName",
    "ssid" : "wlanSSID",
    "description" : "wlanDescription",
    "authServiceOrProfile" : {
        "throughController" : false,
        "id" : "authServiceUUID",
        "name" : "authServiceName"
    },
    "portalServiceProfile" : {
        "id" : "portalServiceUUID",
        "name" : "portalServiceName"
    },
    "advancedOptions" : {
        "hs20Onboarding" : true
    }
}
‧ Sample : Create a Hotspot (WISPr) WLAN with authenticationOption configurations
{
    "name" : "wlanName",
    "ssid" : "wlanSSID",
    "description" : "wlanDescription",
    "authServiceOrProfile" : {
        "throughController" : true,
        "authenticationOption" : "Local DB",
        "backupAuthenticationId" : "otherAuthServiceUUID",
        "backupAuthenticationOption" : null
    },
    "portalServiceProfile" : {
        "id" : "portalServiceUUID",
        "name" : "portalServiceName"
    }
}
Schema
{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "name" : {
            "description" : "Name of the WLAN",
            "type" : "string",
            "minLength" : 1,
            "maxLength" : 32
        },
        "ssid" : {
            "description" : "SSID of the WLAN",
            "type" : "string",
            "minLength" : 1,
            "maxLength" : 32
        },
        "hessid" : {
            "description" : "HESSID of the WLAN",
            "type" : "string",
            "pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$"
        },
        "description" : {
            "description" : "Description of the WLAN",
            "type" : [ "string", "null" ],
            "maxLength" : 64
        },
        "bypassCNA" : {
            "description" : "Bypass Capitive Network Assitance",
            "type" : "boolean",
            "default" : false
        },
        "caleaEnabled" : {
            "description" : "DP CALEA Server Enabled",
            "type" : "boolean"
        },
        "dpTunnelNatEnabled" : {
            "description" : "DP Tunnel NAT Enabled",
            "type" : "boolean"
        },
        "dpTunnelDhcpEnabled" : {
            "description" : "DP Tunnel DHCP Enabled",
            "type" : "boolean"
        },
        "awsExtNasIPEnable" : {
            "description" : "Aws ExtNasIP Enable",
            "type" : "boolean"
        },
        "awsVenueEnable" : {
            "description" : "Aws Venue Enable for CALEA",
            "type" : "boolean"
        },
        "accessTunnelType" : {
            "description" : "Access tunnel type of the WLAN. APLBO means AP local breakout, RuckusGRE means RuckusGRE tunnel to the data plane, and SoftGRE means AP direct SoftGRE tunnel",
            "type" : "string",
            "enum" : [ "APLBO", "RuckusGRE", "SoftGRE" ]
        },
        "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" : [ "L2oGRE", "Bridge" ]
                }
            },
            "required" : [ "type" ],
            "type" : "object"
        },
        "macAuth" : {
            "description" : "MAC address authentication settings of the WLAN. This only applies to standard MAC and Hotspot MAC bypass WLAN.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "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" ]
                },
                "customizedPassword" : {
                    "description" : "User defined password. When this field is set to an empty string, the MAC address is used as password.",
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : "^([!-;=?-~]([ -;=?-~]){0,62}[!-;=?-~]|[!-;=?-~]{1,1}|\s{0,0})$"
                }
            }
        },
        "encryption" : {
            "description" : "Encryption of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "method" : {
                    "description" : "Encryption method",
                    "type" : "string",
                    "enum" : [ "WPA2", "WPA_Mixed", "WEP_64", "WEP_128", "None" ],
                    "default" : "None"
                },
                "algorithm" : {
                    "description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
                    "type" : "string",
                    "enum" : [ "AES", "TKIP_AES" ]
                },
                "passphrase" : {
                    "description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
                    "type" : "string"
                },
                "mfp" : {
                    "description" : "Management frame protection. This only applies to WPA2 + AES",
                    "type" : "string",
                    "enum" : [ "disabled", "capable", "required" ]
                },
                "keyIndex" : {
                    "description" : "Key index. This only applies to WEP64 and WEP128.",
                    "type" : "integer"
                },
                "keyInHex" : {
                    "description" : "Key in hex format. This only applies to WEP64 and WEP128.",
                    "type" : "string"
                },
                "support80211rEnabled" : {
                    "description" : "Enable 802.11r Fast BSS Transition, fast Romaing.",
                    "type" : "boolean"
                },
                "mobilityDomainId" : {
                    "description" : "mobility Domain Id.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 65535
                }
            },
            "required" : [ "method" ]
        },
        "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.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "throughController" : {
                    "description" : "Indicates whether authentication messages were sent through the controller or not",
                    "type" : "boolean"
                },
                "realmBasedAuth" : {
                    "type" : "boolean"
                },
                "id" : {
                    "description" : "Identifier of the authentication service or profile. At least one ID or name or authenticationOption is required in the request.",
                    "type" : "string"
                },
                "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", "null" ],
                    "enum" : [ "Local DB", "Guest", "Always Accept", null ]
                },
                "locationDeliveryEnabled" : {
                    "description" : "RFC5580 location delivery support",
                    "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", "null" ],
                    "enum" : [ "Always Accept", null ]
                }
            }
        },
        "operatorRealm" : {
            "description" : "Operator realm, operatorRealm only supports coreTunnelProfile type is authServiceOrProfile.locationDeliveryEnabled is true",
            "type" : "string",
            "maxLength" : 255,
            "pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
        },
        "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"
                },
                "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"
        },
        "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"
                }
            }
        },
        "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"
                }
            }
        },
        "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" : {
            "description" : "Flexi-VPN profile of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "zoneAffinityId" : {
                    "type" : "string",
                    "description" : "Zone Affinity ID"
                }
            },
            "required" : [ "zoneAffinityId" ]
        },
        "schedule" : {
            "description" : "Schedule of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "type" : {
                    "description" : "Type of WLAN schedule",
                    "type" : "string",
                    "enum" : [ "AlwaysOn", "AlwaysOff", "Customized" ],
                    "default" : "AlwaysOn"
                },
                "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"
                }
            },
            "required" : [ "type" ]
        },
        "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"
        },
        "l2ACL" : {
            "description" : "Layer 2 ACL of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "devicePolicy" : {
            "description" : "Device policy of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "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", "AP_GROUP" ]
                },
                "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", "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"
                }
            }
        },
        "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", "RADIUS_DHCP", "RADIUS_NAT", "RADIUS_DHCP_NAT", "RADIUS_NAT_RUCKUS", "RADIUS_NAT_SOFTGRE", "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"
                },
                "dhcp82SubOptRadiusFormat" : {
                    "description" : "Radius DHCP/NAT option 82 Format",
                    "type" : "string",
                    "enum" : [ "NONE", "RUCKUS_DEFAULT", "RADIUS_DHCP", "RADIUS_NAT", "RADIUS_DHCP_NAT", "RADIUS_NAT_RUCKUS", "RADIUS_NAT_SOFTGRE", "SOFTGRE_CUSTOMIZED" ]
                },
                "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
                },
                "urlFilteringPolicyEnabled" : {
                    "description" : "Indicator of whether URL Filtering is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "urlFilteringPolicyId" : {
                    "description" : "The URL Filtering policy ID.",
                    "type" : "string"
                },
                "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
                },
                "enableRadiusBasedDhcpNat" : {
                    "type" : "boolean",
                    "default" : false
                },
                "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"
        },
        "diffServProfile" : {
            "description" : "DiffServ profile of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "qosMaps" : {
            "description" : "Qos map set of the WLAN.",
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "enable" : {
                        "description" : "Enabled or disabled",
                        "type" : "boolean"
                    },
                    "priority" : {
                        "description" : "Priority",
                        "type" : "integer"
                    },
                    "low" : {
                        "description" : "DSCP range - low",
                        "type" : [ "integer", "null" ],
                        "minimum" : 0,
                        "maximum" : 255
                    },
                    "high" : {
                        "description" : "DSCP range - high",
                        "type" : [ "integer", "null" ],
                        "minimum" : 0,
                        "maximum" : 255
                    },
                    "excepts" : {
                        "type" : [ "array", "null" ],
                        "items" : {
                            "type" : "integer",
                            "minimum" : 0,
                            "maximum" : 63
                        }
                    }
                },
                "required" : [ "enable", "priority" ]
            }
        },
        "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" ]
                        },
                        "passphrase" : {
                            "description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
                            "type" : "string"
                        }
                    }
                },
                "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" ]
        },
        "dnsServerProfile" : {
            "description" : "DNS server profile of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "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"
        },
        "portalDetectionProfileId" : {
            "type" : "string"
        }
    },
    "required" : [ "name", "ssid", "authServiceOrProfile", "portalServiceProfile" ]
}
Response  201
HideShow
Body
{
  "id": "wlanID"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Create - Hotspot + MAC bypass

POST/v8_2/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,
        "backupAuthenticationId" : "otherAuthServiceUUID",
        "backupAuthenticationOption" : null
    },
    "accountingServiceOrProfile" : {
        "id" : "acctingServiceUUID",
        "name" : "acctingServiceName",
        "throughController" : false,
        "realmBasedAcct" : false,
        "interimUpdateMin" : 10,
        "accountingDelayEnabled" : false,
        "backupAccountingId" : "otherAccountingServiceUUID",
        "backupAccountingName" : "otherAccountingServiceName"
    },
    "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"
    },
    "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"
        }
    }
}
‧ Sample : Create a Hotspot (WISPr) WLAN allows Hotspot 2.0 Onboarding
{
    "name" : "wlanName",
    "ssid" : "wlanSSID",
    "description" : "wlanDescription",
    "authServiceOrProfile" : {
        "throughController" : false,
        "id" : "authServiceUUID",
        "name" : "authServiceName"
    },
    "portalServiceProfile" : {
        "id" : "portalServiceUUID",
        "name" : "portalServiceName"
    },
    "advancedOptions" : {
        "hs20Onboarding" : true
    }
}
‧ Sample : Create a Hotspot (WISPr) WLAN with authenticationOption configurations
{
    "name" : "wlanName",
    "ssid" : "wlanSSID",
    "description" : "wlanDescription",
    "authServiceOrProfile" : {
        "throughController" : true,
        "authenticationOption" : "Local DB",
        "backupAuthenticationId" : "otherAuthServiceUUID",
        "backupAuthenticationOption" : null
    },
    "portalServiceProfile" : {
        "id" : "portalServiceUUID",
        "name" : "portalServiceName"
    }
}
Schema
{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "name" : {
            "description" : "Name of the WLAN",
            "type" : "string",
            "minLength" : 1,
            "maxLength" : 32
        },
        "ssid" : {
            "description" : "SSID of the WLAN",
            "type" : "string",
            "minLength" : 1,
            "maxLength" : 32
        },
        "hessid" : {
            "description" : "HESSID of the WLAN",
            "type" : "string",
            "pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$"
        },
        "description" : {
            "description" : "Description of the WLAN",
            "type" : [ "string", "null" ],
            "maxLength" : 64
        },
        "bypassCNA" : {
            "description" : "Bypass Capitive Network Assitance",
            "type" : "boolean",
            "default" : false
        },
        "caleaEnabled" : {
            "description" : "DP CALEA Server Enabled",
            "type" : "boolean"
        },
        "dpTunnelNatEnabled" : {
            "description" : "DP Tunnel NAT Enabled",
            "type" : "boolean"
        },
        "dpTunnelDhcpEnabled" : {
            "description" : "DP Tunnel DHCP Enabled",
            "type" : "boolean"
        },
        "awsExtNasIPEnable" : {
            "description" : "Aws ExtNasIP Enable",
            "type" : "boolean"
        },
        "awsVenueEnable" : {
            "description" : "Aws Venue Enable for CALEA",
            "type" : "boolean"
        },
        "accessTunnelType" : {
            "description" : "Access tunnel type of the WLAN. APLBO means AP local breakout, RuckusGRE means RuckusGRE tunnel to the data plane, and SoftGRE means AP direct SoftGRE tunnel",
            "type" : "string",
            "enum" : [ "APLBO", "RuckusGRE", "SoftGRE" ]
        },
        "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" : [ "L2oGRE", "Bridge" ]
                }
            },
            "required" : [ "type" ],
            "type" : "object"
        },
        "macAuth" : {
            "description" : "MAC address authentication settings of the WLAN. This only applies to standard MAC and Hotspot MAC bypass WLAN.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "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" ]
                },
                "customizedPassword" : {
                    "description" : "User defined password. When this field is set to an empty string, the MAC address is used as password.",
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : "^([!-;=?-~]([ -;=?-~]){0,62}[!-;=?-~]|[!-;=?-~]{1,1}|\s{0,0})$"
                }
            }
        },
        "encryption" : {
            "description" : "Encryption of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "method" : {
                    "description" : "Encryption method",
                    "type" : "string",
                    "enum" : [ "WPA2", "WPA_Mixed", "WEP_64", "WEP_128", "None" ],
                    "default" : "None"
                },
                "algorithm" : {
                    "description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
                    "type" : "string",
                    "enum" : [ "AES", "TKIP_AES" ]
                },
                "passphrase" : {
                    "description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
                    "type" : "string"
                },
                "mfp" : {
                    "description" : "Management frame protection. This only applies to WPA2 + AES",
                    "type" : "string",
                    "enum" : [ "disabled", "capable", "required" ]
                },
                "keyIndex" : {
                    "description" : "Key index. This only applies to WEP64 and WEP128.",
                    "type" : "integer"
                },
                "keyInHex" : {
                    "description" : "Key in hex format. This only applies to WEP64 and WEP128.",
                    "type" : "string"
                },
                "support80211rEnabled" : {
                    "description" : "Enable 802.11r Fast BSS Transition, fast Romaing.",
                    "type" : "boolean"
                },
                "mobilityDomainId" : {
                    "description" : "mobility Domain Id.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 65535
                }
            },
            "required" : [ "method" ]
        },
        "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.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "throughController" : {
                    "description" : "Indicates whether authentication messages were sent through the controller or not",
                    "type" : "boolean"
                },
                "realmBasedAuth" : {
                    "type" : "boolean"
                },
                "id" : {
                    "description" : "Identifier of the authentication service or profile. At least one ID or name or authenticationOption is required in the request.",
                    "type" : "string"
                },
                "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", "null" ],
                    "enum" : [ "Local DB", "Guest", "Always Accept", null ]
                },
                "locationDeliveryEnabled" : {
                    "description" : "RFC5580 location delivery support",
                    "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", "null" ],
                    "enum" : [ "Always Accept", null ]
                }
            }
        },
        "operatorRealm" : {
            "description" : "Operator realm, operatorRealm only supports coreTunnelProfile type is authServiceOrProfile.locationDeliveryEnabled is true",
            "type" : "string",
            "maxLength" : 255,
            "pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
        },
        "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"
                },
                "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"
        },
        "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"
                }
            }
        },
        "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"
                }
            }
        },
        "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" : {
            "description" : "Flexi-VPN profile of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "zoneAffinityId" : {
                    "type" : "string",
                    "description" : "Zone Affinity ID"
                }
            },
            "required" : [ "zoneAffinityId" ]
        },
        "schedule" : {
            "description" : "Schedule of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "type" : {
                    "description" : "Type of WLAN schedule",
                    "type" : "string",
                    "enum" : [ "AlwaysOn", "AlwaysOff", "Customized" ],
                    "default" : "AlwaysOn"
                },
                "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"
                }
            },
            "required" : [ "type" ]
        },
        "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"
        },
        "l2ACL" : {
            "description" : "Layer 2 ACL of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "devicePolicy" : {
            "description" : "Device policy of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "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", "AP_GROUP" ]
                },
                "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", "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"
                }
            }
        },
        "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", "RADIUS_DHCP", "RADIUS_NAT", "RADIUS_DHCP_NAT", "RADIUS_NAT_RUCKUS", "RADIUS_NAT_SOFTGRE", "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"
                },
                "dhcp82SubOptRadiusFormat" : {
                    "description" : "Radius DHCP/NAT option 82 Format",
                    "type" : "string",
                    "enum" : [ "NONE", "RUCKUS_DEFAULT", "RADIUS_DHCP", "RADIUS_NAT", "RADIUS_DHCP_NAT", "RADIUS_NAT_RUCKUS", "RADIUS_NAT_SOFTGRE", "SOFTGRE_CUSTOMIZED" ]
                },
                "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
                },
                "urlFilteringPolicyEnabled" : {
                    "description" : "Indicator of whether URL Filtering is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "urlFilteringPolicyId" : {
                    "description" : "The URL Filtering policy ID.",
                    "type" : "string"
                },
                "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
                },
                "enableRadiusBasedDhcpNat" : {
                    "type" : "boolean",
                    "default" : false
                },
                "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"
        },
        "diffServProfile" : {
            "description" : "DiffServ profile of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "qosMaps" : {
            "description" : "Qos map set of the WLAN.",
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "enable" : {
                        "description" : "Enabled or disabled",
                        "type" : "boolean"
                    },
                    "priority" : {
                        "description" : "Priority",
                        "type" : "integer"
                    },
                    "low" : {
                        "description" : "DSCP range - low",
                        "type" : [ "integer", "null" ],
                        "minimum" : 0,
                        "maximum" : 255
                    },
                    "high" : {
                        "description" : "DSCP range - high",
                        "type" : [ "integer", "null" ],
                        "minimum" : 0,
                        "maximum" : 255
                    },
                    "excepts" : {
                        "type" : [ "array", "null" ],
                        "items" : {
                            "type" : "integer",
                            "minimum" : 0,
                            "maximum" : 63
                        }
                    }
                },
                "required" : [ "enable", "priority" ]
            }
        },
        "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" ]
                        },
                        "passphrase" : {
                            "description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
                            "type" : "string"
                        }
                    }
                },
                "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" ]
        },
        "dnsServerProfile" : {
            "description" : "DNS server profile of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "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"
        },
        "portalDetectionProfileId" : {
            "type" : "string"
        }
    },
    "required" : [ "name", "ssid", "authServiceOrProfile", "portalServiceProfile" ]
}
Response  201
HideShow
Body
{
  "id": "wlanID"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Create - Hotspot + 802.1X

POST/v8_2/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,
        "backupAuthenticationId" : "otherAuthServiceUUID",
        "backupAuthenticationOption" : null
    },
    "accountingServiceOrProfile" : {
        "id" : "acctingServiceUUID",
        "name" : "acctingServiceName",
        "throughController" : false,
        "realmBasedAcct" : false,
        "interimUpdateMin" : 10,
        "accountingDelayEnabled" : false,
        "backupAccountingId" : "otherAccountingServiceUUID",
        "backupAccountingName" : "otherAccountingServiceName"
    },
    "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"
    },
    "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"
        }
    }
}
‧ Sample : Create a Hotspot (WISPr) WLAN allows Hotspot 2.0 Onboarding
{
    "name" : "wlanName",
    "ssid" : "wlanSSID",
    "description" : "wlanDescription",
    "authServiceOrProfile" : {
        "throughController" : false,
        "id" : "authServiceUUID",
        "name" : "authServiceName"
    },
    "portalServiceProfile" : {
        "id" : "portalServiceUUID",
        "name" : "portalServiceName"
    },
    "advancedOptions" : {
        "hs20Onboarding" : true
    }
}
‧ Sample : Create a Hotspot (WISPr) WLAN with authenticationOption configurations
{
    "name" : "wlanName",
    "ssid" : "wlanSSID",
    "description" : "wlanDescription",
    "authServiceOrProfile" : {
        "throughController" : true,
        "authenticationOption" : "Local DB",
        "backupAuthenticationId" : "otherAuthServiceUUID",
        "backupAuthenticationOption" : null
    },
    "portalServiceProfile" : {
        "id" : "portalServiceUUID",
        "name" : "portalServiceName"
    }
}
Schema
{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "name" : {
            "description" : "Name of the WLAN",
            "type" : "string",
            "minLength" : 1,
            "maxLength" : 32
        },
        "ssid" : {
            "description" : "SSID of the WLAN",
            "type" : "string",
            "minLength" : 1,
            "maxLength" : 32
        },
        "hessid" : {
            "description" : "HESSID of the WLAN",
            "type" : "string",
            "pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$"
        },
        "description" : {
            "description" : "Description of the WLAN",
            "type" : [ "string", "null" ],
            "maxLength" : 64
        },
        "bypassCNA" : {
            "description" : "Bypass Capitive Network Assitance",
            "type" : "boolean",
            "default" : false
        },
        "caleaEnabled" : {
            "description" : "DP CALEA Server Enabled",
            "type" : "boolean"
        },
        "dpTunnelNatEnabled" : {
            "description" : "DP Tunnel NAT Enabled",
            "type" : "boolean"
        },
        "dpTunnelDhcpEnabled" : {
            "description" : "DP Tunnel DHCP Enabled",
            "type" : "boolean"
        },
        "awsExtNasIPEnable" : {
            "description" : "Aws ExtNasIP Enable",
            "type" : "boolean"
        },
        "awsVenueEnable" : {
            "description" : "Aws Venue Enable for CALEA",
            "type" : "boolean"
        },
        "accessTunnelType" : {
            "description" : "Access tunnel type of the WLAN. APLBO means AP local breakout, RuckusGRE means RuckusGRE tunnel to the data plane, and SoftGRE means AP direct SoftGRE tunnel",
            "type" : "string",
            "enum" : [ "APLBO", "RuckusGRE", "SoftGRE" ]
        },
        "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" : [ "L2oGRE", "Bridge" ]
                }
            },
            "required" : [ "type" ],
            "type" : "object"
        },
        "macAuth" : {
            "description" : "MAC address authentication settings of the WLAN. This only applies to standard MAC and Hotspot MAC bypass WLAN.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "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" ]
                },
                "customizedPassword" : {
                    "description" : "User defined password. When this field is set to an empty string, the MAC address is used as password.",
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : "^([!-;=?-~]([ -;=?-~]){0,62}[!-;=?-~]|[!-;=?-~]{1,1}|\s{0,0})$"
                }
            }
        },
        "encryption" : {
            "description" : "Encryption of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "method" : {
                    "description" : "Encryption method",
                    "type" : "string",
                    "enum" : [ "WPA2", "WPA_Mixed", "WEP_64", "WEP_128", "None" ],
                    "default" : "None"
                },
                "algorithm" : {
                    "description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
                    "type" : "string",
                    "enum" : [ "AES", "TKIP_AES" ]
                },
                "passphrase" : {
                    "description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
                    "type" : "string"
                },
                "mfp" : {
                    "description" : "Management frame protection. This only applies to WPA2 + AES",
                    "type" : "string",
                    "enum" : [ "disabled", "capable", "required" ]
                },
                "keyIndex" : {
                    "description" : "Key index. This only applies to WEP64 and WEP128.",
                    "type" : "integer"
                },
                "keyInHex" : {
                    "description" : "Key in hex format. This only applies to WEP64 and WEP128.",
                    "type" : "string"
                },
                "support80211rEnabled" : {
                    "description" : "Enable 802.11r Fast BSS Transition, fast Romaing.",
                    "type" : "boolean"
                },
                "mobilityDomainId" : {
                    "description" : "mobility Domain Id.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 65535
                }
            },
            "required" : [ "method" ]
        },
        "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.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "throughController" : {
                    "description" : "Indicates whether authentication messages were sent through the controller or not",
                    "type" : "boolean"
                },
                "realmBasedAuth" : {
                    "type" : "boolean"
                },
                "id" : {
                    "description" : "Identifier of the authentication service or profile. At least one ID or name or authenticationOption is required in the request.",
                    "type" : "string"
                },
                "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", "null" ],
                    "enum" : [ "Local DB", "Guest", "Always Accept", null ]
                },
                "locationDeliveryEnabled" : {
                    "description" : "RFC5580 location delivery support",
                    "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", "null" ],
                    "enum" : [ "Always Accept", null ]
                }
            }
        },
        "operatorRealm" : {
            "description" : "Operator realm, operatorRealm only supports coreTunnelProfile type is authServiceOrProfile.locationDeliveryEnabled is true",
            "type" : "string",
            "maxLength" : 255,
            "pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
        },
        "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"
                },
                "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"
        },
        "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"
                }
            }
        },
        "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"
                }
            }
        },
        "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" : {
            "description" : "Flexi-VPN profile of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "zoneAffinityId" : {
                    "type" : "string",
                    "description" : "Zone Affinity ID"
                }
            },
            "required" : [ "zoneAffinityId" ]
        },
        "schedule" : {
            "description" : "Schedule of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "type" : {
                    "description" : "Type of WLAN schedule",
                    "type" : "string",
                    "enum" : [ "AlwaysOn", "AlwaysOff", "Customized" ],
                    "default" : "AlwaysOn"
                },
                "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"
                }
            },
            "required" : [ "type" ]
        },
        "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"
        },
        "l2ACL" : {
            "description" : "Layer 2 ACL of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "devicePolicy" : {
            "description" : "Device policy of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "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", "AP_GROUP" ]
                },
                "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", "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"
                }
            }
        },
        "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", "RADIUS_DHCP", "RADIUS_NAT", "RADIUS_DHCP_NAT", "RADIUS_NAT_RUCKUS", "RADIUS_NAT_SOFTGRE", "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"
                },
                "dhcp82SubOptRadiusFormat" : {
                    "description" : "Radius DHCP/NAT option 82 Format",
                    "type" : "string",
                    "enum" : [ "NONE", "RUCKUS_DEFAULT", "RADIUS_DHCP", "RADIUS_NAT", "RADIUS_DHCP_NAT", "RADIUS_NAT_RUCKUS", "RADIUS_NAT_SOFTGRE", "SOFTGRE_CUSTOMIZED" ]
                },
                "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
                },
                "urlFilteringPolicyEnabled" : {
                    "description" : "Indicator of whether URL Filtering is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "urlFilteringPolicyId" : {
                    "description" : "The URL Filtering policy ID.",
                    "type" : "string"
                },
                "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
                },
                "enableRadiusBasedDhcpNat" : {
                    "type" : "boolean",
                    "default" : false
                },
                "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"
        },
        "diffServProfile" : {
            "description" : "DiffServ profile of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "qosMaps" : {
            "description" : "Qos map set of the WLAN.",
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "enable" : {
                        "description" : "Enabled or disabled",
                        "type" : "boolean"
                    },
                    "priority" : {
                        "description" : "Priority",
                        "type" : "integer"
                    },
                    "low" : {
                        "description" : "DSCP range - low",
                        "type" : [ "integer", "null" ],
                        "minimum" : 0,
                        "maximum" : 255
                    },
                    "high" : {
                        "description" : "DSCP range - high",
                        "type" : [ "integer", "null" ],
                        "minimum" : 0,
                        "maximum" : 255
                    },
                    "excepts" : {
                        "type" : [ "array", "null" ],
                        "items" : {
                            "type" : "integer",
                            "minimum" : 0,
                            "maximum" : 63
                        }
                    }
                },
                "required" : [ "enable", "priority" ]
            }
        },
        "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" ]
                        },
                        "passphrase" : {
                            "description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
                            "type" : "string"
                        }
                    }
                },
                "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" ]
        },
        "dnsServerProfile" : {
            "description" : "DNS server profile of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "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"
        },
        "portalDetectionProfileId" : {
            "type" : "string"
        }
    },
    "required" : [ "name", "ssid", "authServiceOrProfile", "portalServiceProfile" ]
}
Response  201
HideShow
Body
{
  "id": "wlanID"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Create - Guest Access

POST/v8_2/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
{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "name" : {
            "description" : "Name of the WLAN",
            "type" : "string",
            "minLength" : 1,
            "maxLength" : 32
        },
        "ssid" : {
            "description" : "SSID of the WLAN",
            "type" : "string",
            "minLength" : 1,
            "maxLength" : 32
        },
        "hessid" : {
            "description" : "HESSID of the WLAN",
            "type" : "string",
            "pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$"
        },
        "description" : {
            "description" : "Description of the WLAN",
            "type" : [ "string", "null" ],
            "maxLength" : 64
        },
        "bypassCNA" : {
            "description" : "Bypass Capitive Network Assitance",
            "type" : "boolean",
            "default" : false
        },
        "caleaEnabled" : {
            "description" : "DP CALEA Server Enabled",
            "type" : "boolean"
        },
        "dpTunnelNatEnabled" : {
            "description" : "DP Tunnel NAT Enabled",
            "type" : "boolean"
        },
        "dpTunnelDhcpEnabled" : {
            "description" : "DP Tunnel DHCP Enabled",
            "type" : "boolean"
        },
        "awsExtNasIPEnable" : {
            "description" : "Aws ExtNasIP Enable for CALEA",
            "type" : "boolean"
        },
        "awsVenueEnable" : {
            "description" : "Aws Venue Enable for CALEA",
            "type" : "boolean"
        },
        "accessTunnelType" : {
            "description" : "Access tunnel type of the WLAN. APLBO means AP local breakout, RuckusGRE means RuckusGRE tunnel to the data plane, and SoftGRE means AP direct SoftGRE tunnel",
            "type" : "string",
            "enum" : [ "APLBO", "RuckusGRE", "SoftGRE" ]
        },
        "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" : [ "L2oGRE", "Bridge" ]
                }
            },
            "required" : [ "type" ],
            "type" : "object"
        },
        "macAuth" : {
            "description" : "MAC address authentication settings of the WLAN. This only applies to standard MAC and Hotspot MAC bypass WLAN.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "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" ]
                },
                "customizedPassword" : {
                    "description" : "User defined password. When this field is set to an empty string, the MAC address is used as password.",
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : "^([!-;=?-~]([ -;=?-~]){0,62}[!-;=?-~]|[!-;=?-~]{1,1}|\s{0,0})$"
                }
            }
        },
        "encryption" : {
            "description" : "Encryption of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "method" : {
                    "description" : "Encryption method",
                    "type" : "string",
                    "enum" : [ "WPA2", "WPA_Mixed", "WEP_64", "WEP_128", "None" ],
                    "default" : "None"
                },
                "algorithm" : {
                    "description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
                    "type" : "string",
                    "enum" : [ "AES", "TKIP_AES" ]
                },
                "passphrase" : {
                    "description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
                    "type" : "string"
                },
                "mfp" : {
                    "description" : "Management frame protection. This only applies to WPA2 + AES",
                    "type" : "string",
                    "enum" : [ "disabled", "capable", "required" ]
                },
                "keyIndex" : {
                    "description" : "Key index. This only applies to WEP64 and WEP128.",
                    "type" : "integer"
                },
                "keyInHex" : {
                    "description" : "Key in hex format. This only applies to WEP64 and WEP128.",
                    "type" : "string"
                },
                "support80211rEnabled" : {
                    "description" : "Enable 802.11r Fast BSS Transition, fast Romaing.",
                    "type" : "boolean"
                },
                "mobilityDomainId" : {
                    "description" : "mobility Domain Id.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 65535
                }
            },
            "required" : [ "method" ]
        },
        "authServiceOrProfile" : {
            "description" : "Authentication of the WLAN. Guest WLANs only accept two names: Local DB and Always Accept.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "throughController" : {
                    "description" : "Indicates whether authentication messages were sent through the controller or not",
                    "type" : "boolean"
                },
                "realmBasedAuth" : {
                    "type" : "boolean"
                },
                "id" : {
                    "description" : "Identifier of the authentication service or profile. At least one ID or name or authenticationOption is required in the request.",
                    "type" : "string"
                },
                "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", "null" ],
                    "enum" : [ "Local DB", "Guest", "Always Accept", null ]
                },
                "locationDeliveryEnabled" : {
                    "description" : "RFC5580 location delivery support",
                    "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", "null" ],
                    "enum" : [ "Always Accept", null ]
                }
            }
        },
        "operatorRealm" : {
            "description" : "Operator realm, operatorRealm only supports coreTunnelProfile type is authServiceOrProfile.locationDeliveryEnabled is true",
            "type" : "string",
            "maxLength" : 255,
            "pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
        },
        "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"
                },
                "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"
        },
        "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"
                }
            }
        },
        "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"
                }
            }
        },
        "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" : {
            "description" : "Flexi-VPN profile of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "zoneAffinityId" : {
                    "type" : "string",
                    "description" : "Zone Affinity ID"
                }
            },
            "required" : [ "zoneAffinityId" ]
        },
        "schedule" : {
            "description" : "Schedule of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "type" : {
                    "description" : "Type of WLAN schedule",
                    "type" : "string",
                    "enum" : [ "AlwaysOn", "AlwaysOff", "Customized" ],
                    "default" : "AlwaysOn"
                },
                "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"
                }
            },
            "required" : [ "type" ]
        },
        "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"
        },
        "l2ACL" : {
            "description" : "Layer 2 ACL of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "devicePolicy" : {
            "description" : "Device policy of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "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", "AP_GROUP" ]
                },
                "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", "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"
                }
            }
        },
        "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", "RADIUS_DHCP", "RADIUS_NAT", "RADIUS_DHCP_NAT", "RADIUS_NAT_RUCKUS", "RADIUS_NAT_SOFTGRE", "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"
                },
                "dhcp82SubOptRadiusFormat" : {
                    "description" : "Radius DHCP/NAT option 82 Format",
                    "type" : "string",
                    "enum" : [ "NONE", "RUCKUS_DEFAULT", "RADIUS_DHCP", "RADIUS_NAT", "RADIUS_DHCP_NAT", "RADIUS_NAT_RUCKUS", "RADIUS_NAT_SOFTGRE", "SOFTGRE_CUSTOMIZED" ]
                },
                "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
                },
                "urlFilteringPolicyEnabled" : {
                    "description" : "Indicator of whether URL Filtering is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "urlFilteringPolicyId" : {
                    "description" : "The URL Filtering policy ID.",
                    "type" : "string"
                },
                "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
                },
                "enableRadiusBasedDhcpNat" : {
                    "type" : "boolean",
                    "default" : false
                },
                "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"
        },
        "diffServProfile" : {
            "description" : "DiffServ profile of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "qosMaps" : {
            "description" : "Qos map set of the WLAN.",
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "enable" : {
                        "description" : "Enabled or disabled",
                        "type" : "boolean"
                    },
                    "priority" : {
                        "description" : "Priority",
                        "type" : "integer"
                    },
                    "low" : {
                        "description" : "DSCP range - low",
                        "type" : [ "integer", "null" ],
                        "minimum" : 0,
                        "maximum" : 255
                    },
                    "high" : {
                        "description" : "DSCP range - high",
                        "type" : [ "integer", "null" ],
                        "minimum" : 0,
                        "maximum" : 255
                    },
                    "excepts" : {
                        "type" : [ "array", "null" ],
                        "items" : {
                            "type" : "integer",
                            "minimum" : 0,
                            "maximum" : 63
                        }
                    }
                },
                "required" : [ "enable", "priority" ]
            }
        },
        "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" ]
                        },
                        "passphrase" : {
                            "description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
                            "type" : "string"
                        }
                    }
                },
                "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" ]
        },
        "dnsServerProfile" : {
            "description" : "DNS server profile of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "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"
        },
        "portalDetectionProfileId" : {
            "type" : "string"
        }
    },
    "required" : [ "name", "ssid", "authServiceOrProfile", "portalServiceProfile" ]
}
Response  201
HideShow
Body
{
  "id": "wlanID"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Create - Web Auth

POST/v8_2/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
{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "name" : {
            "description" : "Name of the WLAN",
            "type" : "string",
            "minLength" : 1,
            "maxLength" : 32
        },
        "ssid" : {
            "description" : "SSID of the WLAN",
            "type" : "string",
            "minLength" : 1,
            "maxLength" : 32
        },
        "hessid" : {
            "description" : "HESSID of the WLAN",
            "type" : "string",
            "pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$"
        },
        "description" : {
            "description" : "Description of the WLAN",
            "type" : [ "string", "null" ],
            "maxLength" : 64
        },
        "bypassCNA" : {
            "description" : "Bypass Capitive Network Assitance",
            "type" : "boolean",
            "default" : false
        },
        "caleaEnabled" : {
            "description" : "DP CALEA Server Enabled",
            "type" : "boolean"
        },
        "dpTunnelNatEnabled" : {
            "description" : "DP Tunnel NAT Enabled",
            "type" : "boolean"
        },
        "dpTunnelDhcpEnabled" : {
            "description" : "DP Tunnel DHCP Enabled",
            "type" : "boolean"
        },
        "awsExtNasIPEnable" : {
            "description" : "Aws ExtNasIP Enable for CALEA",
            "type" : "boolean"
        },
        "awsVenueEnable" : {
            "description" : "Aws Venue Enable for CALEA",
            "type" : "boolean"
        },
        "accessTunnelType" : {
            "description" : "Access tunnel type of the WLAN. APLBO means AP local breakout, RuckusGRE means RuckusGRE tunnel to the data plane, and SoftGRE means AP direct SoftGRE tunnel",
            "type" : "string",
            "enum" : [ "APLBO", "RuckusGRE", "SoftGRE" ]
        },
        "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" : [ "L2oGRE", "Bridge" ]
                }
            },
            "required" : [ "type" ],
            "type" : "object"
        },
        "macAuth" : {
            "description" : "MAC address authentication settings of the WLAN. This only applies to standard MAC and Hotspot MAC bypass WLAN.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "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" ]
                },
                "customizedPassword" : {
                    "description" : "User defined password. When this field is set to an empty string, the MAC address is used as password.",
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : "^([!-;=?-~]([ -;=?-~]){0,62}[!-;=?-~]|[!-;=?-~]{1,1}|\s{0,0})$"
                }
            }
        },
        "encryption" : {
            "description" : "Encryption of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "method" : {
                    "description" : "Encryption method",
                    "type" : "string",
                    "enum" : [ "WPA2", "WPA_Mixed", "WEP_64", "WEP_128", "None" ],
                    "default" : "None"
                },
                "algorithm" : {
                    "description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
                    "type" : "string",
                    "enum" : [ "AES", "TKIP_AES" ]
                },
                "passphrase" : {
                    "description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
                    "type" : "string"
                },
                "mfp" : {
                    "description" : "Management frame protection. This only applies to WPA2 + AES",
                    "type" : "string",
                    "enum" : [ "disabled", "capable", "required" ]
                },
                "keyIndex" : {
                    "description" : "Key index. This only applies to WEP64 and WEP128.",
                    "type" : "integer"
                },
                "keyInHex" : {
                    "description" : "Key in hex format. This only applies to WEP64 and WEP128.",
                    "type" : "string"
                },
                "support80211rEnabled" : {
                    "description" : "Enable 802.11r Fast BSS Transition, fast Romaing.",
                    "type" : "boolean"
                },
                "mobilityDomainId" : {
                    "description" : "mobility Domain Id.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 65535
                }
            },
            "required" : [ "method" ]
        },
        "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.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "throughController" : {
                    "description" : "Indicates whether authentication messages were sent through the controller or not",
                    "type" : "boolean"
                },
                "realmBasedAuth" : {
                    "type" : "boolean"
                },
                "id" : {
                    "description" : "Identifier of the authentication service or profile. At least one ID or name or authenticationOption is required in the request.",
                    "type" : "string"
                },
                "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", "null" ],
                    "enum" : [ "Local DB", "Guest", "Always Accept", null ]
                },
                "locationDeliveryEnabled" : {
                    "description" : "RFC5580 location delivery support",
                    "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", "null" ],
                    "enum" : [ "Always Accept", null ]
                }
            }
        },
        "operatorRealm" : {
            "description" : "Operator realm, operatorRealm only supports coreTunnelProfile type is authServiceOrProfile.locationDeliveryEnabled is true",
            "type" : "string",
            "maxLength" : 255,
            "pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
        },
        "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"
                },
                "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"
        },
        "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"
                }
            }
        },
        "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"
                }
            }
        },
        "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" : {
            "description" : "Flexi-VPN profile of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "zoneAffinityId" : {
                    "type" : "string",
                    "description" : "Zone Affinity ID"
                }
            },
            "required" : [ "zoneAffinityId" ]
        },
        "schedule" : {
            "description" : "Schedule of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "type" : {
                    "description" : "Type of WLAN schedule",
                    "type" : "string",
                    "enum" : [ "AlwaysOn", "AlwaysOff", "Customized" ],
                    "default" : "AlwaysOn"
                },
                "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"
                }
            },
            "required" : [ "type" ]
        },
        "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"
        },
        "l2ACL" : {
            "description" : "Layer 2 ACL of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "devicePolicy" : {
            "description" : "Device policy of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "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", "AP_GROUP" ]
                },
                "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", "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"
                }
            }
        },
        "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", "RADIUS_DHCP", "RADIUS_NAT", "RADIUS_DHCP_NAT", "RADIUS_NAT_RUCKUS", "RADIUS_NAT_SOFTGRE", "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"
                },
                "dhcp82SubOptRadiusFormat" : {
                    "description" : "Radius DHCP/NAT option 82 Format",
                    "type" : "string",
                    "enum" : [ "NONE", "RUCKUS_DEFAULT", "RADIUS_DHCP", "RADIUS_NAT", "RADIUS_DHCP_NAT", "RADIUS_NAT_RUCKUS", "RADIUS_NAT_SOFTGRE", "SOFTGRE_CUSTOMIZED" ]
                },
                "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
                },
                "urlFilteringPolicyEnabled" : {
                    "description" : "Indicator of whether URL Filtering is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "urlFilteringPolicyId" : {
                    "description" : "The URL Filtering policy ID.",
                    "type" : "string"
                },
                "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
                },
                "enableRadiusBasedDhcpNat" : {
                    "type" : "boolean",
                    "default" : false
                },
                "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"
        },
        "diffServProfile" : {
            "description" : "DiffServ profile of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "qosMaps" : {
            "description" : "Qos map set of the WLAN.",
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "enable" : {
                        "description" : "Enabled or disabled",
                        "type" : "boolean"
                    },
                    "priority" : {
                        "description" : "Priority",
                        "type" : "integer"
                    },
                    "low" : {
                        "description" : "DSCP range - low",
                        "type" : [ "integer", "null" ],
                        "minimum" : 0,
                        "maximum" : 255
                    },
                    "high" : {
                        "description" : "DSCP range - high",
                        "type" : [ "integer", "null" ],
                        "minimum" : 0,
                        "maximum" : 255
                    },
                    "excepts" : {
                        "type" : [ "array", "null" ],
                        "items" : {
                            "type" : "integer",
                            "minimum" : 0,
                            "maximum" : 63
                        }
                    }
                },
                "required" : [ "enable", "priority" ]
            }
        },
        "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" ]
                        },
                        "passphrase" : {
                            "description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
                            "type" : "string"
                        }
                    }
                },
                "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" ]
        },
        "dnsServerProfile" : {
            "description" : "DNS server profile of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "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"
        },
        "portalDetectionProfileId" : {
            "type" : "string"
        }
    },
    "required" : [ "name", "ssid", "authServiceOrProfile", "portalServiceProfile" ]
}
Response  201
HideShow
Body
{
  "id": "wlanID"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Create - Hotspot 2.0

POST/v8_2/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
{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "name" : {
            "description" : "Name of the WLAN",
            "type" : "string",
            "minLength" : 1,
            "maxLength" : 32
        },
        "ssid" : {
            "description" : "SSID of the WLAN",
            "type" : "string",
            "minLength" : 1,
            "maxLength" : 32
        },
        "hessid" : {
            "description" : "HESSID of the WLAN",
            "type" : "string",
            "pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$"
        },
        "description" : {
            "description" : "Description of the WLAN",
            "type" : [ "string", "null" ],
            "maxLength" : 64
        },
        "caleaEnabled" : {
            "description" : "DP CALEA Server Enabled",
            "type" : "boolean"
        },
        "dpTunnelNatEnabled" : {
            "description" : "DP Tunnel NAT Enabled",
            "type" : "boolean"
        },
        "dpTunnelDhcpEnabled" : {
            "description" : "DP Tunnel DHCP Enabled",
            "type" : "boolean"
        },
        "awsExtNasIPEnable" : {
            "description" : "Aws ExtNasIP Enable for CALEA",
            "type" : "boolean"
        },
        "awsVenueEnable" : {
            "description" : "Aws Venue Enable for CALEA",
            "type" : "boolean"
        },
        "accessTunnelType" : {
            "description" : "Access tunnel type of the WLAN. APLBO means AP local breakout, RuckusGRE means RuckusGRE tunnel to the data plane, and SoftGRE means AP direct SoftGRE tunnel",
            "type" : "string",
            "enum" : [ "APLBO", "RuckusGRE", "SoftGRE" ]
        },
        "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" : [ "L2oGRE", "Bridge" ]
                }
            },
            "required" : [ "type" ],
            "type" : "object"
        },
        "macAuth" : {
            "description" : "MAC address authentication settings of the WLAN. This only applies to standard MAC and Hotspot MAC bypass WLAN.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "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" ]
                },
                "customizedPassword" : {
                    "description" : "User defined password. When this field is set to an empty string, the MAC address is used as password.",
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : "^([!-;=?-~]([ -;=?-~]){0,62}[!-;=?-~]|[!-;=?-~]{1,1}|\s{0,0})$"
                }
            }
        },
        "encryption" : {
            "description" : "Encryption of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "method" : {
                    "description" : "Encryption method",
                    "type" : "string",
                    "enum" : [ "WPA2", "WPA_Mixed", "WEP_64", "WEP_128", "None" ],
                    "default" : "None"
                },
                "algorithm" : {
                    "description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
                    "type" : "string",
                    "enum" : [ "AES", "TKIP_AES" ]
                },
                "passphrase" : {
                    "description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
                    "type" : "string"
                },
                "mfp" : {
                    "description" : "Management frame protection. This only applies to WPA2 + AES",
                    "type" : "string",
                    "enum" : [ "disabled", "capable", "required" ]
                },
                "keyIndex" : {
                    "description" : "Key index. This only applies to WEP64 and WEP128.",
                    "type" : "integer"
                },
                "keyInHex" : {
                    "description" : "Key in hex format. This only applies to WEP64 and WEP128.",
                    "type" : "string"
                },
                "support80211rEnabled" : {
                    "description" : "Enable 802.11r Fast BSS Transition, fast Romaing.",
                    "type" : "boolean"
                },
                "mobilityDomainId" : {
                    "description" : "mobility Domain Id.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 65535
                }
            },
            "required" : [ "method" ]
        },
        "authServiceOrProfile" : {
            "description" : "Authentication of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "throughController" : {
                    "description" : "Indicates whether authentication messages were sent through the controller or not",
                    "type" : "boolean"
                },
                "realmBasedAuth" : {
                    "type" : "boolean"
                },
                "id" : {
                    "description" : "Identifier of the authentication service or profile. At least one ID or name or authenticationOption is required in the request.",
                    "type" : "string"
                },
                "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", "null" ],
                    "enum" : [ "Local DB", "Guest", "Always Accept", null ]
                },
                "locationDeliveryEnabled" : {
                    "description" : "RFC5580 location delivery support",
                    "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", "null" ],
                    "enum" : [ "Always Accept", null ]
                }
            }
        },
        "operatorRealm" : {
            "description" : "Operator realm, operatorRealm only supports coreTunnelProfile type is authServiceOrProfile.locationDeliveryEnabled is true",
            "type" : "string",
            "maxLength" : 255,
            "pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
        },
        "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"
                },
                "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"
        },
        "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"
                }
            }
        },
        "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"
                }
            }
        },
        "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"
        },
        "schedule" : {
            "description" : "Schedule of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "type" : {
                    "description" : "Type of WLAN schedule",
                    "type" : "string",
                    "enum" : [ "AlwaysOn", "AlwaysOff", "Customized" ],
                    "default" : "AlwaysOn"
                },
                "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"
                }
            },
            "required" : [ "type" ]
        },
        "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"
        },
        "l2ACL" : {
            "description" : "Layer 2 ACL of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "devicePolicy" : {
            "description" : "Device policy of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "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", "AP_GROUP" ]
                },
                "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", "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"
                }
            }
        },
        "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", "RADIUS_DHCP", "RADIUS_NAT", "RADIUS_DHCP_NAT", "RADIUS_NAT_RUCKUS", "RADIUS_NAT_SOFTGRE", "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"
                },
                "dhcp82SubOptRadiusFormat" : {
                    "description" : "Radius DHCP/NAT option 82 Format",
                    "type" : "string",
                    "enum" : [ "NONE", "RUCKUS_DEFAULT", "RADIUS_DHCP", "RADIUS_NAT", "RADIUS_DHCP_NAT", "RADIUS_NAT_RUCKUS", "RADIUS_NAT_SOFTGRE", "SOFTGRE_CUSTOMIZED" ]
                },
                "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
                },
                "urlFilteringPolicyEnabled" : {
                    "description" : "Indicator of whether URL Filtering is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "urlFilteringPolicyId" : {
                    "description" : "The URL Filtering policy ID.",
                    "type" : "string"
                },
                "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
                },
                "enableRadiusBasedDhcpNat" : {
                    "type" : "boolean",
                    "default" : false
                },
                "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"
        },
        "diffServProfile" : {
            "description" : "DiffServ profile of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "qosMaps" : {
            "description" : "Qos map set of the WLAN.",
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "enable" : {
                        "description" : "Enabled or disabled",
                        "type" : "boolean"
                    },
                    "priority" : {
                        "description" : "Priority",
                        "type" : "integer"
                    },
                    "low" : {
                        "description" : "DSCP range - low",
                        "type" : [ "integer", "null" ],
                        "minimum" : 0,
                        "maximum" : 255
                    },
                    "high" : {
                        "description" : "DSCP range - high",
                        "type" : [ "integer", "null" ],
                        "minimum" : 0,
                        "maximum" : 255
                    },
                    "excepts" : {
                        "type" : [ "array", "null" ],
                        "items" : {
                            "type" : "integer",
                            "minimum" : 0,
                            "maximum" : 63
                        }
                    }
                },
                "required" : [ "enable", "priority" ]
            }
        },
        "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" ]
                        },
                        "passphrase" : {
                            "description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
                            "type" : "string"
                        }
                    }
                },
                "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" ]
        },
        "dnsServerProfile" : {
            "description" : "DNS server profile of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "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"
        },
        "portalDetectionProfileId" : {
            "type" : "string"
        }
    },
    "required" : [ "name", "ssid", "hotspot20Profile" ]
}
Response  201
HideShow
Body
{
  "id": "wlanID"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Create - Hotspot 2.0 Open

POST/v8_2/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" : {
        "name" : {
            "description" : "Name of the WLAN",
            "type" : "string",
            "minLength" : 1,
            "maxLength" : 32
        },
        "ssid" : {
            "description" : "SSID of the WLAN",
            "type" : "string",
            "minLength" : 1,
            "maxLength" : 32
        },
        "hessid" : {
            "description" : "HESSID of the WLAN",
            "type" : "string",
            "pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$"
        },
        "description" : {
            "description" : "Description of the WLAN",
            "type" : [ "string", "null" ],
            "maxLength" : 64
        },
        "caleaEnabled" : {
            "description" : "DP CALEA Server Enabled",
            "type" : "boolean"
        },
        "dpTunnelNatEnabled" : {
            "description" : "DP Tunnel NAT Enabled",
            "type" : "boolean"
        },
        "dpTunnelDhcpEnabled" : {
            "description" : "DP Tunnel DHCP Enabled",
            "type" : "boolean"
        },
        "awsExtNasIPEnable" : {
            "description" : "Aws ExtNasIP Enable for CALEA",
            "type" : "boolean"
        },
        "awsVenueEnable" : {
            "description" : "Aws Venue Enable for CALEA",
            "type" : "boolean"
        },
        "accessTunnelType" : {
            "description" : "Access tunnel type of the WLAN. APLBO means AP local breakout, RuckusGRE means RuckusGRE tunnel to the data plane, and SoftGRE means AP direct SoftGRE tunnel",
            "type" : "string",
            "enum" : [ "APLBO", "RuckusGRE", "SoftGRE" ]
        },
        "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" : [ "L2oGRE", "Bridge" ]
                }
            },
            "required" : [ "type" ],
            "type" : "object"
        },
        "macAuth" : {
            "description" : "MAC address authentication settings of the WLAN. This only applies to standard MAC and Hotspot MAC bypass WLAN.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "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" ]
                },
                "customizedPassword" : {
                    "description" : "User defined password. When this field is set to an empty string, the MAC address is used as password.",
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : "^([!-;=?-~]([ -;=?-~]){0,62}[!-;=?-~]|[!-;=?-~]{1,1}|\s{0,0})$"
                }
            }
        },
        "encryption" : {
            "description" : "Encryption of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "method" : {
                    "description" : "Encryption method",
                    "type" : "string",
                    "enum" : [ "WPA2", "WPA_Mixed", "WEP_64", "WEP_128", "None" ],
                    "default" : "None"
                },
                "algorithm" : {
                    "description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
                    "type" : "string",
                    "enum" : [ "AES", "TKIP_AES" ]
                },
                "passphrase" : {
                    "description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
                    "type" : "string"
                },
                "mfp" : {
                    "description" : "Management frame protection. This only applies to WPA2 + AES",
                    "type" : "string",
                    "enum" : [ "disabled", "capable", "required" ]
                },
                "keyIndex" : {
                    "description" : "Key index. This only applies to WEP64 and WEP128.",
                    "type" : "integer"
                },
                "keyInHex" : {
                    "description" : "Key in hex format. This only applies to WEP64 and WEP128.",
                    "type" : "string"
                },
                "support80211rEnabled" : {
                    "description" : "Enable 802.11r Fast BSS Transition, fast Romaing.",
                    "type" : "boolean"
                },
                "mobilityDomainId" : {
                    "description" : "mobility Domain Id.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 65535
                }
            },
            "required" : [ "method" ]
        },
        "authServiceOrProfile" : {
            "description" : "Authentication of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "throughController" : {
                    "description" : "Indicates whether authentication messages were sent through the controller or not",
                    "type" : "boolean"
                },
                "realmBasedAuth" : {
                    "type" : "boolean"
                },
                "id" : {
                    "description" : "Identifier of the authentication service or profile. At least one ID or name or authenticationOption is required in the request.",
                    "type" : "string"
                },
                "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", "null" ],
                    "enum" : [ "Local DB", "Guest", "Always Accept", null ]
                },
                "locationDeliveryEnabled" : {
                    "description" : "RFC5580 location delivery support",
                    "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", "null" ],
                    "enum" : [ "Always Accept", null ]
                }
            }
        },
        "operatorRealm" : {
            "description" : "Operator realm, operatorRealm only supports coreTunnelProfile type is authServiceOrProfile.locationDeliveryEnabled is true",
            "type" : "string",
            "maxLength" : 255,
            "pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
        },
        "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"
                },
                "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"
        },
        "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"
                }
            }
        },
        "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"
                }
            }
        },
        "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" : {
            "description" : "Flexi-VPN profile of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "zoneAffinityId" : {
                    "type" : "string",
                    "description" : "Zone Affinity ID"
                }
            },
            "required" : [ "zoneAffinityId" ]
        },
        "schedule" : {
            "description" : "Schedule of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "type" : {
                    "description" : "Type of WLAN schedule",
                    "type" : "string",
                    "enum" : [ "AlwaysOn", "AlwaysOff", "Customized" ],
                    "default" : "AlwaysOn"
                },
                "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"
                }
            },
            "required" : [ "type" ]
        },
        "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"
        },
        "l2ACL" : {
            "description" : "Layer 2 ACL of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "devicePolicy" : {
            "description" : "Device policy of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "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", "AP_GROUP" ]
                },
                "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", "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"
                }
            }
        },
        "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", "RADIUS_DHCP", "RADIUS_NAT", "RADIUS_DHCP_NAT", "RADIUS_NAT_RUCKUS", "RADIUS_NAT_SOFTGRE", "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"
                },
                "dhcp82SubOptRadiusFormat" : {
                    "description" : "Radius DHCP/NAT option 82 Format",
                    "type" : "string",
                    "enum" : [ "NONE", "RUCKUS_DEFAULT", "RADIUS_DHCP", "RADIUS_NAT", "RADIUS_DHCP_NAT", "RADIUS_NAT_RUCKUS", "RADIUS_NAT_SOFTGRE", "SOFTGRE_CUSTOMIZED" ]
                },
                "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
                },
                "urlFilteringPolicyEnabled" : {
                    "description" : "Indicator of whether URL Filtering is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "urlFilteringPolicyId" : {
                    "description" : "The URL Filtering policy ID.",
                    "type" : "string"
                },
                "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
                },
                "enableRadiusBasedDhcpNat" : {
                    "type" : "boolean",
                    "default" : false
                },
                "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"
        },
        "diffServProfile" : {
            "description" : "DiffServ profile of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "qosMaps" : {
            "description" : "Qos map set of the WLAN.",
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "enable" : {
                        "description" : "Enabled or disabled",
                        "type" : "boolean"
                    },
                    "priority" : {
                        "description" : "Priority",
                        "type" : "integer"
                    },
                    "low" : {
                        "description" : "DSCP range - low",
                        "type" : [ "integer", "null" ],
                        "minimum" : 0,
                        "maximum" : 255
                    },
                    "high" : {
                        "description" : "DSCP range - high",
                        "type" : [ "integer", "null" ],
                        "minimum" : 0,
                        "maximum" : 255
                    },
                    "excepts" : {
                        "type" : [ "array", "null" ],
                        "items" : {
                            "type" : "integer",
                            "minimum" : 0,
                            "maximum" : 63
                        }
                    }
                },
                "required" : [ "enable", "priority" ]
            }
        },
        "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" ]
                        },
                        "passphrase" : {
                            "description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
                            "type" : "string"
                        }
                    }
                },
                "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" ]
        },
        "dnsServerProfile" : {
            "description" : "DNS server profile of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "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"
        },
        "portalDetectionProfileId" : {
            "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_2/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" : {
        "name" : {
            "description" : "Name of the WLAN",
            "type" : "string",
            "minLength" : 1,
            "maxLength" : 32
        },
        "ssid" : {
            "description" : "SSID of the WLAN",
            "type" : "string",
            "minLength" : 1,
            "maxLength" : 32
        },
        "hessid" : {
            "description" : "HESSID of the WLAN",
            "type" : "string",
            "pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$"
        },
        "description" : {
            "description" : "Description of the WLAN",
            "type" : [ "string", "null" ],
            "maxLength" : 64
        },
        "caleaEnabled" : {
            "description" : "DP CALEA Server Enabled",
            "type" : "boolean"
        },
        "dpTunnelNatEnabled" : {
            "description" : "DP Tunnel NAT Enabled",
            "type" : "boolean"
        },
        "dpTunnelDhcpEnabled" : {
            "description" : "DP Tunnel DHCP Enabled",
            "type" : "boolean"
        },
        "awsExtNasIPEnable" : {
            "description" : "Aws ExtNasIP Enable for CALEA",
            "type" : "boolean"
        },
        "awsVenueEnable" : {
            "description" : "Aws Venue Enable for CALEA",
            "type" : "boolean"
        },
        "accessTunnelType" : {
            "description" : "Access tunnel type of the WLAN. APLBO means AP local breakout, RuckusGRE means RuckusGRE tunnel to the data plane, and SoftGRE means AP direct SoftGRE tunnel",
            "type" : "string",
            "enum" : [ "APLBO", "RuckusGRE", "SoftGRE" ]
        },
        "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" : [ "L2oGRE", "Bridge" ]
                }
            },
            "required" : [ "type" ],
            "type" : "object"
        },
        "macAuth" : {
            "description" : "MAC address authentication settings of the WLAN. This only applies to standard MAC and Hotspot MAC bypass WLAN.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "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" ]
                },
                "customizedPassword" : {
                    "description" : "User defined password. When this field is set to an empty string, the MAC address is used as password.",
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : "^([!-;=?-~]([ -;=?-~]){0,62}[!-;=?-~]|[!-;=?-~]{1,1}|\s{0,0})$"
                }
            }
        },
        "encryption" : {
            "description" : "Encryption of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "method" : {
                    "description" : "Encryption method",
                    "type" : "string",
                    "enum" : [ "WPA2", "WPA_Mixed", "WEP_64", "WEP_128", "None" ],
                    "default" : "None"
                },
                "algorithm" : {
                    "description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
                    "type" : "string",
                    "enum" : [ "AES", "TKIP_AES" ]
                },
                "passphrase" : {
                    "description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
                    "type" : "string"
                },
                "mfp" : {
                    "description" : "Management frame protection. This only applies to WPA2 + AES",
                    "type" : "string",
                    "enum" : [ "disabled", "capable", "required" ]
                },
                "keyIndex" : {
                    "description" : "Key index. This only applies to WEP64 and WEP128.",
                    "type" : "integer"
                },
                "keyInHex" : {
                    "description" : "Key in hex format. This only applies to WEP64 and WEP128.",
                    "type" : "string"
                },
                "support80211rEnabled" : {
                    "description" : "Enable 802.11r Fast BSS Transition, fast Romaing.",
                    "type" : "boolean"
                },
                "mobilityDomainId" : {
                    "description" : "mobility Domain Id.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 65535
                }
            },
            "required" : [ "method" ]
        },
        "authServiceOrProfile" : {
            "description" : "Authentication of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "throughController" : {
                    "description" : "Indicates whether authentication messages were sent through the controller or not",
                    "type" : "boolean"
                },
                "realmBasedAuth" : {
                    "type" : "boolean"
                },
                "id" : {
                    "description" : "Identifier of the authentication service or profile. At least one ID or name or authenticationOption is required in the request.",
                    "type" : "string"
                },
                "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", "null" ],
                    "enum" : [ "Local DB", "Guest", "Always Accept", null ]
                },
                "locationDeliveryEnabled" : {
                    "description" : "RFC5580 location delivery support",
                    "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", "null" ],
                    "enum" : [ "Always Accept", null ]
                }
            }
        },
        "operatorRealm" : {
            "description" : "Operator realm, operatorRealm only supports coreTunnelProfile type is authServiceOrProfile.locationDeliveryEnabled is true",
            "type" : "string",
            "maxLength" : 255,
            "pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
        },
        "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"
                },
                "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"
        },
        "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"
                }
            }
        },
        "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"
                }
            }
        },
        "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" : {
            "description" : "Flexi-VPN profile of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "zoneAffinityId" : {
                    "type" : "string",
                    "description" : "Zone Affinity ID"
                }
            },
            "required" : [ "zoneAffinityId" ]
        },
        "schedule" : {
            "description" : "Schedule of the WLAN",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "type" : {
                    "description" : "Type of WLAN schedule",
                    "type" : "string",
                    "enum" : [ "AlwaysOn", "AlwaysOff", "Customized" ],
                    "default" : "AlwaysOn"
                },
                "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"
                }
            },
            "required" : [ "type" ]
        },
        "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"
        },
        "l2ACL" : {
            "description" : "Layer 2 ACL of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "devicePolicy" : {
            "description" : "Device policy of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "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", "AP_GROUP" ]
                },
                "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", "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"
                }
            }
        },
        "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", "RADIUS_DHCP", "RADIUS_NAT", "RADIUS_DHCP_NAT", "RADIUS_NAT_RUCKUS", "RADIUS_NAT_SOFTGRE", "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"
                },
                "dhcp82SubOptRadiusFormat" : {
                    "description" : "Radius DHCP/NAT option 82 Format",
                    "type" : "string",
                    "enum" : [ "NONE", "RUCKUS_DEFAULT", "RADIUS_DHCP", "RADIUS_NAT", "RADIUS_DHCP_NAT", "RADIUS_NAT_RUCKUS", "RADIUS_NAT_SOFTGRE", "SOFTGRE_CUSTOMIZED" ]
                },
                "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
                },
                "urlFilteringPolicyEnabled" : {
                    "description" : "Indicator of whether URL Filtering is enabled or disabled",
                    "type" : "boolean",
                    "default" : false
                },
                "urlFilteringPolicyId" : {
                    "description" : "The URL Filtering policy ID.",
                    "type" : "string"
                },
                "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
                },
                "enableRadiusBasedDhcpNat" : {
                    "type" : "boolean",
                    "default" : false
                },
                "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"
        },
        "diffServProfile" : {
            "description" : "DiffServ profile of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "qosMaps" : {
            "description" : "Qos map set of the WLAN.",
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "enable" : {
                        "description" : "Enabled or disabled",
                        "type" : "boolean"
                    },
                    "priority" : {
                        "description" : "Priority",
                        "type" : "integer"
                    },
                    "low" : {
                        "description" : "DSCP range - low",
                        "type" : [ "integer", "null" ],
                        "minimum" : 0,
                        "maximum" : 255
                    },
                    "high" : {
                        "description" : "DSCP range - high",
                        "type" : [ "integer", "null" ],
                        "minimum" : 0,
                        "maximum" : 255
                    },
                    "excepts" : {
                        "type" : [ "array", "null" ],
                        "items" : {
                            "type" : "integer",
                            "minimum" : 0,
                            "maximum" : 63
                        }
                    }
                },
                "required" : [ "enable", "priority" ]
            }
        },
        "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" ]
                        },
                        "passphrase" : {
                            "description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
                            "type" : "string"
                        }
                    }
                },
                "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" ]
        },
        "dnsServerProfile" : {
            "description" : "DNS server profile of the WLAN",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "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"
        },
        "portalDetectionProfileId" : {
            "type" : "string"
        }
    },
    "required" : [ "name", "ssid" ]
}
Response  201
HideShow
Body
{
  "id": "wlanID"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Enable Qos Map Set

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

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

Response  201

Query WLANs

POST/v8_2/query/wlan

Query WLANs with specified filters. 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",
              "CATEGORY",
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "BLADE",
              "SYNCEDSTATUS",
              "REGISTRATIONSTATE",
              "STATUS",
              "SWITCH_GROUP"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraFilters": {
      "description": "\"AND\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "CLIENTIPV6ADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "Type",
              "RogueMac",
              "SSID",
              "ALARMSTATE",
              "DEVICENAME",
              "SWITCH",
              "ZoneAffinityProfileId",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "Specified feature required information",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "type": "string",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "includeUserClickNode": {
          "description": "Can be used when group tree rendering needs include user clicked node.",
          "type": "boolean"
        }
      }
    },
    "extraTimeRange": {
      "description": "Specified data time range of selection",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "interval": {
          "description": "time interval in second",
          "type": "integer",
          "format": "int64"
        },
        "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": 5,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "name": "None",
      "status": null,
      "alerts": null,
      "ssid": "None",
      "authMethod": "OPEN",
      "encryptionMethod": "NONE",
      "clients": null,
      "traffic": null,
      "vlan": 1,
      "applicationVisibility": "Disabled",
      "tunneled": "APBridged",
      "zeroITOnboard": "Disabled",
      "zeroITEnabled": "Disabled",
      "trafficUplink": null,
      "trafficDownlink": null,
      "enability11r": null,
      "enability11k": null,
      "description": "",
      "wlanId": "5",
      "wpaVersion": "",
      "wepEncryptionStrength": 0,
      "tenantId": "",
      "tenantDomainName": ""
    },
    {
      "name": "WEP128",
      "status": null,
      "alerts": null,
      "ssid": "WEP128",
      "authMethod": "OPEN",
      "encryptionMethod": "WEP",
      "clients": null,
      "traffic": null,
      "vlan": 1,
      "applicationVisibility": "Disabled",
      "tunneled": "APBridged",
      "zeroITOnboard": "Disabled",
      "zeroITEnabled": "Disabled",
      "trafficUplink": null,
      "trafficDownlink": null,
      "enability11r": null,
      "enability11k": null,
      "description": "",
      "wlanId": "4",
      "wpaVersion": "WEP128",
      "wepEncryptionStrength": 26,
      "tenantId": "",
      "tenantDomainName": ""
    },
    {
      "name": "WEP64",
      "status": null,
      "alerts": null,
      "ssid": "WEP64",
      "authMethod": "OPEN",
      "encryptionMethod": "WEP",
      "clients": null,
      "traffic": null,
      "vlan": 1,
      "applicationVisibility": "Disabled",
      "tunneled": "APBridged",
      "zeroITOnboard": "Disabled",
      "zeroITEnabled": "Disabled",
      "trafficUplink": null,
      "trafficDownlink": null,
      "enability11r": null,
      "enability11k": null,
      "description": "",
      "wlanId": "3",
      "wpaVersion": "WEP64",
      "wepEncryptionStrength": 10,
      "tenantId": "",
      "tenantDomainName": ""
    },
    {
      "name": "WPA-Mixed",
      "status": null,
      "alerts": null,
      "ssid": "WPA-Mixed",
      "authMethod": "OPEN",
      "encryptionMethod": "WPA",
      "clients": null,
      "traffic": null,
      "vlan": 1,
      "applicationVisibility": "Disabled",
      "tunneled": "APBridged",
      "zeroITOnboard": "Disabled",
      "zeroITEnabled": "Disabled",
      "trafficUplink": null,
      "trafficDownlink": null,
      "enability11r": null,
      "enability11k": null,
      "description": "",
      "wlanId": "2",
      "wpaVersion": "AUTO",
      "wepEncryptionStrength": 0,
      "tenantId": "",
      "tenantDomainName": ""
    },
    {
      "name": "wpa2",
      "status": null,
      "alerts": null,
      "ssid": "wpa2",
      "authMethod": "OPEN",
      "encryptionMethod": "WPA",
      "clients": null,
      "traffic": null,
      "vlan": 1,
      "applicationVisibility": "Disabled",
      "tunneled": "APBridged",
      "zeroITOnboard": "Disabled",
      "zeroITEnabled": "Disabled",
      "trafficUplink": null,
      "trafficDownlink": null,
      "enability11r": null,
      "enability11k": null,
      "description": "",
      "wlanId": "1",
      "wpaVersion": "WPA2",
      "wepEncryptionStrength": 0,
      "tenantId": "",
      "tenantDomainName": ""
    }
  ],
  "extra": {
    "rbacMetadata": [
      {
        "WLAN_CATEGORY": "FULL_ACCESS"
      },
      {
        "WLAN_CATEGORY": "FULL_ACCESS"
      },
      {
        "WLAN_CATEGORY": "FULL_ACCESS"
      },
      {
        "WLAN_CATEGORY": "FULL_ACCESS"
      },
      {
        "WLAN_CATEGORY": "FULL_ACCESS"
      }
    ]
  }
}
Schema
{
  "additionalProperties": false,
  "type": "object",
  "properties": {
    "firstIndex": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "totalCount": {
      "type": "integer"
    },
    "extra": {
      "description": "extra information for wlan list",
      "type": "object",
      "properties": {
        "rbacMetadata": {
          "type": "array",
          "items": {
            "additionalProperties": {
              "type": "string"
            },
            "properties": {}
          }
        }
      }
    },
    "list": {
      "type": "array",
      "items": {
        "additionalProperties": false,
        "type": "object",
        "properties": {
          "clients": {
            "type": "integer"
          },
          "applicationVisibility": {
            "type": "string",
            "enum": [
              "Enabled",
              "Disabled"
            ]
          },
          "zeroITOnboard": {
            "type": "string",
            "enum": [
              "Enabled",
              "Disabled"
            ]
          },
          "trafficUplink": {
            "type": "integer"
          },
          "description": {
            "type": "string"
          },
          "zeroITEnabled": {
            "type": "string",
            "enum": [
              "Enabled",
              "Disabled"
            ]
          },
          "ssid": {
            "type": "string"
          },
          "wlanId": {
            "type": "string"
          },
          "encryptionMethod": {
            "type": "string"
          },
          "enability11k": {
            "type": "string",
            "enum": [
              "Enabled",
              "Disabled"
            ]
          },
          "alerts": {
            "type": "integer"
          },
          "tunneled": {
            "type": "string",
            "enum": [
              "Tunneled",
              "APBridged"
            ]
          },
          "vlan": {
            "type": "integer"
          },
          "enability11r": {
            "type": "string",
            "enum": [
              "Enabled",
              "Disabled"
            ]
          },
          "name": {
            "type": "string"
          },
          "authMethod": {
            "type": "string"
          },
          "authType": {
            "type": "string"
          },
          "domainName": {
            "type": "string"
          },
          "zoneName": {
            "type": "string"
          },
          "trafficDownlink": {
            "type": "integer"
          },
          "status": {
            "type": "string",
            "enum": [
              "Online",
              "Flagged",
              "Offline"
            ]
          },
          "traffic": {
            "type": "integer"
          },
          "wpaVersion": {
            "type": "string"
          },
          "wepEncryptionStrength": {
            "type": "integer"
          },
          "tenantId": {
            "type": "string"
          },
          "tenantDomainName": {
            "type": "string"
          },
          "utp": {
            "type": "string"
          }
        }
      }
    }
  }
}

Modify Entire

PUT/v8_2/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": "APLBO",
  "macAuth": {
    "macAuthMacFormat": "802.1X",
    "customizedPassword": "password"
  },
  "encryption": {
    "method": "WPA2",
    "algorithm": "AES",
    "passphrase": "password",
    "mfp": "disabled",
    "support80211rEnabled": true,
    "mobilityDomainId": 3
  },
  "authServiceOrProfile": {
    "throughController": true,
    "id": "authServiceUUID",
    "name": "authServiceName",
    "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",
  "flexiVpnProfile": {
    "zoneAffinityId": "91fa3fe0-03da-11e7-8d82-0a0027000000"
  },
  "portalDetectionProfileId": "de0fa30c-9565-11e8-9eb6-529269fb1459",
  "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,
    "hs20Onboarding": false,
    "avcEnabled": true,
    "dtimInterval": 1,
    "directedThreshold": 5,
    "urlFilteringPolicyEnabled": false,
    "urlFilteringPolicyId": "",
    "wifiCallingPolicyEnabled": true,
    "wifiCallingPolicyIds": [
      "75e26590-547f-11e6-9ca7-5a095364c13c",
      "869bb532-547f-11e6-9ca7-5a095364c13c"
    ],
    "enableRadiusBasedDhcpNat": false,
    "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"
  },
  "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"
                },
                "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", "RADIUS_DHCP", "RADIUS_NAT", "RADIUS_DHCP_NAT", "RADIUS_NAT_RUCKUS", "RADIUS_NAT_SOFTGRE", "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"
                },
                "dhcp82SubOptRadiusFormat" : {
                    "description" : "Radius DHCP/NAT option 82 Format",
                    "type" : "string",
                    "enum" : [ "NONE", "RUCKUS_DEFAULT", "RADIUS_DHCP", "RADIUS_NAT", "RADIUS_DHCP_NAT", "RADIUS_NAT_RUCKUS", "RADIUS_NAT_SOFTGRE", "SOFTGRE_CUSTOMIZED" ]
                },
                "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
                },
                "urlFilteringPolicyEnabled" : {
                    "description" : "Indicator of whether URL Filtering is enabled or disabled",
                    "type" : "boolean"
                },
                "urlFilteringPolicyId" : {
                    "description" : "The URL Filtering policy ID.",
                    "type" : "string"
                },
                "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
                },
                "enableRadiusBasedDhcpNat" : {
                    "type" : "boolean"
                },
                "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",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "throughController" : {
                    "description" : "Indicates whether authentication messages were sent through the controller or not",
                    "type" : "boolean"
                },
                "realmBasedAuth" : {
                    "type" : "boolean"
                },
                "id" : {
                    "description" : "Identifier of the authentication service or profile. At least one ID or name or authenticationOption is required in the request.",
                    "type" : "string"
                },
                "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", "null" ],
                    "enum" : [ "Local DB", "Guest", "Always Accept", null ]
                },
                "locationDeliveryEnabled" : {
                    "description" : "RFC5580 location delivery support",
                    "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", "null" ],
                    "enum" : [ "Always Accept", null ]
                }
            }
        },
        "awsExtNasIPEnable" : {
            "description" : "Aws ExtNasIP Enable for CALEA",
            "type" : "boolean"
        },
        "awsVenueEnable" : {
            "description" : "Aws Venue Enable for CALEA",
            "type" : "boolean"
        },
        "bypassCNA" : {
            "description" : "Bypass Capitive Network Assitance",
            "type" : "boolean"
        },
        "caleaEnabled" : {
            "description" : "DP CALEA Server Enabled",
            "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" : [ "L2oGRE", "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" : {
            "description" : "Flexi-VPN profile of the WLAN",
            "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"
                }
            }
        },
        "dpTunnelNatEnabled" : {
            "description" : "DP Tunnel NAT Enabled",
            "type" : "boolean"
        },
        "dpTunnelDhcpEnabled" : {
            "description" : "DP Tunnel DHCP Enabled",
            "type" : "boolean"
        },
        "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" ]
                        },
                        "passphrase" : {
                            "description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
                            "type" : "string"
                        }
                    }
                },
                "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",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "method" : {
                    "description" : "Encryption method",
                    "type" : "string",
                    "enum" : [ "WPA2", "WPA_Mixed", "WEP_64", "WEP_128", "None" ]
                },
                "algorithm" : {
                    "description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
                    "type" : "string",
                    "enum" : [ "AES", "TKIP_AES" ]
                },
                "passphrase" : {
                    "description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
                    "type" : "string"
                },
                "mfp" : {
                    "description" : "Management frame protection. This only applies to WPA2 + AES",
                    "type" : "string",
                    "enum" : [ "disabled", "capable", "required" ]
                },
                "keyIndex" : {
                    "description" : "Key index. This only applies to WEP64 and WEP128.",
                    "type" : "integer"
                },
                "keyInHex" : {
                    "description" : "Key in hex format. This only applies to WEP64 and WEP128.",
                    "type" : "string"
                },
                "support80211rEnabled" : {
                    "description" : "Enable 802.11r Fast BSS Transition, fast Romaing.",
                    "type" : "boolean"
                },
                "mobilityDomainId" : {
                    "description" : "mobility Domain Id.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 65535
                }
            },
            "required" : [ "method" ]
        },
        "hessid" : {
            "description" : "HESSID of the WLAN",
            "type" : "string",
            "pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$"
        },
        "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.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "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" ]
                },
                "customizedPassword" : {
                    "description" : "User defined password. When this field is set to an empty string, the MAC address is used as password.",
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : "^([!-;=?-~]([ -;=?-~]){0,62}[!-;=?-~]|[!-;=?-~]{1,1}|\s{0,0})$"
                }
            }
        },
        "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" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "enable" : {
                        "description" : "Enabled or disabled",
                        "type" : "boolean"
                    },
                    "priority" : {
                        "description" : "Priority",
                        "type" : "integer"
                    },
                    "low" : {
                        "description" : "DSCP range - low",
                        "type" : [ "integer", "null" ],
                        "minimum" : 0,
                        "maximum" : 255
                    },
                    "high" : {
                        "description" : "DSCP range - high",
                        "type" : [ "integer", "null" ],
                        "minimum" : 0,
                        "maximum" : 255
                    },
                    "excepts" : {
                        "type" : [ "array", "null" ],
                        "items" : {
                            "type" : "integer",
                            "minimum" : 0,
                            "maximum" : 63
                        }
                    }
                },
                "required" : [ "enable", "priority" ]
            },
            "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", "AP_GROUP" ]
                },
                "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", "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",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "type" : {
                    "description" : "Type of WLAN schedule",
                    "type" : "string",
                    "enum" : [ "AlwaysOn", "AlwaysOff", "Customized" ]
                },
                "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"
                }
            },
            "required" : [ "type" ]
        },
        "ssid" : {
            "description" : "SSID of the WLAN",
            "type" : "string",
            "minLength" : 1,
            "maxLength" : 32
        },
        "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"
        },
        "portalDetectionProfileId" : {
            "type" : "string"
        }
    },
    "type" : "object"
}
Response  204

Modify

PATCH/v8_2/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": "APLBO",
  "macAuth": {
    "macAuthMacFormat": "802.1X",
    "customizedPassword": "password"
  },
  "encryption": {
    "method": "WPA2",
    "algorithm": "AES",
    "passphrase": "password",
    "mfp": "disabled",
    "support80211rEnabled": true,
    "mobilityDomainId": 3
  },
  "authServiceOrProfile": {
    "throughController": true,
    "id": "authServiceUUID",
    "name": "authServiceName",
    "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",
  "flexiVpnProfile": {
    "zoneAffinityId": "91fa3fe0-03da-11e7-8d82-0a0027000000"
  },
  "portalDetectionProfileId": "de0fa30c-9565-11e8-9eb6-529269fb1459",
  "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,
    "hs20Onboarding": false,
    "avcEnabled": true,
    "dtimInterval": 1,
    "directedThreshold": 5,
    "urlFilteringPolicyEnabled": false,
    "urlFilteringPolicyId": "",
    "wifiCallingPolicyEnabled": true,
    "wifiCallingPolicyIds": [
      "75e26590-547f-11e6-9ca7-5a095364c13c",
      "869bb532-547f-11e6-9ca7-5a095364c13c"
    ],
    "enableRadiusBasedDhcpNat": false,
    "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"
  },
  "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"
                },
                "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", "RADIUS_DHCP", "RADIUS_NAT", "RADIUS_DHCP_NAT", "RADIUS_NAT_RUCKUS", "RADIUS_NAT_SOFTGRE", "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"
                },
                "dhcp82SubOptRadiusFormat" : {
                    "description" : "Radius DHCP/NAT option 82 Format",
                    "type" : "string",
                    "enum" : [ "NONE", "RUCKUS_DEFAULT", "RADIUS_DHCP", "RADIUS_NAT", "RADIUS_DHCP_NAT", "RADIUS_NAT_RUCKUS", "RADIUS_NAT_SOFTGRE", "SOFTGRE_CUSTOMIZED" ]
                },
                "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
                },
                "urlFilteringPolicyEnabled" : {
                    "description" : "Indicator of whether URL Filtering is enabled or disabled",
                    "type" : "boolean"
                },
                "urlFilteringPolicyId" : {
                    "description" : "The URL Filtering policy ID.",
                    "type" : "string"
                },
                "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
                },
                "enableRadiusBasedDhcpNat" : {
                    "type" : "boolean"
                },
                "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",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "throughController" : {
                    "description" : "Indicates whether authentication messages were sent through the controller or not",
                    "type" : "boolean"
                },
                "realmBasedAuth" : {
                    "type" : "boolean"
                },
                "id" : {
                    "description" : "Identifier of the authentication service or profile. At least one ID or name or authenticationOption is required in the request.",
                    "type" : "string"
                },
                "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", "null" ],
                    "enum" : [ "Local DB", "Guest", "Always Accept", null ]
                },
                "locationDeliveryEnabled" : {
                    "description" : "RFC5580 location delivery support",
                    "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", "null" ],
                    "enum" : [ "Always Accept", null ]
                }
            }
        },
        "awsExtNasIPEnable" : {
            "description" : "Aws ExtNasIP Enable for CALEA",
            "type" : "boolean"
        },
        "awsVenueEnable" : {
            "description" : "Aws Venue Enable for CALEA",
            "type" : "boolean"
        },
        "bypassCNA" : {
            "description" : "Bypass Capitive Network Assitance",
            "type" : "boolean"
        },
        "caleaEnabled" : {
            "description" : "DP CALEA Server Enabled",
            "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" : [ "L2oGRE", "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" : {
            "description" : "Flexi-VPN profile of the WLAN",
            "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"
                }
            }
        },
        "dpTunnelNatEnabled" : {
            "description" : "DP Tunnel NAT Enabled",
            "type" : "boolean"
        },
        "dpTunnelDhcpEnabled" : {
            "description" : "DP Tunnel DHCP Enabled",
            "type" : "boolean"
        },
        "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" ]
                        },
                        "passphrase" : {
                            "description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
                            "type" : "string"
                        }
                    }
                },
                "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",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "method" : {
                    "description" : "Encryption method",
                    "type" : "string",
                    "enum" : [ "WPA2", "WPA_Mixed", "WEP_64", "WEP_128", "None" ]
                },
                "algorithm" : {
                    "description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
                    "type" : "string",
                    "enum" : [ "AES", "TKIP_AES" ]
                },
                "passphrase" : {
                    "description" : "Passphrase. This only applies to WPA2 and WPA mixed mode.",
                    "type" : "string"
                },
                "mfp" : {
                    "description" : "Management frame protection. This only applies to WPA2 + AES",
                    "type" : "string",
                    "enum" : [ "disabled", "capable", "required" ]
                },
                "keyIndex" : {
                    "description" : "Key index. This only applies to WEP64 and WEP128.",
                    "type" : "integer"
                },
                "keyInHex" : {
                    "description" : "Key in hex format. This only applies to WEP64 and WEP128.",
                    "type" : "string"
                },
                "support80211rEnabled" : {
                    "description" : "Enable 802.11r Fast BSS Transition, fast Romaing.",
                    "type" : "boolean"
                },
                "mobilityDomainId" : {
                    "description" : "mobility Domain Id.",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 65535
                }
            },
            "required" : [ "method" ]
        },
        "hessid" : {
            "description" : "HESSID of the WLAN",
            "type" : "string",
            "pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$"
        },
        "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.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "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" ]
                },
                "customizedPassword" : {
                    "description" : "User defined password. When this field is set to an empty string, the MAC address is used as password.",
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : "^([!-;=?-~]([ -;=?-~]){0,62}[!-;=?-~]|[!-;=?-~]{1,1}|\s{0,0})$"
                }
            }
        },
        "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" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "enable" : {
                        "description" : "Enabled or disabled",
                        "type" : "boolean"
                    },
                    "priority" : {
                        "description" : "Priority",
                        "type" : "integer"
                    },
                    "low" : {
                        "description" : "DSCP range - low",
                        "type" : [ "integer", "null" ],
                        "minimum" : 0,
                        "maximum" : 255
                    },
                    "high" : {
                        "description" : "DSCP range - high",
                        "type" : [ "integer", "null" ],
                        "minimum" : 0,
                        "maximum" : 255
                    },
                    "excepts" : {
                        "type" : [ "array", "null" ],
                        "items" : {
                            "type" : "integer",
                            "minimum" : 0,
                            "maximum" : 63
                        }
                    }
                },
                "required" : [ "enable", "priority" ]
            },
            "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", "AP_GROUP" ]
                },
                "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", "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",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "type" : {
                    "description" : "Type of WLAN schedule",
                    "type" : "string",
                    "enum" : [ "AlwaysOn", "AlwaysOff", "Customized" ]
                },
                "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"
                }
            },
            "required" : [ "type" ]
        },
        "ssid" : {
            "description" : "SSID of the WLAN",
            "type" : "string",
            "minLength" : 1,
            "maxLength" : 32
        },
        "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"
        },
        "portalDetectionProfileId" : {
            "type" : "string"
        }
    },
    "type" : "object"
}
Response  204

Delete

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

Use this API command to delete a WLAN.

Response  204

Disable Accounting

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

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

Response  204

Disable Layer 2 ACL

DELETE/v8_2/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_2/rkszones/{zoneId}/wlans/{id}/devicePolicy

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

Response  204

Disable DiffServ Profile

DELETE/v8_2/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_2/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_2/rkszones/{zoneId}/wlans/{id}/dnsServerProfile

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

Response  204

WLAN Scheduler

Retrieve

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

Retrieve Wlan Scheduler List

POST/v8_2/query/services/wlanScheduler

Query Wlan Schedulers with specified filters. 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": [
    "*"
  ],
  "sortInfo": {
    "sortColumn": "",
    "dir": "ASC"
  },
  "page": 1,
  "limit": 8
}
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",
              "CATEGORY",
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "BLADE",
              "SYNCEDSTATUS",
              "REGISTRATIONSTATE",
              "STATUS",
              "SWITCH_GROUP"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraFilters": {
      "description": "\"AND\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "CLIENTIPV6ADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "Type",
              "RogueMac",
              "SSID",
              "ALARMSTATE",
              "DEVICENAME",
              "SWITCH",
              "ZoneAffinityProfileId",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "Specified feature required information",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "type": "string",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "includeUserClickNode": {
          "description": "Can be used when group tree rendering needs include user clicked node.",
          "type": "boolean"
        }
      }
    },
    "extraTimeRange": {
      "description": "Specified data time range of selection",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "interval": {
          "description": "time interval in second",
          "type": "integer",
          "format": "int64"
        },
        "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

Create

POST/v8_2/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"
    }
  }
}

Modify

PATCH/v8_2/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

Delete

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

Use this API command to delete a WLAN schedule.

Response  204

Zone AAA

Retrieve List - RADIUS

GET/v8_2/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"
          },
          "partnerDomainId": {
            "description": "Identifier of the partner domain which the RADIUS server belongs to",
            "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"
            ]
          },
          "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"
              ]
            }
          }
        }
      }
    }
  }
}

Retrieve - RADIUS

GET/v8_2/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",
  "partnerDomainId": "partnerDomainId",
  "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": {
    "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"
    },
    "partnerDomainId": {
      "description": "Identifier of the partner domain which the RADIUS server belongs to",
      "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"
      ]
    },
    "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"
        ]
      }
    }
  }
}

Retrieve List - ActiveDirectory

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

Retrieve - ActiveDirectory

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

Retrieve List - LDAP

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

Retrieve - LDAP

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

Create - RADIUS

POST/v8_2/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"
  }
}
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"
      ]
    },
    "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"
        ]
      }
    }
  },
  "required": [
    "name",
    "primary"
  ]
}
Response  201
HideShow
Body
{
  "id": "RADIUSServerUUID"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Create - ActiveDirectory

POST/v8_2/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"
}
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"
        ]
      }
    }
  },
  "required": [
    "name",
    "ip",
    "port",
    "globalCatalogEnabled"
  ]
}
Response  201
HideShow
Body
{
  "id": "RADIUSServerUUID"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Create - LDAP

POST/v8_2/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=*"
}
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"
        ]
      }
    }
  },
  "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 - RADIUS

PUT/v8_2/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"
  },
  "mappings": [
    {
      "groupAttr": "newGroupAttr",
      "userRole": {
        "id": "identity user role UUID"
      }
    },
    {
      "groupAttr": "*",
      "userRole": {
        "name": "identity user role name"
      }
    }
  ]
}
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"
      ]
    },
    "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"
        ]
      }
    }
  }
}
Response  204

Modify Entire - ActiveDirectory

PUT/v8_2/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"
      }
    }
  ]
}
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"
        ]
      }
    }
  }
}
Response  204

Modify Entire - LDAP

PUT/v8_2/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"
      }
    }
  ]
}
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"
        ]
      }
    }
  }
}
Response  204

Modify - RADIUS

PATCH/v8_2/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"
  },
  "mappings": [
    {
      "groupAttr": "newGroupAttr",
      "userRole": {
        "id": "identity user role UUID"
      }
    },
    {
      "groupAttr": "*",
      "userRole": {
        "name": "identity user role name"
      }
    }
  ]
}
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"
      ]
    },
    "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"
        ]
      }
    }
  }
}
Response  204

Modify - ActiveDirectory

PATCH/v8_2/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"
      }
    }
  ]
}
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"
        ]
      }
    }
  }
}
Response  204

Modify - LDAP

PATCH/v8_2/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"
      }
    }
  ]
}
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"
        ]
      }
    }
  }
}
Response  204

Delete - RADIUS

DELETE/v8_2/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_2/rkszones/{zoneId}/aaa/radius/{id}/secondary

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

Response  204

Delete - ActiveDirectory

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

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

Response  204

Delete - LDAP

DELETE/v8_2/rkszones/{zoneId}/aaa/ldap/{id}

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

Response  204

Delete AAA server

DELETE/v8_2/rkszones/{zoneId}/aaa/{id}

Use this API command to delete an AAA server.

Response  204

Delete a list of AAA server

DELETE/v8_2/rkszones/{zoneId}/aaa

Use this API command to delete a list of AAA server.

Response  204

Guest Access

Retrieve

GET/v8_2/rkszones/{zoneId}/portals/guest/{id}

Use this API command to retrieve guest access of a zone.

Response  200
HideShow
Body
{
  "id": "15efd160-7153-11e4-aa08-00606eb0c700",
  "zoneId": "d664f517-cdc5-4997-8248-980a0b7a0542",
  "name": "GuestAccessSmart",
  "description": "basic configuration test",
  "portalCustomization": {
    "language": "en_US",
    "title": "Welcome to the Guest Access login page.",
    "logo": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABkAAAAmCAYAAAAxxTAbAAAABHNCSVQICAgIfAhkiAAAABB0RVh0U29mdHdhcmUAU2h1dHRlcmOC0AkAAAFESURBVEjH7ZQhSwRBGIafdfebMVywaLQZDf4BMRi1eAh6zWI1+wvMNovNoKbLgqhBDF6wWKwiiCAXVkG92W8MewvHcocMZxCZB7bsvDPv7PvOLEQikUgkEolE/iQXkDnSLSU7U+yLIrki1w6zMUofZJDDtGIeFPGKdJXsXLFXinwp4gvS7WH64C8pyPYd6RqQVO96sFgam8cOSF3/azEqcqOI/8DO1ccmxln4HswnZt5hWkADICWZHXvHp5A67Kpi2or0ypiyZ0VeFfEOu1LXBxl0QArkuFzYXjrMZk5jpsxejuomlT6wdLtTniJ7MFj8KJNKH9RJgl8qJ+sh4H/qt9IHmXj8W1muLgxmXpDtJrA+Sh9Ej8nl/kV0imkXyIlinvpPux5XpQ82cqRNRe4UeVfktsDsdWHKYVrDTpcjbf6fn+o3cnSSVWnHtbYAAAAASUVORK5CYII=",
    "termsAndConditionsText": "Terms of Use\n\nBy accepting this agreement and accessing the wireless network, you acknowledge that you are of legal age, you have read and understood, and agree to be bound by this agreement.\n(*) The wireless network service is provided by the property owners and is completely at their discretion. Your access to the network may be blocked, suspended, or terminated at any time for any reason.\n(*) You agree not to use the wireless network for any purpose that is unlawful or otherwise prohibited and you are fully responsible for your use.\n(*) The wireless network is provided \"as is\" without warranties of any kind, either expressed or implied.\n\nThis wireless network is powered by Ruckus Wireless.",
    "termsAndConditionsRequired": true
  },
  "redirect": {
    "url": "http://www.google.com"
  },
  "smsGateway": null,
  "userSession": {
    "timeoutInMin": 180,
    "gracePeriodInMin": 120
  }
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "description": "Identifier of the guest access profile",
      "type": "string"
    },
    "zoneId": {
      "description": "Identifier of the zone which the guest access profile belongs to",
      "type": "string"
    },
    "name": {
      "description": "Name of the guest access profile",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "Description of the guest access profile",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "portalCustomization": {
      "description": "Portal customization of the guest access profile",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "language": {
          "description": "Language",
          "default": "en_US",
          "type": "string",
          "enum": [
            "en_US",
            "zh_TW",
            "zh_CN",
            "nl_NL",
            "fr_FR",
            "de_DE",
            "ja_JP",
            "es_ES",
            "se_SE",
            "ar_SA",
            "cz_CZ",
            "da_DK",
            "tr_TR",
            "pt_BR"
          ]
        },
        "title": {
          "description": "Title",
          "type": "string",
          "minLength": 0,
          "maxLength": 63
        },
        "logo": {
          "description": "logo",
          "type": "string"
        },
        "termsAndConditionsRequired": {
          "description": "Terms and conditions is required or not",
          "type": "boolean",
          "default": "false"
        },
        "termsAndConditionsText": {
          "description": "Terms and conditions text",
          "type": "string",
          "default": "Terms of Use\n\nBy accepting this agreement and accessing the wireless network, you acknowledge that you are of legal age, you have read and understood, and agree to be bound by this agreement.\n(*) The wireless network service is provided by the property owners and is completely at their discretion. Your access to the network may be blocked, suspended, or terminated at any time for any reason.\n(*) You agree not to use the wireless network for any purpose that is unlawful or otherwise prohibited and you are fully responsible for your use.\n(*) The wireless network is provided \"as is\" without warranties of any kind, either expressed or implied.\n\nThis wireless network is powered by Ruckus Wireless.",
          "minLength": 0,
          "maxLength": 3999
        }
      },
      "required": [
        "language"
      ]
    },
    "redirect": {
      "description": "Redirect configuration of the guest access profile",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "url": {
          "description": "Portal redirect URL",
          "type": "string"
        }
      }
    },
    "smsGateway": {
      "description": "Portal SMS gateway of the guest access profile",
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "userSession": {
      "description": "User session of the guest access profile",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "timeoutInMin": {
          "description": "Time out value in minutes",
          "type": "integer",
          "default": 1440,
          "minimum": 2,
          "maximum": 14400
        },
        "gracePeriodInMin": {
          "description": "Grace period in minutes",
          "type": "integer",
          "default": 60,
          "minimum": 1,
          "maximum": 14399
        }
      }
    }
  }
}

Retrieve List

GET/v8_2/rkszones/{zoneId}/portals/guest

Use this API command to retrieve a list of guest access of a zone.

Response  200
HideShow
Body
{
  "totalCount": 9,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "id": "c5dfc930-75dc-11e4-8d56-00606eb0c700",
      "name": "portalName1"
    },
    {
      "id": "15efd160-7153-11e4-aa08-00606eb0c700",
      "name": "portalName2"
    },
    {
      "id": "be0f0480-73a9-11e4-9d1d-f0def13d5845",
      "name": "portalName3"
    },
    {
      "id": "7f0eef00-7423-11e4-bcef-000c299b4765",
      "name": "portalName4"
    },
    {
      "id": "4f5c98a0-7123-11e4-bcef-000c299b4765",
      "name": "portalName5"
    },
    {
      "id": "4a023ce0-73ab-11e4-b211-f0def13d5845",
      "name": "portalName6"
    },
    {
      "id": "afebbc80-73be-11e4-bfde-f0def13d5845",
      "name": "portalName7"
    },
    {
      "id": "76f4c020-7620-11e4-b8b9-00606eb0c700",
      "name": "portalName8"
    },
    {
      "id": "96308310-752c-11e4-8276-00606eb0c700",
      "name": "portalName9"
    }
  ]
}
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 service",
            "type": "string"
          },
          "name": {
            "description": "Name of the service",
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
          }
        }
      }
    }
  }
}

Retrieve Guess Access Profile List

POST/v8_0/query/services/guessAccess

Query Guess Access Profiles with specified filters. Please click the link for the usage of Query Criteria.

Deprecated : this URI will be deprecated after Version: v8_0, and no longer be supported.

Request
HideShow
Body
{
  "filters": [
    {
      "type": "DOMAIN",
      "value": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7"
    }
  ],
  "fullTextSearch": {
    "type": "AND",
    "value": ""
  },
  "attributes": [
    "*"
  ],
  "sortInfo": {
    "sortColumn": "",
    "dir": "ASC"
  },
  "page": 1,
  "limit": 8
}
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",
              "CATEGORY",
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "BLADE",
              "SYNCEDSTATUS",
              "REGISTRATIONSTATE",
              "STATUS",
              "SWITCH_GROUP"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraFilters": {
      "description": "\"AND\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "CLIENTIPV6ADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "Type",
              "RogueMac",
              "SSID",
              "ALARMSTATE",
              "DEVICENAME",
              "SWITCH",
              "ZoneAffinityProfileId",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "Specified feature required information",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "type": "string",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "includeUserClickNode": {
          "description": "Can be used when group tree rendering needs include user clicked node.",
          "type": "boolean"
        }
      }
    },
    "extraTimeRange": {
      "description": "Specified data time range of selection",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "interval": {
          "description": "time interval in second",
          "type": "integer",
          "format": "int64"
        },
        "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

Retrieve Guest Access Profile List

POST/v8_2/query/services/guestAccess

Query Guest Access Profiles with specified filters. 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": [
    "*"
  ],
  "sortInfo": {
    "sortColumn": "",
    "dir": "ASC"
  },
  "page": 1,
  "limit": 8
}
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",
              "CATEGORY",
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "BLADE",
              "SYNCEDSTATUS",
              "REGISTRATIONSTATE",
              "STATUS",
              "SWITCH_GROUP"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraFilters": {
      "description": "\"AND\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "CLIENTIPV6ADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "Type",
              "RogueMac",
              "SSID",
              "ALARMSTATE",
              "DEVICENAME",
              "SWITCH",
              "ZoneAffinityProfileId",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "Specified feature required information",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "type": "string",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "includeUserClickNode": {
          "description": "Can be used when group tree rendering needs include user clicked node.",
          "type": "boolean"
        }
      }
    },
    "extraTimeRange": {
      "description": "Specified data time range of selection",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "interval": {
          "description": "time interval in second",
          "type": "integer",
          "format": "int64"
        },
        "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

Create

POST/v8_2/rkszones/{zoneId}/portals/guest

Use this API command to create new guest access of a zone.

Request
HideShow
Body
{
  "name": "GuestAccess test",
  "description": "guest access test description",
  "portalCustomization": {
    "language": "en_US",
    "title": "Welcome to the Guest Access login page.",
    "logo": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABkAAAAmCAYAAAAxxTAbAAAABHNCSVQICAgIfAhkiAAAABB0RVh0U29mdHdhcmUAU2h1dHRlcmOC0AkAAAFESURBVEjH7ZQhSwRBGIafdfebMVywaLQZDf4BMRi1eAh6zWI1+wvMNovNoKbLgqhBDF6wWKwiiCAXVkG92W8MewvHcocMZxCZB7bsvDPv7PvOLEQikUgkEolE/iQXkDnSLSU7U+yLIrki1w6zMUofZJDDtGIeFPGKdJXsXLFXinwp4gvS7WH64C8pyPYd6RqQVO96sFgam8cOSF3/azEqcqOI/8DO1ccmxln4HswnZt5hWkADICWZHXvHp5A67Kpi2or0ypiyZ0VeFfEOu1LXBxl0QArkuFzYXjrMZk5jpsxejuomlT6wdLtTniJ7MFj8KJNKH9RJgl8qJ+sh4H/qt9IHmXj8W1muLgxmXpDtJrA+Sh9Ej8nl/kV0imkXyIlinvpPux5XpQ82cqRNRe4UeVfktsDsdWHKYVrDTpcjbf6fn+o3cnSSVWnHtbYAAAAASUVORK5CYII=",
    "termsAndConditionsRequired": true,
    "termsAndConditionsText": "test"
  },
  "redirect": {
    "url": "http://www.ruckuswireless.com"
  },
  "smsGateway": {
    "name": "defaultServer"
  },
  "userSession": {
    "timeoutInMin": 180,
    "gracePeriodInMin": 120
  }
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "description": "Name of the guest access profile",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "Description of the guest access profile",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "portalCustomization": {
      "description": "Portal customization of the guest access profile",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "language": {
          "description": "Language",
          "default": "en_US",
          "type": "string",
          "enum": [
            "en_US",
            "zh_TW",
            "zh_CN",
            "nl_NL",
            "fr_FR",
            "de_DE",
            "ja_JP",
            "es_ES",
            "se_SE",
            "ar_SA",
            "cz_CZ",
            "da_DK",
            "tr_TR",
            "pt_BR"
          ]
        },
        "title": {
          "description": "Title",
          "type": "string",
          "minLength": 0,
          "maxLength": 63
        },
        "logo": {
          "description": "logo",
          "type": "string"
        },
        "termsAndConditionsRequired": {
          "description": "Terms and conditions is required or not",
          "type": "boolean",
          "default": "false"
        },
        "termsAndConditionsText": {
          "description": "Terms and conditions text",
          "type": "string",
          "default": "Terms of Use\n\nBy accepting this agreement and accessing the wireless network, you acknowledge that you are of legal age, you have read and understood, and agree to be bound by this agreement.\n(*) The wireless network service is provided by the property owners and is completely at their discretion. Your access to the network may be blocked, suspended, or terminated at any time for any reason.\n(*) You agree not to use the wireless network for any purpose that is unlawful or otherwise prohibited and you are fully responsible for your use.\n(*) The wireless network is provided \"as is\" without warranties of any kind, either expressed or implied.\n\nThis wireless network is powered by Ruckus Wireless.",
          "minLength": 0,
          "maxLength": 3999
        }
      },
      "required": [
        "language"
      ]
    },
    "redirect": {
      "description": "Redirect configuration of the guest access profile",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "url": {
          "description": "Portal redirect URL",
          "type": "string"
        }
      }
    },
    "smsGateway": {
      "description": "Portal SMS gateway of the guest access profile",
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "userSession": {
      "description": "Redirect configuration of the guest access profile",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "timeoutInMin": {
          "description": "Time out value in minutes",
          "type": "integer",
          "default": 1440,
          "minimum": 2,
          "maximum": 14400
        },
        "gracePeriodInMin": {
          "description": "Grace period in minutes",
          "type": "integer",
          "default": 60,
          "minimum": 1,
          "maximum": 14399
        }
      }
    }
  },
  "required": [
    "name",
    "portalCustomization",
    "userSession"
  ]
}
Response  201
HideShow
Body
{
  "id": "76f4c020-7620-11e4-b8b9-00606eb0c700"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Modify

PATCH/v8_2/rkszones/{zoneId}/portals/guest/{id}

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

Request
HideShow
Body
{
  "name": "GuestAccessSmart",
  "description": "basic configuration test",
  "portalCustomization": {
    "language": "zh_TW",
    "title": "Welcome to the Guest Access login page.",
    "logo": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABkAAAAmCAYAAAAxxTAbAAAABHNCSVQICAgIfAhkiAAAABB0RVh0U29mdHdhcmUAU2h1dHRlcmOC0AkAAAFESURBVEjH7ZQhSwRBGIafdfebMVywaLQZDf4BMRi1eAh6zWI1+wvMNovNoKbLgqhBDF6wWKwiiCAXVkG92W8MewvHcocMZxCZB7bsvDPv7PvOLEQikUgkEolE/iQXkDnSLSU7U+yLIrki1w6zMUofZJDDtGIeFPGKdJXsXLFXinwp4gvS7WH64C8pyPYd6RqQVO96sFgam8cOSF3/azEqcqOI/8DO1ccmxln4HswnZt5hWkADICWZHXvHp5A67Kpi2or0ypiyZ0VeFfEOu1LXBxl0QArkuFzYXjrMZk5jpsxejuomlT6wdLtTniJ7MFj8KJNKH9RJgl8qJ+sh4H/qt9IHmXj8W1muLgxmXpDtJrA+Sh9Ej8nl/kV0imkXyIlinvpPux5XpQ82cqRNRe4UeVfktsDsdWHKYVrDTpcjbf6fn+o3cnSSVWnHtbYAAAAASUVORK5CYII=",
    "termsAndConditionsRequired": true,
    "termsAndConditionsText": "Terms of Use\n\nBy accepting this agreement and accessing the wireless network, you acknowledge that you are of legal age, you have read and understood, and agree to be bound by this agreement.\n(*) The wireless network service is provided by the property owners and is completely at their discretion. Your access to the network may be blocked, suspended, or terminated at any time for any reason.\n(*) You agree not to use the wireless network for any purpose that is unlawful or otherwise prohibited and you are fully responsible for your use.\n(*) The wireless network is provided \"as is\" without warranties of any kind, either expressed or implied.\n\nThis wireless network is powered by Ruckus Wireless."
  },
  "redirect": {
    "url": "http://www.google.com"
  },
  "smsGateway": {
    "name": "defaultServer"
  },
  "userSession": {
    "timeoutInMin": 180,
    "gracePeriodInMin": 60
  }
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "description": "Name of the guest access profile",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "Description of the guest access profile",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "portalCustomization": {
      "description": "Portal customization of the guest access profile",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "language": {
          "description": "Language",
          "type": "string",
          "enum": [
            "en_US",
            "zh_TW",
            "zh_CN",
            "nl_NL",
            "fr_FR",
            "de_DE",
            "ja_JP",
            "es_ES",
            "se_SE",
            "ar_SA",
            "cz_CZ",
            "da_DK",
            "tr_TR",
            "pt_BR"
          ]
        },
        "title": {
          "description": "Title",
          "type": "string",
          "minLength": 0,
          "maxLength": 63
        },
        "logo": {
          "description": "logo",
          "type": "string"
        },
        "termsAndConditionsRequired": {
          "description": "Terms and conditions is required or not",
          "type": "boolean"
        },
        "termsAndConditionsText": {
          "description": "Terms and conditions text",
          "type": "string",
          "minLength": 0,
          "maxLength": 3999
        }
      },
      "required": [
        "language"
      ]
    },
    "redirect": {
      "description": "Redirect configuration of the guest access profile",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "url": {
          "description": "Portal redirect URL",
          "type": "string"
        }
      }
    },
    "smsGateway": {
      "description": "Portal SMS gateway of the guest access profile",
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "userSession": {
      "description": "User session of the guest access profile",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "timeoutInMin": {
          "description": "Time out value in minutes",
          "type": "integer",
          "minimum": 2,
          "maximum": 14400
        },
        "gracePeriodInMin": {
          "description": "Grace period in minutes",
          "type": "integer",
          "minimum": 1,
          "maximum": 14399
        }
      }
    }
  }
}
Response  204

Delete

DELETE/v8_2/rkszones/{zoneId}/portals/guest/{id}

Use this API command to delete guest access of a zone.

Response  204

Redirect to URL user visit

DELETE/v8_2/rkszones/{zoneId}/portals/guest/{id}/redirect

Use this API command to set redirect to the URL that user intends to visit on guest access of a zone.

Response  204

Disable SMS Gateway

DELETE/v8_2/rkszones/{zoneId}/portals/guest/{id}/smsGateway

Use this API command to disable SMS gateway on guest access of a zone.

Response  204

Hotspot Service

Retrieve

GET/v8_2/rkszones/{zoneId}/portals/hotspot/{id}

Use this API command to retrieve a Hotspot (WISPr) of zone.

Response  200
HideShow
Body
‧ Sample : Hotspot with WalledGarden
{
    "name" : "test-hotspot222",
    "id" : "3e5b3782-6f1a-42bf-9812-95d2c1df2451",
    "description" : "description",
    "smartClientSupport" : "None",
    "smartClientInfo" : null,
    "portalType" : "Internal",
    "portalUrl" : null,
    "backupPortalUrl" : null,
    "redirect" : null,
    "portalCustomization" : {
        "language" : "en_US",
        "title" : "Ruckus Wireless - Subscriber Portal",
        "logo" : "logo",
        "termsAndConditionsRequired" : false
    },
    "userSession" : {
        "timeoutInMin" : 1440,
        "gracePeriodInMin" : 60
    },
    "location" : {
        "id" : "locationId",
        "name" : "locationName"
    },
    "macAddressFormat" : 2,
    "walledGardens" : [ "10.1.1.1", "11.11.111.11" ],
    "zoneId" : "d664f517-cdc5-4997-8248-980a0b7a0542",
    "httpsRedirect" : false
}
‧ Sample : Hotspot with Traffic Class Profile
{
    "name" : "test-hotspot222",
    "id" : "3e5b3782-6f1a-42bf-9812-95d2c1df2451",
    "description" : "description",
    "smartClientSupport" : "None",
    "smartClientInfo" : null,
    "portalType" : "Internal",
    "portalUrl" : null,
    "backupPortalUrl" : null,
    "redirect" : null,
    "portalCustomization" : {
        "language" : "en_US",
        "title" : "Ruckus Wireless - Subscriber Portal",
        "logo" : "logo",
        "termsAndConditionsRequired" : false
    },
    "userSession" : {
        "timeoutInMin" : 1440,
        "gracePeriodInMin" : 60
    },
    "location" : {
        "id" : "locationId",
        "name" : "locationName"
    },
    "macAddressFormat" : 2,
    "trafficClassProfileId" : "f099db61-a464-11e8-996f-000000031396",
    "signatureSigningKey" : "123456789",
    "internalNode" : "1.1.1.1",
    "zoneId" : "d664f517-cdc5-4997-8248-980a0b7a0542",
    "httpsRedirect" : false
}
Schema
{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "id" : {
            "description" : "Identifier of the Hotspot",
            "type" : "string"
        },
        "zoneId" : {
            "description" : "Identifier of the zone which the Hotspot belongs to",
            "type" : "string"
        },
        "name" : {
            "description" : "Name of the Hotspot",
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 32,
            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$"
        },
        "description" : {
            "description" : "Description of the Hotspot",
            "type" : [ "string", "null" ],
            "maxLength" : 64
        },
        "smartClientSupport" : {
            "description" : "Smart client support of the Hotspot",
            "type" : "string",
            "enum" : [ "None", "Enabled", "SmartClientOnly" ]
        },
        "smartClientInfo" : {
            "description" : "Smart client info of the Hotspot. Type instructions for enabling users to log on using the Smart Client application.",
            "type" : "string"
        },
        "portalType" : {
            "description" : "Portal type of the Hotspot",
            "type" : "string",
            "enum" : [ "Internal", "External" ]
        },
        "portalUrl" : {
            "description" : "Portal URL of the Hotspot",
            "type" : "string"
        },
        "backupPortalUrl" : {
            "type" : [ "string", "null" ]
        },
        "location" : {
            "description" : "Location of the Hotspot",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "description" : "Portal location id",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Portal location name",
                    "type" : "string"
                }
            }
        },
        "redirect" : {
            "description" : "Redirect configuration of the Hotspot",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "url" : {
                    "description" : "Portal redirect URL",
                    "type" : "string"
                }
            }
        },
        "portalCustomization" : {
            "description" : "Portal customization of the guest access profile",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "language" : {
                    "description" : "Language",
                    "default" : "en_US",
                    "type" : "string",
                    "enum" : [ "en_US", "zh_TW", "zh_CN", "nl_NL", "fr_FR", "de_DE", "ja_JP", "es_ES", "se_SE", "ar_SA", "cz_CZ", "da_DK", "tr_TR", "pt_BR" ]
                },
                "title" : {
                    "description" : "Title",
                    "type" : "string",
                    "minLength" : 0,
                    "maxLength" : 63
                },
                "logo" : {
                    "description" : "logo",
                    "type" : "string"
                },
                "termsAndConditionsRequired" : {
                    "description" : "Terms and conditions is required or not",
                    "type" : "boolean",
                    "default" : "false"
                },
                "termsAndConditionsText" : {
                    "description" : "Terms and conditions text",
                    "type" : "string",
                    "default" : "Terms of Use\n\nBy accepting this agreement and accessing the wireless network, you acknowledge that you are of legal age, you have read and understood, and agree to be bound by this agreement.\n(*) The wireless network service is provided by the property owners and is completely at their discretion. Your access to the network may be blocked, suspended, or terminated at any time for any reason.\n(*) You agree not to use the wireless network for any purpose that is unlawful or otherwise prohibited and you are fully responsible for your use.\n(*) The wireless network is provided \"as is\" without warranties of any kind, either expressed or implied.\n\nThis wireless network is powered by Ruckus Wireless.",
                    "minLength" : 0,
                    "maxLength" : 3999
                }
            },
            "required" : [ "language" ]
        },
        "userSession" : {
            "description" : "User session of the Hotspot",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "timeoutInMin" : {
                    "description" : "Time out value in minutes",
                    "type" : "integer",
                    "default" : 1440,
                    "minimum" : 2,
                    "maximum" : 14400
                },
                "gracePeriodInMin" : {
                    "description" : "Grace period in minutes",
                    "type" : "integer",
                    "default" : 60,
                    "minimum" : 1,
                    "maximum" : 14399
                }
            }
        },
        "walledGardens" : {
            "description" : "Walled garden map set of the Hotspot. Unauthenticated users are allowed to access the following destinations. Format: - IP (e.g. 10.11.12.13) - IP Range (e.g. 10.11.12.13-10.11.12.15) - CIDR (e.g. 10.11.12.100/28) - IP and mask (e.g. 10.11.12.13 255.255.255.0) - Precise web site (e.g. www.ruckus.com) - Web site with special regular expression like    - *.amazon.com    - *.com",
            "type" : "array",
            "items" : {
                "type" : "string"
            }
        },
        "trafficClassProfileId" : {
            "description" : "Traffic Class Profile of the Hotspot",
            "type" : "string"
        },
        "signatureSigningKey" : {
            "description" : "Signature Signing Key of the Hotspot",
            "type" : "string"
        },
        "internalNode" : {
            "description" : "Internal Node of the Hotspot",
            "type" : "string"
        },
        "macAddressFormat" : {
            "description" : "mac address format of redirection,the format define: 0(aabbccddeeff), 1(AA-BB-CC-DD-EE-FF), 2(AA:BB:CC:DD:EE:FF), 3(AABBCCDDEEFF), 4(aa-bb-cc-dd-ee-ff), 5(aa:bb:cc:dd:ee:ff)",
            "type" : "integer",
            "default" : 2,
            "minimum" : 0,
            "maximum" : 5
        },
        "httpsRedirect" : {
            "description" : "HTTPS Redirect is disable or not",
            "type" : "boolean",
            "default" : "true"
        }
    }
}

Retrieve List

GET/v8_2/rkszones/{zoneId}/portals/hotspot

Use this API command to retrieve a list of Hotspot (WISPr) of a zone.

Response  200
HideShow
Body
{
  "totalCount": 9,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "id": "c5dfc930-75dc-11e4-8d56-00606eb0c700",
      "name": "portalName1"
    },
    {
      "id": "15efd160-7153-11e4-aa08-00606eb0c700",
      "name": "portalName2"
    },
    {
      "id": "be0f0480-73a9-11e4-9d1d-f0def13d5845",
      "name": "portalName3"
    },
    {
      "id": "7f0eef00-7423-11e4-bcef-000c299b4765",
      "name": "portalName4"
    },
    {
      "id": "4f5c98a0-7123-11e4-bcef-000c299b4765",
      "name": "portalName5"
    },
    {
      "id": "4a023ce0-73ab-11e4-b211-f0def13d5845",
      "name": "portalName6"
    },
    {
      "id": "afebbc80-73be-11e4-bfde-f0def13d5845",
      "name": "portalName7"
    },
    {
      "id": "76f4c020-7620-11e4-b8b9-00606eb0c700",
      "name": "portalName8"
    },
    {
      "id": "96308310-752c-11e4-8276-00606eb0c700",
      "name": "portalName9"
    }
  ]
}
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 service",
            "type": "string"
          },
          "name": {
            "description": "Name of the service",
            "type": "string",
            "minLength": 2,
            "maxLength": 32,
            "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
          }
        }
      }
    }
  }
}

Retrieve Hotspot Profile List

POST/v8_2/query/services/hotspot

Query Hotspot Profiles with specified filters. 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": [
    "*"
  ],
  "sortInfo": {
    "sortColumn": "",
    "dir": "ASC"
  },
  "page": 1,
  "limit": 8
}
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",
              "CATEGORY",
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "BLADE",
              "SYNCEDSTATUS",
              "REGISTRATIONSTATE",
              "STATUS",
              "SWITCH_GROUP"
            ]
          },
          "value": {
            "description": "Group ID",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraFilters": {
      "description": "\"AND\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "CLIENTIPV6ADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "Type",
              "RogueMac",
              "SSID",
              "ALARMSTATE",
              "DEVICENAME",
              "SWITCH",
              "ZoneAffinityProfileId",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value to search",
            "type": "string"
          },
          "operator": {
            "description": "operator",
            "type": "string",
            "enum": [
              "eq",
              "gt",
              "lt",
              "gte",
              "lte"
            ]
          }
        }
      }
    },
    "extraNotFilters": {
      "description": "\"NOT\" condition for multiple filters",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "type": {
            "description": "Filters for specific attribute",
            "type": "string",
            "enum": [
              "CONTROLBLADE",
              "DATABLADE",
              "DOMAIN",
              "ZONE",
              "THIRD_PARTY_ZONE",
              "APGROUP",
              "WLANGROUP",
              "INDOORMAP",
              "AP",
              "WLAN",
              "ProtocolType",
              "TIMERANGE",
              "RADIOID",
              "WLANID",
              "CATEGORY",
              "CLIENT",
              "CP",
              "DP",
              "CLUSTER",
              "NODE",
              "BLADE",
              "SYNCEDSTATUS",
              "OSTYPE",
              "APP",
              "PORT",
              "STATUS",
              "REGISTRATIONSTATE",
              "GATEWAY",
              "APIPADDRESS",
              "CLIENTIPADDRESS",
              "SEVERITY",
              "ACKNOWLEDGED",
              "MVNOID",
              "USER",
              "USERID",
              "WLANNAME",
              "AUDITIPADDRESS",
              "AUDITUSERUUID",
              "AUDITOBJECT",
              "AUDITACTION",
              "AUDITTENANTUUID",
              "AUDITOBJECTUUID",
              "AUTHTYPE",
              "AUDITTYPE",
              "H20SuppportEnabled",
              "AaaSuppportEnabled",
              "GppSuppportEnabled",
              "MONITORINGENABLED"
            ]
          },
          "value": {
            "description": "value not to search",
            "type": "string"
          }
        }
      }
    },
    "options": {
      "description": "Specified feature required information",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "auth_includeNa": {
          "description": "include Not Available auth service option while returning result",
          "type": "boolean"
        },
        "auth_includeLocalDb": {
          "description": "include LocalDB auth service while returning result",
          "type": "boolean"
        },
        "auth_includeGuest": {
          "description": "include Guest auth service while returning result",
          "type": "boolean"
        },
        "auth_includeAdGlobal": {
          "description": "If AD is in list, include only AD with Global Catalog configured",
          "type": "boolean"
        },
        "auth_type": {
          "description": "authentication service types to get, use comma to separate, Ex: RADIUS,AD",
          "type": "string"
        },
        "auth_realmType": {
          "description": "To get specific authentication service information for configuring realm based authentication profile",
          "type": "string",
          "enum": [
            "ALL",
            "RADIUS"
          ]
        },
        "acct_type": {
          "description": "accounting service types to get, use comma to separate, Ex: RADIUS,CGF",
          "type": "string"
        },
        "auth_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_testableOnly": {
          "description": "only get testable service type",
          "type": "boolean"
        },
        "acct_includeNa": {
          "description": "include Not Available acct service option while returning result",
          "type": "boolean"
        },
        "forwarding_type": {
          "description": "forwarding service types to get, use comma to separate, Ex: L2oGRE,TTGPDG,Bridge,Advanced",
          "type": "string"
        },
        "includeSharedResources": {
          "description": "Whether to include the resources of parent domain or not.",
          "type": "boolean"
        },
        "INCLUDE_RBAC_METADATA": {
          "description": "Whether to include RBAC metadata or not.",
          "type": "boolean"
        },
        "TENANT_ID": {
          "description": "Specify Tenant ID for query.",
          "type": "string"
        },
        "inMap": {
          "description": "Specify inMap status for query.",
          "type": "boolean"
        },
        "globalFilterId": {
          "description": "Specify GlobalFilter ID for query.",
          "type": "string"
        },
        "auth_hostedAaaSupportedEnabled": {
          "description": "Indicate if Hosted AAA Support is enabled",
          "type": "boolean"
        },
        "auth_plmnIdentifierEnabled": {
          "description": "Indicate if Configure PLMN identifier is enabled",
          "type": "boolean"
        },
        "includeUsers": {
          "description": "Should also retrieve users or not",
          "type": "boolean"
        },
        "includeUserClickNode": {
          "description": "Can be used when group tree rendering needs include user clicked node.",
          "type": "boolean"
        }
      }
    },
    "extraTimeRange": {
      "description": "Specified data time range of selection",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "start": {
          "description": "start time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "end": {
          "description": "end time for collecting data",
          "type": "integer",
          "format": "int64"
        },
        "interval": {
          "description": "time interval in second",
          "type": "integer",
          "format": "int64"
        },
        "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

Create Internal

POST/v8_2/rkszones/{zoneId}/portals/hotspot/internal

Use this API command to create a new Hotspot (WISPr) with internal logon URL of a zone.MacAddressFormat.

Request
HideShow
Body
{
  "name": "test-hotspot222",
  "description": "description",
  "smartClientSupport": "None",
  "location": {
    "id": "locationId",
    "name": "locationName"
  },
  "macAddressFormat": 2,
  "walledGardens": [
    "10.11.12.16",
    "10.11.12.13"
  ],
  "httpsRedirect": true
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "description": "Name of the Hotspot",
      "type": "string",
      "minLength": 2,
      "maxLength": 32,
      "pattern": "^[!-~]([ -~]){0,30}[!-~]$"
    },
    "description": {
      "description": "Description of the Hotspot",
      "type": [
        "string",
        "null"
      ],
      "maxLength": 64
    },
    "smartClientSupport": {
      "description": "Smart client support of the Hotspot",
      "type": "string",
      "enum": [
        "None",
        "Enabled"
      ]
    },
    "location": {
      "description": "Location of the Hotspot",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "id": {
          "description": "Portal location id",
          "type": "string"
        },
        "name": {
          "description": "Portal location name",
          "type": "string"
        }
      }
    },
    "redirect": {
      "description": "Redirect configuration of the Hotspot",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "url": {
          "description": "Portal redirect URL",
          "type": "string"
        }
      }
    },
    "userSession": {
      "description": "User session of the Hotspot",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "timeoutInMin": {
          "description": "Time out value in minutes",
          "type": "integer",
          "default": 1440,
          "minimum": 2,
          "maximum": 14400
        },
        "gracePeriodInMin": {
          "description": "Grace period in minutes",
          "type": "integer",
          "default": 60,
          "minimum": 1,
          "maximum": 14399
        }
      }
    },
    "walledGardens": {
      "description": "Walled garden map set of the Hotspot. Unauthenticated users are allowed to access the following destinations. Format: - IP (e.g. 10.11.12.13) - IP Range (e.g. 10.11.12.13-10.11.12.15) - CIDR (e.g. 10.11.12.100/28) - IP and mask (e.g. 10.11.12.13 255.255.255.0) - Precise web site (e.g. www.ruckus.com) - Web site with special regular expression like    - *.amazon.com    - *.com",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "macAddressFormat": {
      "description": "mac address format of redirection,the format define: 0(aabbccddeeff), 1(AA-BB-CC-DD-EE-FF), 2(AA:BB:CC:DD:EE:FF), 3(AABBCCDDEEFF), 4(aa-bb-cc-dd-ee-ff), 5(aa:bb:cc:dd:ee:ff)",
      "type": "integer",
      "default": 2,
      "minimum": 0,
      "maximum": 5
    },
    "httpsRedirect": {
      "description": "HTTPS Redirect is disable or not",
      "type": "boolean",
      "default": "true"
    }
  },
  "required": [
    "name",
    "smartClientSupport",
    "macAddressFormat"
  ]
}
Response  201
HideShow
Body
{
  "id": "76f4c020-7620-11e4-b8b9-00606eb0c700"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Create External

POST/v8_2/rkszones/{zoneId}/portals/hotspot/external

Use this API command to create a new Hotspot (WISPr) with external logon URL of a zone.MacAddressFormat.

Request
HideShow
Body
‧ Sample : Create a Hotspot with WalledGarden
{
    "name" : "test-hotspot222",
    "description" : "description",
    "smartClientSupport" : "None",
    "portalUrl" : "https://172.17.26.59",
    "backupPortalUrl" : "https://172.17.26.60",
    "location" : {
        "id" : "locationId",
        "name" : "locationName"
    },
    "macAddressFormat" : 2,
    "walledGardens" : [ "10.11.12.16", "10.11.12.13" ],
    "httpsRedirect" : true
}
‧ Sample : Create a Hotspot with Traffic Class Profile
{
    "name" : "test-hotspot222",
    "description" : "description",
    "smartClientSupport" : "None",
    "portalUrl" : "https://172.17.26.59",
    "backupPortalUrl" : "https://172.17.26.60",
    "location" : {
        "id" : "locationId",
        "name" : "locationName"
    },
    "macAddressFormat" : 2,
    "trafficClassProfileId" : "f099db61-a464-11e8-996f-000000031396",
    "signatureSigningKey" : "123456789",
    "internalNode" : "1.1.1.1",
    "httpsRedirect" : true
}
Schema
{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "name" : {
            "description" : "Name of the Hotspot",
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 32,
            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$"
        },
        "description" : {
            "description" : "Description of the Hotspot",
            "type" : [ "string", "null" ],
            "maxLength" : 64
        },
        "smartClientSupport" : {
            "description" : "Smart client support of the Hotspot",
            "type" : "string",
            "enum" : [ "None", "Enabled" ]
        },
        "portalUrl" : {
            "description" : "Portal URL of the Hotspot",
            "type" : "string"
        },
        "backupPortalUrl" : {
            "description" : "Backup Portal URL of the Hotspot",
            "type" : [ "string", "null" ]
        },
        "location" : {
            "description" : "Location of the hotspot",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "description" : "Portal location id",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Portal location name",
                    "type" : "string"
                }
            }
        },
        "redirect" : {
            "description" : "Redirect configuration of the Hotspot",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "url" : {
                    "description" : "Portal redirect URL",
                    "type" : "string"
                }
            }
        },
        "userSession" : {
            "description" : "User session of the Hotspot",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "timeoutInMin" : {
                    "description" : "Time out value in minutes",
                    "type" : "integer",
                    "default" : 1440,
                    "minimum" : 2,
                    "maximum" : 14400
                },
                "gracePeriodInMin" : {
                    "description" : "Grace period in minutes",
                    "type" : "integer",
                    "default" : 60,
                    "minimum" : 1,
                    "maximum" : 14399
                }
            }
        },
        "walledGardens" : {
            "description" : "Walled garden map set of the Hotspot. Unauthenticated users are allowed to access the following destinations. Format: - IP (e.g. 10.11.12.13) - IP Range (e.g. 10.11.12.13-10.11.12.15) - CIDR (e.g. 10.11.12.100/28) - IP and mask (e.g. 10.11.12.13 255.255.255.0) - Precise web site (e.g. www.ruckus.com) - Web site with special regular expression like    - *.amazon.com    - *.com",
            "type" : "array",
            "items" : {
                "type" : "string"
            }
        },
        "trafficClassProfileId" : {
            "description" : "Traffic Class Profile of the Hotspot",
            "type" : "string"
        },
        "signatureSigningKey" : {
            "description" : "Signature Signing Key of the Hotspot",
            "type" : "string"
        },
        "internalNode" : {
            "description" : "Internal Node of the Hotspot",
            "type" : "string"
        },
        "macAddressFormat" : {
            "description" : "mac address format of redirection,the format define: 0(aabbccddeeff), 1(AA-BB-CC-DD-EE-FF), 2(AA:BB:CC:DD:EE:FF), 3(AABBCCDDEEFF), 4(aa-bb-cc-dd-ee-ff), 5(aa:bb:cc:dd:ee:ff)",
            "type" : "integer",
            "default" : 2,
            "minimum" : 0,
            "maximum" : 5
        },
        "httpsRedirect" : {
            "description" : "HTTPS Redirect is disable or not",
            "type" : "boolean",
            "default" : "true"
        }
    },
    "required" : [ "name", "smartClientSupport", "portalUrl", "macAddressFormat" ]
}
Response  201
HideShow
Body
{
  "id": "76f4c020-7620-11e4-b8b9-00606eb0c700"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Create Smart Client Only

POST/v8_2/rkszones/{zoneId}/portals/hotspot/smartClientOnly

Use this API command to create a new Hotspot (WISPr) with smart client only of a zone.MacAddressFormat.

Request
HideShow
Body
‧ Sample : Create a Hotspot with WalledGarden
{
    "name" : "test-hotspot222-smartClientOnly",
    "description" : "description-smartClientOnly",
    "smartClientInfo" : "smartClient only, yyyy!",
    "location" : {
        "id" : "locationId",
        "name" : "locationName"
    },
    "macAddressFormat" : 2,
    "walledGardens" : [ "10.11.12.16", "10.11.12.13" ],
    "httpsRedirect" : true
}
‧ Sample : Create a Hotspot with Traffic Class Profile
{
    "name" : "test-hotspot222-smartClientOnly",
    "description" : "description-smartClientOnly",
    "smartClientInfo" : "smartClient only, yyyy!",
    "location" : {
        "id" : "locationId",
        "name" : "locationName"
    },
    "macAddressFormat" : 2,
    "trafficClassProfileId" : "f099db61-a464-11e8-996f-000000031396",
    "signatureSigningKey" : "123456789",
    "internalNode" : "1.1.1.1",
    "httpsRedirect" : true
}
Schema
{
    "type" : "object",
    "additionalProperties" : false,
    "properties" : {
        "name" : {
            "description" : "Name of the Hotspot",
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 32,
            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$"
        },
        "description" : {
            "description" : "Description of the Hotspot",
            "type" : [ "string", "null" ],
            "maxLength" : 64
        },
        "smartClientInfo" : {
            "description" : "Smart client info of the Hotspot. Type instructions for enabling users to log on using the Smart Client application.",
            "type" : "string"
        },
        "location" : {
            "description" : "Location of the Hotspot",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "description" : "Portal location id",
                    "type" : "string"
                },
                "name" : {
                    "description" : "Portal location name",
                    "type" : "string"
                }
            }
        },
        "redirect" : {
            "description" : "Redirect configuration of the Hotspot",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "url" : {
                    "description" : "Portal redirect URL",
                    "type" : "string"
                }
            }
        },
        "userSession" : {
            "description" : "Redirect configuration of the Hotspot profile",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "timeoutInMin" : {
                    "description" : "Time out value in minutes",
                    "type" : "integer",
                    "default" : 1440,
                    "minimum" : 2,
                    "maximum" : 14400
                },
                "gracePeriodInMin" : {
                    "description" : "Grace period in minutes",
                    "type" : "integer",
                    "default" : 60,
                    "minimum" : 1,
                    "maximum" : 14399
                }
            }
        },
        "walledGardens" : {
            "description" : "Walled garden map set of the Hotspot. Unauthenticated users are allowed to access the following destinations. Format: - IP (e.g. 10.11.12.13) - IP Range (e.g. 10.11.12.13-10.11.12.15) - CIDR (e.g. 10.11.12.100/28) - IP and mask (e.g. 10.11.12.13 255.255.255.0) - Precise web site (e.g. www.ruckus.com) - Web site with special regular expression like    - *.amazon.com    - *.com",
            "type" : "array",
            "items" : {
                "type" : "string"
            }
        },
        "trafficClassProfileId" : {
            "description" : "Traffic Class Profile of the Hotspot",
            "type" : "string"
        },
        "signatureSigningKey" : {
            "description" : "Signature Signing Key of the Hotspot",
            "type" : "string"
        },
        "internalNode" : {
            "description" : "Internal Node of the Hotspot",
            "type" : "string"
        },
        "macAddressFormat" : {
            "description" : "mac address format of redirection,the format define: 0(aabbccddeeff), 1(AA-BB-CC-DD-EE-FF), 2(AA:BB:CC:DD:EE:FF), 3(AABBCCDDEEFF), 4(aa-bb-cc-dd-ee-ff), 5(aa:bb:cc:dd:ee:ff)",
            "type" : "integer",
            "default" : 2,
            "minimum" : 0,
            "maximum" : 5
        },
        "httpsRedirect" : {
            "description" : "HTTPS Redirect is disable or not",
            "type" : "boolean",
            "default" : "true"
        }
    },
    "required" : [ "name", "smartClientInfo", "macAddressFormat" ]
}
Response  201
HideShow
Body
{
  "id": "76f4c020-7620-11e4-b8b9-00606eb0c700"
}
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

Modify

PATCH/v8_2/rkszones/{zoneId}/portals/hotspot/{id}

Use this API command to modify the basic information on Hotspot (WISPr) of a zone.MacAddressFormat.

Request
HideShow
Body
‧ Sample : Modify a Hotspot with WalledGarden
{
    "name" : "test-hotspot-modify",
    "description" : "description-modify",
    "smartClientSupport" : "Enabled",
    "portalUrl" : "https://172.17.26.59",
    "backupPortalUrl" : "https://172.17.26.60",
    "location" : {
        "id" : "locationId",
        "name" : "locationName"
    },