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 use the common prefix "https://{host}:7443/api/public", where {host} is the IP address of the management interface of the controller.
The following parameters are required in the HTTP headers of all API requests (except for the logon API).
Parameter | Value |
---|---|
Content-Type | “application/json;charset=UTF-8” |
Cookie | “JSESSIONID={JSESSIONID}” |
JSESSIONID is returned as the following parameter in the response header of the logon API.
Parameter | Value |
---|---|
Set-cookie | “JSESSIONID={JSESSIONID}; Path=/wsg; Secure” |
Code | Response | Description |
---|---|---|
200 | OK | The request was completed successfully. Some API calls may return a 201 response instead. |
201 | Created | The request was completed successfully and a resource was created. |
204 | No Content | The request was completed successfully, but there was no representation to return (that is, the response was empty). |
Code | Response | Description |
---|---|---|
400 | Bad request | The request could not be understood or was missing at least one required parameter. |
401 | Unauthorized | Authentication failed or you do not have the permission to perform the requested operation. |
403 | Forbidden | Access denied. |
404 | Not found | The resource could not be found. |
405 | Method not allowed | The requested method is unsupported for the resource. |
406 | Not acceptable | The controller is unable to send data in the format specified in the Accept header of the request. |
422 | Unprocessable entity | The request was well-formed but it could not be completed because of semantic errors. |
Code | Response | Description |
---|---|---|
500 | Internal server error | The request is valid, but the controller is unable to process the request. |
503 | Service unavailable | The service is temporary unavailable (for example, a scheduled maintenance). Please try again later. |
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 |
201 | No active session |
202 | Login denied |
211 | Insufficient administrative privileges |
212 | Resource access denied |
301 | Resource cannot be found |
302 | Business rule violation |
What’s New
Changes
Backward Compatible Notice
The following API commands are used to acquire, retrieve, and release logon sessions.
Use this API command to log on to the controller and acquire a valid logon session.
{
"username" : "admin",
"password" : "admin!234",
"apiVersions" : [ "1", "2" ],
"timeZoneUtcOffset" : "+08:00"
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"username" : {
"description" : "Logon user name",
"type" : "string"
},
"password" : {
"description" : "Logon password",
"type" : "string"
},
"domainName" : {
"description" : "Logon domain name",
"type" : "string"
},
"apiVersions" : {
"description" : "API version supported by the client",
"type" : "array",
"items" : {
"type" : "string"
},
"minItems" : 1,
"uniqueItems" : true
},
"timeZoneUtcOffset" : {
"description" : "Local timezone of the client, offset to UTC",
"enum" : [ "-12:00", "-11:00", "-10:00", "-09:30", "-09:00", "-08:00", "-07:00", "-06:00", "-05:00", "-04:30", "-04:00", "-03:30", "-03:00", "-02:00", "-01:00", "+00:00", "-00:00", "±00:00", "+01:00", "+02:00", "+03:00", "+03:30", "+04:00", "+04:30", "+05:00", "+05:30", "+05:45", "+06:00", "+06:30", "+07:00", "+08:00", "+08:45", "+09:00", "+09:30", "+10:00", "+10:30", "+11:00", "+11:30", "+12:00", "+12:45", "+13:00", "+14:00" ]
}
},
"required" : [ "username", "password" ]
}
200
ShowHide{
"apiVersion" : "1"
}
{
"type" : "object",
"properties" : {
"controllerVersion" : {
"type" : "string"
}
}
}
Use this API command to log off of the controller.
200
Use this API command to retrieve information about the current logon session.
200
ShowHide{
"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
}
{
"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"
}
}
}
Use this API command to retrieve the list of Ruckus Wireless AP zones that belong to a domain.
number
(optional) The index of the first entry to be retrieved. Default: 0
number
(optional) The maximum number of entries to be retrieved. Default: 100
string
(optional) The domain ID. Default: current logon domain ID
200
ShowHide{
"totalCount" : 2,
"hasMore" : false,
"firstIndex" : 0,
"list" : [ {
"id" : "zoneUUID",
"name" : "zoneName"
}, {
"id" : "zoneUUID2",
"name" : "zoneName2"
} ]
}
{
"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"
}
}
}
}
}
}
Use this API command to retrieve Ruckus Wireless AP zones configuration.
200
ShowHide{
"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,
"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 ]
},
"syslog" : null,
"smartMonitor" : null,
"clientAdmissionControl24" : null,
"clientAdmissionControl50" : null,
"channelModeEnabled" : false,
"tunnelType" : "No_Tunneled",
"tunnelProfile" : null,
"backgroundScanning24" : null,
"backgroundScanning50" : null,
"clientLoadBalancing24" : null,
"clientLoadBalancing50" : null,
"bandBalancing" : null,
"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"
}
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Identifier of the zone",
"type" : "string"
},
"domainId" : {
"description" : "Identifier of the management domain to which the zone belongs",
"type" : "string"
},
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the zone"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the zone"
},
"version" : {
"type" : "string",
"pattern" : "^\d+\.\d+\.\d+\.\d+\.\d+$",
"description" : "AP firmware version of the zone"
},
"countryCode" : {
"description" : "Country code of the zone",
"type" : "string"
},
"timezone" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"systemTimezone" : {
"description" : "System defined time zone",
"type" : "string"
},
"customizedTimezone" : {
"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" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"month" : {
"description" : "Month when daylight saving time begins",
"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)",
"enum" : [ 1, 2, 3, 4, 5 ]
},
"day" : {
"description" : "Day of the week (0 for Sunday, 1 for Monday, 2 for Tuesday, and so on)",
"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" ],
"description" : "Daylight saving time start"
},
"end" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"month" : {
"description" : "Month when daylight saving time begins",
"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)",
"enum" : [ 1, 2, 3, 4, 5 ]
},
"day" : {
"description" : "Day of the week (0 for Sunday, 1 for Monday, 2 for Tuesday, and so on)",
"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" ],
"description" : "Daylight saving time end"
}
},
"required" : [ "abbreviation", "gmtOffset", "gmtOffsetMinute" ],
"description" : "User defined time zone"
}
}
},
"login" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"apLoginName" : {
"type" : "string",
"maxLength" : 64,
"pattern" : "^((?!\$\()[!-_a-~]){1,64}$",
"description" : "User name of the AP administrator"
},
"apLoginPassword" : {
"type" : "string",
"maxLength" : 64,
"pattern" : ".*(?=.{8,})(?=.*[a-zA-Z])(?=.*[0-9])(?=.*[_`~!@#$%^&*\(\)\[\]\{\}|;:'\",.\<>\/?=+-]).*",
"description" : "Password of the AP administrator"
}
},
"required" : [ "apLoginName", "apLoginPassword" ],
"description" : "AP administrator account"
},
"ipMode" : {
"enum" : [ "IPV4", "IPV6", "IPV4_IPV6" ],
"description" : "IP mode of the zone"
},
"mesh" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"ssid" : {
"description" : "SSID of the mesh network",
"type" : "string"
},
"passphrase" : {
"description" : "Passphrase for the mesh network",
"type" : "string"
}
},
"description" : "Mesh configuration of the zone."
},
"dfsChannelEnabled" : {
"description" : "DFS Channel enabled configuration of the zone, only for the US country code .",
"type" : "boolean"
},
"wifi24" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"txPower" : {
"enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
"description" : "Transmission power"
},
"channelWidth" : {
"description" : "Channel width. Zero (0) means Auto.",
"enum" : [ 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"
}
}
},
"description" : "AP 2.4GHz radio configuration of the zone."
},
"wifi50" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"txPower" : {
"enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
"description" : "Transmission power"
},
"channelWidth" : {
"description" : "Channel width. Zero (0) means Auto.",
"enum" : [ 0, 20, 40, 80 ]
},
"indoorChannel" : {
"description" : "Indoor channel number",
"type" : "integer"
},
"outdoorChannel" : {
"description" : "Outdoor channel number",
"type" : "integer"
},
"indoorChannelRange" : {
"description" : "Channel range options",
"type" : "array",
"items" : {
"type" : "integer"
}
},
"outdoorChannelRange" : {
"description" : "Channel range options",
"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"
}
}
},
"description" : "AP 5GHz radio configuration of the zone."
},
"syslog" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"address" : {
"type" : "string",
"description" : "Address of the syslog server."
},
"port" : {
"description" : "Port number of the syslog server",
"type" : "integer",
"default" : 514,
"minimum" : 1,
"maximum" : 65535
},
"facility" : {
"description" : "Facility of the syslog server",
"enum" : [ "Keep_Original", "Local0", "Local1", "Local2", "Local3", "Local4", "Local5", "Local6", "Local7" ],
"default" : "keep_Original"
},
"priority" : {
"description" : "Priority of the log messages",
"enum" : [ "Emergency", "Alert", "Critical", "Error", "Warning", "Notice", "Info", "All" ],
"default" : "Error"
}
},
"description" : "Syslog configuration of the zone."
},
"smartMonitor" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"intervalInSec" : {
"description" : "Interval in seconds. This is required if smartMonitor is enabled",
"type" : "integer",
"default" : 10,
"minimum" : 5,
"maximum" : 60
},
"retryThreshold" : {
"description" : "Retry threshold. This is required if smartMonitor is enabled",
"type" : "integer",
"default" : 3,
"minimum" : 1,
"maximum" : 10
}
},
"description" : "Smart monitor configuration of the zone."
},
"clientAdmissionControl24" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"maxRadioLoadPercent" : {
"description" : "Maximum radio load percentage.",
"type" : "integer",
"default" : 75,
"minimum" : 50,
"maximum" : 100
},
"minClientCount" : {
"description" : "Minimum client count number.",
"type" : "integer",
"default" : 10,
"minimum" : 0,
"maximum" : 100
},
"minClientThroughputMbps" : {
"description" : "Minimum client throughput in Mbps.",
"type" : "number",
"default" : 0,
"minimum" : 0,
"maximum" : 100
}
},
"description" : "AP client admission control 2.4GHz radio configuration of the zone."
},
"clientAdmissionControl50" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"maxRadioLoadPercent" : {
"description" : "Maximum radio load percentage.",
"type" : "integer",
"default" : 75,
"minimum" : 50,
"maximum" : 100
},
"minClientCount" : {
"description" : "Minimum client count number.",
"type" : "integer",
"default" : 10,
"minimum" : 0,
"maximum" : 100
},
"minClientThroughputMbps" : {
"description" : "Minimum client throughput in Mbps.",
"type" : "number",
"default" : 0,
"minimum" : 0,
"maximum" : 100
}
},
"description" : "AP client admission control 5GHz radio configuration of the zone."
},
"channelModeEnabled" : {
"description" : "Channel mode configuration of the zone.",
"type" : "boolean"
},
"tunnelType" : {
"description" : "Tunnel type configuration of the zone. No_Tunneled is for IPv6 mode",
"enum" : [ "No_Tunneled", "RuckusGRE", "SoftGRE", "SoftGREIpsec" ]
},
"tunnelProfile" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
},
"description" : "Tunnel type configuration of the zone."
},
"backgroundScanning24" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"frequencyInSec" : {
"description" : "Frequency in second",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
}
},
"description" : "Background scanning on 2.4GHz radio configuration of the zone."
},
"backgroundScanning50" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"frequencyInSec" : {
"description" : "Frequency in second",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
}
},
"description" : "Background scanning on 5GHz radio configuration of the zone."
},
"clientLoadBalancing24" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"adjacentRadioThreshold" : {
"description" : "Adjacent radio threshold",
"type" : "integer",
"minimum" : 1,
"maximum" : 100
}
},
"description" : "Client load balancing on 2.4GHz radio configuration of the zone."
},
"clientLoadBalancing50" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"adjacentRadioThreshold" : {
"description" : "Adjacent radio threshold",
"type" : "integer",
"minimum" : 1,
"maximum" : 100
}
},
"description" : "Client load balancing on 5GHz radio configuration of the zone."
},
"bandBalancing" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"wifi24Percentage" : {
"description" : "Percentage of client load on 2.4GHz radio band",
"type" : "integer",
"minimum" : 0,
"maximum" : 100
}
},
"description" : "Band balancing configuration of the zone."
},
"rogue" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"reportType" : {
"description" : "Report type",
"enum" : [ "All", "Malicious" ]
},
"maliciousTypes" : {
"description" : "Malicious type when reportType is Malicious",
"type" : [ "array", "null" ],
"items" : {
"enum" : [ "SSIDSpoofing", "SameNetwork", "MACSpoofing" ]
}
},
"protectionEnabled" : {
"description" : "Protection enabled",
"type" : "boolean"
}
},
"description" : "Rogue AP detection configuration of the zone."
},
"locationBasedService" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
},
"description" : "Location based service configuration of the zone."
},
"apRebootTimeout" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"gatewayLossTimeoutInSec" : {
"description" : "Gateway loss timeout in second",
"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",
"enum" : [ 0, 7200, 14400, 21600, 28800, 36000, 43200, 50400, 57600, 64800, 72000, 79200, 86400 ]
}
},
"description" : "AP reboot timeout of the zone."
},
"location" : {
"type" : "string",
"pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Location of the Zone."
},
"locationAdditionalInfo" : {
"type" : "string",
"pattern" : "^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$",
"description" : "Location additional info of the zone."
},
"latitude" : {
"type" : "number",
"description" : "Latitude coordinate (in decimal format) of the zone"
},
"longitude" : {
"type" : "number",
"description" : "Longitude coordinate (in decimal format) of the zone"
},
"vlanOverlappingEnabled" : {
"description" : "VLAN pooling overlapping of the zone",
"type" : "boolean"
},
"nodeAffinityProfile" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
},
"description" : "Node affinity profile of the zone."
},
"venueProfile" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
},
"description" : "venue profile configuration of the Zone."
},
"usbSoftwarePackage" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"usbSoftware" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
},
"description" : "APUsbSoftwarePackage id or name"
},
"applyModel" : {
"description" : "List of apply models",
"type" : "array",
"items" : {
"type" : "string"
}
}
},
"description" : "APUsbSoftwarePackage of the zone"
},
"autoChannelSelection24" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"channelSelectMode" : {
"description" : "Channel Select Mode",
"enum" : [ "None", "BackgroundScanning", "ChannelFly" ]
},
"channelFlyMtbc" : {
"description" : "ChannelFly MTBC",
"type" : "integer",
"default" : 480,
"minimum" : 100,
"maximum" : 1440
}
},
"description" : "client load balancing on Radio 2.4G, auto channel selection mode"
},
"autoChannelSelection50" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"channelSelectMode" : {
"description" : "Channel Select Mode",
"enum" : [ "None", "BackgroundScanning", "ChannelFly" ]
},
"channelFlyMtbc" : {
"description" : "ChannelFly MTBC",
"type" : "integer",
"default" : 480,
"minimum" : 100,
"maximum" : 1440
}
},
"description" : "client load balancing on Radio 5G, auto channel selection mode"
},
"channelEvaluationInterval" : {
"description" : "channel evaluation Interval of the zone",
"type" : "integer",
"default" : 600,
"minimum" : 60,
"maximum" : 3600
},
"apMgmtVlan" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"mode" : {
"description" : "Vlan Mode of the zone",
"enum" : [ "KEEP", "USER_DEFINED" ]
},
"id" : {
"description" : "Vlan id of the zone",
"type" : "integer"
}
},
"description" : "ap Management Vlan of the zone"
},
"ipsecProfile" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
},
"description" : "ipsec profile configuration of the Zone."
}
}
}
Use this API command to retrieve the mesh configuration of a zone.
200
ShowHide{
"ssid" : "meshSSID",
"passphrase" : "passphrase"
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"ssid" : {
"description" : "SSID of the mesh network",
"type" : "string"
},
"passphrase" : {
"description" : "Passphrase for the mesh network",
"type" : "string"
}
}
}
Use this API command to enable mesh networking or update the mesh configuration.
{
"ssid" : "meshSSID"
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"ssid" : {
"description" : "SSID of the mesh network",
"type" : "string"
},
"passphrase" : {
"description" : "Passphrase for the mesh network",
"type" : "string"
}
},
"description" : "Mesh configuration of the zone."
}
204
Use this API command to disable mesh networking.
204
Use this API command to create a new Ruckus Wireless AP zone.
{
"domainId" : "domainUUID",
"name" : "zoneName",
"login" : {
"apLoginName" : "apLoginName",
"apLoginPassword" : "apLoginPassword"
},
"description" : "description",
"version" : "3.0.0.0.145",
"countryCode" : "US"
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"domainId" : {
"description" : "Identifier of the management domain to which the zone belongs",
"type" : "string"
},
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the zone"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the zone"
},
"version" : {
"type" : "string",
"pattern" : "^\d+\.\d+\.\d+\.\d+\.\d+$",
"description" : "AP firmware version of the zone"
},
"countryCode" : {
"description" : "Country code of the zone",
"type" : "string"
},
"login" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"apLoginName" : {
"type" : "string",
"maxLength" : 64,
"pattern" : "^((?!\$\()[!-_a-~]){1,64}$",
"description" : "User name of the AP administrator"
},
"apLoginPassword" : {
"type" : "string",
"maxLength" : 64,
"pattern" : ".*(?=.{8,})(?=.*[a-zA-Z])(?=.*[0-9])(?=.*[_`~!@#$%^&*\(\)\[\]\{\}|;:'\",.\<>\/?=+-]).*",
"description" : "Password of the AP administrator"
}
},
"required" : [ "apLoginName", "apLoginPassword" ],
"description" : "AP administrator account"
}
},
"required" : [ "name", "login" ]
}
201
ShowHide{
"id" : "zoneUUID"
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Identifier of the zone",
"type" : "string"
}
}
}
Use this API command to create a new Ruckus Wireless AP zone of IPv6.
{
"domainId" : "domainUUID",
"name" : "zoneName",
"login" : {
"apLoginName" : "apLoginName",
"apLoginPassword" : "apLoginPassword"
},
"description" : "description",
"version" : "3.0.0.0.145",
"countryCode" : "US"
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"domainId" : {
"description" : "Identifier of the management domain to which the zone belongs",
"type" : "string"
},
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the zone"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the zone"
},
"version" : {
"type" : "string",
"pattern" : "^\d+\.\d+\.\d+\.\d+\.\d+$",
"description" : "AP firmware version of the zone"
},
"countryCode" : {
"description" : "Country code of the zone",
"type" : "string"
},
"login" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"apLoginName" : {
"type" : "string",
"maxLength" : 64,
"pattern" : "^((?!\$\()[!-_a-~]){1,64}$",
"description" : "User name of the AP administrator"
},
"apLoginPassword" : {
"type" : "string",
"maxLength" : 64,
"pattern" : ".*(?=.{8,})(?=.*[a-zA-Z])(?=.*[0-9])(?=.*[_`~!@#$%^&*\(\)\[\]\{\}|;:'\",.\<>\/?=+-]).*",
"description" : "Password of the AP administrator"
}
},
"required" : [ "apLoginName", "apLoginPassword" ],
"description" : "AP administrator account"
}
},
"required" : [ "name", "login" ]
}
201
ShowHide{
"id" : "zoneUUID"
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Identifier of the zone",
"type" : "string"
}
}
}
Use this API command to create a new Ruckus Wireless AP zone of IPv4/IPv6.
{
"domainId" : "domainUUID",
"name" : "zoneName",
"login" : {
"apLoginName" : "apLoginName",
"apLoginPassword" : "apLoginPassword"
},
"description" : "description",
"version" : "3.0.0.0.145",
"countryCode" : "US"
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"domainId" : {
"description" : "Identifier of the management domain to which the zone belongs",
"type" : "string"
},
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the zone"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the zone"
},
"version" : {
"type" : "string",
"pattern" : "^\d+\.\d+\.\d+\.\d+\.\d+$",
"description" : "AP firmware version of the zone"
},
"countryCode" : {
"description" : "Country code of the zone",
"type" : "string"
},
"login" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"apLoginName" : {
"type" : "string",
"maxLength" : 64,
"pattern" : "^((?!\$\()[!-_a-~]){1,64}$",
"description" : "User name of the AP administrator"
},
"apLoginPassword" : {
"type" : "string",
"maxLength" : 64,
"pattern" : ".*(?=.{8,})(?=.*[a-zA-Z])(?=.*[0-9])(?=.*[_`~!@#$%^&*\(\)\[\]\{\}|;:'\",.\<>\/?=+-]).*",
"description" : "Password of the AP administrator"
}
},
"required" : [ "apLoginName", "apLoginPassword" ],
"description" : "AP administrator account"
}
},
"required" : [ "name", "login" ]
}
201
ShowHide{
"id" : "zoneUUID"
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Identifier of the zone",
"type" : "string"
}
}
}
Use this API command to modify the basic information of a zone.
{
"domainId" : "domainUUIDToMove",
"name" : "zoneModified",
"description" : "description modified",
"version" : "3.0.0.0.175",
"countryCode" : "US",
"dfsChannelEnabled" : false,
"channelModeEnabled" : false,
"tunnelType" : "RuckusGRE",
"location" : "location",
"locationAdditionalInfo" : "locationAdditionalInfo",
"latitude" : 23,
"longitude" : 23,
"vlanOverlappingEnabled" : false,
"channelEvaluationInterval" : 777
}
{
"domainId" : {
"description" : "Identifier of the management domain to which the zone belongs",
"type" : "string"
},
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the zone"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the zone"
},
"version" : {
"type" : "string",
"pattern" : "^\d+\.\d+\.\d+\.\d+\.\d+$",
"description" : "AP firmware version of the zone"
},
"countryCode" : {
"description" : "Country code of the zone",
"type" : "string"
},
"dfsChannelEnabled" : {
"description" : "DFS Channel enabled configuration of the zone, only for the US country code .",
"type" : "boolean"
},
"channelModeEnabled" : {
"description" : "Channel mode configuration of the zone.",
"type" : "boolean"
},
"tunnelType" : {
"description" : "Tunnel type configuration of the zone. No_Tunneled is for IPv6 mode",
"enum" : [ "No_Tunneled", "RuckusGRE", "SoftGRE", "SoftGREIpsec" ]
},
"location" : {
"type" : "string",
"pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Location of the zone."
},
"locationAdditionalInfo" : {
"type" : "string",
"pattern" : "^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$",
"description" : "Location additional info of the zone."
},
"latitude" : {
"type" : "number",
"description" : "Latitude coordinate (in decimal format) of the zone"
},
"longitude" : {
"type" : "number",
"description" : "Longitude coordinate (in decimal format) of the zone"
},
"vlanOverlappingEnabled" : {
"description" : "VLAN pooling overlapping of the zone",
"type" : "boolean"
},
"channelEvaluationInterval" : {
"description" : "channel evaluation Interval of the zone",
"type" : "integer",
"default" : 600,
"minimum" : 60,
"maximum" : 3600
}
}
204
Use this API command to modify the time zone of a zone.
{
"customizedTimezone" : {
"abbreviation" : "ABC",
"gmtOffset" : 4,
"gmtOffsetMinute" : 10
}
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"systemTimezone" : {
"description" : "System defined time zone",
"type" : "string"
},
"customizedTimezone" : {
"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" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"month" : {
"description" : "Month when daylight saving time begins",
"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)",
"enum" : [ 1, 2, 3, 4, 5 ]
},
"day" : {
"description" : "Day of the week (0 for Sunday, 1 for Monday, 2 for Tuesday, and so on)",
"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" ],
"description" : "Daylight saving time start"
},
"end" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"month" : {
"description" : "Month when daylight saving time begins",
"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)",
"enum" : [ 1, 2, 3, 4, 5 ]
},
"day" : {
"description" : "Day of the week (0 for Sunday, 1 for Monday, 2 for Tuesday, and so on)",
"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" ],
"description" : "Daylight saving time end"
}
},
"required" : [ "abbreviation", "gmtOffset", "gmtOffsetMinute" ],
"description" : "User defined time zone"
}
},
"description" : "Either systemTimezone or customizedTimezone must be specified"
}
204
Use this API command to modify the AP logon information for APs that belong to a zone.
{
"apLoginName" : "apLoginName",
"apLoginPassword" : "apLoginPassword"
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"apLoginName" : {
"type" : "string",
"maxLength" : 64,
"pattern" : "^((?!\$\()[!-_a-~]){1,64}$",
"description" : "User name of the AP administrator"
},
"apLoginPassword" : {
"type" : "string",
"maxLength" : 64,
"pattern" : ".*(?=.{8,})(?=.*[a-zA-Z])(?=.*[0-9])(?=.*[_`~!@#$%^&*\(\)\[\]\{\}|;:'\",.\<>\/?=+-]).*",
"description" : "Password of the AP administrator"
}
},
"required" : [ "apLoginName", "apLoginPassword" ],
"description" : "AP administrator account"
}
204
Use this API command to modify the 2.4GHz radio configuration for APs that belong to a zone.
{
"txPower" : "Full",
"channelWidth" : 20,
"channel" : 0,
"channelRange" : [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11 ]
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"txPower" : {
"enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
"description" : "Transmission power"
},
"channelWidth" : {
"description" : "Channel width. Zero (0) means Auto.",
"enum" : [ 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"
}
}
},
"description" : "AP 2.4GHz radio configuration of the zone."
}
204
Use this API command to modify the 5GHz radio configuration for APs that belong to a zone.
{
"txPower" : "-1dB",
"channelWidth" : 40,
"indoorChannel" : 0,
"outdoorChannel" : 0,
"indoorChannelRange" : [ 36, 40, 44, 48, 149, 153, 157, 161 ],
"outdoorChannelRange" : [ 149, 153, 157, 161 ]
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"txPower" : {
"enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
"description" : "Transmission power"
},
"channelWidth" : {
"description" : "Channel width. Zero (0) means Auto.",
"enum" : [ 0, 20, 40, 80 ]
},
"indoorChannel" : {
"description" : "Indoor channel number",
"type" : "integer"
},
"outdoorChannel" : {
"description" : "Outdoor channel number",
"type" : "integer"
},
"indoorChannelRange" : {
"description" : "Channel range options",
"type" : "array",
"items" : {
"type" : "integer"
}
},
"outdoorChannelRange" : {
"description" : "Channel range options",
"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"
}
}
},
"description" : "AP 5GHz radio configuration of the zone."
}
204
Use this API command to modify the syslog configuration for APs that belong to a zone.
{
"address" : "1.1.1.1",
"port" : 514,
"facility" : "keep_Original",
"priority" : "Error"
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"address" : {
"type" : "string",
"description" : "Address of the syslog server."
},
"port" : {
"description" : "Port number of the syslog server",
"type" : "integer",
"default" : 514,
"minimum" : 1,
"maximum" : 65535
},
"facility" : {
"description" : "Facility of the syslog server",
"enum" : [ "Keep_Original", "Local0", "Local1", "Local2", "Local3", "Local4", "Local5", "Local6", "Local7" ],
"default" : "keep_Original"
},
"priority" : {
"description" : "Priority of the log messages",
"enum" : [ "Emergency", "Alert", "Critical", "Error", "Warning", "Notice", "Info", "All" ],
"default" : "Error"
}
},
"description" : "Syslog configuration of the zone."
}
204
Use this API command to disable syslog configuration for APs that belong to a zone.
204
Use this API command to modify the smart monitor for APs that belong to a zone.
{
"intervalInSec" : 10,
"retryThreshold" : 3
}
{
"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
}
},
"description" : "Smart monitor configuration of the zone."
}
204
Use this API command to disable smart monitor for APs that belong to a zone.
204
Use this API command to modify the client admission control 2.4GHz radio configuration for APs that belong to a zone.
{
"maxRadioLoadPercent" : 75,
"minClientCount" : "10",
"minClientThroughputMbps" : 0
}
{
"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
}
},
"description" : "AP client admission control 2.4GHz radio configuration of the zone."
}
204
Use this API command to disable client admission control 2.4GHz radio configuration for APs that belong to a zone.
204
Use this API command to modify the client admission control 5GHz radio configuration for APs that belong to a zone.
{
"maxRadioLoadPercent" : 75,
"minClientCount" : "10",
"minClientThroughputMbps" : 0
}
{
"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
}
},
"description" : "AP client admission control 5GHz radio configuration of the zone."
}
204
Use this API command to disable client admission control 5GHz radio configuration for APs that belong to a zone.
204
Use this API command to modify the tunnel profile for APs that belong to a zone.
{
"id" : "tunnelProfileId",
"name" : "tunnelProfileName"
}
{
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
},
"description" : "Tunnel type configuration of the zone."
}
204
Use this API command to modify the background scanning 2.4GHz radio configuration for APs that belong to a zone.
{
"frequencyInSec" : 20
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"frequencyInSec" : {
"description" : "Frequency in second",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
}
},
"description" : "Background scanning on 2.4GHz radio configuration of the zone."
}
204
Use this API command to disable background scanning 2.4GHz radio configuration for APs that belong to a zone.
204
Use this API command to modify the background scanning 5GHz radio configuration for APs that belong to a zone.
{
"frequencyInSec" : 20
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"frequencyInSec" : {
"description" : "Frequency in second",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
}
},
"description" : "Background scanning on 5GHz radio configuration of the zone."
}
204
Use this API command to disable background scanning 5GHz radio configuration for APs that belong to a zone.
204
Use this API command to modify the client load balancing 2.4GHz radio configuration for APs that belong to a zone.
{
"adjacentRadioThreshold" : 12
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"adjacentRadioThreshold" : {
"description" : "Adjacent radio threshold",
"type" : "integer",
"minimum" : 1,
"maximum" : 100
}
},
"description" : "Client load balancing on 2.4GHz radio configuration of the zone."
}
204
Use this API command to disable client load balancing 2.4GHz radio configuration for APs that belong to a zone.
204
Use this API command to modify the client load balancing 5GHz radio configuration for APs that belong to a zone.
{
"adjacentRadioThreshold" : 12
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"adjacentRadioThreshold" : {
"description" : "Adjacent radio threshold",
"type" : "integer",
"minimum" : 1,
"maximum" : 100
}
},
"description" : "Client load balancing on 5GHz radio configuration of the zone."
}
204
Use this API command to disable client load balancing 5GHz radio configuration for APs that belong to a zone.
204
Use this API command to modify band balancing for APs that belong to a zone.
{
"wifi24Percentage" : 10
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"wifi24Percentage" : {
"description" : "Percentage of client load on 2.4GHz radio band",
"type" : "integer",
"minimum" : 0,
"maximum" : 100
}
},
"description" : "Band balancing configuration of the zone."
}
204
Use this API command to disable band balancing for APs that belong to a zone.
204
Use this API command to modify AP reboot timeout for APs that belong to a zone.
{
"gatewayLossTimeoutInSec" : 1800,
"serverLossTimeoutInSec" : 7200
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"gatewayLossTimeoutInSec" : {
"description" : "Gateway loss timeout in second",
"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",
"enum" : [ 0, 7200, 14400, 21600, 28800, 36000, 43200, 50400, 57600, 64800, 72000, 79200, 86400 ]
}
},
"description" : "AP reboot timeout of the zone."
}
204
Use this API command to modify node affinity profile for APs that belong to a zone.
{
"id" : "nodeAffinityProfileId",
"name" : "nodeAffinityProfileName"
}
{
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
},
"description" : "Node affinity profile of the zone."
}
204
Use this API command to modify Hotspot 2.0 venue profile for APs that belong to a zone.
{
"id" : "venueProfileId",
"name" : "venueProfileName"
}
{
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
},
"description" : "Venue profile configuration of the zone."
}
204
Use this API command to clear Hotspot 2.0 venue profile for APs that belong to a zone.
204
Use this API command to modify the rogue AP detection for APs that belong to a zone.
{
"reportType" : "All",
"maliciousTypes" : null,
"protectionEnabled" : true
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"reportType" : {
"description" : "Report type",
"enum" : [ "All", "Malicious" ]
},
"maliciousTypes" : {
"description" : "Malicious type when reportType is Malicious",
"type" : [ "array", "null" ],
"items" : {
"enum" : [ "SSIDSpoofing", "SameNetwork", "MACSpoofing" ]
}
},
"protectionEnabled" : {
"description" : "Protection enabled",
"type" : "boolean"
}
},
"description" : "Rogue AP detection configuration of the zone."
}
204
Use this API command to disable rogue AP detection for APs that belong to a zone.
204
Use this API command to modify location based service for APs that belong to a zone.
{
"id" : "lbsId",
"name" : "lbsName"
}
{
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
},
"description" : "Location based service configuration of the zone."
}
204
Use this API command to disable location based service for APs that belong to a zone.
204
Use this API command to retrieve AP model specific configuration that belong to a zone.
200
ShowHide{
"ledStatusEnabled" : true,
"lldp" : {
"enabled" : true,
"advertiseIntervalInSec" : 30,
"holdTimeInSec" : 120,
"managementIPTLVEnabled" : false
},
"ledMode" : null,
"internalHeaterEnabled" : null,
"poeOutPortEnabled" : null,
"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"
}
} ]
}
{
"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" ]
},
"ledMode" : {
"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" ]
},
"radioBand" : {
"enum" : [ null, "2.4GHz", "5GHz" ]
},
"externalAntenna24" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"enabled" : {
"type" : "boolean"
},
"dbi" : {
"type" : [ "integer", "null" ],
"minimum" : 0,
"maximum" : 90
},
"chainMask" : {
"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" : {
"enum" : [ null, "Two", "Three" ]
}
},
"required" : [ "enabled" ]
},
"lanPorts" : {
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"portName" : {
"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" ]
}
}
}
}
Use this API command to modify the AP model specific configuration that belong to a zone.
{
"ledStatusEnabled" : true,
"lldp" : {
"enabled" : true,
"advertiseIntervalInSec" : 30,
"holdTimeInSec" : 120,
"managementIPTLVEnabled" : false
},
"ledMode" : null,
"internalHeaterEnabled" : null,
"poeOutPortEnabled" : null,
"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"
}
} ]
}
{
"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" ]
},
"ledMode" : {
"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" ]
},
"radioBand" : {
"enum" : [ null, "2.4GHz", "5GHz" ]
},
"externalAntenna24" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"enabled" : {
"type" : "boolean"
},
"dbi" : {
"type" : [ "integer", "null" ],
"minimum" : 0,
"maximum" : 90
},
"chainMask" : {
"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" : {
"enum" : [ null, "Two", "Three" ]
}
},
"required" : [ "enabled" ]
},
"lanPorts" : {
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"portName" : {
"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" ]
}
}
}
}
204
Modify Radio 2.4G Auto ChannelSelectMode and ChannelFly MTBC of a zone
{
"channelSelectMode" : "ChannelFly",
"channelFlyMtbc" : 480
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"channelSelectMode" : {
"description" : "Channel Select Mode",
"enum" : [ "None", "BackgroundScanning", "ChannelFly" ]
},
"channelFlyMtbc" : {
"description" : "ChannelFly MTBC",
"type" : "integer",
"default" : 480,
"minimum" : 100,
"maximum" : 1440
}
},
"description" : "client load balancing on Radio 2.4G, auto channel selection mode"
}
204
Modify Radio 5G Auto ChannelSelectMode and ChannelFly MTBC of a zone
{
"channelSelectMode" : "BackgroundScanning",
"channelFlyMtbc" : 480
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"channelSelectMode" : {
"description" : "Channel Select Mode",
"enum" : [ "None", "BackgroundScanning", "ChannelFly" ]
},
"channelFlyMtbc" : {
"description" : "ChannelFly MTBC",
"type" : "integer",
"default" : 480,
"minimum" : 100,
"maximum" : 1440
}
},
"description" : "client load balancing on Radio 5G, auto channel selection mode"
}
204
Modify IPsec Profile of a zone
{
"id" : "ipsecProfileId",
"name" : "ipsecProfileName"
}
{
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
},
"description" : "ipsec profile configuration of the Zone."
}
204
Modify AP Usb Software Package of a zone
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"usbSoftware" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
},
"description" : "APUsbSoftwarePackage id or name"
},
"applyModel" : {
"description" : "List of apply models",
"type" : "array",
"items" : {
"type" : "string"
}
}
},
"description" : "APUsbSoftwarePackage of the zone"
}
204
Modify AP Management Vlan of a zone
{
"id" : 1,
"mode" : "KEEP"
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"mode" : {
"description" : "Vlan Mode of the zone",
"enum" : [ "KEEP", "USER_DEFINED" ]
},
"id" : {
"description" : "Vlan id of the zone",
"type" : "integer"
}
},
"description" : "ap Management Vlan of the zone"
}
204
Disable AP Usb Software Package of a zone
string
(optional) Specify ap models. ex : applyModel=ZF7321U&applyModel=ZF7323
204
Use this API command to delete a zone.
204
Use this API command to retrieve the list of AP groups that belong to a zone.
number
(optional) The index of the first entry to be retrieved. Default: 0
number
(optional) The maximum number of entries to be retrieved. Default: 100
200
ShowHide{
"totalCount" : 2,
"hasMore" : false,
"firstIndex" : 0,
"list" : [ {
"id" : "apGroupUUID",
"name" : "apGroupName"
}, {
"id" : "apGroupUUID2",
"name" : "apGroupName2"
} ]
}
{
"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"
}
}
}
}
}
}
Use this API command to retrieve information about an AP group.
200
ShowHide{
"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 ]
},
"wlanGroup24" : {
"id" : "19b10850-7eaa-11e4-a584-08002716c79f",
"name" : "default"
},
"wlanGroup50" : null,
"locationBasedService" : null,
"clientAdmissionControl24" : {
"maxRadioLoadPercent" : 70,
"minClientCount" : 30,
"minClientThroughputMbps" : 10.0,
"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"
}
}
{
"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" : {
"type" : "string",
"pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Location of the AP group."
},
"locationAdditionalInfo" : {
"type" : "string",
"pattern" : "^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$",
"description" : "Location additional info of the AP group."
},
"latitude" : {
"type" : "number",
"description" : "Latitude coordinate (in decimal format) of the AP group"
},
"longitude" : {
"type" : "number",
"description" : "Longitude coordinate (in decimal format) of the AP group"
},
"wifi24" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"txPower" : {
"enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
"description" : "Transmission power"
},
"channelWidth" : {
"description" : "Channel width. Zero (0) means Auto.",
"enum" : [ 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"
}
}
},
"description" : "AP 2.4GHz radio configuration of the AP group."
},
"wifi50" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"txPower" : {
"enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
"description" : "Transmission power"
},
"channelWidth" : {
"description" : "Channel width. Zero (0) means Auto.",
"enum" : [ 0, 20, 40, 80 ]
},
"indoorChannel" : {
"description" : "Indoor channel number",
"type" : "integer"
},
"outdoorChannel" : {
"description" : "Outdoor channel number",
"type" : "integer"
},
"indoorChannelRange" : {
"description" : "Channel range options",
"type" : "array",
"items" : {
"type" : "integer"
}
},
"outdoorChannelRange" : {
"description" : "Channel range options",
"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"
}
}
},
"description" : "AP 5GHz radio configuration of the AP group."
},
"wlanGroup24" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
},
"description" : "WLAN group of radio 2.4G. This configuraiton will override the WLAN group of radio 2.4G at the zone level."
},
"wlanGroup50" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
},
"description" : "WLAN group of radio 5G. This configuration will override the WLAN group of radio 5G at the zone level."
},
"locationBasedService" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"enabled" : {
"type" : "boolean"
},
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
},
"description" : "Location based service configuration of the AP group."
},
"clientAdmissionControl24" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"enabled" : {
"type" : "boolean"
},
"maxRadioLoadPercent" : {
"description" : "Maximum radio load percentage.",
"type" : "integer",
"default" : 75,
"minimum" : 50,
"maximum" : 100
},
"minClientCount" : {
"description" : "Minimum client count number.",
"type" : "integer",
"default" : 10,
"minimum" : 0,
"maximum" : 100
},
"minClientThroughputMbps" : {
"description" : "Minimum client throughput in Mbps.",
"type" : "number",
"default" : 0,
"minimum" : 0,
"maximum" : 100
}
},
"description" : "WLAN group of 2.4GHz radio. This configuraiton will override the WLAN group of 2.4GHz radio at the zone level."
},
"clientAdmissionControl50" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"enabled" : {
"type" : "boolean"
},
"maxRadioLoadPercent" : {
"description" : "Maximum radio load percentage.",
"type" : "integer",
"default" : 75,
"minimum" : 50,
"maximum" : 100
},
"minClientCount" : {
"description" : "Minimum client count number.",
"type" : "integer",
"default" : 10,
"minimum" : 0,
"maximum" : 100
},
"minClientThroughputMbps" : {
"description" : "Minimum client throughput in Mbps.",
"type" : "number",
"default" : 0,
"minimum" : 0,
"maximum" : 100
}
},
"description" : "WLAN group of 5G radio. This configuration will override the WLAN group of 5G radio at the zone level."
},
"venueProfile" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
},
"description" : "Venue profile configuration of the AP group."
},
"members" : {
"description" : "Members of the AP group",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"apMac" : {
"type" : "string",
"pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$",
"description" : "MAC address of member AP"
}
}
}
},
"autoChannelSelection24" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"channelSelectMode" : {
"description" : "Channel Select Mode",
"enum" : [ "None", "BackgroundScanning", "ChannelFly" ]
},
"channelFlyMtbc" : {
"description" : "ChannelFly MTBC",
"type" : "integer",
"default" : 480,
"minimum" : 100,
"maximum" : 1440
}
},
"description" : "client load balancing on Radio 2.4G, auto channel selection mode"
},
"autoChannelSelection50" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"channelSelectMode" : {
"description" : "Channel Select Mode",
"enum" : [ "None", "BackgroundScanning", "ChannelFly" ]
},
"channelFlyMtbc" : {
"description" : "ChannelFly MTBC",
"type" : "integer",
"default" : 480,
"minimum" : 100,
"maximum" : 1440
}
},
"description" : "client load balancing on Radio 5G, auto channel selection mode"
},
"channelEvaluationInterval" : {
"description" : "channel evaluation Interval of the ap group",
"type" : "integer",
"default" : 600,
"minimum" : 60,
"maximum" : 3600
},
"apMgmtVlan" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"mode" : {
"description" : "Vlan Mode of the zone",
"enum" : [ "KEEP", "USER_DEFINED" ]
},
"id" : {
"description" : "Vlan id of the zone",
"type" : "integer"
}
},
"description" : "ap Management Vlan of the apgroup"
}
},
"required" : [ "name" ]
}
Use this API command to create new AP group within a zone.
{
"name" : "apGroupName",
"description" : "apGroupDescription"
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the AP group"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the AP group"
}
},
"required" : [ "name" ]
}
201
ShowHide{
"id" : "apGroupUUID"
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Identifier of the AP group",
"type" : "string"
}
}
}
Use this API command to modify the basic information of an AP group.
{
"name" : "apGroupNameModified",
"description" : "apGroupDescriptionModified",
"location" : "test-ap1_modify",
"locationAdditionalInfo" : "add",
"latitude" : 34,
"longitude" : 45,
"channelEvaluationInterval" : 777
}
{
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the AP group"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the AP group"
},
"location" : {
"type" : "string",
"pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Location of the AP group."
},
"locationAdditionalInfo" : {
"type" : "string",
"pattern" : "^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$",
"description" : "Location additional info of the AP group."
},
"latitude" : {
"type" : "number",
"description" : "Latitude coordinate (in decimal format) of the AP group"
},
"longitude" : {
"type" : "number",
"description" : "Longitude coordinate (in decimal format) of the AP group"
},
"channelEvaluationInterval" : {
"description" : "channel evaluation Interval of the ap group",
"type" : "integer",
"default" : 600,
"minimum" : 60,
"maximum" : 3600
}
}
204
Use this API command to disable location override for APs that belong to an AP group.
204
Use this API command to disable location additionalInfo override zone for APs that belong to an AP group.
204
Use this API command to modify the 2.4GHz radio configuration override zone for APs that belong to an AP group.
{
"txPower" : "Full",
"channelWidth" : 20,
"channel" : 10,
"channelRange" : [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11 ]
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"txPower" : {
"enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
"description" : "Transmission power"
},
"channelWidth" : {
"description" : "Channel width. Zero (0) means Auto.",
"enum" : [ 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"
}
}
},
"description" : "AP 2.4GHz radio configuration of the AP group."
}
204
Use this API command to disable 2.4GHz radio configuration override zone for APs that belong to an AP group.
204
Use this API command to modify the 5GHz radio configuration override zone for APs that belong to an AP group.
{
"txPower" : "Full",
"channelWidth" : 20,
"indoorChannel" : 36,
"outdoorChannel" : 149,
"indoorChannelRange" : [ 36, 40, 44, 48, 149, 153, 157, 161 ],
"outdoorChannelRange" : [ 149, 153, 157, 161 ]
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"txPower" : {
"enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
"description" : "Transmission power"
},
"channelWidth" : {
"description" : "Channel width. Zero (0) means Auto.",
"enum" : [ 0, 20, 40, 80 ]
},
"indoorChannel" : {
"description" : "Indoor channel number",
"type" : "integer"
},
"outdoorChannel" : {
"description" : "Outdoor channel number",
"type" : "integer"
},
"indoorChannelRange" : {
"description" : "Channel range options",
"type" : "array",
"items" : {
"type" : "integer"
}
},
"outdoorChannelRange" : {
"description" : "Channel range options",
"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"
}
}
},
"description" : "AP 5GHz radio configuration of the AP group."
}
204
Use this API command to disable 5GHz radio configuration override zone for APs that belong to an AP group.
204
Use this API command to modify the WLAN group on 2.4GHz radio override zone for APs that belong to an AP group.
{
"id" : "19b10850-7eaa-11e4-a584-08002716c79f",
"name" : "default"
}
{
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
},
"description" : "WLAN group of 2.4GHz radio. This configuraiton will override the WLAN group of 2.4GHz radio at the zone level."
}
204
Use this API command to disable WLAN group on 2.4GHz radio override zone for APs that belong to an AP group.
204
Use this API command to modify the WLAN group on 5GHz radio override zone for APs that belong to an AP group.
{
"id" : "19b10850-7eaa-11e4-a584-08002716c79f",
"name" : "default"
}
{
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
},
"description" : "WLAN group of 5G radio. This configuration will override the WLAN group of 5G radio at the zone level."
}
204
Use this API command to disable WLAN group on 5GHz radio override zone for APs that belong to an AP group.
204
Use this API command to modify location based service override zone for APs that belong to an AP group.
{
"id" : "lbsServiceId",
"name" : "lbsServiceName"
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"enabled" : {
"type" : "boolean"
},
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
},
"description" : "Location based service configuration of the AP group."
}
204
Use this API command to disable location based service override zone for APs that belong to an AP group.
204
Use this API command to modify client admission control 2.4GHz radio configuration override zone for APs that belong to an AP group.
{
"maxRadioLoadPercent" : 70,
"minClientCount" : 30,
"minClientThroughputMbps" : 10.0,
"enabled" : true
}
{
"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" : "AP client admission control of 2.4GHz radio configuration of the AP group."
}
204
Use this API command to disable client admission control 2.4GHz radio configuration override zone for APs that belong to an AP group.
204
Use this API command to modify client admission control 5GHz radio configuration override zone for APs that belong to an AP group.
{
"maxRadioLoadPercent" : 70,
"minClientCount" : 30,
"minClientThroughputMbps" : 10.0,
"enabled" : true
}
{
"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" : "AP client admission control of 5GHz radio configuration of the AP group."
}
204
Use this API command to disable client admission control 5GHz radio configuration override zone for APs that belong to an AP group.
204
Use this API command to modify Hotspot 2.0 venue profile for APs that belong to an AP group.
{
"id" : "venueProfileId",
"name" : "venueProfileName"
}
{
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
},
"description" : "Venue profile configuration of the AP group."
}
204
Use this API command to clear Hotspot 2.0 venue profile for APs that belong to an AP group.
204
Use this API command to add a member AP to an AP group.
201
Add multiple members to an AP group
{
"memberList" : [ {
"apMac" : "00:22:11:0C:BD:13"
}, {
"apMac" : "10:11:22:0C:0D:15"
} ]
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"memberList" : {
"description" : "List of apMac",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"apMac" : {
"type" : "string",
"pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$",
"description" : "MAC address of member AP"
}
}
}
}
}
}
201
Use this API command to remove a member AP from an AP group.
204
Use this API command to retrieve AP model specific configuration override zone that belong to an AP group, empty mean not override zone.
200
ShowHide{
"ledStatusEnabled" : true,
"lldp" : {
"enabled" : true,
"advertiseIntervalInSec" : 30,
"holdTimeInSec" : 120,
"managementIPTLVEnabled" : false
},
"ledMode" : null,
"internalHeaterEnabled" : null,
"poeOutPortEnabled" : null,
"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"
}
} ]
}
{
"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" ]
},
"ledMode" : {
"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" ]
},
"radioBand" : {
"enum" : [ null, "2.4GHz", "5GHz" ]
},
"externalAntenna24" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"enabled" : {
"type" : "boolean"
},
"dbi" : {
"type" : [ "integer", "null" ],
"minimum" : 0,
"maximum" : 90
},
"chainMask" : {
"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" : {
"enum" : [ null, "Two", "Three" ]
}
},
"required" : [ "enabled" ]
},
"lanPorts" : {
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"portName" : {
"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" ]
}
}
}
}
Use this API command to modify AP model specific configuration override zone that belong to an AP group.
{
"ledStatusEnabled" : true,
"lldp" : {
"enabled" : true,
"advertiseIntervalInSec" : 30,
"holdTimeInSec" : 120,
"managementIPTLVEnabled" : false
},
"ledMode" : null,
"internalHeaterEnabled" : null,
"poeOutPortEnabled" : null,
"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"
}
} ]
}
{
"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" ]
},
"ledMode" : {
"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" ]
},
"radioBand" : {
"enum" : [ null, "2.4GHz", "5GHz" ]
},
"externalAntenna24" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"enabled" : {
"type" : "boolean"
},
"dbi" : {
"type" : [ "integer", "null" ],
"minimum" : 0,
"maximum" : 90
},
"chainMask" : {
"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" : {
"enum" : [ null, "Two", "Three" ]
}
},
"required" : [ "enabled" ]
},
"lanPorts" : {
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"portName" : {
"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" ]
}
}
}
}
204
Use this API command to disable AP model specific configuration override zone that belong to an AP group.
204
Override Radio 2.4G Auto ChannelSelectMode and ChannelFly MTBC of an AP group
{
"channelSelectMode" : "ChannelFly",
"channelFlyMtbc" : 480
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"channelSelectMode" : {
"description" : "Channel Select Mode",
"enum" : [ "None", "BackgroundScanning", "ChannelFly" ]
},
"channelFlyMtbc" : {
"description" : "ChannelFly MTBC",
"type" : "integer",
"default" : 480,
"minimum" : 100,
"maximum" : 1440
}
},
"description" : "client load balancing on Radio 2.4G, auto channel selection mode"
}
204
Override Radio 5G Auto ChannelSelectMode and ChannelFly MTBC of an AP group
{
"channelSelectMode" : "BackgroundScanning",
"channelFlyMtbc" : 480
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"channelSelectMode" : {
"description" : "Channel Select Mode",
"enum" : [ "None", "BackgroundScanning", "ChannelFly" ]
},
"channelFlyMtbc" : {
"description" : "ChannelFly MTBC",
"type" : "integer",
"default" : 480,
"minimum" : 100,
"maximum" : 1440
}
},
"description" : "client load balancing on Radio 5G, auto channel selection mode"
}
204
Disable Radio 2.4G Auto ChannelSelectMode and ChannelFly MTBC Override of an AP group
204
Disable Radio 5G Auto ChannelSelectMode and ChannelFly MTBC Override of an AP group
204
Disable Channel Evaluation Interval Override of an AP group
204
Modify AP Usb Software Package of an AP group
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"usbSoftware" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
},
"description" : "APUsbSoftwarePackage id or name"
},
"applyModel" : {
"description" : "List of apply models",
"type" : "array",
"items" : {
"type" : "string"
}
}
},
"description" : "APUsbSoftwarePackage of the AP group"
}
204
Disable AP Usb Software Package of an AP group
string
(optional) Specify ap models. ex : applyModel=ZF7321U&applyModel=ZF7323
204
Modify AP Management Vlan of an AP group
{
"id" : 1,
"mode" : "KEEP"
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"mode" : {
"description" : "Vlan Mode of the zone",
"enum" : [ "KEEP", "USER_DEFINED" ]
},
"id" : {
"description" : "Vlan id of the zone",
"type" : "integer"
}
},
"description" : "ap Management Vlan of the apgroup"
}
204
Disable AP Management Vlan Override of an AP group
204
Use this API command to delete an AP group.
204
Use this API command to retrieve the list of APs that belong to a zone or a domain.
number
(optional) The index of the first entry to be retrieved. Default: 0
number
(optional) The maximum number of entries to be retrieved. Default: 100
string
(optional) filter AP list by zone
string
(optional) filter AP list by domain. Default: current logon domain
200
ShowHide{
"totalCount" : 2,
"hasMore" : false,
"firstIndex" : 0,
"list" : [ {
"mac" : "00:11:22:33:44:55",
"zoneId" : "zoneUUID",
"apGroupId" : "apGroupUUID",
"name" : "apName"
}, {
"mac" : "11:22:33:44:55:66",
"zoneId" : "zoneUUID2",
"apGroupId" : "apGroupUUID2",
"name" : "apName2"
} ]
}
{
"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" : {
"type" : "string",
"pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$",
"description" : "MAC address of the AP"
},
"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"
},
"connectionState" : {
"description" : "Connection state of the AP",
"type" : "string"
},
"clientCount" : {
"description" : "Number of clients on the AP",
"type" : "integer"
}
}
}
}
}
}
Use this API command to retrieve the configuration of an AP.
200
ShowHide{
"zoneId" : "zoneUUID",
"apGroupId" : "apGroupUUID",
"serial" : "00000096",
"model" : "ZF7343",
"name" : "apName",
"latitude" : 22.3,
"longitude" : 114,
"location" : "location",
"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 ]
},
"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"
},
"smartMonitor" : {
"enabled" : true,
"intervalInSec" : 10,
"retryThreshold" : 10
},
"bonjourGateway" : {
"id" : "bonjourGatewayUUID",
"name" : "bonjourGatewayName"
},
"specific" : {
"ledStatusEnabled" : false,
"lldp" : {
"enabled" : true,
"advertiseIntervalInSec" : 100,
"holdTimeInSec" : 1000,
"managementIPTLVEnabled" : false
},
"ledMode" : null,
"internalHeaterEnabled" : null,
"poeOutPortEnabled" : null,
"usbPowerEnable" : null,
"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"
}
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"mac" : {
"type" : "string",
"pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$",
"description" : "MAC address of the AP"
},
"zoneId" : {
"description" : "Identifier of the AP group to which the AP belongs",
"type" : "string"
},
"apGroupId" : {
"type" : "string"
},
"serial" : {
"description" : "Serial number of the AP",
"type" : "string"
},
"model" : {
"description" : "Model name of the AP",
"type" : "string"
},
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 64,
"pattern" : "^[!-~]((?!\$\()[ -_a-~]){0,62}[!-~]$",
"description" : "Name of the AP"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the AP"
},
"latitude" : {
"type" : "number",
"description" : "Latitude coordinate (in decimal format) of the AP"
},
"longitude" : {
"type" : "number",
"description" : "Longitude coordinate (in decimal format) of the AP"
},
"location" : {
"type" : "string",
"pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Location of the AP. It is a text description to indicate the location of the AP."
},
"locationAdditionalInfo" : {
"type" : "string",
"pattern" : "^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$",
"description" : "Location additional info of the AP. This is a text description that indicates the location additional info of the AP."
},
"provisionChecklist" : {
"description" : "Provision checklist of the AP. This field indicates the steps that have been completed in the AP provisioning process.",
"type" : "string"
},
"administrativeState" : {
"description" : "Administrative state of the AP. A locked AP will not provide any WLAN services.",
"enum" : [ "Locked", "Unlocked" ],
"default" : "Unlocked"
},
"userLocationInfo" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"areaCode" : {
"description" : "Area code",
"type" : "integer"
},
"cellId" : {
"description" : "Cell identifier",
"type" : "integer"
}
},
"description" : "User location information"
},
"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"
},
"login" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"apLoginName" : {
"type" : "string",
"maxLength" : 64,
"pattern" : "^((?!\$\()[!-_a-~]){1,64}$",
"description" : "User name of the AP administrator"
},
"apLoginPassword" : {
"type" : "string",
"maxLength" : 64,
"pattern" : ".*(?=.{8,})(?=.*[a-zA-Z])(?=.*[0-9])(?=.*[_`~!@#$%^&*\(\)\[\]\{\}|;:'\",.\<>\/?=+-]).*",
"description" : "Password of the AP administrator"
}
},
"required" : [ "apLoginName", "apLoginPassword" ],
"description" : "Logon credentials for the AP. These logon credentials will override the logon credentials specified at the zone level or AP group level."
},
"syslog" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"enabled" : {
"description" : "Indicates whether syslog is enabled or disabled",
"type" : "boolean"
},
"address" : {
"type" : "string",
"description" : "Address of the syslog server. If syslog is enabled, this attribute is required."
},
"port" : {
"description" : "Port number of the syslog server",
"type" : "integer",
"default" : "514",
"minimum" : 1,
"maximum" : 65535
},
"facility" : {
"description" : "Facility of the syslog server",
"enum" : [ "Keep_Original", "Local0", "Local1", "Local2", "Local3", "Local4", "Local5", "Local6", "Local7" ]
},
"priority" : {
"description" : "Priority of the log messages",
"enum" : [ "Emergency", "Alert", "Critical", "Error", "Warning", "Notice", "Info", "All" ]
}
},
"required" : [ "enabled" ],
"description" : "Syslog configuration of the AP. This configuration will override the syslog configuration at the zone level or AP group level."
},
"wifi24" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"txPower" : {
"enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
"description" : "Transmission power"
},
"channelWidth" : {
"description" : "Channel width. Zero (0) means Auto.",
"enum" : [ 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"
}
}
},
"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."
},
"wifi50" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"txPower" : {
"enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
"description" : "transmission power"
},
"channelWidth" : {
"description" : "channel width, 0 mean Auto",
"enum" : [ 0, 20, 40, 80 ]
},
"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"
}
}
},
"description" : "5GHz radio configuration. This configuration will override the 5GHz radio configuration at the zone level or AP group level."
},
"wlanGroup24" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Identifier of the WLAN group",
"type" : "string"
},
"name" : {
"description" : "Name of the WLAN group",
"type" : "string"
}
},
"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."
},
"wlanGroup50" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Identifier of the WLAN group",
"type" : "string"
},
"name" : {
"description" : "Name of the WLAN group",
"type" : "string"
}
},
"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."
},
"network" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"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.",
"enum" : [ "Static", "Dynamic", "Autoconfig", "Keep" ]
},
"ip" : {
"type" : "string",
"description" : "IP address of the AP"
},
"netmask" : {
"type" : "string",
"pattern" : "^$|(^(128|192|224|24[08]|25[245]).0.0.0$)|(^255.(0|128|192|224|24[08]|25[245]).0.0$)|(^255.255.(0|128|192|224|24[08]|25[245]).0$)|(^255.255.255.(0|128|192|224|24[08]|252|255)$)",
"description" : "Netmask of the AP's subnet"
},
"gateway" : {
"type" : "string",
"description" : "Gateway of the AP"
},
"primaryDns" : {
"type" : "string",
"description" : "Primary DNS server address of the AP"
},
"secondaryDns" : {
"type" : "string",
"description" : "Secondary DNS server address of the AP"
}
},
"description" : "Network settings of the AP."
},
"smartMonitor" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"enabled" : {
"type" : "boolean"
},
"intervalInSec" : {
"description" : "Interval in seconds. This is required if smartMonitor is enabled",
"type" : "integer",
"default" : 10,
"minimum" : 5,
"maximum" : 60
},
"retryThreshold" : {
"description" : "Retry threshold. This is required if smartMonitor is enabled",
"type" : "integer",
"default" : 3,
"minimum" : 1,
"maximum" : 10
}
},
"description" : "Smart monitor of the AP."
},
"bonjourGateway" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
},
"description" : "Bonjour gateway of the AP."
},
"clientAdmissionControl24" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"enabled" : {
"type" : "boolean"
},
"maxRadioLoadPercent" : {
"description" : "Maximum radio load percentage.",
"type" : "integer",
"default" : 75,
"minimum" : 50,
"maximum" : 100
},
"minClientCount" : {
"description" : "Minimum client count number.",
"type" : "integer",
"default" : 10,
"minimum" : 0,
"maximum" : 100
},
"minClientThroughputMbps" : {
"description" : "Minimum client throughput in Mbps.",
"type" : "number",
"default" : 0,
"minimum" : 0,
"maximum" : 100
}
},
"description" : "Client admission control configuration of 2.4GHz radio of the AP."
},
"clientAdmissionControl50" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"enabled" : {
"type" : "boolean"
},
"maxRadioLoadPercent" : {
"description" : "Maximum radio load percentage.",
"type" : "integer",
"default" : 75,
"minimum" : 50,
"maximum" : 100
},
"minClientCount" : {
"description" : "Minimum client count number.",
"type" : "integer",
"default" : 10,
"minimum" : 0,
"maximum" : 100
},
"minClientThroughputMbps" : {
"description" : "Minimum client throughput in Mbps.",
"type" : "number",
"default" : 0,
"minimum" : 0,
"maximum" : 100
}
},
"description" : "Client admission control configuration of 5GHz radio of the AP."
},
"venueProfile" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
},
"description" : "Venue profile configuration of the AP."
},
"autoChannelSelection24" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"channelSelectMode" : {
"description" : "Channel Select Mode",
"enum" : [ "None", "BackgroundScanning", "ChannelFly" ]
},
"channelFlyMtbc" : {
"description" : "ChannelFly MTBC",
"type" : "integer",
"default" : 480,
"minimum" : 100,
"maximum" : 1440
}
},
"description" : "client load balancing on Radio 2.4G, auto channel selection mode"
},
"autoChannelSelection50" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"channelSelectMode" : {
"description" : "Channel Select Mode",
"enum" : [ "None", "BackgroundScanning", "ChannelFly" ]
},
"channelFlyMtbc" : {
"description" : "ChannelFly MTBC",
"type" : "integer",
"default" : 480,
"minimum" : 100,
"maximum" : 1440
}
},
"description" : "client load balancing on Radio 5G, auto channel selection mode"
},
"channelEvaluationInterval" : {
"description" : "channel evaluation Interval of the AP",
"type" : "integer",
"default" : 600,
"minimum" : 60,
"maximum" : 3600
},
"apMgmtVlan" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"mode" : {
"description" : "Vlan Mode of the zone",
"enum" : [ "KEEP", "USER_DEFINED" ]
},
"id" : {
"description" : "Vlan id of the zone",
"type" : "integer"
}
},
"description" : "ap Management Vlan"
},
"specific" : {
"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" ]
},
"ledMode" : {
"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" ]
},
"radioBand" : {
"enum" : [ null, "2.4GHz", "5GHz" ]
},
"externalAntenna24" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"enabled" : {
"type" : "boolean"
},
"dbi" : {
"type" : [ "integer", "null" ],
"minimum" : 0,
"maximum" : 90
},
"chainMask" : {
"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" : {
"enum" : [ null, "Two", "Three" ]
}
},
"required" : [ "enabled" ]
},
"lanPorts" : {
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"portName" : {
"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" ]
}
}
},
"description" : "Model specific configuration of the AP"
}
}
}
Use this API command to retrieve the current AP picture.
200
ShowHideBinary data for the picture
Use this API command to create a new access point.
{
"mac" : "00:11:22:33:44:55",
"zoneId" : "zoneUUID",
"apGroupId" : "apGroupUUID",
"serial" : "00000096",
"model" : "ZF7962",
"name" : "apName",
"latitude" : 22.3,
"longitude" : 114,
"location" : "shenzhen",
"description" : "apDescription",
"administrativeState" : "Unlocked",
"provisionChecklist" : "test"
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"mac" : {
"type" : "string",
"pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$",
"description" : "MAC address of the AP"
},
"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. If the AP belongs to the default AP group, this property is not needed.",
"type" : "string"
},
"serial" : {
"description" : "Serial number of the AP",
"type" : "string"
},
"model" : {
"description" : "Model name of the AP",
"type" : "string"
},
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 64,
"pattern" : "^[!-~]((?!\$\()[ -_a-~]){0,62}[!-~]$",
"description" : "Name of the AP"
},
"latitude" : {
"type" : "number",
"description" : "Latitude coordinate (in decimal format) of the AP"
},
"longitude" : {
"type" : "number",
"description" : "Longitude coordinate (in decimal format) of the AP"
},
"location" : {
"type" : "string",
"pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Location of the AP. This is a free format text description that indicates the location of the AP."
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the AP"
},
"administrativeState" : {
"description" : "Administrative state of the AP. A locked AP will not provide any WLAN services.",
"enum" : [ "Locked", "Unlocked" ],
"default" : "Unlocked"
},
"provisionChecklist" : {
"description" : "Provision checklist of the AP. This field indicates the steps that have been completed in the AP provisioning process.",
"type" : "string"
}
},
"required" : [ "mac", "zoneId" ]
}
201
Use this API command to modify the basic information of an AP.
{
"zoneId" : "zoneUUID",
"apGroupId" : "apGroupUUID",
"serial" : "00000096",
"model" : "ZF7343",
"name" : "apName",
"latitude" : 22.3,
"longitude" : 114,
"location" : "location",
"locationAdditionalInfo" : "locationAdditionalInfo",
"description" : "apDescription",
"administrativeState" : "Unlocked",
"provisionChecklist" : "provisionChecklist",
"wlanService24Enabled" : true,
"wlanService50Enabled" : null,
"channelEvaluationInterval" : 777
}
{
"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"
},
"serial" : {
"description" : "Serial number of the AP",
"type" : "string"
},
"model" : {
"description" : "Model name of the AP",
"type" : "string"
},
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 64,
"pattern" : "^[!-~]((?!\$\()[ -_a-~]){0,62}[!-~]$",
"description" : "Name of the AP"
},
"latitude" : {
"type" : "number",
"description" : "Latitude coordinate (in decimal format) of the AP"
},
"longitude" : {
"type" : "number",
"description" : "Longitude coordinate (in decimal format) of the AP"
},
"location" : {
"type" : "string",
"pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Location of the AP. This is a text description that indicates the location of the AP."
},
"locationAdditionalInfo" : {
"type" : "string",
"pattern" : "^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$",
"description" : "Location additional info of the AP. This is a text description that indicates the location additional info of the AP."
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the AP"
},
"administrativeState" : {
"description" : "Administrative state of the AP. A locked AP will not provide any WLAN services.",
"enum" : [ "Locked", "Unlocked" ]
},
"provisionChecklist" : {
"description" : "Provision checklist of the AP. This field indicates the steps that have been completed in the AP provisioning process.",
"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"
},
"channelEvaluationInterval" : {
"description" : "channel evaluation Interval of the AP",
"type" : "integer",
"default" : 600,
"minimum" : 60,
"maximum" : 3600
}
}
204
Use this API command to disable AP level override of location. The access point will take its group’s configuration or zone’s configuration.
204
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.
204
Use this API command to enable or modify the AP-level logon override settings.
{
"apLoginName" : "apLoginName",
"apLoginPassword" : "apLoginPassword"
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"apLoginName" : {
"type" : "string",
"maxLength" : 64,
"pattern" : "^((?!\$\()[!-_a-~]){1,64}$",
"description" : "User name of the AP administrator"
},
"apLoginPassword" : {
"type" : "string",
"maxLength" : 64,
"pattern" : ".*(?=.{8,})(?=.*[a-zA-Z])(?=.*[0-9])(?=.*[_`~!@#$%^&*\(\)\[\]\{\}|;:'\",.\<>\/?=+-]).*",
"description" : "Password of the AP administrator"
}
},
"required" : [ "apLoginName", "apLoginPassword" ],
"description" : "Logon credentials for the AP. These logon credentials will override the logon credentials specified at the zone level or AP group level."
}
204
Use this API command to disable the AP-level logon override. The AP will apply its group’s or zone’s configuration.
204
Use this API command to enable or modify the AP-level syslog override settings.
{
"enabled" : true,
"address" : "1.1.1.1",
"port" : 514,
"facility" : "keep_Original",
"priority" : "Error"
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"enabled" : {
"description" : "Indicates whether syslog is enabled or disabled",
"type" : "boolean"
},
"address" : {
"type" : "string",
"description" : "Address of the syslog server. If syslog is enabled, this attribute is required."
},
"port" : {
"description" : "Port number of the syslog server",
"type" : "integer",
"default" : "514",
"minimum" : 1,
"maximum" : 65535
},
"facility" : {
"description" : "Facility of the syslog server",
"enum" : [ "Keep_Original", "Local0", "Local1", "Local2", "Local3", "Local4", "Local5", "Local6", "Local7" ]
},
"priority" : {
"description" : "Priority of the log messages",
"enum" : [ "Emergency", "Alert", "Critical", "Error", "Warning", "Notice", "Info", "All" ]
}
},
"required" : [ "enabled" ],
"description" : "Syslog configuration of the AP. This configuration will override the syslog configuration at the zone level or AP group level."
}
204
Use this API command to disable the AP level syslog override. The access point will take its group’s or zone’s configuration.
204
Use this API command to modify the AP level override of the 2.4GHz radio configuration.
{
"txPower" : "Full",
"channelWidth" : 20,
"channel" : 1,
"channelRange" : [ 1, 2, 3 ]
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"txPower" : {
"enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
"description" : "Transmission power"
},
"channelWidth" : {
"description" : "Channel width. Zero (0) means Auto.",
"enum" : [ 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"
}
}
},
"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."
}
204
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.
204
Use this API command to Modify the AP level override of the 5GHz radio configuration.
{
"txPower" : "Full",
"channelWidth" : 20,
"channel" : 52,
"channelRange" : [ 52, 56, 60 ]
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"txPower" : {
"enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
"description" : "transmission power"
},
"channelWidth" : {
"description" : "channel width, 0 mean Auto",
"enum" : [ 0, 20, 40, 80 ]
},
"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"
}
}
},
"description" : "5GHz radio configuration. This configuration will override the 5GHz radio configuration at the zone level or AP group level."
}
204
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.
204
Use this API command to enable or modify the AP level override of the WLAN group configuration on the 2.4GHz radio.
{
"id" : "wlanGroupUUID",
"name" : "wlanGroupName"
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Identifier of the WLAN group",
"type" : "string"
},
"name" : {
"description" : "Name of the WLAN group",
"type" : "string"
}
},
"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."
}
204
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.
204
Use this API command to enable or modify the AP level override of the WLAN group configuration on the 5GHz radio.
{
"id" : "wlanGroupUUID",
"name" : "wlanGroupName"
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Identifier of the WLAN group",
"type" : "string"
},
"name" : {
"description" : "Name of the WLAN group",
"type" : "string"
}
},
"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."
}
204
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.
204
Use this API command to modify the network settings of an AP.
{
"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"
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"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.",
"enum" : [ "Static", "Dynamic", "Autoconfig", "Keep" ]
},
"ip" : {
"type" : "string",
"description" : "IP address of the AP"
},
"netmask" : {
"type" : "string",
"pattern" : "^$|(^(128|192|224|24[08]|25[245]).0.0.0$)|(^255.(0|128|192|224|24[08]|25[245]).0.0$)|(^255.255.(0|128|192|224|24[08]|25[245]).0$)|(^255.255.255.(0|128|192|224|24[08]|252|255)$)",
"description" : "Netmask of the AP's subnet"
},
"gateway" : {
"type" : "string",
"description" : "Gateway of the AP"
},
"primaryDns" : {
"type" : "string",
"description" : "Primary DNS server address of the AP"
},
"secondaryDns" : {
"type" : "string",
"description" : "Secondary DNS server address of the AP"
}
},
"description" : "Network settings of the AP."
}
204
Use this API command to modify smart monitor of an AP.
{
"enabled" : true,
"intervalInSec" : 10,
"retryThreshold" : 10
}
{
"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
}
},
"description" : "Smart monitor of the AP."
}
204
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.
204
Use this API command to modify bonjour gateway of an AP.
{
"id" : "bonjourGatewayUUID",
"name" : "bonjourGatewayName"
}
{
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
},
"description" : "Bonjour gateway of the AP."
}
204
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.
204
Use this API command to modify client admission control 2.4GHz radio configuration of an AP.
{
"maxRadioLoadPercent" : 70,
"minClientCount" : 30,
"minClientThroughputMbps" : 10.0,
"enabled" : true
}
{
"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" : "Client admission control configuration of 2.4GHz radio of the AP."
}
204
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.
204
Use this API command to modify client admission control 5GHz radio configuration of an AP.
{
"maxRadioLoadPercent" : 70,
"minClientCount" : 30,
"minClientThroughputMbps" : 10.0,
"enabled" : true
}
{
"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" : "Client admission control configuration of 5GHz radio of the AP."
}
204
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.
204
Use this API command to modify venue profile of an AP.
{
"id" : "venueProfileId",
"name" : "venueProfileName"
}
{
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
},
"description" : "Venue profile configuration of the AP."
}
204
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.
204
Use this API command to modify user location info of an AP.
{
"description" : "User location information of the AP.",
"type" : "object",
"additionalProperties" : false,
"properties" : {
"areaCode" : {
"description" : "area code",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
}
}
}
204
Use this API command to modify model specific configuration.
{
"ledStatusEnabled" : false,
"lldp" : {
"enabled" : true,
"advertiseIntervalInSec" : 100,
"holdTimeInSec" : 1000,
"managementIPTLVEnabled" : false
},
"ledMode" : null,
"internalHeaterEnabled" : null,
"poeOutPortEnabled" : null,
"usbPowerEnable" : null,
"radioBand" : null,
"externalAntenna24" : null,
"externalAntenna50" : null,
"lanPorts" : [ {
"portName" : "LAN1",
"enabled" : false
}, {
"portName" : "LAN2",
"enabled" : true,
"ethPortProfile" : {
"id" : "0"
}
}, {
"portName" : "LAN3",
"enabled" : true,
"ethPortProfile" : {
"id" : "1"
},
"overwriteVlanEnabled" : true,
"vlanUntagId" : 1,
"members" : "1"
} ]
}
{
"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" ]
},
"ledMode" : {
"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" ]
},
"radioBand" : {
"enum" : [ null, "2.4GHz", "5GHz" ]
},
"externalAntenna24" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"enabled" : {
"type" : "boolean"
},
"dbi" : {
"type" : [ "integer", "null" ],
"minimum" : 0,
"maximum" : 90
},
"chainMask" : {
"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" : {
"enum" : [ null, "Two", "Three" ]
}
},
"required" : [ "enabled" ]
},
"lanPorts" : {
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"portName" : {
"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" ]
}
}
}
}
204
Use this API command to disable model specific configuration override from AP group or zone.
204
Use this API command to upload a new AP picture.
Binary data for the picture
204
Use this API command to modify an AP picture
Binary data for the picture
204
Use this API command to delete an AP picture.
204
Modify AP Usb Software Package of an access point
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"usbSoftware" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
},
"description" : "APUsbSoftwarePackage id or name"
},
"applyModel" : {
"description" : "List of apply models",
"type" : "array",
"items" : {
"type" : "string"
}
}
},
"description" : "APUsbSoftwarePackage of the zone"
}
204
Disable AP level Usb Software Package. The access point will take its group’s configuration or zone’s configuration.
204
Disable AP lChannel Evaluation Interval. The access point will take its group’s configuration or zone’s configuration.
204
Override Radio 2.4G Auto ChannelSelectMode and ChannelFly MTBC of an AP
{
"channelSelectMode" : "ChannelFly",
"channelFlyMtbc" : 480
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"channelSelectMode" : {
"description" : "Channel Select Mode",
"enum" : [ "None", "BackgroundScanning", "ChannelFly" ]
},
"channelFlyMtbc" : {
"description" : "ChannelFly MTBC",
"type" : "integer",
"default" : 480,
"minimum" : 100,
"maximum" : 1440
}
},
"description" : "client load balancing on Radio 2.4G, auto channel selection mode"
}
204
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.
204
Override Radio 5G Auto ChannelSelectMode and ChannelFly MTBC of an AP
{
"channelSelectMode" : "BackgroundScanning",
"channelFlyMtbc" : 480
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"channelSelectMode" : {
"description" : "Channel Select Mode",
"enum" : [ "None", "BackgroundScanning", "ChannelFly" ]
},
"channelFlyMtbc" : {
"description" : "ChannelFly MTBC",
"type" : "integer",
"default" : 480,
"minimum" : 100,
"maximum" : 1440
}
},
"description" : "client load balancing on Radio 5G, auto channel selection mode"
}
204
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.
204
Modify AP Management Vlan of an AP
{
"id" : 1,
"mode" : "KEEP"
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"mode" : {
"description" : "Vlan Mode of the zone",
"enum" : [ "KEEP", "USER_DEFINED" ]
},
"id" : {
"description" : "Vlan id of the zone",
"type" : "integer"
}
},
"description" : "ap Management Vlan"
}
204
Disable AP Management Vlan Override of an AP
204
Use this API command to delete an access point.
204
reboot an access point
204
Use this API command to retrieve the operational information of an AP.
200
ShowHide{
"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,
"location" : "location",
"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
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"mac" : {
"type" : "string",
"pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$",
"description" : "MAC address of the AP"
},
"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"
},
"serial" : {
"description" : "Serial number of the AP",
"type" : "string"
},
"model" : {
"description" : "Model name of the AP",
"type" : "string"
},
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 64,
"pattern" : "^[!-~]((?!\$\()[ -_a-~]){0,62}[!-~]$",
"description" : "Name of the AP"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the AP"
},
"version" : {
"type" : "string",
"pattern" : "^\d+\.\d+\.\d+\.\d+\.\d+$",
"description" : "Firmware version of the AP"
},
"countryCode" : {
"description" : "Country code of the AP",
"type" : "string"
},
"latitude" : {
"type" : "number",
"description" : "Latitude coordinate (in decimal format) of the AP"
},
"longitude" : {
"type" : "number",
"description" : "Longitude coordinate (in decimal format) of the AP"
},
"location" : {
"type" : "string",
"pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Location of the AP. This is a text description that indicates the location of the AP."
},
"cpId" : {
"description" : "Identifier of the control plane to which the AP is currently connected",
"type" : "string"
},
"dpId" : {
"description" : "Identifier of the data plane to which the AP is currently connected",
"type" : "string"
},
"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"
},
"meshRole" : {
"description" : "Mesh role of the AP",
"enum" : [ "Disabled", "Root", "Map", "eMap", "Down", "Undefined" ]
},
"meshHop" : {
"description" : "Number of mesh hops of the AP. This is only applicable to mesh APs.",
"type" : "integer"
},
"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.",
"enum" : [ "Static", "Dynamic", "Keep" ]
},
"ip" : {
"description" : "IP address of the AP",
"type" : "string"
},
"ipv6Type" : {
"description" : "Indicates how the AP's IP address was obtained. The AP's IP address can be statically or dynamically assigned or kept unchanged.",
"enum" : [ "Static", "Autoconfig", "Keep" ]
},
"ipv6" : {
"description" : "IP address of the AP",
"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"
},
"configState" : {
"description" : "State of the AP configuration.",
"enum" : [ "newConfig", "fwApplied", "fwDownloaded", "fwFailed", "configApplied", "completed", "configFailed" ]
},
"connectionState" : {
"description" : "Connection state of the AP",
"type" : "string"
},
"registrationState" : {
"description" : "Registration state of the AP",
"type" : "string"
},
"administrativeState" : {
"description" : "Administrative state of the AP. A locked AP will not provide any WLAN services.",
"enum" : [ "Locked", "Unlocked" ]
},
"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.",
"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.",
"type" : "string"
},
"isCriticalAP" : {
"description" : "Indicates critical APs. Critical AP are APs that were tagged by the controller based on predefined rules.",
"type" : "boolean"
},
"approvedTime" : {
"description" : "Timestamp when the AP was approved by the controller",
"type" : "integer"
},
"lastSeenTime" : {
"description" : "Timestamp of the last successful communication with the AP",
"type" : "integer"
},
"uptime" : {
"description" : "Uptime of the AP since it was last rebooted",
"type" : "integer"
},
"clientCount" : {
"description" : "Number of clients on the AP",
"type" : "integer"
},
"managementVlan" : {
"description" : "Management vlan on the AP",
"type" : "integer"
}
}
}
Use this API command to retrieve the alarm summary of an AP.
200
ShowHide{
"criticalCount" : 3,
"majorCount" : 3,
"minorCount" : 4,
"warningCount" : 0
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"criticalCount" : {
"description" : "Critical alarm count",
"type" : "integer"
},
"majorCount" : {
"description" : "Major alarm count",
"type" : "integer"
},
"minorCount" : {
"description" : "Minor alarm count",
"type" : "integer"
},
"warningCount" : {
"description" : "Warning alarm count",
"type" : "integer"
}
}
}
Use this API command to retrieve the event summary of an AP.
200
ShowHide{
"criticalCount" : 4,
"majorCount" : 2,
"minorCount" : 5,
"warningCount" : 5,
"informationalCount" : 2,
"debugCount" : 5
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"criticalCount" : {
"description" : "Critical event count",
"type" : "integer"
},
"majorCount" : {
"description" : "Major event count",
"type" : "integer"
},
"minorCount" : {
"description" : "Minor event count",
"type" : "integer"
},
"warningCount" : {
"description" : "Warning event count",
"type" : "integer"
},
"informationalCount" : {
"description" : "Informational event count",
"type" : "integer"
},
"debugCount" : {
"description" : "Debug event count",
"type" : "integer"
}
}
}
Use this API command to retrieve the list of outstanding alarms on an AP.
number
(optional) The index of the first entry to be retrieved. Default: 0
number
(optional) The maximum number of entries to be retrieved. Default: 100
string
(optional) filter by severity
string
(optional) filter by category
number
(optional) filter by alarm code
string
(optional) filter by trigger time later than startTime (milliseconds in UTC time)
string
(optional) filter by trigger time earlier than endTime (milliseconds in UTC time)
string
(optional) filter by alarm status
200
ShowHide{
"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
} ]
}
{
"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" : {
"type" : "string",
"pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$",
"description" : "Identifier of the alarm"
},
"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",
"enum" : [ "Critical", "Major", "Minor", "Warning", "Informational" ]
},
"description" : {
"description" : "Alarm description",
"type" : "string"
},
"status" : {
"description" : "Alarm status",
"enum" : [ "Outstanding", "Acknowledged", "Cleared" ]
},
"clearedTime" : {
"description" : "Time that alarm was cleared",
"type" : "integer"
},
"acknowledgedTime" : {
"description" : "Time the alarm was acknowledged",
"type" : "integer"
}
}
}
}
}
}
Use this API command to retrieve the list of events from an AP.
number
(optional) The index of the first entry to be retrieved. Default: 0
number
(optional) The maximum number of entries to be retrieved. Default: 100
string
(optional) filter by severity
string
(optional) filter by category
number
(optional) filter by event code
string
(optional) filter by trigger time later than startTime (milliseconds in UTC time)
string
(optional) filter by trigger time earlier than endTime (milliseconds in UTC time)
200
ShowHide{
"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]."
} ]
}
{
"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" : {
"type" : "string",
"pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$",
"description" : "Identifier of the event"
},
"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",
"enum" : [ "Critical", "Major", "Minor", "Warning", "Informational", "Debug" ]
},
"description" : {
"description" : "Event description",
"type" : "string"
}
}
}
}
}
}
Use this API command to retrieve a list of neighbor access points on mesh AP.
number
(optional) The index of the first entry to be retrieved. Default: 0
number
(optional) The maximum number of entries to be retrieved. Default: 100
200
ShowHide{
"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"
} ]
}
{
"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" : {
"type" : "string",
"pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$",
"description" : "MAC address of the mesh neighbor AP"
},
"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"
}
}
}
}
}
}
Use this API command to retrieve ap on-demand data.
200
Use this API command to retrieve mesh ap on-demand data.
200
Use this API command to retrieve ap client on-demand data.
string
(required) 200
Use this API command to retrieve a list of rogue access points.
number
(optional) The index of the first entry to be retrieved. Default: 0
number
(optional) The maximum number of entries to be retrieved. Default: 100
string
(optional) Filter rogue ap list by type. Valid values are: (ROGUE, MALICIOUS_AP_SSID_SPOOF, MALICIOUS_AP_MAC_SPOOF, MALICIOUS_AP_SAME_NETWORK, AD_HOC).
string
(optional) Filter rogue ap list by Rogue MAC.
200
ShowHide{
"totalCount" : 1,
"hasMore" : false,
"firstIndex" : 0,
"list" : [ {
"apMac" : "C4:10:8A:1F:D3:99",
"apName" : "apName",
"rogueMac" : "8C:0C:90:05:87:B8",
"rogueAPMac" : "01:01:03:04:05:10",
"rssi" : "10DB",
"encryption" : "0",
"radio" : "2.4G",
"type" : "ROGUE",
"channel" : "11",
"ssid" : "test",
"timestamp" : null,
"id" : "C4:10:8A:1F:D3:99_8C:0C:90:05:87:B8"
} ]
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"totalCount" : {
"description" : "Total Rogue APs count",
"type" : "integer"
},
"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" : {
"id" : {
"description" : "Identifier of the rogue AP",
"type" : "string"
},
"apMac" : {
"type" : "string",
"pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$",
"description" : "AP MAC of the rogue AP"
},
"apName" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 64,
"pattern" : "^[!-~]((?!\$\()[ -_a-~]){0,62}[!-~]$",
"description" : "Name of the rogue AP"
},
"rogueMac" : {
"type" : "string",
"pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$",
"description" : "Rogue MAC of the rogue AP"
},
"rogueAPMac" : {
"type" : "string",
"pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$",
"description" : "Rogue AP MAC of the rogue AP"
},
"rssi" : {
"description" : "RSSI of the rogue AP",
"type" : "string"
},
"encryption" : {
"description" : "Encryption of the rogue AP",
"type" : "string"
},
"radio" : {
"description" : "Radio of the rogue AP",
"type" : "string"
},
"type" : {
"description" : "Type of the rogue AP",
"type" : "string"
},
"channel" : {
"description" : "Channel of the rogue AP",
"type" : "string"
},
"ssid" : {
"description" : "SSID of the rogue AP",
"type" : "string"
},
"timestamp" : {
"description" : "Timestamp of the rogue AP",
"type" : "string"
}
}
}
}
}
}
Use this API command to retrieve the list of WLAN groups within a zone.
number
(optional) The index of the first entry to be retrieved. Default: 0
number
(optional) The maximum number of entries to be retrieved. Default: 100
200
ShowHide{
"totalCount" : 2,
"hasMore" : false,
"firstIndex" : 0,
"list" : [ {
"id" : "wlanGroupUUID",
"name" : "wlanGroupName",
"description" : "wlanGroupDescription",
"members" : [ {
"id" : "wlanUUID",
"accessVlan" : 1,
"nasId" : "nasId",
"vlanPooling" : null
} ]
}, {
"id" : "wlanGroupUUID2",
"zoneId" : "zoneUUID",
"name" : "wlanGroupName2",
"description" : "wlanGroupDescription2",
"members" : [ {
"id" : "wlanUUID2",
"accessVlan" : 1,
"nasId" : "nasId",
"vlanPooling" : null
} ]
} ]
}
{
"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" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the WLAN group"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the WLAN group"
},
"members" : {
"description" : "Members of the WLAN group",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Identifier of the WLAN",
"type" : "string"
},
"accessVlan" : {
"description" : "Access VLAN",
"type" : "integer",
"minimum" : 1,
"maximum" : 4094
},
"vlanPooling" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
},
"description" : "Vlan pooling"
},
"nasId" : {
"description" : "NAS-ID",
"type" : "string",
"maxLength" : 63,
"pattern" : "^([!-~]([ -~]){0,61}[!-~]|[!-~]{1,1})$"
}
},
"required" : [ "id" ]
}
}
},
"required" : [ "name" ]
}
}
}
}
Use this API command to retrieve the WLAN group.
200
ShowHide{
"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" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the WLAN group"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the WLAN group"
},
"members" : {
"description" : "Members of the WLAN group",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Identifier of the WLAN",
"type" : "string"
},
"accessVlan" : {
"description" : "Access VLAN",
"type" : "integer",
"minimum" : 1,
"maximum" : 4094
},
"vlanPooling" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
},
"description" : "Vlan pooling"
},
"nasId" : {
"description" : "NAS-ID",
"type" : "string",
"maxLength" : 63,
"pattern" : "^([!-~]([ -~]){0,61}[!-~]|[!-~]{1,1})$"
}
},
"required" : [ "id" ]
}
}
},
"required" : [ "name" ]
}
Use this API command to create a new WLAN group.
{
"name" : "wlanGroupName",
"description" : "wlanGroupDescription"
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the WLAN group"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the WLAN group"
}
},
"required" : [ "name" ]
}
201
ShowHide{
"id" : "wlanGroupUUID"
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Identifier of the WLAN group",
"type" : "string"
}
}
}
Use this API command to modify the basic information of a WLAN group.
{
"name" : "wlanGroupNameModified",
"description" : "wlanGroupDescriptionModified"
}
{
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the WLAN group"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the WLAN group"
}
}
204
Use this API command to add a member to a WLAN group.
{
"id" : "wlanUUID",
"accessVlan" : 1
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Identifier of the WLAN",
"type" : "string"
},
"accessVlan" : {
"description" : "Access VLAN",
"type" : "integer",
"minimum" : 1,
"maximum" : 4094
},
"vlanPooling" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
},
"description" : "Vlan pooling"
},
"nasId" : {
"description" : "NAS-ID",
"type" : "string",
"maxLength" : 63,
"pattern" : "^([!-~]([ -~]){0,61}[!-~]|[!-~]{1,1})$"
}
},
"required" : [ "id" ]
}
201
Use this API command to modify a member of a WLAN group.
{
"accessVlan" : 23,
"nasId" : "nasId"
}
{
"accessVlan" : {
"description" : "Access VLAN",
"type" : "integer",
"minimum" : 1,
"maximum" : 4094
},
"nasId" : {
"description" : "NAS-ID",
"type" : "string",
"maxLength" : 63,
"pattern" : "^([!-~]([ -~]){0,61}[!-~]|[!-~]{1,1})$"
}
}
204
Use this API command to modify a member’s VLAN pooling of a WLAN group.
{
"id" : "a61997e0-699b-11e4-b9bb-08002716c79f",
"name" : "zoneVlanPooling"
}
{
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
},
"description" : "Vlan pooling"
}
204
Use this API command to disable a member VLAN override of a WLAN group.
204
Use this API command to disable a member NAS-ID override of a WLAN group.
204
Use this API command to remove a member from a WLAN group.
204
Use this API command to delete a WLAN group.
204
Use this API command to retrieve a list of WLANs within a zone.
number
(optional) The index of the first entry to be retrieved. Default: 0
number
(optional) The maximum number of entries to be retrieved. Default: 100
200
ShowHide{
"totalCount" : 2,
"hasMore" : false,
"firstIndex" : 0,
"list" : [ {
"id" : "1028",
"name" : "wlan2",
"ssid" : "wlan2"
}, {
"id" : "1027",
"zoneId" : "21a18b1c-e260-48c8-866c-69e66c81368e",
"name" : "wlan1",
"ssid" : "wlan1"
} ]
}
{
"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"
},
"name" : {
"description" : "Name of the WLAN",
"type" : "string"
},
"ssid" : {
"description" : "SSID of the WLAN",
"type" : "string"
}
}
}
}
}
}
Use this API command to retrieve a WLAN.
200
ShowHide{
"id" : "1027",
"zoneId" : "21a18b1c-e260-48c8-866c-69e66c81368e",
"name" : "wlan1",
"ssid" : "wlan1",
"hessid" : "BSSID",
"description" : "",
"type" : "Standard_Open",
"encryption" : {
"method" : "None"
},
"macAuth" : null,
"authServiceOrProfile" : null,
"accountingServiceOrProfile" : {
"id" : "",
"name" : null,
"throughController" : false,
"interimUpdateMin" : null,
"accountingTTGSessionEnabled" : false,
"accountingDelayEnabled" : null
},
"accessTunnelType" : "APLBO",
"coreTunnelProfile" : null,
"portalServiceProfile" : null,
"hotspot20Profile" : null,
"defaultUserTrafficProfile" : {
"id" : "24f24c00-0b47-11e4-a9b5-000c29b1347d",
"name" : "Factory Default"
},
"l2ACL" : null,
"devicePolicy" : null,
"vlan" : {
"accessVlan" : 1,
"aaaVlanOverride" : false,
"coreQinQEnabled" : false,
"coreSVlan" : null
},
"schedule" : {
"id" : null,
"name" : null,
"type" : "AlwaysOn"
},
"radiusOptions" : {
"nasIdType" : "WLAN_BSSID",
"customizedNasId" : null,
"nasRequestTimeoutSec" : 3,
"nasMaxRetry" : 2,
"nasReconnectPrimaryMin" : 5,
"calledStaIdType" : "WLAN_BSSID"
},
"advancedOptions" : {
"uplinkRateLimiting" : "Disable",
"downlinkRateLimiting" : "Disable",
"clientIsolcationEnabled" : false,
"priority" : "High",
"zeroItActivationEnabled" : false,
"hideSsidEnabled" : true,
"clientLoadBalancingEnabled" : true,
"proxyARPEnabled" : false,
"dgafEnabled" : null,
"maxClientsPerRadio" : 100,
"support80211dEnabled" : false,
"forceDHCPEnabled" : false,
"forceClientDHCPTimeout" : 10,
"dhcpOption82Enabled" : false,
"dhcp82Format" : "RUCKUS_DEFAULT",
"unauthClientStatsEnabled" : false,
"clientIdleTimeoutSec" : 120,
"clientFingerprintingEnabled" : false,
"ofdmOnlyEnabled" : false,
"bssMinRateMbps" : "Disable",
"mgmtTxRateMbps" : "2 mbps",
"bandBalancing" : "UseZoneSetting"
},
"qosMaps" : [ {
"enable" : true,
"priority" : 0,
"low" : 0,
"high" : 7,
"excepts" : null
}, {
"enable" : true,
"priority" : 1,
"low" : 8,
"high" : 15,
"excepts" : null
}, {
"enable" : true,
"priority" : 2,
"low" : 16,
"high" : 23,
"excepts" : null
}, {
"enable" : true,
"priority" : 3,
"low" : 0,
"high" : 32,
"excepts" : [ 43, 45, 60 ]
}, {
"enable" : true,
"priority" : 4,
"low" : 32,
"high" : 39,
"excepts" : null
}, {
"enable" : true,
"priority" : 5,
"low" : 40,
"high" : 47,
"excepts" : null
}, {
"enable" : true,
"priority" : 6,
"low" : 48,
"high" : 55,
"excepts" : [ 46 ]
}, {
"enable" : true,
"priority" : 7,
"low" : 56,
"high" : 63,
"excepts" : null
} ]
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Identifier of the WLAN",
"type" : "string"
},
"zoneId" : {
"description" : "Identifier of the zone to which the WLAN belongs",
"type" : "string"
},
"name" : {
"description" : "Name of the WLAN",
"type" : "string"
},
"ssid" : {
"description" : "SSID of the WLAN",
"type" : "string"
},
"hessid" : {
"type" : "string",
"pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$",
"description" : "HESSID of the WLAN"
},
"description" : {
"description" : "Description of the WLAN",
"type" : "string"
},
"type" : {
"description" : "Type of the WLAN",
"enum" : [ "Standard_Open", "Standard_80211", "Standard_Mac", "Hotspot", "Hotspot_MacByPass", "Guest", "WebAuth", "Hotspot20", "Hotspot20_OSEN" ]
},
"bypassCNA" : {
"description" : "By pass Capitive Network Assitance",
"type" : [ "boolean", "null" ]
},
"encryption" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"method" : {
"description" : "Encryption method",
"enum" : [ "WPA2", "WPA_Mixed", "WEP_64", "WEP_128", "None" ]
},
"algorithm" : {
"description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
"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",
"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"
}
},
"required" : [ "method" ],
"description" : "Encryption of the WLAN"
},
"authServiceOrProfile" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"throughController" : {
"description" : "Indicates whether authentication messages were sent through the controller or not",
"type" : "boolean"
},
"id" : {
"description" : "Identifier of the authentication service or profile. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the authentication service or profile. At least one ID or name is required in the request.",
"type" : "string"
},
"locationDeliveryEnabled" : {
"description" : "RFC5580 location delivery support",
"type" : "boolean"
}
},
"description" : "Autentication of the WLAN"
},
"macAuth" : {
"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.",
"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})$"
}
},
"description" : "MAC authentication of the WLAN"
},
"accountingServiceOrProfile" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"throughController" : {
"description" : "Indicates whether accounting messages were sent through the controller",
"type" : "boolean"
},
"id" : {
"description" : "Accounting service or profile ID. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Accounting service or profile name. At least one ID or name is required in the request.",
"type" : "string"
},
"interimUpdateMin" : {
"description" : "Interval (in minutes) for sending interim updates",
"type" : "integer",
"minimum" : 0,
"maximum" : 1440
},
"accountingDelayEnabled" : {
"description" : "Indicates whether accounting delay time is enabled",
"type" : "boolean"
},
"accountingTTGSessionEnabled" : {
"description" : "Indicates whether accounting for TTG sessions is to enabled",
"type" : "boolean"
}
},
"description" : "Accounting of the WLAN"
},
"accessTunnelType" : {
"description" : "Access tunnel type of the WLAN. APLBO means AP local breakout, RuckusGRE means RuckusGRE tunnel to data plane, SoftGRE means AP direct SoftGRE tunnel",
"enum" : [ "APLBO", "RuckusGRE", "SoftGRE" ]
},
"portalServiceProfile" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
},
"description" : "Portal service of the WLAN. This only applies to hotspot, hotspot MAC bypass, guest and web auth WLANs."
},
"hotspot20Profile" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
},
"description" : "Hotspot 2.0 operator profile of the WLAN. id or name of the hotspot 2.0 operator profiles within the zone is required."
},
"defaultUserTrafficProfile" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
},
"description" : "User traffic profile of the WLAN"
},
"coreTunnelProfile" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"type" : {
"description" : "Tunnel type",
"enum" : [ "Bridge", "L2oGRE", "L3oGRE", "TTG_PDG", "PMIPv6", "Mixed" ]
},
"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"
},
"operatorRealm" : {
"type" : "string",
"maxLength" : 255,
"pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$",
"description" : "Operator realm, supports for PMIPv6"
}
},
"required" : [ "type" ],
"description" : "Core tunnel of the WLAN. This only applies when the access tunnel type is set to RuckusGRE."
},
"vlan" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"accessVlan" : {
"description" : "Access VLAN ID",
"type" : "integer",
"minimum" : 1,
"maximum" : 4094
},
"aaaVlanOverride" : {
"description" : "Indicates whether the AAA VLAN settings can be overriden or not",
"type" : "boolean"
},
"coreQinQEnabled" : {
"description" : "Indicates whether Q-in-Q is allowed at the core network or not",
"type" : "boolean"
},
"coreSVlan" : {
"description" : "Core SVLAN ID. This only applies when core Q-in-Q is enabled",
"type" : "integer",
"minimum" : 1,
"maximum" : 4094
},
"vlanPooling" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
},
"description" : "Vlan pooling"
}
},
"description" : "VLAN (access and/or core) of the WLAN."
},
"l2ACL" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
},
"description" : "Layer 2 ACL of the WLAN"
},
"devicePolicy" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
},
"description" : "Device policy of the WLAN"
},
"radiusOptions" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"nasIdType" : {
"description" : "NAS ID type",
"enum" : [ "WLAN_BSSID", "AP_MAC", "Customized" ],
"default" : "WLAN_BSSID"
},
"customizedNasId" : {
"description" : "User defined NAS ID",
"type" : "string",
"maxLength" : 63,
"pattern" : "^([!-~]([ -~]){0,61}[!-~]|[!-~]{1,1})$"
},
"nasRequestTimeoutSec" : {
"description" : "NAS request timeout in seconds",
"type" : "integer",
"default" : 3,
"minimum" : 2,
"maximum" : 20
},
"nasMaxRetry" : {
"description" : "NAS request maximum retry",
"type" : "integer",
"default" : 2,
"minimum" : 2,
"maximum" : 10
},
"nasReconnectPrimaryMin" : {
"description" : "NAS reconnect primary time in minutes",
"type" : "integer",
"default" : 5,
"minimum" : 1,
"maximum" : 60
},
"calledStaIdType" : {
"description" : "Called station ID type",
"enum" : [ "WLAN_BSSID", "AP_MAC" ],
"default" : "WLAN_BSSID"
}
},
"description" : "RADIUS options of the WLAN."
},
"schedule" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"type" : {
"description" : "Type of WLAN schedule",
"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" ],
"description" : "Schedule of the WLAN."
},
"advancedOptions" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"clientIsolationEnabled" : {
"description" : "Indicates whether wireless client isolation is enabled or disabled",
"type" : "boolean",
"default" : true
},
"priority" : {
"description" : "Priority of the WLAN",
"enum" : [ "High", "Low" ],
"default" : "High"
},
"hideSsidEnabled" : {
"description" : "Indicates whether the SSID is hidden or broadcast",
"type" : "boolean",
"default" : false
},
"maxClientsPerRadio" : {
"description" : "Maximum number of clients per radio",
"type" : "integer",
"default" : 100,
"minimum" : 1,
"maximum" : 512
},
"clientIdleTimeoutSec" : {
"description" : "Client idle timeout in seconds",
"type" : "integer",
"minimum" : 60,
"maximum" : 1000,
"default" : 120
},
"dgafEnabled" : {
"description" : "Indicates whether dgaf is enabled or disabled",
"type" : "boolean"
},
"proxyARPEnabled" : {
"description" : "Indicates whether proxy ARP is enabled or disabled",
"type" : "boolean",
"default" : false
},
"support80211dEnabled" : {
"description" : "Indicates whether support for 802.11d is enabled or disabled",
"type" : "boolean",
"default" : true
},
"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).",
"enum" : [ 0, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15 ],
"default" : 0
},
"dhcpOption82Enabled" : {
"description" : "Indicates whether DCHP Option 82 is enabled or disabled",
"type" : "boolean",
"default" : false
},
"dhcp82Format" : {
"description" : "DHCP Option 82 format",
"enum" : [ "RUCKUS_DEFAULT", "SOFTGRE_CUSTOMIZED" ]
},
"unauthClientStatsEnabled" : {
"description" : "Indicates whether to send statistics of unauthorized clients or not",
"type" : "boolean",
"default" : true
},
"clientFingerprintingEnabled" : {
"description" : "Indicates whether client fingerprinting is enabled or disabled",
"type" : "boolean",
"default" : false
},
"ofdmOnlyEnabled" : {
"description" : "Indicates whether OFDM only is enabled or disabled",
"type" : "boolean",
"default" : false
},
"bandBalancing" : {
"description" : "Indicates whether band balancing is enabled or disabled",
"enum" : [ "Disabled", "UseZoneSetting" ],
"default" : "UseZoneSetting"
},
"bssMinRateMbps" : {
"enum" : [ "Disable", "1 mbps", "2 mbps", "5.5 mbps", "12 mbps", "24 mbps" ],
"description" : "BSS minimum rate (mbps)"
},
"mgmtTxRateMbps" : {
"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" ],
"description" : "Management TX rate (mbps)"
},
"zeroItActivationEnabled" : {
"description" : "Indicator of whether Zero-IT activation is enabled or disabled",
"type" : "boolean",
"default" : false
},
"pmkCachingEnabled" : {
"description" : "Indicator of whether PKM caching support is enabled or disabled",
"type" : "boolean",
"default" : false
},
"okcEnabled" : {
"description" : "Indicator of whether OKC support is enabled or disabled",
"type" : "boolean",
"default" : false
}
},
"description" : "Advanced settings for the WLAN."
},
"diffServProfile" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
},
"description" : "DiffServ profile of the WLAN"
},
"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" ]
}
},
"onlineSignupService" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"zeroITOnboarding" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"portal" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
},
"description" : "Onboarding portal profile"
},
"authServices" : {
"description" : "Authentication services",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Identifier of authentication service",
"type" : "string"
},
"name" : {
"description" : "Authentication service name",
"type" : "string"
},
"credentialType" : {
"description" : "Provisioning credential type",
"enum" : [ "LOCAL", "REMOTE" ]
},
"realm" : {
"type" : "string",
"maxLength" : 255,
"pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$",
"description" : "Device provisioning realm"
},
"expiration" : {
"description" : "Expiration hour. null mean never expire",
"type" : [ "integer", "null" ],
"minimum" : 1,
"maximum" : 175200
}
},
"required" : [ "credentialType", "realm" ]
}
}
},
"required" : [ "portal", "authServices" ],
"description" : "Zero-IT Onboarding"
},
"onlineSignupEnabled" : {
"description" : "Hotspot 2.0 online signup enabled device registration from this guest portal",
"type" : "boolean",
"default" : false
}
},
"description" : "Online signup service, only support for guest access WLAN"
}
}
}
Use this API command to create a new standard, open and non-tunneled basic WLAN.
{
"name" : "wlanName",
"ssid" : "wlanSSID",
"description" : "wlanDescription"
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"description" : "Name of the WLAN"
},
"ssid" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"description" : "SSID of the WLAN"
},
"hessid" : {
"type" : "string",
"pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$",
"description" : "HESSID of the WLAN"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the WLAN"
}
},
"required" : [ "name", "ssid" ]
}
201
ShowHide{
"id" : "wlanUUID"
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
}
}
}
Use this API command to create a new standard, 802.1X and non-tunneled WLAN.
{
"name" : "wlanName",
"ssid" : "wlanSSID",
"description" : "wlanDescription",
"authServiceOrProfile" : {
"throughController" : false,
"id" : "authServiceUUID",
"name" : "authServiceName"
}
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"description" : "Name of the WLAN"
},
"ssid" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"description" : "SSID of the WLAN"
},
"hessid" : {
"type" : "string",
"pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$",
"description" : "HESSID of the WLAN"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the WLAN"
},
"authServiceOrProfile" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"throughController" : {
"description" : "Indicates whether authentication messages were sent through the controller or not",
"type" : "boolean"
},
"id" : {
"description" : "Identifier of the authentication service or profile. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the authentication service or profile. At least one ID or name is required in the request.",
"type" : "string"
},
"locationDeliveryEnabled" : {
"description" : "RFC5580 location delivery support",
"type" : "boolean"
}
},
"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."
}
},
"required" : [ "name", "ssid", "authServiceOrProfile" ]
}
201
ShowHide{
"id" : "wlanUUID"
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
}
}
}
Use this API command to create a new standard, MAC auth and non-tunneled WLAN.
{
"name" : "wlanName",
"ssid" : "wlanSSID",
"description" : "wlanDescription",
"authServiceOrProfile" : {
"throughController" : false,
"id" : "authServiceUUID",
"name" : "authServiceName"
}
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"description" : "Name of the WLAN"
},
"ssid" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"description" : "SSID of the WLAN"
},
"hessid" : {
"type" : "string",
"pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$",
"description" : "HESSID of the WLAN"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the WLAN"
},
"authServiceOrProfile" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"throughController" : {
"description" : "Indicates whether authentication messages were sent through the controller or not",
"type" : "boolean"
},
"id" : {
"description" : "Identifier of the authentication service or profile. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the authentication service or profile. At least one ID or name is required in the request.",
"type" : "string"
},
"locationDeliveryEnabled" : {
"description" : "RFC5580 location delivery support",
"type" : "boolean"
}
},
"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."
}
},
"required" : [ "name", "ssid", "authServiceOrProfile" ]
}
201
ShowHide{
"id" : "wlanUUID"
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
}
}
}
Use this API command to create new hotspot (WISPr) WLAN.
{
"name" : "wlanName",
"ssid" : "wlanSSID",
"description" : "wlanDescription",
"authServiceOrProfile" : {
"throughController" : false,
"id" : "authServiceUUID",
"name" : "authServiceName"
},
"portalServiceProfile" : {
"id" : "portalServiceUUID",
"name" : "portalServiceName"
}
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"description" : "Name of the WLAN"
},
"ssid" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"description" : "SSID of the WLAN"
},
"hessid" : {
"type" : "string",
"pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$",
"description" : "HESSID of the WLAN"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the WLAN"
},
"authServiceOrProfile" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"throughController" : {
"description" : "Indicates whether authentication messages were sent through the controller or not",
"type" : "boolean"
},
"id" : {
"description" : "Identifier of the authentication service or profile. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the authentication service or profile. At least one ID or name is required in the request.",
"type" : "string"
},
"locationDeliveryEnabled" : {
"description" : "RFC5580 location delivery support",
"type" : "boolean"
}
},
"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."
},
"portalServiceProfile" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
},
"description" : "Hotspot portal service of the WLAN. The ID or name of the hotspot portal services within the zone is required."
}
},
"required" : [ "name", "ssid", "authServiceOrProfile", "portalServiceProfile" ]
}
201
ShowHide{
"id" : "wlanUUID"
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
}
}
}
Use this API command to create a new hotspot (WISPr) with MAC bypass WLAN.
{
"name" : "wlanName",
"ssid" : "wlanSSID",
"description" : "wlanDescription",
"authServiceOrProfile" : {
"throughController" : false,
"id" : "authServiceUUID",
"name" : "authServiceName"
},
"portalServiceProfile" : {
"id" : "portalServiceUUID",
"name" : "portalServiceName"
}
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"description" : "Name of the WLAN"
},
"ssid" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"description" : "SSID of the WLAN"
},
"hessid" : {
"type" : "string",
"pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$",
"description" : "HESSID of the WLAN"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the WLAN"
},
"authServiceOrProfile" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"throughController" : {
"description" : "Indicates whether authentication messages were sent through the controller or not",
"type" : "boolean"
},
"id" : {
"description" : "Identifier of the authentication service or profile. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the authentication service or profile. At least one ID or name is required in the request.",
"type" : "string"
},
"locationDeliveryEnabled" : {
"description" : "RFC5580 location delivery support",
"type" : "boolean"
}
},
"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."
},
"portalServiceProfile" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
},
"description" : "Hotspot portal service of the WLAN. The ID or name of the hotspot portal services within the zone is required."
}
},
"required" : [ "name", "ssid", "authServiceOrProfile", "portalServiceProfile" ]
}
201
ShowHide{
"id" : "wlanUUID"
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
}
}
}
Use this API command to create a new guest access WLAN.
{
"name" : "wlanName",
"ssid" : "wlanSSID",
"description" : "wlanDescription",
"authServiceOrProfile" : {
"throughController" : false,
"id" : "authServiceUUID",
"name" : "authServiceName"
},
"portalServiceProfile" : {
"id" : "portalServiceUUID",
"name" : "portalServiceName"
}
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"description" : "Name of the WLAN"
},
"ssid" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"description" : "SSID of the WLAN"
},
"hessid" : {
"type" : "string",
"pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$",
"description" : "HESSID of the WLAN"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the WLAN"
},
"authServiceOrProfile" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"throughController" : {
"description" : "Indicates whether authentication messages were sent through the controller or not",
"type" : "boolean"
},
"id" : {
"description" : "Identifier of the authentication service or profile. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the authentication service or profile. At least one ID or name is required in the request.",
"type" : "string"
},
"locationDeliveryEnabled" : {
"description" : "RFC5580 location delivery support",
"type" : "boolean"
}
},
"description" : "Authentication of the WLAN. Guest WLANs only accept two names: Local DB and Always Accept."
},
"portalServiceProfile" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
},
"description" : "Guest portal service of the WLAN. The ID or name of the guest portal services within the zone is required."
}
},
"required" : [ "name", "ssid", "authServiceOrProfile", "portalServiceProfile" ]
}
201
ShowHide{
"id" : "wlanUUID"
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
}
}
}
Use this API command to creates new web authentication WLAN.
{
"name" : "wlanName",
"ssid" : "wlanSSID",
"description" : "wlanDescription",
"authServiceOrProfile" : {
"throughController" : false,
"id" : "authServiceUUID",
"name" : "authServiceName"
},
"portalServiceProfile" : {
"id" : "portalServiceUUID",
"name" : "portalServiceName"
}
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"description" : "Name of the WLAN"
},
"ssid" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"description" : "SSID of the WLAN"
},
"hessid" : {
"type" : "string",
"pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$",
"description" : "HESSID of the WLAN"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the WLAN"
},
"authServiceOrProfile" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"throughController" : {
"description" : "Indicates whether authentication messages were sent through the controller or not",
"type" : "boolean"
},
"id" : {
"description" : "Identifier of the authentication service or profile. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the authentication service or profile. At least one ID or name is required in the request.",
"type" : "string"
},
"locationDeliveryEnabled" : {
"description" : "RFC5580 location delivery support",
"type" : "boolean"
}
},
"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."
},
"portalServiceProfile" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
},
"description" : "Web authorizationn portal service of the WLAN. The ID or name of the guest portal services within the zone is required."
}
},
"required" : [ "name", "ssid", "authServiceOrProfile", "portalServiceProfile" ]
}
201
ShowHide{
"id" : "wlanUUID"
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
}
}
}
Use this API command to create a new Hotspot 2.0 access WLAN.
{
"name" : "wlanName",
"ssid" : "wlanSSID",
"description" : "wlanDescription",
"hotspot20Profile" : {
"id" : "hotspot20ServiceUUID",
"name" : "hotspot20ServiceName"
}
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"description" : "Name of the WLAN"
},
"ssid" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"description" : "SSID of the WLAN"
},
"hessid" : {
"type" : "string",
"pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$",
"description" : "HESSID of the WLAN"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the WLAN"
},
"hotspot20Profile" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
},
"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."
}
},
"required" : [ "name", "ssid", "hotspot20Profile" ]
}
201
ShowHide{
"id" : "wlanUUID"
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
}
}
}
Use this API command to create a new Hotspot 2.0 Secure Online Signup WLAN.
{
"name" : "api-test-wlanhs20osen",
"ssid" : "api-test-wlanhs20osen",
"description" : "wlanDescription"
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"description" : "Name of the WLAN"
},
"ssid" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"description" : "SSID of the WLAN"
},
"hessid" : {
"type" : "string",
"pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$",
"description" : "HESSID of the WLAN"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the WLAN"
}
},
"required" : [ "name", "ssid" ]
}
201
ShowHide{
"id" : "wlanUUID"
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
}
}
}
Use this API command to create a new wechat WLAN.
{
"name" : "wlanName",
"ssid" : "wlanSSID",
"description" : "wlanDescription",
"portalServiceProfile" : {
"id" : "portalServiceUUID",
"name" : "portalServiceName"
}
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"description" : "Name of the WLAN"
},
"ssid" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"description" : "SSID of the WLAN"
},
"hessid" : {
"type" : "string",
"pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$",
"description" : "HESSID of the WLAN"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the WLAN"
},
"portalServiceProfile" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
},
"description" : "Wechat portal service of the WLAN. The ID or name of the wechat portal services within the zone is required."
}
},
"required" : [ "name", "ssid", "portalServiceProfile" ]
}
201
ShowHide{
"id" : "wlanUUID"
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
}
}
}
Use this API command to modify the basic information of a WLAN.
{
"name" : "wlanName",
"ssid" : "wlanSSID",
"description" : "wlanDescription",
"accessTunnelType" : "RuckusGRE"
}
{
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"description" : "Name of the WLAN"
},
"ssid" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"description" : "SSID of the WLAN"
},
"hessid" : {
"type" : "string",
"pattern" : "^(bssid|BSSID|([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F]))$",
"description" : "HESSID of the WLAN"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the WLAN"
},
"bypassCNA" : {
"description" : "By pass Capitive Network Assitance",
"type" : [ "boolean", "null" ]
},
"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",
"enum" : [ "APLBO", "RuckusGRE", "SoftGRE" ]
}
}
204
Use this API command to modify the authentication method of a WLAN.
{
"throughController" : false,
"id" : "authServiceUUID",
"name" : "authServiceName"
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"throughController" : {
"description" : "Indicates whether authentication messages were sent through the controller or not",
"type" : "boolean"
},
"id" : {
"description" : "Identifier of the authentication service or profile. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Name of the authentication service or profile. At least one ID or name is required in the request.",
"type" : "string"
},
"locationDeliveryEnabled" : {
"description" : "RFC5580 location delivery support",
"type" : "boolean"
}
},
"description" : "Authentication of the WLAN"
}
204
Use this API command to modify the MAC authentication settings of a WLAN. macAuthMacFormat : Open(aabbccddeeff), 802.1X(AA-BB-CC-DD-EE-FF), UpperColon (AA:BB:CC:DD:EE:FF), Upper (AABBCCDDEEFF), LowerDash (aa-bb-cc-dd-ee-ff) and LowerColon (aa:bb:cc:dd:ee:ff)
{
"macAuthMacFormat" : "802.1X",
"customizedPassword" : "password"
}
{
"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.",
"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})$"
}
},
"description" : "MAC address authentication settings of the WLAN. This only applies to standard MAC and Hotspot MAC bypass WLAN."
}
204
Use this API command to modify the accounting settings of a WLAN.
{
"throughController" : false,
"id" : "accountingServiceUUID",
"name" : "accountingServiceName",
"interimUpdateMin" : 10,
"accountingDelayEnabled" : false,
"accountingTTGSessionEnabled" : false
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"throughController" : {
"description" : "Indicates whether accounting messages were sent through the controller",
"type" : "boolean"
},
"id" : {
"description" : "Accounting service or profile ID. At least one ID or name is required in the request.",
"type" : "string"
},
"name" : {
"description" : "Accounting service or profile name. At least one ID or name is required in the request.",
"type" : "string"
},
"interimUpdateMin" : {
"description" : "Interval (in minutes) for sending interim updates",
"type" : "integer",
"minimum" : 0,
"maximum" : 1440
},
"accountingDelayEnabled" : {
"description" : "Indicates whether accounting delay time is enabled",
"type" : "boolean"
},
"accountingTTGSessionEnabled" : {
"description" : "Indicates whether accounting for TTG sessions is to enabled",
"type" : "boolean"
}
},
"description" : "Accounting of the WLAN"
}
204
Use this API command to disable the accounting of a WLAN.
204
Use this API command to modify the encryption settings of a WLAN.
{
"method" : "WPA2",
"algorithm" : "AES",
"passphrase" : "password",
"mfp" : "capable"
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"method" : {
"description" : "Encryption method",
"enum" : [ "WPA2", "WPA_Mixed", "WEP_64", "WEP_128", "None" ]
},
"algorithm" : {
"description" : "Encryption algorithm. This only applies to WPA2 and WPA mixed mode.",
"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",
"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"
}
},
"required" : [ "method" ],
"description" : "Encryption of the WLAN"
}
204
Use this API command to modify the core tunnel configuration of a WLAN.
{
"type" : "Bridge",
"id" : "forwardingUUID",
"name" : "forwardingName"
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"type" : {
"description" : "Tunnel type",
"enum" : [ "Bridge", "L2oGRE", "L3oGRE", "TTG_PDG", "PMIPv6", "Mixed" ]
},
"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"
},
"operatorRealm" : {
"type" : "string",
"maxLength" : 255,
"pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$",
"description" : "Operator realm, supports for PMIPv6"
}
},
"required" : [ "type" ],
"description" : "Core tunnel of the WLAN. This only applies when the access tunnel type is set to RuckusGRE."
}
204
Use this API command to modify the portal configuration of a WLAN.
{
"id" : "portalServiceUUID",
"name" : "portalServiceName"
}
{
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
},
"description" : "Portal service of the WLAN. This only applies to hotspot, hotspot MAC bypass, guest and web auth WLANs."
}
204
Use this API command to modify the Hotspot 2.0 profile configuration of a WLAN.
{
"id" : "hotspot20ServiceUUID",
"name" : "hotspot20ServiceName"
}
{
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
},
"description" : "Hotspot 2.0 operator profile of the WLAN. id or name of the hotspot 2.0 operator profiles within the zone is required."
}
204
Use this API command to modify the user traffic profile configuration of a WLAN.
{
"id" : "userTrafficUUID",
"name" : "userTrafficName"
}
{
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
},
"description" : "User traffic profile of the WLAN"
}
204
Use this API command to modify the schedule configuration of a WLAN.
{
"type" : "Customized",
"id" : "ServiceUUID",
"name" : "ServiceName"
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"type" : {
"description" : "Type of WLAN schedule",
"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" ],
"description" : "Schedule of the WLAN"
}
204
Use this API command to modify the VLAN configuration of a WLAN.
{
"accessVlan" : 23,
"aaaVlanOverride" : true,
"coreQinQEnabled" : false,
"coreSVlan" : null
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"accessVlan" : {
"description" : "Access VLAN ID",
"type" : "integer",
"minimum" : 1,
"maximum" : 4094
},
"aaaVlanOverride" : {
"description" : "Indicates whether the AAA VLAN settings can be overriden or not",
"type" : "boolean"
},
"coreQinQEnabled" : {
"description" : "Indicates whether Q-in-Q is allowed at the core network or not",
"type" : "boolean"
},
"coreSVlan" : {
"description" : "Core SVLAN ID. This only applies when core Q-in-Q is enabled",
"type" : "integer",
"minimum" : 1,
"maximum" : 4094
},
"vlanPooling" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
},
"description" : "Vlan pooling"
}
},
"description" : "VLAN (access and/or core) of the WLAN."
}
204
Use this API command to modify the layer 2 access control list (ACL) configuration of a WLAN.
{
"id" : "l2ACLUUID",
"name" : "l2ACLName"
}
{
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
},
"description" : "Layer 2 ACL of the WLAN"
}
204
Use this API command to disable the layer 2 access control list (ACL) configuration of a WLAN.
204
Use this API command to modify the device policy of a WLAN.
{
"id" : "devicePolicyUUID",
"name" : "devicePolicyName"
}
{
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
},
"description" : "Device policy of the WLAN"
}
204
Use this API command to disable the device policy of a WLAN.
204
Use this API command to modify the RADIUS settings of a WLAN.
{
"nasIdType" : "Customized",
"customizedNasId" : "nasId",
"nasRequestTimeoutSec" : 12,
"nasMaxRetry" : 3,
"nasReconnectPrimaryMin" : 30,
"calledStaIdType" : "WLAN_BSSID"
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"nasIdType" : {
"description" : "NAS ID type",
"enum" : [ "WLAN_BSSID", "AP_MAC", "Customized" ],
"default" : "WLAN_BSSID"
},
"customizedNasId" : {
"description" : "User defined NAS ID",
"type" : "string",
"maxLength" : 63,
"pattern" : "^([!-~]([ -~]){0,61}[!-~]|[!-~]{1,1})$"
},
"nasRequestTimeoutSec" : {
"description" : "NAS request timeout in seconds",
"type" : "integer",
"default" : 3,
"minimum" : 2,
"maximum" : 20
},
"nasMaxRetry" : {
"description" : "NAS request maximum retry",
"type" : "integer",
"default" : 2,
"minimum" : 2,
"maximum" : 10
},
"nasReconnectPrimaryMin" : {
"description" : "NAS reconnect primary time in minutes",
"type" : "integer",
"default" : 5,
"minimum" : 1,
"maximum" : 60
},
"calledStaIdType" : {
"description" : "Called station ID type",
"enum" : [ "WLAN_BSSID", "AP_MAC" ],
"default" : "WLAN_BSSID"
}
},
"description" : "RADIUS options of the WLAN"
}
204
Use this API command to modify the advanced settings of a WLAN.
{
"clientIsolationEnabled" : false,
"priority" : "High",
"hideSsidEnabled" : true,
"maxClientsPerRadio" : 12,
"clientIdleTimeoutSec" : 12,
"proxyARPEnabled" : true,
"support80211dEnabled" : false,
"forceDHCPEnabled" : false,
"forceClientDHCPTimeout" : 21,
"dhcpOption82Enabled" : true,
"dhcp82Format" : "RUCKUS_DEFAULT",
"unauthClientStatsEnabled" : false,
"clientFingerprintingEnabled" : true,
"ofdmOnlyEnabled" : false,
"bandBalancing" : "UseZoneSetting",
"bssMinRateMbps" : "Disable",
"mgmtTxRateMbps" : "2 mbps",
"uplinkRateLimiting" : "Disable",
"downlinkRateLimiting" : "Disable",
"zeroItActivationEnabled" : false
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"clientIsolationEnabled" : {
"description" : "Indicates whether wireless client isolation is enabled or disabled",
"type" : "boolean",
"default" : true
},
"priority" : {
"description" : "Priority of the WLAN",
"enum" : [ "High", "Low" ],
"default" : "High"
},
"hideSsidEnabled" : {
"description" : "Indicates whether the SSID is hidden or broadcast",
"type" : "boolean",
"default" : false
},
"maxClientsPerRadio" : {
"description" : "Maximum number of clients per radio",
"type" : "integer",
"default" : 100,
"minimum" : 1,
"maximum" : 512
},
"clientIdleTimeoutSec" : {
"description" : "Client idle timeout in seconds",
"type" : "integer",
"minimum" : 60,
"maximum" : 1000,
"default" : 120
},
"dgafEnabled" : {
"description" : "Indicates whether dgaf is enabled or disabled",
"type" : "boolean"
},
"proxyARPEnabled" : {
"description" : "Indicates whether proxy ARP is enabled or disabled",
"type" : "boolean",
"default" : false
},
"support80211dEnabled" : {
"description" : "Indicates whether support for 802.11d is enabled or disabled",
"type" : "boolean",
"default" : true
},
"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).",
"enum" : [ 0, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15 ],
"default" : 0
},
"dhcpOption82Enabled" : {
"description" : "Indicates whether DCHP Option 82 is enabled or disabled",
"type" : "boolean",
"default" : false
},
"dhcp82Format" : {
"description" : "DHCP Option 82 format",
"enum" : [ "RUCKUS_DEFAULT", "SOFTGRE_CUSTOMIZED" ]
},
"unauthClientStatsEnabled" : {
"description" : "Indicates whether to send statistics of unauthorized clients or not",
"type" : "boolean",
"default" : true
},
"clientFingerprintingEnabled" : {
"description" : "Indicates whether client fingerprinting is enabled or disabled",
"type" : "boolean",
"default" : false
},
"ofdmOnlyEnabled" : {
"description" : "Indicates whether OFDM only is enabled or disabled",
"type" : "boolean",
"default" : false
},
"bandBalancing" : {
"description" : "Indicates whether band balancing is enabled or disabled",
"enum" : [ "Disabled", "UseZoneSetting" ],
"default" : "UseZoneSetting"
},
"bssMinRateMbps" : {
"enum" : [ "Disable", "1 mbps", "2 mbps", "5.5 mbps", "12 mbps", "24 mbps" ],
"description" : "BSS minimum rate (mbps)"
},
"mgmtTxRateMbps" : {
"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" ],
"description" : "Management TX rate (mbps)"
},
"zeroItActivationEnabled" : {
"description" : "Indicator of whether Zero-IT activation is enabled or disabled",
"type" : "boolean",
"default" : false
},
"pmkCachingEnabled" : {
"description" : "Indicator of whether PKM caching support is enabled or disabled",
"type" : "boolean",
"default" : false
},
"okcEnabled" : {
"description" : "Indicator of whether OKC support is enabled or disabled",
"type" : "boolean",
"default" : false
}
},
"description" : "Advanced settings for the WLAN."
}
204
Use this API command to modify the DiffServ profile of a WLAN.
{
"id" : "diffServId",
"name" : "diffServName"
}
{
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
},
"description" : "DiffServ profile of the WLAN"
}
204
Use this API command to disable the DiffServ profile of a WLAN.
204
Use this API command to enable Qos Map Set of a WLAN.
201
Use this API command to modify Qos Map Set of a WLAN.
[ {
"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
} ]
{
"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" ]
}
}
204
Use this API command to disable Qos Map Set of a WLAN.
204
Use this API command to modify online signup service of a WLAN.
{
"zeroITOnboarding" : {
"portal" : {
"name" : "onlineSignupProfile"
},
"authServices" : [ {
"name" : "globalAuth",
"credentialType" : "LOCAL",
"realm" : "realm.com",
"expiration" : 123
} ]
},
"onlineSignupEnabled" : true
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"zeroITOnboarding" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"portal" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
},
"description" : "Onboarding portal profile"
},
"authServices" : {
"description" : "Authentication services",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Identifier of authentication service",
"type" : "string"
},
"name" : {
"description" : "Authentication service name",
"type" : "string"
},
"credentialType" : {
"description" : "Provisioning credential type",
"enum" : [ "LOCAL", "REMOTE" ]
},
"realm" : {
"type" : "string",
"maxLength" : 255,
"pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$",
"description" : "Device provisioning realm"
},
"expiration" : {
"description" : "Expiration hour. null mean never expire",
"type" : [ "integer", "null" ],
"minimum" : 1,
"maximum" : 175200
}
},
"required" : [ "credentialType", "realm" ]
}
}
},
"required" : [ "portal", "authServices" ],
"description" : "Zero-IT Onboarding"
},
"onlineSignupEnabled" : {
"description" : "Hotspot 2.0 online signup enabled device registration from this guest portal",
"type" : "boolean",
"default" : false
}
},
"description" : "Online signup service, only support for guest access WLAN"
}
204
Use this API command to disable Zero-IT onboarding of a WLAN.
204
Use this API command to delete a WLAN.
204
Use this API command to retrieve the list of WLAN schedule from a zone.
number
(optional) The index of the first entry to be retrieved. Default: 0
number
(optional) The maximum number of entries to be retrieved. Default: 100
200
ShowHide{
"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:15-01:15" ],
"tue" : [ "00:15-01:15" ],
"wed" : [ "00:15-01:15" ],
"thu" : [ "00:15-01:15" ],
"fri" : [ "00:15-01:15" ],
"sat" : [ "00:15-01:15" ]
}, {
"id" : "wlanSchedulerUUID2",
"name" : "wlanSchedulerName2",
"description" : "wlanSchedulerDescription2",
"sun" : [ "00:15-01:15" ],
"mon" : [ "00:15-01:15" ],
"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" : [ "00:15-01:15" ]
} ]
}
{
"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" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the WLAN schedule"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the WLAN schedule"
},
"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"
}
}
}
}
}
}
}
Use this API command to retrieve a WLAN schedule.
200
ShowHide{
"id" : "wlanSchedulerUUID",
"zoneId" : "zoneUUID",
"name" : "wlanSchedulerName",
"description" : "wlanSchedulerDescription",
"sun" : [ "00:15-01:15", "07:00-08:30", "10:45-12:00" ],
"mon" : [ "00:15-01:15" ],
"tue" : [ "00:15-01:15" ],
"wed" : [ "00:15-01:15" ],
"thu" : [ "00:15-01:15" ],
"fri" : [ "00:15-01:15" ],
"sat" : [ "00:15-01:15" ]
}
{
"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" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the WLAN schedule"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the WLAN schedule"
},
"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"
}
}
}
}
Use this API command to create a new WLAN schedule.
{
"name" : "wlanSchedulerName",
"description" : "wlanSchedulerDescription",
"sun" : [ "00:15-01:15", "07:00-08:30", "10:45-12:00" ],
"mon" : [ "00:15-01:15" ],
"tue" : [ "00:15-01:15" ],
"wed" : [ "00:15-01:15" ],
"thu" : [ "00:15-01:15" ],
"fri" : [ "00:15-01:15" ],
"sat" : [ "00:15-01:15" ]
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the WLAN schedule"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the WLAN schedule"
},
"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"
}
}
},
"required" : [ "name" ]
}
201
ShowHide{
"id" : "wlanSchedulerUUID"
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Identifier of the WLAN schedule",
"type" : "string"
}
}
}
Use this API command to modify a WLAN schedule.
{
"name" : "wlanSchedulerName",
"description" : "wlanSchedulerDescription"
}
{
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the WLAN schedule"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the WLAN schedule"
}
}
204
Use this API command to delete a WLAN schedule.
204
Use this API command to retrieve a list of radius servers of a zone.
200
ShowHide{
"totalCount" : 1,
"hasMore" : false,
"firstIndex" : 0,
"list" : [ {
"id" : "authenticationServerUUID",
"mvnoId" : "userMVNOId",
"zoneId" : "zoneUUID",
"name" : "authenticationServerName",
"description" : "authenticationServerDescription",
"primary" : {
"ip" : "192.168.1.1",
"port" : 1812,
"sharedSecret" : "sharedSecret"
},
"secondary" : {
"ip" : "192.168.1.2",
"port" : 1812,
"sharedSecret" : "sharedSecret"
}
} ]
}
{
"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 authentication server",
"type" : "string"
},
"zoneId" : {
"description" : "Identifier of the zone which the authentication server belongs to",
"type" : "string"
},
"mvnoId" : {
"description" : "Tenant UUID",
"type" : "string"
},
"name" : {
"description" : "Name of the authentication server",
"type" : "string"
},
"description" : {
"description" : "Description of the authentication server",
"type" : "string"
},
"primary" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"ip" : {
"type" : "string",
"description" : "Server IP"
},
"port" : {
"description" : "Server port",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
},
"sharedSecret" : {
"description" : "Server shared secrect",
"type" : "string"
}
},
"required" : [ "ip", "port", "sharedSecret" ],
"description" : "Primary RADIUS server"
},
"secondary" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"ip" : {
"type" : "string",
"description" : "Server IP"
},
"port" : {
"description" : "Server port",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
},
"sharedSecret" : {
"description" : "Server shared secrect",
"type" : "string"
}
},
"required" : [ "ip", "port", "sharedSecret" ],
"description" : "Secondary RADIUS server"
}
}
}
}
}
}
Use this API command to retrieve a radius server of a zone.
200
ShowHide{
"id" : "authenticationServerUUID",
"mvnoId" : "userMVNOId",
"zoneId" : "zoneUUID",
"name" : "authenticationServerName",
"description" : "authenticationServerDescription",
"primary" : {
"ip" : "192.168.1.1",
"port" : 1812,
"sharedSecret" : "sharedSecret"
},
"secondary" : {
"ip" : "192.168.1.2",
"port" : 1812,
"sharedSecret" : "sharedSecret"
}
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Identifier of the authentication server",
"type" : "string"
},
"zoneId" : {
"description" : "Identifier of the zone which the authentication server belongs to",
"type" : "string"
},
"mvnoId" : {
"description" : "Tenant UUID",
"type" : "string"
},
"name" : {
"description" : "Name of the authentication server",
"type" : "string"
},
"description" : {
"description" : "Description of the authentication server",
"type" : "string"
},
"primary" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"ip" : {
"type" : "string",
"description" : "Server IP"
},
"port" : {
"description" : "Server port",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
},
"sharedSecret" : {
"description" : "Server shared secrect",
"type" : "string"
}
},
"required" : [ "ip", "port", "sharedSecret" ],
"description" : "Primary RADIUS server"
},
"secondary" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"ip" : {
"type" : "string",
"description" : "Server IP"
},
"port" : {
"description" : "Server port",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
},
"sharedSecret" : {
"description" : "Server shared secrect",
"type" : "string"
}
},
"required" : [ "ip", "port", "sharedSecret" ],
"description" : "Secondary RADIUS server"
}
}
}
Use this API command to create a new radius server of a zone.
{
"name" : "authenticationServerName",
"primary" : {
"ip" : "192.168.1.1",
"port" : 1812,
"sharedSecret" : "sharedSecret"
}
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the authentication server"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the authentication server"
},
"primary" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"ip" : {
"type" : "string",
"description" : "Server IP"
},
"port" : {
"description" : "Server port",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
},
"sharedSecret" : {
"description" : "Server shared secrect",
"type" : "string"
}
},
"required" : [ "ip", "port", "sharedSecret" ],
"description" : "Primary RADIUS server"
},
"secondary" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"ip" : {
"type" : "string",
"description" : "Server IP"
},
"port" : {
"description" : "Server port",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
},
"sharedSecret" : {
"description" : "Server shared secrect",
"type" : "string"
}
},
"required" : [ "ip", "port", "sharedSecret" ],
"description" : "Secondary RADIUS server"
}
},
"required" : [ "name", "primary" ]
}
201
ShowHide{
"id" : "AAAServerUUID"
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
}
}
}
Use this API command to modify the basic information on radius server of a zone.
{
"name" : "authenticationServerName",
"description" : "authenticationServerDescription"
}
{
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the authentication server"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the authentication server"
}
}
204
Use this API command to modify primary server on radius server of a zone.
{
"ip" : "192.168.1.1",
"port" : 1812,
"sharedSecret" : "abc"
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"ip" : {
"type" : "string",
"description" : "Server IP"
},
"port" : {
"description" : "Server port",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
},
"sharedSecret" : {
"description" : "Server shared secrect",
"type" : "string"
}
},
"required" : [ "ip", "port", "sharedSecret" ],
"description" : "Primary RADIUS server"
}
204
Use this API command to modify secondary server on radius server of a zone.
{
"ip" : "192.168.1.2",
"port" : 1812,
"sharedSecret" : "sharedSecret"
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"ip" : {
"type" : "string",
"description" : "Server IP"
},
"port" : {
"description" : "Server port",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
},
"sharedSecret" : {
"description" : "Server shared secrect",
"type" : "string"
}
},
"required" : [ "ip", "port", "sharedSecret" ],
"description" : "Secondary RADIUS server"
}
204
Use this API command to disable secondary server on radius server of a zone.
204
Use this API command to delete a radius server of a zone.
204
Use this API command to retrieve a list of radius accounting servers of a zone.
200
ShowHide{
"totalCount" : 1,
"hasMore" : false,
"firstIndex" : 0,
"list" : [ {
"id" : "accountingServerUUID",
"mvnoId" : "userMVNOId",
"zoneId" : "zoneUUID",
"name" : "accountingServerName",
"description" : "accountingServerDescription",
"primary" : {
"ip" : "192.168.1.1",
"port" : 1813,
"sharedSecret" : "sharedSecret"
},
"secondary" : {
"ip" : "192.168.1.2",
"port" : 1813,
"sharedSecret" : "sharedSecret"
}
} ]
}
{
"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 accounting server",
"type" : "string"
},
"zoneId" : {
"description" : "Identifier of the zone which the accounting server belongs to",
"type" : "string"
},
"mvnoId" : {
"description" : "Tenant UUID",
"type" : "string"
},
"name" : {
"description" : "Name of the accounting server",
"type" : "string"
},
"description" : {
"description" : "Description of the accounting server",
"type" : "string"
},
"primary" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"ip" : {
"type" : "string",
"description" : "Server IP"
},
"port" : {
"description" : "Server port",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
},
"sharedSecret" : {
"description" : "Server shared secrect",
"type" : "string"
}
},
"required" : [ "ip", "port", "sharedSecret" ],
"description" : "Primary RADIUS server"
},
"secondary" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"ip" : {
"type" : "string",
"description" : "Server IP"
},
"port" : {
"description" : "Server port",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
},
"sharedSecret" : {
"description" : "Server shared secrect",
"type" : "string"
}
},
"required" : [ "ip", "port", "sharedSecret" ],
"description" : "Secondary RADIUS server"
}
}
}
}
}
}
Use this API command to retrieve a radius accounting server of a zone.
200
ShowHide{
"id" : "accountingServerUUID",
"mvnoId" : "userMVNOId",
"zoneId" : "zoneUUID",
"name" : "accountingServerName",
"description" : "accountingServerDescription",
"primary" : {
"ip" : "192.168.1.1",
"port" : 1813,
"sharedSecret" : "sharedSecret"
},
"secondary" : {
"ip" : "192.168.1.2",
"port" : 1813,
"sharedSecret" : "sharedSecret"
}
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Identifier of the accounting server",
"type" : "string"
},
"zoneId" : {
"description" : "Identifier of the zone which the accounting server belongs to",
"type" : "string"
},
"mvnoId" : {
"description" : "Tenant UUID",
"type" : "string"
},
"name" : {
"description" : "Name of the accounting server",
"type" : "string"
},
"description" : {
"description" : "Description of the accounting server",
"type" : "string"
},
"primary" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"ip" : {
"type" : "string",
"description" : "Server IP"
},
"port" : {
"description" : "Server port",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
},
"sharedSecret" : {
"description" : "Server shared secrect",
"type" : "string"
}
},
"required" : [ "ip", "port", "sharedSecret" ],
"description" : "Primary RADIUS server"
},
"secondary" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"ip" : {
"type" : "string",
"description" : "Server IP"
},
"port" : {
"description" : "Server port",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
},
"sharedSecret" : {
"description" : "Server shared secrect",
"type" : "string"
}
},
"required" : [ "ip", "port", "sharedSecret" ],
"description" : "Secondary RADIUS server"
}
}
}
Use this API command to create a new radius accounting server of a zone.
{
"name" : "accountingServerName",
"primary" : {
"ip" : "192.168.1.1",
"port" : 1813,
"sharedSecret" : "sharedSecret"
}
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the accounting server"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the accounting server"
},
"primary" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"ip" : {
"type" : "string",
"description" : "Server IP"
},
"port" : {
"description" : "Server port",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
},
"sharedSecret" : {
"description" : "Server shared secrect",
"type" : "string"
}
},
"required" : [ "ip", "port", "sharedSecret" ],
"description" : "Primary RADIUS server"
},
"secondary" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"ip" : {
"type" : "string",
"description" : "Server IP"
},
"port" : {
"description" : "Server port",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
},
"sharedSecret" : {
"description" : "Server shared secrect",
"type" : "string"
}
},
"required" : [ "ip", "port", "sharedSecret" ],
"description" : "Secondary RADIUS server"
}
},
"required" : [ "name", "primary" ]
}
201
ShowHide{
"id" : "AAAServerUUID"
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
}
}
}
Use this API command to modify the basic information on radius accounting server of a zone.
{
"name" : "accountingServerName",
"description" : "accountingServerDescription"
}
{
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the accounting server"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the accounting server"
}
}
204
Use this API command to modify primary server on radius accounting server of a zone.
{
"ip" : "1.1.1.1",
"port" : 1813,
"sharedSecret" : "abc"
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"ip" : {
"type" : "string",
"description" : "Server IP"
},
"port" : {
"description" : "Server port",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
},
"sharedSecret" : {
"description" : "Server shared secrect",
"type" : "string"
}
},
"required" : [ "ip", "port", "sharedSecret" ],
"description" : "Primary RADIUS server"
}
204
Use this API command to modify secondary server on radius accounting server of a zone.
{
"ip" : "192.168.1.2",
"port" : 1813,
"sharedSecret" : "sharedSecret"
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"ip" : {
"type" : "string",
"description" : "Server IP"
},
"port" : {
"description" : "Server port",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
},
"sharedSecret" : {
"description" : "Server shared secrect",
"type" : "string"
}
},
"required" : [ "ip", "port", "sharedSecret" ],
"description" : "Secondary RADIUS server"
}
204
Use this API command to disable secondary server on radius accounting server of a zone.
204
Use this API command to delete a radius accounting server of a zone.
204
Use this API command to retrieve a list of active directory servers of a zone.
200
ShowHide{
"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
} ]
}
{
"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"
}
}
}
}
}
}
Use this API command to retrieve an active directory server of a zone.
200
ShowHide{
"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
}
{
"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"
}
}
}
Use this API command to create a new active directory server of a zone.
{
"name" : "activeDirectoryServerName",
"ip" : "192.168.1.1",
"port" : 389,
"globalCatalogEnabled" : false
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the active directory server"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the active directory server"
},
"ip" : {
"type" : "string",
"description" : "IP address"
},
"port" : {
"description" : "Port",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535,
"default" : 389
},
"windowsDomainName" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 64,
"pattern" : "^[!-~]([ -~]){0,62}[!-~]$",
"description" : "Windows domain name"
},
"adminDomainName" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 64,
"pattern" : "^[!-~]([ -~]){0,62}[!-~]$",
"description" : "Admin domain name"
},
"password" : {
"description" : "Admin password",
"type" : "string"
},
"globalCatalogEnabled" : {
"description" : "Enable global catalog support",
"type" : "boolean"
}
},
"required" : [ "name", "ip", "port", "globalCatalogEnabled" ]
}
201
ShowHide{
"id" : "AAAServerUUID"
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
}
}
}
Use this API command to modify the basic information on active directory server of a zone.
{
"name" : "new name",
"ip" : "192.168.1.2",
"port" : 3268,
"adminDomainName" : "[email protected]",
"password" : "admin",
"globalCatalogEnabled" : true
}
{
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the active directory server"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the active directory server"
},
"ip" : {
"type" : "string",
"description" : "IP address"
},
"port" : {
"description" : "Port",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535,
"default" : 389
},
"windowsDomainName" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 64,
"pattern" : "^[!-~]([ -~]){0,62}[!-~]$",
"description" : "Windows domain name"
},
"adminDomainName" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 64,
"pattern" : "^[!-~]([ -~]){0,62}[!-~]$",
"description" : "Admin domain name"
},
"password" : {
"description" : "Admin password",
"type" : "string"
},
"globalCatalogEnabled" : {
"description" : "Enable global catalog support",
"type" : "boolean"
}
}
204
Use this API command to delete an active directory server of a zone.
204
Use this API command to retrieve a list of LDAP servers of a zone.
200
ShowHide{
"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=*"
} ]
}
{
"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"
}
}
}
}
}
}
Use this API command to retrieve a LDAP server of a zone.
200
ShowHide{
"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=*"
}
{
"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"
}
}
}
Use this API command to create a new LDAP server of a zone.
{
"name" : "rapheal-ldap",
"ip" : "1.1.1.2",
"port" : 389,
"baseDomainName" : "dc=ldap",
"adminDomainName" : "ibm",
"password" : "admin",
"keyAttribute" : "uid",
"searchFilter" : "objectClass=*"
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the LDAP server"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the LDAP server"
},
"ip" : {
"type" : "string",
"description" : "IP address"
},
"port" : {
"description" : "Port",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535,
"default" : 389
},
"baseDomainName" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 64,
"pattern" : "^[!-~]([ -~]){0,62}[!-~]$",
"description" : "Base domain name"
},
"adminDomainName" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 64,
"pattern" : "^[!-~]([ -~]){0,62}[!-~]$",
"description" : "Admin domain name"
},
"password" : {
"description" : "Admin password",
"type" : "string"
},
"keyAttribute" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 64,
"pattern" : "^[!-~]([ -~]){0,62}[!-~]$",
"description" : "Key attribute"
},
"searchFilter" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 64,
"pattern" : "^[!-~]([ -~]){0,62}[!-~]$",
"description" : "Search filter"
}
},
"required" : [ "name", "ip", "port", "baseDomainName", "adminDomainName", "password", "keyAttribute", "searchFilter" ]
}
201
ShowHide{
"id" : "AAAServerUUID"
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
}
}
}
Use this API command to modify the basic information on LDAP server of a zone.
{
"name" : "rapheal-ldap2",
"ip" : "1.1.1.22",
"port" : 389,
"baseDomainName" : "dc=ldap",
"adminDomainName" : "ibm",
"password" : "admin",
"keyAttribute" : "uid",
"searchFilter" : "objectClass=*"
}
{
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the LDAP server"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the LDAP server"
},
"ip" : {
"type" : "string",
"description" : "IP address"
},
"port" : {
"description" : "Port",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535,
"default" : 389
},
"baseDomainName" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 64,
"pattern" : "^[!-~]([ -~]){0,62}[!-~]$",
"description" : "Base domain name"
},
"adminDomainName" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 64,
"pattern" : "^[!-~]([ -~]){0,62}[!-~]$",
"description" : "Admin domain name"
},
"password" : {
"description" : "Admin password",
"type" : "string"
},
"keyAttribute" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 64,
"pattern" : "^[!-~]([ -~]){0,62}[!-~]$",
"description" : "Key attribute"
},
"searchFilter" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 64,
"pattern" : "^[!-~]([ -~]){0,62}[!-~]$",
"description" : "Search filter"
}
}
204
Use this API command to delete a LDAP server of a zone.
204
Use this API command to retrieve a list of web authentication of a zone.
200
ShowHide{
"totalCount" : 9,
"hasMore" : false,
"firstIndex" : 0,
"list" : [ {
"id" : "c5dfc930-75dc-11e4-8d56-00606eb0c700",
"name" : "protalName1"
}, {
"id" : "15efd160-7153-11e4-aa08-00606eb0c700",
"name" : "protalName2"
}, {
"id" : "be0f0480-73a9-11e4-9d1d-f0def13d5845",
"name" : "protalName3"
}, {
"id" : "7f0eef00-7423-11e4-bcef-000c299b4765",
"name" : "protalName4"
}, {
"id" : "4f5c98a0-7123-11e4-bcef-000c299b4765",
"name" : "protalName5"
}, {
"id" : "4a023ce0-73ab-11e4-b211-f0def13d5845",
"name" : "protalName6"
}, {
"id" : "afebbc80-73be-11e4-bfde-f0def13d5845",
"name" : "protalName7"
}, {
"id" : "76f4c020-7620-11e4-b8b9-00606eb0c700",
"name" : "protalName8"
}, {
"id" : "96308310-752c-11e4-8276-00606eb0c700",
"name" : "protalName9"
} ]
}
{
"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" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the service"
}
}
}
}
}
}
Use this API command to retrieve a web authentication of a zone.
200
ShowHide{
"name" : "Web Authentication Modify",
"id" : "3e769bc0-7ead-11e4-9517-00606eb0c700",
"description" : "Web Authentication Modify Description",
"portalLanguage" : "en_US",
"redirect" : {
"url" : "https://www.ruckuswireless.com"
},
"userSession" : {
"timeoutInMin" : 180,
"gracePeriodInMin" : 120
},
"zoneId" : "b4187899-38ae-4ace-8e40-0bc444455156"
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Identifier of the web authentication profile",
"type" : "string"
},
"zoneId" : {
"description" : "Identifier of the zone which the web authentication profile belongs to",
"type" : "string"
},
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the web authentication profile"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the web authentication profile"
},
"portalLanguage" : {
"description" : "Portal language of the web authentication profile",
"default" : "en_US",
"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" ]
},
"redirect" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"url" : {
"type" : "string",
"description" : "Portal redirect URL"
}
},
"description" : "Redirect configuration of the web authentication profile"
},
"userSession" : {
"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
}
},
"description" : "User session of the web authentication profile"
}
}
}
Use this API command to create a new web authentication of a zone.
{
"name" : "Web Authentication Create",
"description" : "Web Authentication Create Description"
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the web authentication profile"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the web authentication profile"
}
},
"required" : [ "name" ]
}
201
ShowHide{
"id" : "76f4c020-7620-11e4-b8b9-00606eb0c700"
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Identifier of the created portal profile",
"type" : "string"
}
}
}
Use this API command to modify the basic information on web authentication of a zone.
{
"name" : "Web Authentication Modify",
"description" : "Web Authentication Modify Description",
"portalLanguage" : "en_US"
}
{
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the web authentication profile"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the web authentication profile"
},
"portalLanguage" : {
"description" : "Portal language of the web authentication profile",
"default" : "en_US",
"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" ]
}
}
204
Use this API command to modify the redirect information on web authentication of a zone.
{
"url" : "https://www.ruckuswireless.com"
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"url" : {
"type" : "string",
"description" : "Portal redirect URL"
}
},
"description" : "Redirect configuration of the web authentication profile"
}
204
Use this API command to set redirect to the URL that user intends to visit on web authentication of a zone.
204
Use this API command to delete an web authentication of a zone.
204
Use this API command to retrieve a list of guest access of a zone.
200
ShowHide{
"totalCount" : 9,
"hasMore" : false,
"firstIndex" : 0,
"list" : [ {
"id" : "c5dfc930-75dc-11e4-8d56-00606eb0c700",
"name" : "protalName1"
}, {
"id" : "15efd160-7153-11e4-aa08-00606eb0c700",
"name" : "protalName2"
}, {
"id" : "be0f0480-73a9-11e4-9d1d-f0def13d5845",
"name" : "protalName3"
}, {
"id" : "7f0eef00-7423-11e4-bcef-000c299b4765",
"name" : "protalName4"
}, {
"id" : "4f5c98a0-7123-11e4-bcef-000c299b4765",
"name" : "protalName5"
}, {
"id" : "4a023ce0-73ab-11e4-b211-f0def13d5845",
"name" : "protalName6"
}, {
"id" : "afebbc80-73be-11e4-bfde-f0def13d5845",
"name" : "protalName7"
}, {
"id" : "76f4c020-7620-11e4-b8b9-00606eb0c700",
"name" : "protalName8"
}, {
"id" : "96308310-752c-11e4-8276-00606eb0c700",
"name" : "protalName9"
} ]
}
{
"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" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the service"
}
}
}
}
}
}
Use this API command to retrieve guest access of a zone.
200
ShowHide{
"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" : "logo description",
"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
}
}
{
"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" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the guest access profile"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the guest access profile"
},
"portalCustomization" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"language" : {
"description" : "Language",
"default" : "en_US",
"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" ],
"description" : "Portal customization of the guest access profile"
},
"redirect" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"url" : {
"type" : "string",
"description" : "Portal redirect URL"
}
},
"description" : "Redirect configuration of the guest access profile"
},
"smsGateway" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
},
"description" : "Portal SMS gateway of the guest access profile"
},
"userSession" : {
"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
}
},
"description" : "User session of the guest access profile"
}
}
}
Use this API command to create new guest access of a zone.
{
"name" : "GuestAccess test",
"description" : "guest access test description",
"portalCustomization" : {
"language" : "en_US",
"title" : "Welcome to the Guest Access login page.",
"logo" : "test",
"termsAndConditionsRequired" : true,
"termsAndConditionsText" : "test"
},
"redirect" : {
"url" : "http://www.ruckuswireless.com"
},
"smsGateway" : {
"name" : "defaultServer"
},
"userSession" : {
"timeoutInMin" : 180,
"gracePeriodInMin" : 120
}
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the guest access profile"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the guest access profile"
},
"portalCustomization" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"language" : {
"description" : "Language",
"default" : "en_US",
"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" ],
"description" : "Portal customization of the guest access profile"
},
"redirect" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"url" : {
"type" : "string",
"description" : "Portal redirect URL"
}
},
"description" : "Redirect configuration of the guest access profile"
},
"smsGateway" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
},
"description" : "Portal SMS gateway of the guest access profile"
},
"userSession" : {
"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
}
},
"description" : "Redirect configuration of the guest access profile"
}
},
"required" : [ "name", "portalCustomization", "userSession" ]
}
201
ShowHide{
"id" : "76f4c020-7620-11e4-b8b9-00606eb0c700"
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Identifier of the created portal profile",
"type" : "string"
}
}
}
Use this API command to modify the basic information on guest access of a zone.
{
"name" : "GuestAccessSmart",
"description" : "basic configuration test"
}
{
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the guest access profile"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the guest access profile"
}
}
204
Use this API command to modify the redirect information on guest access of a zone.
{
"url" : "http://www.google.com"
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"url" : {
"type" : "string",
"description" : "Portal redirect URL"
}
},
"description" : "Redirect configuration of the guest access profile"
}
204
Use this API command to set redirect to the URL that user intends to visit on guest access of a zone.
204
Use this API command to modify SMS gateway on guest access of a zone.
{
"name" : "defaultServer"
}
{
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
},
"description" : "Portal SMS gateway of the guest access profile"
}
204
Use this API command to disable SMS gateway on guest access of a zone.
204
Use this API command to modify the portal customization on guest access of a zone.
{
"language" : "zh_TW",
"title" : "Welcome to the Guest Access login page.",
"logo" : "logo description",
"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."
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"language" : {
"description" : "Language",
"default" : "en_US",
"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" ],
"description" : "Portal customization of the guest access profile"
}
204
Use this API command to modify the user session on guest access of a zone.
{
"timeoutInMin" : 180,
"gracePeriodInMin" : 60
}
{
"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
}
},
"description" : "User session of the guest access profile"
}
204
Use this API command to delete guest access of a zone.
204
Use this API command to retrieve a list of user traffic profile
number
(optional) The index of the first entry to be retrieved. Default: 0
number
(optional) The maximum number of entries to be retrieved. Default: 100
200
ShowHide{
"totalCount" : 1,
"hasMore" : false,
"firstIndex" : 0,
"list" : [ {
"id" : "267ef3a0-738b-11e4-96d5-0a7820524153",
"name" : "new name"
} ]
}
{
"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 profile",
"type" : "string"
},
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the profile"
}
}
}
}
}
}
Use this API command to retrieve an user traffic profile
200
ShowHide{
"id" : "1869c000-9c5e-11e4-9d3a-00606eb0c700",
"name" : "user-traffic-profile-name",
"description" : "user traffic profile description",
"defaultAction" : "ALLOW",
"ipAclRules" : [ {
"priority" : 1,
"description" : "Allow DNS",
"enableSourceIpSubnet" : true,
"sourceIp" : "172.17.26.50",
"sourceIpMask" : "255.255.0.0",
"enableDestinationIpSubnet" : true,
"destinationIp" : "172.17.29.31",
"destinationIpMask" : "255.255.255.0",
"enableSourcePortRange" : true,
"sourceMinPort" : 10,
"sourceMaxPort" : 65530,
"enableDestinationPortRange" : false,
"destinationMinPort" : 53,
"destinationMaxPort" : null,
"protocol" : null,
"action" : "ALLOW",
"direction" : "UPSTREAM"
}, {
"priority" : 2,
"description" : "Allow DHCP",
"enableSourceIpSubnet" : false,
"sourceIp" : "172.17.51.99",
"sourceIpMask" : "",
"enableDestinationIpSubnet" : false,
"destinationIp" : "172.17.53.99",
"destinationIpMask" : "",
"enableSourcePortRange" : true,
"sourceMinPort" : null,
"sourceMaxPort" : null,
"enableDestinationPortRange" : false,
"destinationMinPort" : 67,
"destinationMaxPort" : null,
"protocol" : null,
"action" : "ALLOW",
"direction" : "UPSTREAM"
} ],
"uplinkRateLimiting" : {
"uplinkRateLimitingEnabled" : true,
"uplinkRateLimitingBps" : "2.75 mbps"
},
"downlinkRateLimiting" : {
"downlinkRateLimitingEnabled" : true,
"downlinkRateLimitingBps" : "2.00 mbps"
}
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Identifier of the user traffic profile",
"type" : "string"
},
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the user traffic profile"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the user traffic profile"
},
"defaultAction" : {
"description" : "Default action",
"default" : "ALLOW",
"enum" : [ "BLOCK", "ALLOW" ]
},
"uplinkRateLimiting" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"uplinkRateLimitingEnabled" : {
"description" : "Uplink rate limiting enabled or disabled",
"type" : "boolean",
"default" : false
},
"uplinkRateLimitingBps" : {
"enum" : [ "Disable", "0.10 mbps", "0.25 mbps", "0.50 mbps", "0.75 mbps", "1.00 mbps", "1.25 mbps", "1.50 mbps", "1.75 mbps", "2.00 mbps", "2.25 mbps", "2.50 mbps", "2.75 mbps", "3.00 mbps", "3.25 mbps", "3.50 mbps", "3.75 mbps", "4.00 mbps", "4.25 mbps", "4.50 mbps", "4.75 mbps", "5.00 mbps", "5.25 mbps", "5.50 mbps", "5.75 mbps", "6.00 mbps", "6.25 mbps", "6.50 mbps", "6.75 mbps", "7.00 mbps", "7.25 mbps", "7.50 mbps", "7.75 mbps", "8.00 mbps", "8.25 mbps", "8.50 mbps", "8.75 mbps", "9.00 mbps", "9.25 mbps", "9.50 mbps", "9.75 mbps", "10.00 mbps", "10.25 mbps", "10.50 mbps", "10.75 mbps", "11.00 mbps", "11.25 mbps", "11.50 mbps", "11.75 mbps", "12.00 mbps", "12.25 mbps", "12.50 mbps", "12.75 mbps", "13.00 mbps", "13.25 mbps", "13.50 mbps", "13.75 mbps", "14.00 mbps", "14.25 mbps", "14.50 mbps", "14.75 mbps", "15.00 mbps", "15.25 mbps", "15.50 mbps", "15.75 mbps", "16.00 mbps", "16.25 mbps", "16.50 mbps", "16.75 mbps", "17.00 mbps", "17.25 mbps", "17.50 mbps", "17.75 mbps", "18.00 mbps", "18.25 mbps", "18.50 mbps", "18.75 mbps", "19.00 mbps", "19.25 mbps", "19.50 mbps", "19.75 mbps", "20.00 mbps" ],
"description" : "Uplink rate limiting"
}
},
"description" : "Uplink rate limiting"
},
"downlinkRateLimiting" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"downlinkRateLimitingEnabled" : {
"description" : "Downlink rate limiting enabled or disabled",
"type" : "boolean",
"default" : false
},
"downlinkRateLimitingBps" : {
"enum" : [ "Disable", "0.10 mbps", "0.25 mbps", "0.50 mbps", "0.75 mbps", "1.00 mbps", "1.25 mbps", "1.50 mbps", "1.75 mbps", "2.00 mbps", "2.25 mbps", "2.50 mbps", "2.75 mbps", "3.00 mbps", "3.25 mbps", "3.50 mbps", "3.75 mbps", "4.00 mbps", "4.25 mbps", "4.50 mbps", "4.75 mbps", "5.00 mbps", "5.25 mbps", "5.50 mbps", "5.75 mbps", "6.00 mbps", "6.25 mbps", "6.50 mbps", "6.75 mbps", "7.00 mbps", "7.25 mbps", "7.50 mbps", "7.75 mbps", "8.00 mbps", "8.25 mbps", "8.50 mbps", "8.75 mbps", "9.00 mbps", "9.25 mbps", "9.50 mbps", "9.75 mbps", "10.00 mbps", "10.25 mbps", "10.50 mbps", "10.75 mbps", "11.00 mbps", "11.25 mbps", "11.50 mbps", "11.75 mbps", "12.00 mbps", "12.25 mbps", "12.50 mbps", "12.75 mbps", "13.00 mbps", "13.25 mbps", "13.50 mbps", "13.75 mbps", "14.00 mbps", "14.25 mbps", "14.50 mbps", "14.75 mbps", "15.00 mbps", "15.25 mbps", "15.50 mbps", "15.75 mbps", "16.00 mbps", "16.25 mbps", "16.50 mbps", "16.75 mbps", "17.00 mbps", "17.25 mbps", "17.50 mbps", "17.75 mbps", "18.00 mbps", "18.25 mbps", "18.50 mbps", "18.75 mbps", "19.00 mbps", "19.25 mbps", "19.50 mbps", "19.75 mbps", "20.00 mbps" ],
"description" : "Downlink rate limiting"
}
},
"description" : "Downlink rate limiting"
},
"ipAclRules" : {
"type" : "array",
"description" : "Traffic access control list",
"items" : {
"type" : "object",
"description" : "Traffic access control list",
"additionalProperties" : false,
"properties" : {
"priority" : {
"type" : "integer",
"description" : "Priority"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the traffic access control rule"
},
"enableSourceIpSubnet" : {
"description" : "Source IP subnet enabled or disabled",
"type" : "boolean"
},
"sourceIp" : {
"type" : "string",
"description" : "Subnet network address or ip address of source IP."
},
"sourceIpMask" : {
"type" : "string",
"description" : "Subnet mask of source IP"
},
"enableDestinationIpSubnet" : {
"description" : "Destination IP subnet enabled or disabled",
"type" : "boolean"
},
"destinationIp" : {
"type" : "string",
"description" : "Subnet network address or ip address of destination IP."
},
"destinationIpMask" : {
"type" : "string",
"description" : "Subnet mask of destination IP"
},
"enableSourcePortRange" : {
"description" : "Source port range enabled or disabled",
"type" : "boolean"
},
"sourceMinPort" : {
"type" : "integer",
"description" : "The minunum port of source port range."
},
"sourceMaxPort" : {
"type" : "integer",
"description" : "The maxinum port of source port range."
},
"enableDestinationPortRange" : {
"description" : "Destincation port range enabled or disabled",
"type" : "boolean"
},
"destinationMinPort" : {
"type" : "integer",
"description" : "The mininum port of destination port range."
},
"destinationMaxPort" : {
"type" : "integer",
"description" : "The maxinum port of destination port range."
},
"protocol" : {
"description" : "The protocol of traffic access control.",
"enum" : [ "TCP", "UDP", "UDPLITE", "ICMP_ICMPV4", "ICMPV6", "IGMP", "ESP", "AH", "SCTP" ]
},
"action" : {
"description" : "The access of traffic access control.",
"default" : "ALLOW",
"enum" : [ "ALLOW", "BLOCK" ]
},
"direction" : {
"description" : "The direction of traffic access control.",
"default" : "UPSTREAM",
"enum" : [ "UPSTREAM" ]
}
},
"required" : [ "action", "direction" ]
}
}
}
}
Use this API command to create a new user traffic profile
{
"name" : "user-traffic-profile-name",
"description" : "User traffic profile description",
"defaultAction" : "ALLOW",
"uplinkRateLimiting" : {
"uplinkRateLimitingEnabled" : true,
"uplinkRateLimitingBps" : "2.75 mbps"
},
"downlinkRateLimiting" : {
"downlinkRateLimitingEnabled" : true,
"downlinkRateLimitingBps" : "2.00 mbps"
}
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the user traffic profile"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the user traffic profile"
},
"defaultAction" : {
"description" : "Default action",
"default" : "ALLOW",
"enum" : [ "BLOCK", "ALLOW" ]
},
"uplinkRateLimiting" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"uplinkRateLimitingEnabled" : {
"description" : "Uplink rate limiting enabled or disabled",
"type" : "boolean",
"default" : false
},
"uplinkRateLimitingBps" : {
"enum" : [ "Disable", "0.10 mbps", "0.25 mbps", "0.50 mbps", "0.75 mbps", "1.00 mbps", "1.25 mbps", "1.50 mbps", "1.75 mbps", "2.00 mbps", "2.25 mbps", "2.50 mbps", "2.75 mbps", "3.00 mbps", "3.25 mbps", "3.50 mbps", "3.75 mbps", "4.00 mbps", "4.25 mbps", "4.50 mbps", "4.75 mbps", "5.00 mbps", "5.25 mbps", "5.50 mbps", "5.75 mbps", "6.00 mbps", "6.25 mbps", "6.50 mbps", "6.75 mbps", "7.00 mbps", "7.25 mbps", "7.50 mbps", "7.75 mbps", "8.00 mbps", "8.25 mbps", "8.50 mbps", "8.75 mbps", "9.00 mbps", "9.25 mbps", "9.50 mbps", "9.75 mbps", "10.00 mbps", "10.25 mbps", "10.50 mbps", "10.75 mbps", "11.00 mbps", "11.25 mbps", "11.50 mbps", "11.75 mbps", "12.00 mbps", "12.25 mbps", "12.50 mbps", "12.75 mbps", "13.00 mbps", "13.25 mbps", "13.50 mbps", "13.75 mbps", "14.00 mbps", "14.25 mbps", "14.50 mbps", "14.75 mbps", "15.00 mbps", "15.25 mbps", "15.50 mbps", "15.75 mbps", "16.00 mbps", "16.25 mbps", "16.50 mbps", "16.75 mbps", "17.00 mbps", "17.25 mbps", "17.50 mbps", "17.75 mbps", "18.00 mbps", "18.25 mbps", "18.50 mbps", "18.75 mbps", "19.00 mbps", "19.25 mbps", "19.50 mbps", "19.75 mbps", "20.00 mbps" ],
"description" : "Uplink rate limiting"
}
},
"description" : "Uplink rate limiting"
},
"downlinkRateLimiting" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"downlinkRateLimitingEnabled" : {
"description" : "Downlink rate limiting enabled or disabled",
"type" : "boolean",
"default" : false
},
"downlinkRateLimitingBps" : {
"enum" : [ "Disable", "0.10 mbps", "0.25 mbps", "0.50 mbps", "0.75 mbps", "1.00 mbps", "1.25 mbps", "1.50 mbps", "1.75 mbps", "2.00 mbps", "2.25 mbps", "2.50 mbps", "2.75 mbps", "3.00 mbps", "3.25 mbps", "3.50 mbps", "3.75 mbps", "4.00 mbps", "4.25 mbps", "4.50 mbps", "4.75 mbps", "5.00 mbps", "5.25 mbps", "5.50 mbps", "5.75 mbps", "6.00 mbps", "6.25 mbps", "6.50 mbps", "6.75 mbps", "7.00 mbps", "7.25 mbps", "7.50 mbps", "7.75 mbps", "8.00 mbps", "8.25 mbps", "8.50 mbps", "8.75 mbps", "9.00 mbps", "9.25 mbps", "9.50 mbps", "9.75 mbps", "10.00 mbps", "10.25 mbps", "10.50 mbps", "10.75 mbps", "11.00 mbps", "11.25 mbps", "11.50 mbps", "11.75 mbps", "12.00 mbps", "12.25 mbps", "12.50 mbps", "12.75 mbps", "13.00 mbps", "13.25 mbps", "13.50 mbps", "13.75 mbps", "14.00 mbps", "14.25 mbps", "14.50 mbps", "14.75 mbps", "15.00 mbps", "15.25 mbps", "15.50 mbps", "15.75 mbps", "16.00 mbps", "16.25 mbps", "16.50 mbps", "16.75 mbps", "17.00 mbps", "17.25 mbps", "17.50 mbps", "17.75 mbps", "18.00 mbps", "18.25 mbps", "18.50 mbps", "18.75 mbps", "19.00 mbps", "19.25 mbps", "19.50 mbps", "19.75 mbps", "20.00 mbps" ],
"description" : "Downlink rate limiting"
}
},
"description" : "Downlink rate limiting"
}
},
"required" : [ "name", "defaultAction" ]
}
201
ShowHide{
"id" : "profileUUID"
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
}
}
}
Use this API command to modify the basic information of user traffic profile
{
"name" : "new-user-traffic-profile-name",
"description" : "user traffic profile description",
"defaultAction" : "ALLOW"
}
{
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the user traffic profile"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the user traffic profile"
},
"defaultAction" : {
"description" : "Default action",
"default" : "ALLOW",
"enum" : [ "BLOCK", "ALLOW" ]
}
}
204
Use this API command to modify IP ACL rules of user traffic profile
[ {
"priority" : 3,
"description" : "acl rule description",
"enableSourceIpSubnet" : true,
"sourceIp" : "172.17.26.55",
"sourceIpMask" : "255.255.255.0",
"enableSourcePortRange" : false,
"sourceMinPort" : 101,
"enableDestinationPortRange" : false,
"destinationIp" : "172.17.26.60",
"destinationIpMask" : "255.255.0.0",
"protocol" : "TCP",
"action" : "ALLOW",
"direction" : "UPSTREAM"
}, {
"priority" : 4,
"description" : "acl rule description",
"enableSourceIpSubnet" : true,
"sourceIp" : "255.17.26.87",
"sourceIpMask" : "255.255.255.0",
"destinationIp" : "172.17.26.69",
"destinationIpMask" : "255.255.0.0",
"protocol" : "UDP",
"action" : "BLOCK",
"direction" : "UPSTREAM"
} ]
{
"type" : "array",
"description" : "Traffic access control list",
"items" : {
"type" : "object",
"description" : "Traffic access control list",
"additionalProperties" : false,
"properties" : {
"priority" : {
"type" : "integer",
"description" : "Priority"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the traffic access control rule"
},
"enableSourceIpSubnet" : {
"description" : "Source IP subnet enabled or disabled",
"type" : "boolean"
},
"sourceIp" : {
"type" : "string",
"description" : "Subnet network address or ip address of source IP."
},
"sourceIpMask" : {
"type" : "string",
"description" : "Subnet mask of source IP"
},
"enableDestinationIpSubnet" : {
"description" : "Destination IP subnet enabled or disabled",
"type" : "boolean"
},
"destinationIp" : {
"type" : "string",
"description" : "Subnet network address or ip address of destination IP."
},
"destinationIpMask" : {
"type" : "string",
"description" : "Subnet mask of destination IP"
},
"enableSourcePortRange" : {
"description" : "Source port range enabled or disabled",
"type" : "boolean"
},
"sourceMinPort" : {
"type" : "integer",
"description" : "The minunum port of source port range."
},
"sourceMaxPort" : {
"type" : "integer",
"description" : "The maxinum port of source port range."
},
"enableDestinationPortRange" : {
"description" : "Destincation port range enabled or disabled",
"type" : "boolean"
},
"destinationMinPort" : {
"type" : "integer",
"description" : "The mininum port of destination port range."
},
"destinationMaxPort" : {
"type" : "integer",
"description" : "The maxinum port of destination port range."
},
"protocol" : {
"description" : "The protocol of traffic access control.",
"enum" : [ "TCP", "UDP", "UDPLITE", "ICMP_ICMPV4", "ICMPV6", "IGMP", "ESP", "AH", "SCTP" ]
},
"action" : {
"description" : "The access of traffic access control.",
"default" : "ALLOW",
"enum" : [ "ALLOW", "BLOCK" ]
},
"direction" : {
"description" : "The direction of traffic access control.",
"default" : "UPSTREAM",
"enum" : [ "UPSTREAM" ]
}
},
"required" : [ "action", "direction" ]
}
}
204
Use this API command to modify uplink rate limiting of user traffic profile
{
"uplinkRateLimitingEnabled" : true,
"uplinkRateLimitingBps" : "0.10 mbps"
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"uplinkRateLimitingEnabled" : {
"description" : "Uplink rate limiting enabled or disabled",
"type" : "boolean",
"default" : false
},
"uplinkRateLimitingBps" : {
"enum" : [ "Disable", "0.10 mbps", "0.25 mbps", "0.50 mbps", "0.75 mbps", "1.00 mbps", "1.25 mbps", "1.50 mbps", "1.75 mbps", "2.00 mbps", "2.25 mbps", "2.50 mbps", "2.75 mbps", "3.00 mbps", "3.25 mbps", "3.50 mbps", "3.75 mbps", "4.00 mbps", "4.25 mbps", "4.50 mbps", "4.75 mbps", "5.00 mbps", "5.25 mbps", "5.50 mbps", "5.75 mbps", "6.00 mbps", "6.25 mbps", "6.50 mbps", "6.75 mbps", "7.00 mbps", "7.25 mbps", "7.50 mbps", "7.75 mbps", "8.00 mbps", "8.25 mbps", "8.50 mbps", "8.75 mbps", "9.00 mbps", "9.25 mbps", "9.50 mbps", "9.75 mbps", "10.00 mbps", "10.25 mbps", "10.50 mbps", "10.75 mbps", "11.00 mbps", "11.25 mbps", "11.50 mbps", "11.75 mbps", "12.00 mbps", "12.25 mbps", "12.50 mbps", "12.75 mbps", "13.00 mbps", "13.25 mbps", "13.50 mbps", "13.75 mbps", "14.00 mbps", "14.25 mbps", "14.50 mbps", "14.75 mbps", "15.00 mbps", "15.25 mbps", "15.50 mbps", "15.75 mbps", "16.00 mbps", "16.25 mbps", "16.50 mbps", "16.75 mbps", "17.00 mbps", "17.25 mbps", "17.50 mbps", "17.75 mbps", "18.00 mbps", "18.25 mbps", "18.50 mbps", "18.75 mbps", "19.00 mbps", "19.25 mbps", "19.50 mbps", "19.75 mbps", "20.00 mbps" ],
"description" : "Uplink rate limiting"
}
},
"description" : "Uplink rate limiting"
}
204
Use this API command to disable uplink rateLimiting of user traffic profile
204
Use this API command to modify downlink rate limiting of user traffic profile
{
"downlinkRateLimitingEnabled" : true,
"downlinkRateLimitingBps" : "0.10 mbps"
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"downlinkRateLimitingEnabled" : {
"description" : "Downlink rate limiting enabled or disabled",
"type" : "boolean",
"default" : false
},
"downlinkRateLimitingBps" : {
"enum" : [ "Disable", "0.10 mbps", "0.25 mbps", "0.50 mbps", "0.75 mbps", "1.00 mbps", "1.25 mbps", "1.50 mbps", "1.75 mbps", "2.00 mbps", "2.25 mbps", "2.50 mbps", "2.75 mbps", "3.00 mbps", "3.25 mbps", "3.50 mbps", "3.75 mbps", "4.00 mbps", "4.25 mbps", "4.50 mbps", "4.75 mbps", "5.00 mbps", "5.25 mbps", "5.50 mbps", "5.75 mbps", "6.00 mbps", "6.25 mbps", "6.50 mbps", "6.75 mbps", "7.00 mbps", "7.25 mbps", "7.50 mbps", "7.75 mbps", "8.00 mbps", "8.25 mbps", "8.50 mbps", "8.75 mbps", "9.00 mbps", "9.25 mbps", "9.50 mbps", "9.75 mbps", "10.00 mbps", "10.25 mbps", "10.50 mbps", "10.75 mbps", "11.00 mbps", "11.25 mbps", "11.50 mbps", "11.75 mbps", "12.00 mbps", "12.25 mbps", "12.50 mbps", "12.75 mbps", "13.00 mbps", "13.25 mbps", "13.50 mbps", "13.75 mbps", "14.00 mbps", "14.25 mbps", "14.50 mbps", "14.75 mbps", "15.00 mbps", "15.25 mbps", "15.50 mbps", "15.75 mbps", "16.00 mbps", "16.25 mbps", "16.50 mbps", "16.75 mbps", "17.00 mbps", "17.25 mbps", "17.50 mbps", "17.75 mbps", "18.00 mbps", "18.25 mbps", "18.50 mbps", "18.75 mbps", "19.00 mbps", "19.25 mbps", "19.50 mbps", "19.75 mbps", "20.00 mbps" ],
"description" : "Downlink rate limiting"
}
},
"description" : "Downlink rate limiting"
}
204
Use this API command to disable downlink rate limiting of user traffic profile
204
Use this API command to delete an user traffic profile
204
Use this API command to retrieve a list of Hotspot(WISPr) of a zone.
200
ShowHide{
"totalCount" : 9,
"hasMore" : false,
"firstIndex" : 0,
"list" : [ {
"id" : "c5dfc930-75dc-11e4-8d56-00606eb0c700",
"name" : "protalName1"
}, {
"id" : "15efd160-7153-11e4-aa08-00606eb0c700",
"name" : "protalName2"
}, {
"id" : "be0f0480-73a9-11e4-9d1d-f0def13d5845",
"name" : "protalName3"
}, {
"id" : "7f0eef00-7423-11e4-bcef-000c299b4765",
"name" : "protalName4"
}, {
"id" : "4f5c98a0-7123-11e4-bcef-000c299b4765",
"name" : "protalName5"
}, {
"id" : "4a023ce0-73ab-11e4-b211-f0def13d5845",
"name" : "protalName6"
}, {
"id" : "afebbc80-73be-11e4-bfde-f0def13d5845",
"name" : "protalName7"
}, {
"id" : "76f4c020-7620-11e4-b8b9-00606eb0c700",
"name" : "protalName8"
}, {
"id" : "96308310-752c-11e4-8276-00606eb0c700",
"name" : "protalName9"
} ]
}
{
"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" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the service"
}
}
}
}
}
}
Use this API command to retrieve a Hotspot(WISPr) of zone.
200
ShowHide{
"name" : "test-hotspot222",
"id" : "3e5b3782-6f1a-42bf-9812-95d2c1df2451",
"description" : "description",
"smartClientSupport" : "None",
"smartClientInfo" : null,
"portalType" : "Internal",
"portalUrl" : 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"
}
{
"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" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the Hotspot"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the Hotspot"
},
"smartClientSupport" : {
"description" : "Smart client support of the Hotspot",
"enum" : [ "None", "Enabled", "SmartClientOnly" ]
},
"smartClientInfo" : {
"description" : "Smart client info of the Hotspot",
"type" : "string"
},
"portalType" : {
"description" : "Portal type of the Hotspot",
"enum" : [ "Internal", "External" ]
},
"portalUrl" : {
"type" : "string",
"description" : "Portal URL of the Hotspot"
},
"location" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Portal location id",
"type" : "string"
},
"name" : {
"description" : "Portal location name",
"type" : "string"
}
},
"description" : "Location of the Hotspot"
},
"redirect" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"url" : {
"type" : "string",
"description" : "Portal redirect URL"
}
},
"description" : "Redirect configuration of the Hotspot"
},
"portalCustomization" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"language" : {
"description" : "Language",
"default" : "en_US",
"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" ],
"description" : "Portal customization of the guest access profile"
},
"userSession" : {
"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
}
},
"description" : "User session of the Hotspot"
},
"walledGardens" : {
"description" : "Walled garden map set of the Hotspot",
"type" : "array",
"items" : {
"type" : "string"
}
},
"macAddressFormat" : {
"description" : "mac address format of redirection",
"type" : "integer",
"default" : 2,
"minimum" : 0,
"maximum" : 5
}
}
}
Use this API command to create a new Hotspot(WISPr) with internal logon URL of a zone.MacAddressFormat : 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)
{
"name" : "test-hotspot222",
"description" : "description",
"smartClientSupport" : "None",
"portalUrl" : "https://172.17.26.59",
"location" : {
"id" : "locationId",
"name" : "locationName"
},
"macAddressFormat" : 2,
"walledGardens" : [ "10.11.12.16", "10.11.12.13" ]
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the Hotspot"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the Hotspot"
},
"smartClientSupport" : {
"description" : "Smart client support of the Hotspot",
"enum" : [ "None", "Enabled" ]
},
"location" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Portal location id",
"type" : "string"
},
"name" : {
"description" : "Portal location name",
"type" : "string"
}
},
"description" : "Location of the Hotspot"
},
"redirect" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"url" : {
"type" : "string",
"description" : "Portal redirect URL"
}
},
"description" : "Redirect configuration of the Hotspot"
},
"userSession" : {
"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
}
},
"description" : "User session of the Hotspot"
},
"walledGardens" : {
"description" : "Walled garden map set of the Hotspot",
"type" : "array",
"items" : {
"type" : "string"
}
},
"macAddressFormat" : {
"description" : "mac address format of redirection",
"type" : "integer",
"default" : 2,
"minimum" : 0,
"maximum" : 5
}
},
"required" : [ "name", "smartClientSupport", "macAddressFormat" ]
}
201
ShowHide{
"id" : "76f4c020-7620-11e4-b8b9-00606eb0c700"
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Identifier of the created portal profile",
"type" : "string"
}
}
}
Use this API command to create a new Hotspot(WISPr) with external logon URL of a zone.MacAddressFormat : 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)
{
"name" : "test-hotspot222",
"description" : "description",
"smartClientSupport" : "None",
"portalUrl" : "https://172.17.26.59",
"location" : {
"id" : "locationId",
"name" : "locationName"
},
"macAddressFormat" : 2,
"walledGardens" : [ "10.11.12.16", "10.11.12.13" ]
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the Hotspot"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the Hotspot"
},
"smartClientSupport" : {
"description" : "Smart client support of the Hotspot",
"enum" : [ "None", "Enabled" ]
},
"portalUrl" : {
"type" : "string",
"description" : "Portal URL of the Hotspot"
},
"location" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Portal location id",
"type" : "string"
},
"name" : {
"description" : "Portal location name",
"type" : "string"
}
},
"description" : "Location of the hotspot"
},
"redirect" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"url" : {
"type" : "string",
"description" : "Portal redirect URL"
}
},
"description" : "Redirect configuration of the Hotspot"
},
"userSession" : {
"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
}
},
"description" : "User session of the Hotspot"
},
"walledGardens" : {
"description" : "Walled garden map set of the Hotspot",
"type" : "array",
"items" : {
"type" : "string"
}
},
"macAddressFormat" : {
"description" : "mac address format of redirection",
"type" : "integer",
"default" : 2,
"minimum" : 0,
"maximum" : 5
}
},
"required" : [ "name", "smartClientSupport", "portalUrl", "macAddressFormat" ]
}
201
ShowHide{
"id" : "76f4c020-7620-11e4-b8b9-00606eb0c700"
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Identifier of the created portal profile",
"type" : "string"
}
}
}
Use this API command to create a new Hotspot(WISPr) with smart client only of a zone.MacAddressFormat : 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)
{
"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" ]
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the Hotspot"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the Hotspot"
},
"smartClientInfo" : {
"description" : "Smart client info of the Hotspot",
"type" : "string"
},
"location" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Portal location id",
"type" : "string"
},
"name" : {
"description" : "Portal location name",
"type" : "string"
}
},
"description" : "Location of the Hotspot"
},
"redirect" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"url" : {
"type" : "string",
"description" : "Portal redirect URL"
}
},
"description" : "Redirect configuration of the Hotspot"
},
"userSession" : {
"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
}
},
"description" : "Redirect configuration of the Hotspot profile"
},
"walledGardens" : {
"description" : "Walled garden map set of the Hotspot",
"type" : "array",
"items" : {
"type" : "string"
}
},
"macAddressFormat" : {
"description" : "mac address format of redirection",
"type" : "integer",
"default" : 2,
"minimum" : 0,
"maximum" : 5
}
},
"required" : [ "name", "smartClientInfo", "macAddressFormat" ]
}
201
ShowHide{
"id" : "76f4c020-7620-11e4-b8b9-00606eb0c700"
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Identifier of the created portal profile",
"type" : "string"
}
}
}
Use this API command to modify the basic information on Hotspot(WISPr) of a zone.MacAddressFormat : 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)
{
"name" : "test-hotspot-modify",
"description" : "description-modify",
"smartClientSupport" : "Enabled",
"portalUrl" : "https://172.17.26.59",
"macAddressFormat" : 2
}
{
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the Hotspot"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the Hotspot"
},
"smartClientSupport" : {
"description" : "Smart client support of the Hotspot",
"enum" : [ "None", "Enabled" ]
},
"smartClientInfo" : {
"description" : "Smart client info of the Hotspot",
"type" : "string"
},
"portalUrl" : {
"type" : "string",
"description" : "Portal URL of the Hotspot"
},
"macAddressFormat" : {
"description" : "mac address format of redirection",
"type" : "integer",
"default" : 2,
"minimum" : 0,
"maximum" : 5
}
}
204
Use this API command to modify the redirect information on Hotspot(WISPr) of a zone.
{
"url" : "https://www.testurl.com"
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"url" : {
"type" : "string",
"description" : "Portal redirect URL"
}
},
"description" : "Redirect configuration of the Hotspot"
}
204
Use this API command to modify portal customization on Hotspot(WISPr) of a zone.
{
"language" : "en_US",
"title" : "Ruckus Wireless - Subscriber Portal",
"logo" : "logo",
"termsAndConditionsRequired" : false
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"language" : {
"description" : "Language",
"default" : "en_US",
"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" ],
"description" : "Portal customization of the guest access profile"
}
204
Use this API command to modify the location information on Hotspot(WISPr) of a zone.
{
"id" : "locationId",
"name" : "locationName"
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Portal location id",
"type" : "string"
},
"name" : {
"description" : "Portal location name",
"type" : "string"
}
},
"description" : "Location of the Hotspot"
}
204
Use this API command to modify walled gardens on Hotspot(WISPr) of a zone.
[ "10.1.1.1", "11.11.111.11" ]
{
"description" : "Walled garden map set of the Hotspot",
"type" : "array",
"items" : {
"type" : "string"
}
}
204
Use this API command to delete a Hotspot(WISPr) of a zone.
204
Use this API command to retrieve a list of Hotspot 2.0 WLAN profiles of a zone.
200
ShowHide{
"totalCount" : 9,
"hasMore" : false,
"firstIndex" : 0,
"list" : [ {
"id" : "c5dfc930-75dc-11e4-8d56-00606eb0c700",
"name" : "protalName1"
}, {
"id" : "15efd160-7153-11e4-aa08-00606eb0c700",
"name" : "protalName2"
}, {
"id" : "be0f0480-73a9-11e4-9d1d-f0def13d5845",
"name" : "protalName3"
}, {
"id" : "7f0eef00-7423-11e4-bcef-000c299b4765",
"name" : "protalName4"
}, {
"id" : "4f5c98a0-7123-11e4-bcef-000c299b4765",
"name" : "protalName5"
}, {
"id" : "4a023ce0-73ab-11e4-b211-f0def13d5845",
"name" : "protalName6"
}, {
"id" : "afebbc80-73be-11e4-bfde-f0def13d5845",
"name" : "protalName7"
}, {
"id" : "76f4c020-7620-11e4-b8b9-00606eb0c700",
"name" : "protalName8"
}, {
"id" : "96308310-752c-11e4-8276-00606eb0c700",
"name" : "protalName9"
} ]
}
{
"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" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the service"
}
}
}
}
}
}
Use this API command to retrieve a Hotspot 2.0 WLAN profile of a zone.
200
ShowHide{
"id" : "b6af6e80-8409-11e4-a4e7-80fa5b024259",
"name" : "test-hs20Wlan",
"description" : "test-hs20Wlan-desc",
"operator" : {
"id" : "e6373c40-8194-11e4-aa2e-000c299b4765",
"name" : "operatorTEST"
},
"identityProviders" : [ {
"id" : "9eec1055-45dd-45c5-a631-f1b76530bb67",
"name" : "identityProviderDisabled"
}, {
"id" : "5fc11810-c8bd-4876-9acf-356a1f4727a3",
"name" : "identityProviderEnabled"
} ],
"defaultIdentityProvider" : {
"id" : "5fc11810-c8bd-4876-9acf-356a1f4727a3",
"name" : "identityProviderEnabled"
},
"signupSsid" : {
"id" : "1",
"name" : "osenWlan"
},
"internetOption" : true,
"accessNetworkType" : "FREE_PUBLIC",
"ipv4AddressType" : "UNAVAILABLE",
"ipv6AddressType" : "UNAVAILABLE",
"connectionCapabilities" : [ {
"protocolName" : "ICMP",
"protocolNumber" : 1,
"portNumber" : 0,
"status" : "OPEN"
}, {
"protocolName" : "FTP",
"protocolNumber" : 6,
"portNumber" : 20,
"status" : "OPEN"
}, {
"protocolName" : "SSH",
"protocolNumber" : 6,
"portNumber" : 22,
"status" : "CLOSED"
}, {
"protocolName" : "HTTP",
"protocolNumber" : 6,
"portNumber" : 80,
"status" : "CLOSED"
}, {
"protocolName" : "Used by TLS VPN",
"protocolNumber" : 6,
"portNumber" : 443,
"status" : "CLOSED"
}, {
"protocolName" : "Used by PPTP VPNs",
"protocolNumber" : 6,
"portNumber" : 1723,
"status" : "CLOSED"
}, {
"protocolName" : "VoIP",
"protocolNumber" : 6,
"portNumber" : 5060,
"status" : "CLOSED"
}, {
"protocolName" : "VoIP",
"protocolNumber" : 17,
"portNumber" : 5060,
"status" : "CLOSED"
}, {
"protocolName" : "Used by IKEv2(IPSec VPN)",
"protocolNumber" : 17,
"portNumber" : 500,
"status" : "CLOSED"
}, {
"protocolName" : "IPSec VPN",
"protocolNumber" : 17,
"portNumber" : 4500,
"status" : "CLOSED"
}, {
"protocolName" : "ESP",
"protocolNumber" : 50,
"portNumber" : 0,
"status" : "CLOSED"
} ],
"customConnectionCapabilities" : [ {
"protocolName" : "ICMP",
"protocolNumber" : 2,
"portNumber" : 0,
"status" : "OPEN"
}, {
"protocolName" : "FTP",
"protocolNumber" : 2,
"portNumber" : 20,
"status" : "OPEN"
} ]
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Identifier of the Hotspot 2.0 WLAN profile",
"type" : "string"
},
"zoneId" : {
"description" : "Identifier of the zone which the Hotspot 2.0 WLAN profile belongs to",
"type" : "string"
},
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the Hotspot 2.0 WLAN profile"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the Hotspot 2.0 WLAN profile"
},
"operator" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
},
"description" : "Operator of the Hotspot 2.0 WLAN profile"
},
"identityProviders" : {
"description" : "Identity providers of the Hotspot 2.0 WLAN profile",
"type" : "array",
"items" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
}
},
"defaultIdentityProvider" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
},
"description" : "Default identity provider of the Hotspot 2.0 WLAN profile"
},
"signupSsid" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
},
"description" : "Signup SSID of the Hotspot 2.0 WLAN profile"
},
"internetOption" : {
"description" : "Internet option of the Hotspot 2.0 WLAN profile",
"type" : "boolean"
},
"accessNetworkType" : {
"description" : "Access network type of the Hotspot 2.0 WLAN profile",
"enum" : [ "CHARGEABLE_PUBLIC", "FREE_PUBLIC", "PERSONAL_DEVICE", "PRIVATE", "PRIVATE_WITH_GUEST", "TEST", "WILDCARD" ]
},
"ipv4AddressType" : {
"description" : "IPv4 address type of the v WLAN profile",
"enum" : [ "UNAVAILABLE", "PUBLIC", "PORT_RESTRICTED", "SINGLE_NATED_PRIVATE", "DOUBLE_NATED_PRIVATE", "PORT_RESTRICTED_AND_SINGLE_NATED", "PORT_RESTRICTED_AND_DOUBLE_NATED", "UNKNOWN" ]
},
"ipv6AddressType" : {
"description" : "IPv6 address type of the Hotspot 2.0 WLAN profile",
"enum" : [ "UNAVAILABLE", "AVAILABLE", "UNKNOWN" ]
},
"connectionCapabilities" : {
"description" : "Default connection capabilities of the Hotspot 2.0 WLAN profile",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"protocolName" : {
"description" : "Protocol aame of connection capability, cannot be modified",
"type" : "string",
"pattern" : "^[!-~]([ -~]){0,31}$"
},
"protocolNumber" : {
"description" : "Protocol number of connection capability, cannot be modified",
"type" : "number",
"minimum" : 0,
"maximum" : 254
},
"portNumber" : {
"description" : "Port number of connection capability, cannot be modified",
"type" : "number",
"minimum" : 0,
"maximum" : 65535
},
"status" : {
"description" : "Status of connection capability",
"enum" : [ "CLOSED", "OPEN", "UNKNOWN" ]
}
},
"required" : [ "protocolName", "protocolNumber", "portNumber", "status" ]
}
},
"customConnectionCapabilities" : {
"description" : "Custom connection capabilities of the Hotspot 2.0 WLAN profile",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"protocolName" : {
"description" : "Protocol aame of connection capability",
"type" : "string",
"pattern" : "^[!-~]([ -~]){0,31}$"
},
"protocolNumber" : {
"description" : "Protocol number of connection capability",
"type" : "number",
"minimum" : 0,
"maximum" : 254
},
"portNumber" : {
"description" : "Port number of connection capability",
"type" : "number",
"minimum" : 0,
"maximum" : 65535
},
"status" : {
"description" : "Status of connection capability",
"enum" : [ "CLOSED", "OPEN", "UNKNOWN" ]
}
},
"required" : [ "protocolName", "protocolNumber", "portNumber", "status" ]
}
}
}
}
Use this API command to create a new Hotspot 2.0 WLAN profile of a zone.
{
"name" : "hotspot20WlanCreate",
"description" : "hotspot20 Wlan profile Create desc",
"operator" : {
"id" : "e6373c40-8194-11e4-aa2e-000c299b4765",
"name" : "operatorTEST"
},
"identityProviders" : [ {
"id" : "9eec1055-45dd-45c5-a631-f1b76530bb67",
"name" : "identityProviderDisabled"
}, {
"id" : "5fc11810-c8bd-4876-9acf-356a1f4727a3",
"name" : "identityProviderEnabled"
} ],
"defaultIdentityProvider" : {
"id" : "5fc11810-c8bd-4876-9acf-356a1f4727a3",
"name" : "identityProviderEnabled"
},
"signupSsid" : {
"id" : "1",
"name" : "osenWlan"
},
"internetOption" : true,
"accessNetworkType" : "CHARGEABLE_PUBLIC",
"ipv4AddressType" : "UNAVAILABLE",
"ipv6AddressType" : "UNAVAILABLE"
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the Hotspot 2.0 WLAN profile"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the Hotspot 2.0 WLAN profile"
},
"operator" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
},
"description" : "Operator of the Hotspot 2.0 WLAN profile"
},
"identityProviders" : {
"description" : "Ddentity providers of the Hotspot 2.0 WLAN profile",
"type" : "array",
"items" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
}
},
"defaultIdentityProvider" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
},
"description" : "Default identity provider of the Hotspot 2.0 WLAN profile"
},
"signupSsid" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
},
"description" : "Signup SSID of the Hotspot 2.0 WLAN profile"
},
"internetOption" : {
"description" : "Internet option of the Hotspot 2.0 WLAN profile",
"type" : "boolean"
},
"accessNetworkType" : {
"description" : "Access network type of the Hotspot 2.0 WLAN profile",
"enum" : [ "CHARGEABLE_PUBLIC", "FREE_PUBLIC", "PERSONAL_DEVICE", "PRIVATE", "PRIVATE_WITH_GUEST", "TEST", "WILDCARD" ]
},
"ipv4AddressType" : {
"description" : "IPv4 address type of the Hotspot 2.0 WLAN profile",
"enum" : [ "UNAVAILABLE", "PUBLIC", "PORT_RESTRICTED", "SINGLE_NATED_PRIVATE", "DOUBLE_NATED_PRIVATE", "PORT_RESTRICTED_AND_SINGLE_NATED", "PORT_RESTRICTED_AND_DOUBLE_NATED", "UNKNOWN" ]
},
"ipv6AddressType" : {
"description" : "IPv6 address type of the Hotspot 2.0 WLAN profile",
"enum" : [ "UNAVAILABLE", "AVAILABLE", "UNKNOWN" ]
}
},
"required" : [ "name", "operator", "defaultIdentityProvider", "internetOption", "accessNetworkType", "ipv4AddressType", "ipv6AddressType" ]
}
201
ShowHide{
"id" : "76f4c020-7620-11e4-b8b9-00606eb0c700"
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Identifier of the created portal profile",
"type" : "string"
}
}
}
Use this API command to modify the basic information on Hotspot 2.0 WLAN profile of a zone.
{
"name" : "hotspot20WlanProfilePath",
"description" : "hotspot20 wlan profile pathc desc",
"internetOption" : true,
"accessNetworkType" : "CHARGEABLE_PUBLIC",
"ipv4AddressType" : "UNAVAILABLE",
"ipv6AddressType" : "UNAVAILABLE"
}
{
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the Hotspot 2.0 WLAN profile"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the Hotspot 2.0 WLAN profile"
},
"internetOption" : {
"description" : "Internet option of the Hotspot 2.0 WLAN profile",
"type" : "boolean"
},
"accessNetworkType" : {
"description" : "Access network type of the Hotspot 2.0 WLAN profile",
"enum" : [ "CHARGEABLE_PUBLIC", "FREE_PUBLIC", "PERSONAL_DEVICE", "PRIVATE", "PRIVATE_WITH_GUEST", "TEST", "WILDCARD" ]
},
"ipv4AddressType" : {
"description" : "IPv4 address type of the Hotspot 2.0 Wlan profile",
"enum" : [ "UNAVAILABLE", "PUBLIC", "PORT_RESTRICTED", "SINGLE_NATED_PRIVATE", "DOUBLE_NATED_PRIVATE", "PORT_RESTRICTED_AND_SINGLE_NATED", "PORT_RESTRICTED_AND_DOUBLE_NATED", "UNKNOWN" ]
},
"ipv6AddressType" : {
"description" : "IPv6 address type of the Hotspot 2.0 Wlan profile",
"enum" : [ "UNAVAILABLE", "AVAILABLE", "UNKNOWN" ]
}
}
204
Use this API command to modify operator profile on Hotspot 2.0 WLAN profile of a zone.
{
"id" : "e6373c40-8194-11e4-aa2e-000c299b4765",
"name" : "operatorTEST"
}
{
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
},
"description" : "Operator of the Hotspot 2.0 WLAN profile"
}
204
Use this API command to modify identity provider profiles on Hotspot 2.0 WLAN profile of a zone.
[ {
"id" : "9eec1055-45dd-45c5-a631-f1b76530bb67",
"name" : "identityProviderDisabled"
}, {
"id" : "5fc11810-c8bd-4876-9acf-356a1f4727a3",
"name" : "identityProviderEnabled"
} ]
{
"description" : "Identity providers of the Hotspot 2.0 WLAN profile",
"type" : "array",
"items" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
}
}
204
Use this API command to modify the default identity provider profile on Hotspot 2.0 WLAN profile of a zone.
{
"id" : "5fc11810-c8bd-4876-9acf-356a1f4727a3",
"name" : "identityProviderEnabled"
}
{
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
},
"description" : "Default identity provider of the Hotspot 2.0 WLAN profile"
}
204
Use this API command to modify signup SSID on Hotspot 2.0 WLAN profile of a zone.
{
"id" : "1",
"name" : "osenWlan"
}
{
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
},
"description" : "Signup SSID of the Hotspot 2.0 WLAN profile"
}
204
Use this API command to modify connection capabilities on Hotspot 2.0 WLAN profile of a zone.
[ {
"protocolName" : "ICMP",
"protocolNumber" : 1,
"portNumber" : 0,
"status" : "OPEN"
}, {
"protocolName" : "FTP",
"protocolNumber" : 6,
"portNumber" : 20,
"status" : "OPEN"
}, {
"protocolName" : "SSH",
"protocolNumber" : 6,
"portNumber" : 22,
"status" : "UNKNOWN"
}, {
"protocolName" : "HTTP",
"protocolNumber" : 6,
"portNumber" : 80,
"status" : "CLOSED"
}, {
"protocolName" : "Used by TLS VPN",
"protocolNumber" : 6,
"portNumber" : 443,
"status" : "CLOSED"
}, {
"protocolName" : "Used by PPTP VPNs",
"protocolNumber" : 6,
"portNumber" : 1723,
"status" : "CLOSED"
}, {
"protocolName" : "VoIP",
"protocolNumber" : 6,
"portNumber" : 5060,
"status" : "CLOSED"
}, {
"protocolName" : "VoIP",
"protocolNumber" : 17,
"portNumber" : 5060,
"status" : "CLOSED"
}, {
"protocolName" : "Used by IKEv2(IPSec VPN)",
"protocolNumber" : 17,
"portNumber" : 500,
"status" : "CLOSED"
}, {
"protocolName" : "IPSec VPN",
"protocolNumber" : 17,
"portNumber" : 4500,
"status" : "CLOSED"
}, {
"protocolName" : "ESP",
"protocolNumber" : 50,
"portNumber" : 0,
"status" : "CLOSED"
} ]
{
"description" : "Default connection capabilities of the Hotspot 2.0 WLAN profile",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"protocolName" : {
"description" : "Protocol aame of connection capability, cannot be modified",
"type" : "string",
"pattern" : "^[!-~]([ -~]){0,31}$"
},
"protocolNumber" : {
"description" : "Protocol number of connection capability, cannot be modified",
"type" : "number",
"minimum" : 0,
"maximum" : 254
},
"portNumber" : {
"description" : "Port number of connection capability, cannot be modified",
"type" : "number",
"minimum" : 0,
"maximum" : 65535
},
"status" : {
"description" : "Status of connection capability",
"enum" : [ "CLOSED", "OPEN", "UNKNOWN" ]
}
},
"required" : [ "protocolName", "protocolNumber", "portNumber", "status" ]
}
}
204
Use this API command to modify custom connection capabilities on Hotspot 2.0 WLAN profile of a zone.
[ {
"protocolName" : "ICMP",
"protocolNumber" : 2,
"portNumber" : 0,
"status" : "OPEN"
}, {
"protocolName" : "FTP",
"protocolNumber" : 2,
"portNumber" : 20,
"status" : "OPEN"
} ]
{
"description" : "Custom connection capabilities of the Hotspot 2.0 WLAN profile",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"protocolName" : {
"description" : "Protocol aame of connection capability",
"type" : "string",
"pattern" : "^[!-~]([ -~]){0,31}$"
},
"protocolNumber" : {
"description" : "Protocol number of connection capability",
"type" : "number",
"minimum" : 0,
"maximum" : 254
},
"portNumber" : {
"description" : "Port number of connection capability",
"type" : "number",
"minimum" : 0,
"maximum" : 65535
},
"status" : {
"description" : "Status of connection capability",
"enum" : [ "CLOSED", "OPEN", "UNKNOWN" ]
}
},
"required" : [ "protocolName", "protocolNumber", "portNumber", "status" ]
}
}
204
Use this API command to delete a Hotspot 2.0 WLAN Profile of a zone.
204
Use this API command to retrieve a list of RADIUS authentication services.
200
ShowHide{
"totalCount" : 1,
"hasMore" : false,
"firstIndex" : 0,
"list" : [ {
"id" : "82109ce0-64e6-11e4-8916-0026b9f85aaf",
"mvnoId" : "839f87c6-d116-497e-afce-aa8157abd30c",
"name" : "rapheal-auth-x3",
"friendlyName" : "rapheal-auth-x",
"description" : "authentication service created by rapheal via public API",
"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"
}
}
} ],
"primary" : {
"ip" : "1.1.1.155",
"port" : 1812,
"sharedSecret" : "abc"
},
"secondary" : {
"ip" : "2.2.2.231",
"port" : 1812,
"sharedSecret" : "abc"
},
"healthCheckPolicy" : {
"responseWindow" : 20,
"reviveInterval" : 120,
"zombiePeriod" : 40
},
"rateLimiting" : {
"maxOutstandingRequestsPerServer" : 0,
"threshold" : 0,
"sanityTimer" : 10
}
} ]
}
{
"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 authentication service",
"type" : "string"
},
"mvnoId" : {
"description" : "Tenant UUID",
"type" : "string"
},
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the RADIUS authentication service"
},
"friendlyName" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Friendly name of the RADIUS authentication service"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the RADIUS authentication service"
},
"locationDeliveryEnabled" : {
"description" : "RFC5580 out of band location delivery support(for Ruckus AP only)",
"type" : "boolean",
"default" : false
},
"primary" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"ip" : {
"type" : "string",
"description" : "Server IP"
},
"port" : {
"description" : "Server port",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
},
"sharedSecret" : {
"description" : "Server shared secrect",
"type" : "string"
}
},
"required" : [ "ip", "port", "sharedSecret" ],
"description" : "Primary RADIUS server"
},
"secondary" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"autoFallbackDisable" : {
"descriptin" : "Automatic fallback enabled or disabled",
"type" : "boolean"
},
"ip" : {
"type" : "string",
"description" : "RADIUS server IP"
},
"port" : {
"description" : "RADIUS server port",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535,
"default" : 1812
},
"sharedSecret" : {
"description" : "RADIUS server shared secrect",
"type" : "string"
}
},
"required" : [ "autoFallbackDisable", "ip", "port", "sharedSecret" ],
"description" : "Secondary RADIUS server"
},
"healthCheckPolicy" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"responseWindow" : {
"description" : "Response window",
"type" : "integer",
"minimum" : 5,
"maximum" : 30,
"default" : 20
},
"reviveInterval" : {
"description" : "Revive interval",
"type" : "integer",
"minimum" : 60,
"maximum" : 3600,
"default" : 120
},
"zombiePeriod" : {
"description" : "Zombie period",
"type" : "integer",
"minimum" : 30,
"maximum" : 120,
"default" : 40
}
},
"required" : [ "responseWindow", "reviveInterval", "zombiePeriod" ],
"description" : "Health check policy"
},
"rateLimiting" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"maxOutstandingRequestsPerServer" : {
"description" : "Maximum outstanding requests (MOR), value should be 0 or between 10 and 4096",
"type" : "integer",
"default" : 0
},
"threshold" : {
"description" : "Threshold, value should be 0 if MOR is 0, or between 10 and 90 if MOR is between 10 and 4096",
"type" : "integer",
"default" : 0
},
"sanityTimer" : {
"description" : "Sanity timer ",
"type" : "integer",
"minimum" : 1,
"maximum" : 3600,
"default" : 10
}
},
"required" : [ "maxOutstandingRequestsPerServer", "threshold", "sanityTimer" ],
"description" : "Rate limiting"
},
"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" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Identity user role name"
},
"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" ]
}
}
}
}
}
}
}
Use this API command to retrieve a RADIUS authentication service.
200
ShowHide{
"id" : "82109ce0-64e6-11e4-8916-0026b9f85aaf",
"mvnoId" : "839f87c6-d116-497e-afce-aa8157abd30c",
"name" : "rapheal-auth-x3",
"friendlyName" : "rapheal-auth-x",
"description" : "authentication service created by rapheal via public API",
"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"
}
}
} ],
"primary" : {
"ip" : "1.1.1.155",
"port" : 1812,
"sharedSecret" : "abc"
},
"secondary" : {
"ip" : "2.2.2.231",
"port" : 1812,
"sharedSecret" : "abc"
},
"healthCheckPolicy" : {
"responseWindow" : 20,
"reviveInterval" : 120,
"zombiePeriod" : 40
},
"rateLimiting" : {
"maxOutstandingRequestsPerServer" : 0,
"threshold" : 0,
"sanityTimer" : 10
}
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Identifier of the RADIUS authentication service",
"type" : "string"
},
"mvnoId" : {
"description" : "Tenant UUID",
"type" : "string"
},
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the RADIUS authentication service"
},
"friendlyName" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Friendly name of the RADIUS authentication service"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the RADIUS authentication service"
},
"locationDeliveryEnabled" : {
"description" : "RFC5580 out of band location delivery support(for Ruckus AP only)",
"type" : "boolean",
"default" : false
},
"primary" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"ip" : {
"type" : "string",
"description" : "Server IP"
},
"port" : {
"description" : "Server port",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
},
"sharedSecret" : {
"description" : "Server shared secrect",
"type" : "string"
}
},
"required" : [ "ip", "port", "sharedSecret" ],
"description" : "Primary RADIUS server"
},
"secondary" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"autoFallbackDisable" : {
"descriptin" : "Automatic fallback enabled or disabled",
"type" : "boolean"
},
"ip" : {
"type" : "string",
"description" : "RADIUS server IP"
},
"port" : {
"description" : "RADIUS server port",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535,
"default" : 1812
},
"sharedSecret" : {
"description" : "RADIUS server shared secrect",
"type" : "string"
}
},
"required" : [ "autoFallbackDisable", "ip", "port", "sharedSecret" ],
"description" : "Secondary RADIUS server"
},
"healthCheckPolicy" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"responseWindow" : {
"description" : "Response window",
"type" : "integer",
"minimum" : 5,
"maximum" : 30,
"default" : 20
},
"reviveInterval" : {
"description" : "Revive interval",
"type" : "integer",
"minimum" : 60,
"maximum" : 3600,
"default" : 120
},
"zombiePeriod" : {
"description" : "Zombie period",
"type" : "integer",
"minimum" : 30,
"maximum" : 120,
"default" : 40
}
},
"required" : [ "responseWindow", "reviveInterval", "zombiePeriod" ],
"description" : "Health check policy"
},
"rateLimiting" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"maxOutstandingRequestsPerServer" : {
"description" : "Maximum outstanding requests (MOR), value should be 0 or between 10 and 4096",
"type" : "integer",
"default" : 0
},
"threshold" : {
"description" : "Threshold, value should be 0 if MOR is 0, or between 10 and 90 if MOR is between 10 and 4096",
"type" : "integer",
"default" : 0
},
"sanityTimer" : {
"description" : "Sanity timer ",
"type" : "integer",
"minimum" : 1,
"maximum" : 3600,
"default" : 10
}
},
"required" : [ "maxOutstandingRequestsPerServer", "threshold", "sanityTimer" ],
"description" : "Rate limiting"
},
"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" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Identity user role name"
},
"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" ]
}
}
}
}
Use this API command to create a new RADIUS authentication service.
{
"name" : "authenticationServiceName",
"primary" : {
"ip" : "192.168.1.1",
"port" : 1812,
"sharedSecret" : "abc"
}
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the RADIUS authentication service"
},
"friendlyName" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Friendly name of the RADIUS authentication service"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the RADIUS authentication service"
},
"locationDeliveryEnabled" : {
"description" : "RFC5580 out of band location delivery support(for Ruckus AP only)",
"type" : "boolean",
"default" : false
},
"primary" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"ip" : {
"type" : "string",
"description" : "Server IP"
},
"port" : {
"description" : "Server port",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
},
"sharedSecret" : {
"description" : "Server shared secrect",
"type" : "string"
}
},
"required" : [ "ip", "port", "sharedSecret" ],
"description" : "Primary RADIUS server"
},
"secondary" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"autoFallbackDisable" : {
"descriptin" : "Automatic fallback enabled or disabled",
"type" : "boolean"
},
"ip" : {
"type" : "string",
"description" : "RADIUS server IP"
},
"port" : {
"description" : "RADIUS server port",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535,
"default" : 1812
},
"sharedSecret" : {
"description" : "RADIUS server shared secrect",
"type" : "string"
}
},
"required" : [ "autoFallbackDisable", "ip", "port", "sharedSecret" ],
"description" : "Secondary RADIUS server"
},
"healthCheckPolicy" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"responseWindow" : {
"description" : "Response window",
"type" : "integer",
"minimum" : 5,
"maximum" : 30,
"default" : 20
},
"reviveInterval" : {
"description" : "Revive interval",
"type" : "integer",
"minimum" : 60,
"maximum" : 3600,
"default" : 120
},
"zombiePeriod" : {
"description" : "Zombie period",
"type" : "integer",
"minimum" : 30,
"maximum" : 120,
"default" : 40
}
},
"required" : [ "responseWindow", "reviveInterval", "zombiePeriod" ],
"description" : "Health check policy"
},
"rateLimiting" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"maxOutstandingRequestsPerServer" : {
"description" : "Maximum outstanding requests (MOR), value should be 0 or between 10 and 4096",
"type" : "integer",
"default" : 0
},
"threshold" : {
"description" : "Threshold, value should be 0 if MOR is 0, or between 10 and 90 if MOR is between 10 and 4096",
"type" : "integer",
"default" : 0
},
"sanityTimer" : {
"description" : "Sanity timer ",
"type" : "integer",
"minimum" : 1,
"maximum" : 3600,
"default" : 10
}
},
"required" : [ "maxOutstandingRequestsPerServer", "threshold", "sanityTimer" ],
"description" : "Rate limiting"
},
"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" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Identity user role name"
}
}
}
},
"required" : [ "groupAttr", "userRole" ]
}
}
},
"required" : [ "name", "primary" ]
}
201
ShowHide{
"id" : "serviceUUID"
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
}
}
}
Use this API command to modify the basic information of a RADIUS authentication service.
{
"name" : "new name",
"description" : "new description"
}
{
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the RADIUS authentication service"
},
"friendlyName" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Friendly name of the RADIUS authentication service"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the RADIUS authentication service"
},
"locationDeliveryEnabled" : {
"description" : "RFC5580 out of band location delivery support(for Ruckus AP only)",
"type" : "boolean",
"default" : false
}
}
204
Use this API command to modify primary RADIUS server of a RADIUS authentication service.
{
"ip" : "1.1.1.155",
"port" : 1812,
"sharedSecret" : "abc"
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"ip" : {
"type" : "string",
"description" : "Server IP"
},
"port" : {
"description" : "Server port",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
},
"sharedSecret" : {
"description" : "Server shared secrect",
"type" : "string"
}
},
"required" : [ "ip", "port", "sharedSecret" ],
"description" : "Primary RADIUS server"
}
204
Use this API command to modify secondary RADIUS server of a RADIUS authentication service.
{
"ip" : "2.2.2.231",
"port" : 1812,
"sharedSecret" : "abc"
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"autoFallbackDisable" : {
"descriptin" : "Automatic fallback enabled or disabled",
"type" : "boolean"
},
"ip" : {
"type" : "string",
"description" : "RADIUS server IP"
},
"port" : {
"description" : "RADIUS server port",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535,
"default" : 1812
},
"sharedSecret" : {
"description" : "RADIUS server shared secrect",
"type" : "string"
}
},
"required" : [ "autoFallbackDisable", "ip", "port", "sharedSecret" ],
"description" : "Secondary RADIUS server"
}
204
Use this API command to modify rate limiting of a RADIUS authentication service.
{
"maxOutstandingRequestsPerServer" : 0,
"threshold" : 0,
"sanityTimer" : 10
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"maxOutstandingRequestsPerServer" : {
"description" : "Maximum outstanding requests (MOR), value should be 0 or between 10 and 4096",
"type" : "integer",
"default" : 0
},
"threshold" : {
"description" : "Threshold, value should be 0 if MOR is 0, or between 10 and 90 if MOR is between 10 and 4096",
"type" : "integer",
"default" : 0
},
"sanityTimer" : {
"description" : "Sanity timer ",
"type" : "integer",
"minimum" : 1,
"maximum" : 3600,
"default" : 10
}
},
"required" : [ "maxOutstandingRequestsPerServer", "threshold", "sanityTimer" ],
"description" : "Rate limiting"
}
204
Use this API command to modify health check policy of a RADIUS authentication service.
{
"responseWindow" : 20,
"reviveInterval" : 120,
"zombiePeriod" : 40
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"responseWindow" : {
"description" : "Response window",
"type" : "integer",
"minimum" : 5,
"maximum" : 30,
"default" : 20
},
"reviveInterval" : {
"description" : "Revive interval",
"type" : "integer",
"minimum" : 60,
"maximum" : 3600,
"default" : 120
},
"zombiePeriod" : {
"description" : "Zombie period",
"type" : "integer",
"minimum" : 30,
"maximum" : 120,
"default" : 40
}
},
"required" : [ "responseWindow", "reviveInterval", "zombiePeriod" ],
"description" : "Health check policy"
}
204
Use this API command to modify user traffic profile mapping of a RADIUS authentication service.
[ {
"groupAttr" : "newGroupAttr",
"userRole" : {
"id" : "identity user role UUID"
}
}, {
"groupAttr" : "*",
"userRole" : {
"name" : "identity user role name"
}
} ]
{
"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" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Identity user role name"
}
}
}
},
"required" : [ "groupAttr", "userRole" ]
}
}
204
Use this API command to disable secondary RADIUS server of a RADIUS authentication service.
204
Use this API command to delete a RADIUS authentication service.
204
Use this API command to retrieve a list of active directory authentication services.
200
ShowHide{
"totalCount" : 1,
"hasMore" : false,
"firstIndex" : 0,
"list" : [ {
"id" : "49322250-6afd-11e4-832a-dc6020524153",
"mvnoId" : "839f87c6-d116-497e-afce-aa8157abd30c",
"name" : "rapheal-ad",
"friendlyName" : "",
"description" : "",
"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"
}
}
} ],
"ip" : "1.1.1.1",
"port" : 3268,
"windowsDomainName" : "dc=domain",
"adminDomainName" : "[email protected]",
"password" : "abced",
"globalCatalogEnabled" : true
} ]
}
{
"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 authentication service",
"type" : "string"
},
"mvnoId" : {
"description" : "Tenant UUID",
"type" : "string"
},
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the active directory authentication service"
},
"friendlyName" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Friendly name of the active directory authentication service"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the active directory authentication service"
},
"ip" : {
"type" : "string",
"description" : "IP address"
},
"port" : {
"description" : "Port",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535,
"default" : 389
},
"windowsDomainName" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 64,
"pattern" : "^[!-~]([ -~]){0,62}[!-~]$",
"description" : "Windows domain name"
},
"adminDomainName" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 64,
"pattern" : "^[!-~]([ -~]){0,62}[!-~]$",
"description" : "Admin domain name"
},
"password" : {
"description" : "Admin password",
"type" : "string"
},
"globalCatalogEnabled" : {
"description" : "Global catalog support enabled or disabled",
"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" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Identity user role name"
},
"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" ]
}
}
}
}
}
}
}
Use this API command to retrieve an active directory authentication service.
200
ShowHide{
"id" : "49322250-6afd-11e4-832a-dc6020524153",
"mvnoId" : "839f87c6-d116-497e-afce-aa8157abd30c",
"name" : "rapheal-ad",
"friendlyName" : "",
"description" : "",
"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"
}
}
} ],
"ip" : "1.1.1.1",
"port" : 3268,
"windowsDomainName" : "dc=domain",
"adminDomainName" : "[email protected]",
"password" : "abced",
"globalCatalogEnabled" : true
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Identifier of the active directory authentication service",
"type" : "string"
},
"mvnoId" : {
"description" : "Tenant UUID",
"type" : "string"
},
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the active directory authentication service"
},
"friendlyName" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Friendly name of the active directory authentication service"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the active directory authentication service"
},
"ip" : {
"type" : "string",
"description" : "IP address"
},
"port" : {
"description" : "Port",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535,
"default" : 389
},
"windowsDomainName" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 64,
"pattern" : "^[!-~]([ -~]){0,62}[!-~]$",
"description" : "Windows domain name"
},
"adminDomainName" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 64,
"pattern" : "^[!-~]([ -~]){0,62}[!-~]$",
"description" : "Admin domain name"
},
"password" : {
"description" : "Admin password",
"type" : "string"
},
"globalCatalogEnabled" : {
"description" : "Global catalog support enabled or disabled",
"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" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Identity user role name"
},
"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" ]
}
}
}
}
Use this API command to create a new active directory authentication service.
{
"name" : "rapheal-ad2",
"ip" : "1.1.1.15",
"port" : 389,
"windowsDomainName" : "dc=domain",
"globalCatalogEnabled" : false
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the active directory authentication service"
},
"friendlyName" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Friendly name of the active directory authentication service"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the active directory authentication service"
},
"ip" : {
"type" : "string",
"description" : "IP address"
},
"port" : {
"description" : "Port",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535,
"default" : 389
},
"windowsDomainName" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 64,
"pattern" : "^[!-~]([ -~]){0,62}[!-~]$",
"description" : "Windows domain name"
},
"adminDomainName" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 64,
"pattern" : "^[!-~]([ -~]){0,62}[!-~]$",
"description" : "Admin domain name"
},
"password" : {
"description" : "Admin password",
"type" : "string"
},
"globalCatalogEnabled" : {
"description" : "Global catalog support enabled or disabled",
"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" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Identity user role name"
}
}
}
},
"required" : [ "groupAttr", "userRole" ]
}
}
},
"required" : [ "name", "ip", "port", "windowsDomainName", "globalCatalogEnabled" ]
}
201
ShowHide{
"id" : "serviceUUID"
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
}
}
}
Use this API command to modify the basic information of an active directory authentication service.
{
"adminDomainName" : "[email protected]",
"password" : "newpassword",
"globalCatalogEnabled" : true
}
{
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the active directory authentication service"
},
"friendlyName" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Friendly name of the active directory authentication service"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the active directory authentication service"
},
"ip" : {
"type" : "string",
"description" : "IP address"
},
"port" : {
"description" : "Port",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535,
"default" : 389
},
"windowsDomainName" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 64,
"pattern" : "^[!-~]([ -~]){0,62}[!-~]$",
"description" : "Windows domain name"
},
"adminDomainName" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 64,
"pattern" : "^[!-~]([ -~]){0,62}[!-~]$",
"description" : "Admin domain name"
},
"password" : {
"description" : "Admin password",
"type" : "string"
},
"globalCatalogEnabled" : {
"description" : "Global catalog support enabled or disabled",
"type" : "boolean"
}
}
204
Use this API command to modify user traffic profile mapping of an active directory authentication service.
[ {
"groupAttr" : "newGroupAttr",
"userRole" : {
"id" : "identity user role UUID"
}
}, {
"groupAttr" : "*",
"userRole" : {
"name" : "identity user role name"
}
} ]
{
"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" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Identity user role name"
}
}
}
},
"required" : [ "groupAttr", "userRole" ]
}
}
204
Use this API command to delete an active directory authentication service.
204
Use this API command to retrieve a list of LDAP authentication services.
200
ShowHide{
"totalCount" : 1,
"hasMore" : false,
"firstIndex" : 0,
"list" : [ {
"id" : "18b76a50-6a57-11e4-96af-dc6020524153",
"mvnoId" : "839f87c6-d116-497e-afce-aa8157abd30c",
"name" : "rapheal-ldap",
"friendlyName" : "",
"description" : "",
"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"
}
}
} ],
"ip" : "1.1.1.122",
"port" : 389,
"baseDomainName" : "dc=ldap",
"adminDomainName" : "uid=ibm",
"password" : "admin",
"keyAttribute" : "uid",
"searchFilter" : "(objectClass=*)"
} ]
}
{
"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 authentication service",
"type" : "string"
},
"mvnoId" : {
"description" : "Tenant UUID",
"type" : "string"
},
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the LDAP authentication service"
},
"friendlyName" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Friendly name of the LDAP authentication service"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the LDAP authentication service"
},
"ip" : {
"type" : "string",
"description" : "IP address"
},
"port" : {
"description" : "Port",
"type" : "integer"
},
"baseDomainName" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 64,
"pattern" : "^[!-~]([ -~]){0,62}[!-~]$",
"description" : "Base domain name"
},
"adminDomainName" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 64,
"pattern" : "^[!-~]([ -~]){0,62}[!-~]$",
"description" : "Admin domain name"
},
"password" : {
"description" : "Admin password",
"type" : "string"
},
"keyAttribute" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 64,
"pattern" : "^[!-~]([ -~]){0,62}[!-~]$",
"description" : "Key attribute"
},
"searchFilter" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 64,
"pattern" : "^[!-~]([ -~]){0,62}[!-~]$",
"description" : "Search filter"
},
"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" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Identity user role name"
},
"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" ]
}
}
}
}
}
}
}
Use this API command to retrieve a LDAP authentication service.
200
ShowHide{
"id" : "18b76a50-6a57-11e4-96af-dc6020524153",
"mvnoId" : "839f87c6-d116-497e-afce-aa8157abd30c",
"name" : "rapheal-ldap",
"friendlyName" : "",
"description" : "",
"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"
}
}
} ],
"ip" : "1.1.1.122",
"port" : 389,
"baseDomainName" : "dc=ldap",
"adminDomainName" : "uid=ibm",
"password" : "admin",
"keyAttribute" : "uid",
"searchFilter" : "(objectClass=*)"
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Identifier of the LDAP authentication service",
"type" : "string"
},
"mvnoId" : {
"description" : "Tenant UUID",
"type" : "string"
},
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the LDAP authentication service"
},
"friendlyName" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Friendly name of the LDAP authentication service"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the LDAP authentication service"
},
"ip" : {
"type" : "string",
"description" : "IP address"
},
"port" : {
"description" : "Port",
"type" : "integer"
},
"baseDomainName" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 64,
"pattern" : "^[!-~]([ -~]){0,62}[!-~]$",
"description" : "Base domain name"
},
"adminDomainName" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 64,
"pattern" : "^[!-~]([ -~]){0,62}[!-~]$",
"description" : "Admin domain name"
},
"password" : {
"description" : "Admin password",
"type" : "string"
},
"keyAttribute" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 64,
"pattern" : "^[!-~]([ -~]){0,62}[!-~]$",
"description" : "Key attribute"
},
"searchFilter" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 64,
"pattern" : "^[!-~]([ -~]){0,62}[!-~]$",
"description" : "Search filter"
},
"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" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Identity user role name"
},
"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" ]
}
}
}
}
Use this API command to create a new LDAP authentication service.
{
"name" : "rapheal-ldap",
"ip" : "1.1.1.1",
"port" : 389,
"baseDomainName" : "dc=ldap",
"adminDomainName" : "uid=ibm",
"password" : "admin",
"keyAttribute" : "uid",
"searchFilter" : "(objectClass=*)"
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the LDAP authentication service"
},
"friendlyName" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Friendly name of the LDAP authentication service"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the LDAP authentication service"
},
"ip" : {
"type" : "string",
"description" : "IP address"
},
"port" : {
"description" : "Port",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535,
"default" : 389
},
"baseDomainName" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 64,
"pattern" : "^[!-~]([ -~]){0,62}[!-~]$",
"description" : "Base domain name"
},
"adminDomainName" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 64,
"pattern" : "^[!-~]([ -~]){0,62}[!-~]$",
"description" : "Admin domain name"
},
"password" : {
"description" : "Admin password",
"type" : "string"
},
"keyAttribute" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 64,
"pattern" : "^[!-~]([ -~]){0,62}[!-~]$",
"description" : "Key attribute"
},
"searchFilter" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 64,
"pattern" : "^[!-~]([ -~]){0,62}[!-~]$",
"description" : "Search filter"
},
"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" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Identity user role name"
}
}
}
},
"required" : [ "groupAttr", "userRole" ]
}
}
},
"required" : [ "name", "ip", "port", "baseDomainName", "adminDomainName", "password", "keyAttribute", "searchFilter" ]
}
201
ShowHide{
"id" : "serviceUUID"
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
}
}
}
Use this API command to modify the basic information of a LDAP authentication service.
{
"friendlyName" : "new name",
"description" : "new description"
}
{
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the LDAP authentication service"
},
"friendlyName" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Friendly name of the LDAP authentication service"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the LDAP authentication service"
},
"ip" : {
"type" : "string",
"description" : "IP address"
},
"port" : {
"description" : "Port",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535,
"default" : 389
},
"baseDomainName" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 64,
"pattern" : "^[!-~]([ -~]){0,62}[!-~]$",
"description" : "Base domain name"
},
"adminDomainName" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 64,
"pattern" : "^[!-~]([ -~]){0,62}[!-~]$",
"description" : "Admin domain name"
},
"password" : {
"description" : "Admin password",
"type" : "string"
},
"keyAttribute" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 64,
"pattern" : "^[!-~]([ -~]){0,62}[!-~]$",
"description" : "Key attribute"
},
"searchFilter" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 64,
"pattern" : "^[!-~]([ -~]){0,62}[!-~]$",
"description" : "Search filter"
}
}
204
Use this API command to modify user traffic profile mapping of a LDAP authentication service.
[ {
"groupAttr" : "newGroupAttr",
"userRole" : {
"id" : "identity user role UUID"
}
}, {
"groupAttr" : "*",
"userRole" : {
"name" : "identity user role name"
}
} ]
{
"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" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Identity user role name"
}
}
}
},
"required" : [ "groupAttr", "userRole" ]
}
}
204
Use this API command to delete a LDAP authentication service.
204
Use this API command to retrieve a list of OAuth authentication service.
200
ShowHide{
"totalCount" : 1,
"hasMore" : false,
"firstIndex" : 0,
"list" : [ {
"id" : "c74c5340-ac1b-11e4-8a77-08002716c79f",
"mvnoId" : "839f87c6-d116-497e-afce-aa8157abd30c",
"name" : "globalOauth",
"description" : "",
"mappings" : [ {
"id" : "c76bc220-ac1b-11e4-8a77-08002716c79f",
"groupAttr" : "*",
"userRole" : {
"id" : "ad0c58e3-acf7-42a2-a6a7-5a6216110906",
"name" : "Default",
"userTrafficProfile" : {
"id" : "f63a7ad0-8590-11e4-8051-08002716c79f",
"name" : "System Default"
}
}
} ],
"type" : "FACEBOOK",
"applicationId" : "test",
"applicationSecret" : "test",
"willCollectEmail" : true,
"defaultWhitelistedDomains" : [ "fbcdn-profile-a.akamaihd.net", "fbstatic-a.akamaihd.net", "www.facebook.com" ],
"whitelistedDomains" : [ "*.facebook.com", "ruckus.com" ]
} ]
}
{
"type" : "object",
"additionalProperties" : false,
"oauthSpecifiedItems" : true,
"properties" : {
"totalCount" : {
"type" : "integer"
},
"hasMore" : {
"type" : "boolean"
},
"firstIndex" : {
"type" : "integer"
},
"list" : {
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Identifier of the OAuth authentication service",
"type" : "string"
},
"type" : {
"description" : "OAuth Type, may be GOOGLE, FACEBOOK or LINKEDIN",
"enum" : [ "FACEBOOK", "GOOGLE", "LINKEDIN" ]
},
"mvnoId" : {
"description" : "Tenant UUID",
"type" : "string"
},
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the OAuth authentication service"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the OAuth authentication service"
},
"applicationId" : {
"description" : "Application ID",
"type" : "string"
},
"applicationSecret" : {
"description" : "Application Secret",
"type" : "string"
},
"willCollectEmail" : {
"description" : "Will collect user's email address",
"type" : "boolean"
},
"defaultWhitelistedDomains" : {
"description" : "Defualt whitelisted domains",
"type" : "array",
"items" : {
"type" : "string"
}
},
"whitelistedDomains" : {
"description" : "Customized whitelisted domains",
"type" : "array",
"items" : {
"description" : "admin domain name",
"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" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Identity user role name"
},
"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" ]
}
}
}
}
}
}
}
Use this API command to retrieve a OAuth authentication service.
200
ShowHide{
"id" : "c74c5340-ac1b-11e4-8a77-08002716c79f",
"mvnoId" : "839f87c6-d116-497e-afce-aa8157abd30c",
"name" : "globalOauth",
"description" : "",
"mappings" : [ {
"id" : "c76bc220-ac1b-11e4-8a77-08002716c79f",
"groupAttr" : "*",
"userRole" : {
"id" : "ad0c58e3-acf7-42a2-a6a7-5a6216110906",
"name" : "Default",
"userTrafficProfile" : {
"id" : "f63a7ad0-8590-11e4-8051-08002716c79f",
"name" : "System Default"
}
}
} ],
"type" : "FACEBOOK",
"applicationId" : "test",
"applicationSecret" : "test",
"willCollectEmail" : true,
"defaultWhitelistedDomains" : [ "fbcdn-profile-a.akamaihd.net", "fbstatic-a.akamaihd.net", "*.facebook.com" ],
"whitelistedDomains" : [ "ruckus.com" ]
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Identifier of the OAuth authentication service",
"type" : "string"
},
"type" : {
"description" : "OAuth Type, may be GOOGLE, FACEBOOK or LINKEDIN",
"enum" : [ "FACEBOOK", "GOOGLE", "LINKEDIN" ]
},
"mvnoId" : {
"description" : "Tenant UUID",
"type" : "string"
},
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the OAuth authentication service"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the OAuth authentication service"
},
"applicationId" : {
"description" : "Application ID",
"type" : "string"
},
"applicationSecret" : {
"description" : "Application Secret",
"type" : "string"
},
"willCollectEmail" : {
"description" : "Will collect user's email address",
"type" : "boolean"
},
"defaultWhitelistedDomains" : {
"description" : "Defualt whitelisted domains",
"type" : "array",
"items" : {
"type" : "string"
}
},
"whitelistedDomains" : {
"description" : "Customized whitelisted domains",
"type" : "array",
"items" : {
"description" : "admin domain name",
"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" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Identity user role name"
},
"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" ]
}
}
}
}
Use this API command to create a new OAuth authentication service.
{
"type" : "GOOGLE",
"name" : "globalOauth",
"description" : "create oAuthAuthentication desc",
"mappings" : [ {
"groupAttr" : "*",
"userRole" : {
"name" : "Default"
}
} ],
"applicationId" : "test",
"applicationSecret" : "test",
"willCollectEmail" : true,
"whitelistedDomains" : [ "ruckus.com" ]
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"type" : {
"description" : "OAuth Type, may be GOOGLE, FACEBOOK or LINKEDIN",
"enum" : [ "FACEBOOK", "GOOGLE", "LINKEDIN" ]
},
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the OAuth authentication service"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the OAuth authentication service"
},
"applicationId" : {
"description" : "Application ID",
"type" : "string"
},
"applicationSecret" : {
"description" : "Application Secret",
"type" : "string"
},
"willCollectEmail" : {
"description" : "Will collect user's email address",
"type" : "boolean"
},
"whitelistedDomains" : {
"description" : "Admin domain name",
"type" : "array",
"items" : {
"type" : "string"
}
},
"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" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Identity user role name"
}
}
}
},
"required" : [ "groupAttr", "userRole" ]
}
}
},
"required" : [ "type", "name", "applicationId", "applicationSecret", "willCollectEmail" ]
}
201
ShowHide{
"id" : "serviceUUID"
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
}
}
}
Use this API command to modify the basic information of an OAuth authentication service.
{
"name" : "globalOauth",
"description" : "modify oAuthAuthentication desc",
"applicationId" : "test",
"applicationSecret" : "test",
"willCollectEmail" : true
}
{
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the OAuth authentication service"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the OAuth authentication service"
},
"applicationId" : {
"description" : "Application ID",
"type" : "string"
},
"applicationSecret" : {
"description" : "Application Secret",
"type" : "string"
},
"willCollectEmail" : {
"description" : "Will collect user's email address",
"type" : "boolean"
}
}
204
Use this API command to modify whitelisted domains of an OAuth authentication service.
[ "ruckus.com" ]
{
"description" : "Admin domain name",
"type" : "array",
"items" : {
"type" : "string"
}
}
204
Use this API command to modify user traffic profile mapping of an OAuth authentication service.
[ {
"groupAttr" : "*",
"userRole" : {
"name" : "Default"
}
} ]
{
"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" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Identity user role name"
}
}
}
},
"required" : [ "groupAttr", "userRole" ]
}
}
204
Use this API command to delete an OAuth authentication service.
204
Use this API command to retrieve a list of RADIUS accounting services.
200
ShowHide{
"totalCount" : 1,
"hasMore" : false,
"firstIndex" : 0,
"list" : [ {
"id" : "accountingServiceUUID",
"mvnoId" : "userMVNOId",
"name" : "accountingServiceName",
"description" : "accountingServiceDescription",
"primary" : {
"ip" : "192.168.1.1",
"port" : 1812,
"sharedSecret" : "sharedSecret"
},
"secondary" : {
"ip" : "192.168.1.2",
"port" : 1812,
"sharedSecret" : "sharedSecret"
},
"healthCheckPolicy" : {
"responseWindow" : 20,
"reviveInterval" : 120,
"zombiePeriod" : 40
},
"rateLimiting" : {
"maxOutstandingRequestsPerServer" : 0,
"threshold" : 0,
"sanityTimer" : 10
}
} ]
}
{
"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 accounting service",
"type" : "string"
},
"mvnoId" : {
"description" : "Tenant UUID",
"type" : "string"
},
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the RADIUS accounting service"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the RADIUS accounting service"
},
"primary" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"ip" : {
"type" : "string",
"description" : "Server IP"
},
"port" : {
"description" : "Server port",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
},
"sharedSecret" : {
"description" : "Server shared secrect",
"type" : "string"
}
},
"required" : [ "ip", "port", "sharedSecret" ],
"description" : "Primary RADIUS server"
},
"secondary" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"autoFallbackDisable" : {
"descriptin" : "Automatic fallback enabled or disabled",
"type" : "boolean"
},
"ip" : {
"type" : "string",
"description" : "RADIUS server IP"
},
"port" : {
"description" : "RADIUS server port",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535,
"default" : 1812
},
"sharedSecret" : {
"description" : "RADIUS server shared secrect",
"type" : "string"
}
},
"required" : [ "autoFallbackDisable", "ip", "port", "sharedSecret" ],
"description" : "Secondary RADIUS server"
},
"healthCheckPolicy" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"responseWindow" : {
"description" : "Response window",
"type" : "integer",
"minimum" : 5,
"maximum" : 30,
"default" : 20
},
"reviveInterval" : {
"description" : "Revive interval",
"type" : "integer",
"minimum" : 60,
"maximum" : 3600,
"default" : 120
},
"zombiePeriod" : {
"description" : "Zombie period",
"type" : "integer",
"minimum" : 30,
"maximum" : 120,
"default" : 40
}
},
"required" : [ "responseWindow", "reviveInterval", "zombiePeriod" ],
"description" : "Health check policy"
},
"rateLimiting" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"maxOutstandingRequestsPerServer" : {
"description" : "Maximum outstanding requests (MOR), value should be 0 or between 10 and 4096",
"type" : "integer",
"default" : 0
},
"threshold" : {
"description" : "Threshold, value should be 0 if MOR is 0, or between 10 and 90 if MOR is between 10 and 4096",
"type" : "integer",
"default" : 0
},
"sanityTimer" : {
"description" : "Sanity timer ",
"type" : "integer",
"minimum" : 1,
"maximum" : 3600,
"default" : 10
}
},
"required" : [ "maxOutstandingRequestsPerServer", "threshold", "sanityTimer" ],
"description" : "Rate limiting"
}
}
}
}
}
}
Use this API command to retrieve a RADIUS accounting service.
200
ShowHide{
"id" : "accountingServiceUUID",
"mvnoId" : "userMVNOId",
"name" : "accountingServiceName",
"description" : "accountingServiceDescription",
"primary" : {
"ip" : "192.168.1.1",
"port" : 1812,
"sharedSecret" : "sharedSecret"
},
"secondary" : {
"ip" : "192.168.1.2",
"port" : 1812,
"sharedSecret" : "sharedSecret"
},
"healthCheckPolicy" : {
"responseWindow" : 20,
"reviveInterval" : 120,
"zombiePeriod" : 40
},
"rateLimiting" : {
"maxOutstandingRequestsPerServer" : 0,
"threshold" : 0,
"sanityTimer" : 10
}
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Identifier of the RADIUS accounting service",
"type" : "string"
},
"mvnoId" : {
"description" : "Tenant UUID",
"type" : "string"
},
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the RADIUS accounting service"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the RADIUS accounting service"
},
"primary" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"ip" : {
"type" : "string",
"description" : "Server IP"
},
"port" : {
"description" : "Server port",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
},
"sharedSecret" : {
"description" : "Server shared secrect",
"type" : "string"
}
},
"required" : [ "ip", "port", "sharedSecret" ],
"description" : "Primary RADIUS server"
},
"secondary" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"autoFallbackDisable" : {
"descriptin" : "Automatic fallback enabled or disabled",
"type" : "boolean"
},
"ip" : {
"type" : "string",
"description" : "RADIUS server IP"
},
"port" : {
"description" : "RADIUS server port",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535,
"default" : 1812
},
"sharedSecret" : {
"description" : "RADIUS server shared secrect",
"type" : "string"
}
},
"required" : [ "autoFallbackDisable", "ip", "port", "sharedSecret" ],
"description" : "Secondary RADIUS server"
},
"healthCheckPolicy" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"responseWindow" : {
"description" : "Response window",
"type" : "integer",
"minimum" : 5,
"maximum" : 30,
"default" : 20
},
"reviveInterval" : {
"description" : "Revive interval",
"type" : "integer",
"minimum" : 60,
"maximum" : 3600,
"default" : 120
},
"zombiePeriod" : {
"description" : "Zombie period",
"type" : "integer",
"minimum" : 30,
"maximum" : 120,
"default" : 40
}
},
"required" : [ "responseWindow", "reviveInterval", "zombiePeriod" ],
"description" : "Health check policy"
},
"rateLimiting" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"maxOutstandingRequestsPerServer" : {
"description" : "Maximum outstanding requests (MOR), value should be 0 or between 10 and 4096",
"type" : "integer",
"default" : 0
},
"threshold" : {
"description" : "Threshold, value should be 0 if MOR is 0, or between 10 and 90 if MOR is between 10 and 4096",
"type" : "integer",
"default" : 0
},
"sanityTimer" : {
"description" : "Sanity timer ",
"type" : "integer",
"minimum" : 1,
"maximum" : 3600,
"default" : 10
}
},
"required" : [ "maxOutstandingRequestsPerServer", "threshold", "sanityTimer" ],
"description" : "Rate limiting"
}
}
}
Use this API command to create a new RADIUS accounting service.
{
"name" : "accountingServiceName",
"primary" : {
"ip" : "192.168.1.1",
"port" : 1813,
"sharedSecret" : "sharedSecret"
}
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the RADIUS accounting service"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the RADIUS accounting service"
},
"primary" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"ip" : {
"type" : "string",
"description" : "Server IP"
},
"port" : {
"description" : "Server port",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
},
"sharedSecret" : {
"description" : "Server shared secrect",
"type" : "string"
}
},
"required" : [ "ip", "port", "sharedSecret" ],
"description" : "Primary RADIUS server"
},
"secondary" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"autoFallbackDisable" : {
"descriptin" : "Automatic fallback enabled or disabled",
"type" : "boolean"
},
"ip" : {
"type" : "string",
"description" : "RADIUS server IP"
},
"port" : {
"description" : "RADIUS server port",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535,
"default" : 1812
},
"sharedSecret" : {
"description" : "RADIUS server shared secrect",
"type" : "string"
}
},
"required" : [ "autoFallbackDisable", "ip", "port", "sharedSecret" ],
"description" : "Secondary RADIUS server"
},
"healthCheckPolicy" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"responseWindow" : {
"description" : "Response window",
"type" : "integer",
"minimum" : 5,
"maximum" : 30,
"default" : 20
},
"reviveInterval" : {
"description" : "Revive interval",
"type" : "integer",
"minimum" : 60,
"maximum" : 3600,
"default" : 120
},
"zombiePeriod" : {
"description" : "Zombie period",
"type" : "integer",
"minimum" : 30,
"maximum" : 120,
"default" : 40
}
},
"required" : [ "responseWindow", "reviveInterval", "zombiePeriod" ],
"description" : "Health check policy"
},
"rateLimiting" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"maxOutstandingRequestsPerServer" : {
"description" : "Maximum outstanding requests (MOR), value should be 0 or between 10 and 4096",
"type" : "integer",
"default" : 0
},
"threshold" : {
"description" : "Threshold, value should be 0 if MOR is 0, or between 10 and 90 if MOR is between 10 and 4096",
"type" : "integer",
"default" : 0
},
"sanityTimer" : {
"description" : "Sanity timer ",
"type" : "integer",
"minimum" : 1,
"maximum" : 3600,
"default" : 10
}
},
"required" : [ "maxOutstandingRequestsPerServer", "threshold", "sanityTimer" ],
"description" : "Rate limiting"
}
},
"required" : [ "name", "primary" ]
}
201
ShowHide{
"id" : "serviceUUID"
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
}
}
}
Use this API command to modify the basic information of a RADIUS accounting service.
{
"name" : "new name",
"description" : "new description"
}
{
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the RADIUS accounting service"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the RADIUS accounting service"
}
}
204
Use this API command to modify primary RADIUS server of a RADIUS accounting service.
{
"ip" : "192.168.1.1",
"port" : 1812,
"sharedSecret" : "sharedSecret"
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"ip" : {
"type" : "string",
"description" : "Server IP"
},
"port" : {
"description" : "Server port",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535
},
"sharedSecret" : {
"description" : "Server shared secrect",
"type" : "string"
}
},
"required" : [ "ip", "port", "sharedSecret" ],
"description" : "Primary RADIUS server"
}
204
Use this API command to modify secondary RADIUS server of a RADIUS accounting service.
{
"ip" : "192.168.1.2",
"port" : 1812,
"sharedSecret" : "sharedSecret"
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"autoFallbackDisable" : {
"descriptin" : "Automatic fallback enabled or disabled",
"type" : "boolean"
},
"ip" : {
"type" : "string",
"description" : "RADIUS server IP"
},
"port" : {
"description" : "RADIUS server port",
"type" : "integer",
"minimum" : 1,
"maximum" : 65535,
"default" : 1812
},
"sharedSecret" : {
"description" : "RADIUS server shared secrect",
"type" : "string"
}
},
"required" : [ "autoFallbackDisable", "ip", "port", "sharedSecret" ],
"description" : "Secondary RADIUS server"
}
204
Use this API command to modify rate limiting of a RADIUS accounting service.
{
"maxOutstandingRequestsPerServer" : 0,
"threshold" : 0,
"sanityTimer" : 10
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"maxOutstandingRequestsPerServer" : {
"description" : "Maximum outstanding requests (MOR), value should be 0 or between 10 and 4096",
"type" : "integer",
"default" : 0
},
"threshold" : {
"description" : "Threshold, value should be 0 if MOR is 0, or between 10 and 90 if MOR is between 10 and 4096",
"type" : "integer",
"default" : 0
},
"sanityTimer" : {
"description" : "Sanity timer ",
"type" : "integer",
"minimum" : 1,
"maximum" : 3600,
"default" : 10
}
},
"required" : [ "maxOutstandingRequestsPerServer", "threshold", "sanityTimer" ],
"description" : "Rate limiting"
}
204
Use this API command to modify health check policy of a RADIUS accounting service.
{
"responseWindow" : 20,
"reviveInterval" : 120,
"zombiePeriod" : 40
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"responseWindow" : {
"description" : "Response window",
"type" : "integer",
"minimum" : 5,
"maximum" : 30,
"default" : 20
},
"reviveInterval" : {
"description" : "Revive interval",
"type" : "integer",
"minimum" : 60,
"maximum" : 3600,
"default" : 120
},
"zombiePeriod" : {
"description" : "Zombie period",
"type" : "integer",
"minimum" : 30,
"maximum" : 120,
"default" : 40
}
},
"required" : [ "responseWindow", "reviveInterval", "zombiePeriod" ],
"description" : "Health check policy"
}
204
Use this API command to disable secondary RADIUS server of a RADIUS accounting service.
204
Use this API command to delete a RADIUS accounting service.
204
Use this API command to retrieve a list of authentication profiles.
200
ShowHide{
"totalCount" : 1,
"hasMore" : false,
"firstIndex" : 0,
"list" : [ {
"id" : "5f154cd0-6f91-11e4-9984-068020524153",
"mvnoId" : "839f87c6-d116-497e-afce-aa8157abd30c",
"name" : "authenticationProfileName",
"description" : null,
"gppSuppportEnabled" : true,
"aaaSuppportEnabled" : true,
"ttgCommonSetting" : {
"interimAcctInterval" : 600,
"sessionTimeout" : 22,
"sessionIdleTimeout" : 120,
"mobileCountryCode" : "086",
"mobileNetworkCode" : "010"
},
"realmMappings" : [ {
"realm" : "No Match",
"id" : null,
"name" : null,
"dynamicVlanId" : null,
"serviceType" : "NA",
"authorizationMethod" : "NonGPPCallFlow"
}, {
"realm" : "Unspecified",
"id" : null,
"name" : null,
"dynamicVlanId" : null,
"serviceType" : "NA",
"authorizationMethod" : "NonGPPCallFlow"
} ]
} ]
}
{
"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 authentication profile",
"type" : "string"
},
"mvnoId" : {
"description" : "Tenant UUID",
"type" : "string"
},
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the authentication profile"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the authentication profile"
},
"gppSuppportEnabled" : {
"description" : "3GPP support enabled or disabled",
"type" : "boolean"
},
"aaaSuppportEnabled" : {
"description" : "Hosted AAA support enabled or disabled",
"type" : "boolean"
},
"ttgCommonSetting" : {
"type" : "object",
"description" : "Hosted AAA server RADIUS settings & PLMN ID settings",
"properties" : {
"interimAcctInterval" : {
"type" : "integer",
"description" : "Interim accounting interval (value should be 0 or 600~65536, unit: seconds)"
},
"sessionTimeout" : {
"type" : "integer",
"description" : "Session timeout (unit: seconds)",
"minimum" : 0,
"maximum" : 2147483647,
"default" : 0
},
"sessionIdleTimeout" : {
"type" : "integer",
"description" : "Session idle timeout (unit: seconds)",
"minimum" : 90,
"maximum" : 600,
"default" : 120
},
"mobileCountryCode" : {
"type" : "string",
"description" : "Mobile country code",
"minLength" : 3,
"maxLength" : 3,
"pattern" : "[0-9]+"
},
"mobileNetworkCode" : {
"type" : "string",
"description" : "Mobile network code",
"minLength" : 2,
"maxLength" : 3,
"pattern" : "[0-9]+"
}
}
},
"realmMappings" : {
"type" : "array",
"description" : "Realm based authentication service mappings",
"items" : {
"type" : "object",
"description" : "Realm based authentication service mappings",
"additionalProperties" : false,
"properties" : {
"realm" : {
"type" : "string",
"maxLength" : 255,
"pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$",
"description" : "Realm"
},
"serviceType" : {
"description" : "Authentication service type, NA is NA-Request Rejected",
"enum" : [ "NA", "RADIUS", "LOCAL_DB", "HLR", "AD", "LDAP" ]
},
"id" : {
"type" : [ "string", "null" ],
"description" : "Authentication service UUID"
},
"name" : {
"type" : [ "string", "null" ],
"description" : "Authentication service name"
},
"authorizationMethod" : {
"description" : "Authorization method",
"enum" : [ "NonGPPCallFlow", "GPPCallFlow", "UpdateGPRSLocation", "RestoreData", "NoAutz" ]
},
"dynamicVlanId" : {
"type" : [ "integer", "null" ],
"description" : "Dynamic VLAN ID",
"minimum" : 2,
"maximum" : 4094
}
},
"required" : [ "realm", "serviceType", "authorizationMethod" ]
}
}
}
}
}
}
}
Use this API command to retrieve an authentication profile.
200
ShowHide{
"id" : "5f154cd0-6f91-11e4-9984-068020524153",
"mvnoId" : "839f87c6-d116-497e-afce-aa8157abd30c",
"name" : "authenticationProfileName",
"description" : null,
"gppSuppportEnabled" : true,
"aaaSuppportEnabled" : true,
"ttgCommonSetting" : {
"interimAcctInterval" : 600,
"sessionTimeout" : 22,
"sessionIdleTimeout" : 120,
"mobileCountryCode" : "086",
"mobileNetworkCode" : "010"
},
"realmMappings" : [ {
"realm" : "No Match",
"id" : null,
"name" : null,
"dynamicVlanId" : null,
"serviceType" : "NA",
"authorizationMethod" : "NonGPPCallFlow"
}, {
"realm" : "Unspecified",
"id" : null,
"name" : null,
"dynamicVlanId" : null,
"serviceType" : "NA",
"authorizationMethod" : "NonGPPCallFlow"
} ]
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Identifier of the authentication profile",
"type" : "string"
},
"mvnoId" : {
"description" : "Tenant UUID",
"type" : "string"
},
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the authentication profile"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the authentication profile"
},
"gppSuppportEnabled" : {
"description" : "3GPP support enabled or disabled",
"type" : "boolean"
},
"aaaSuppportEnabled" : {
"description" : "Hosted AAA support enabled or disabled",
"type" : "boolean"
},
"ttgCommonSetting" : {
"type" : "object",
"description" : "Hosted AAA server RADIUS settings & PLMN ID settings",
"properties" : {
"interimAcctInterval" : {
"type" : "integer",
"description" : "Interim accounting interval (value should be 0 or 600~65536, unit: seconds)"
},
"sessionTimeout" : {
"type" : "integer",
"description" : "Session timeout (unit: seconds)",
"minimum" : 0,
"maximum" : 2147483647,
"default" : 0
},
"sessionIdleTimeout" : {
"type" : "integer",
"description" : "Session idle timeout (unit: seconds)",
"minimum" : 90,
"maximum" : 600,
"default" : 120
},
"mobileCountryCode" : {
"type" : "string",
"description" : "Mobile country code",
"minLength" : 3,
"maxLength" : 3,
"pattern" : "[0-9]+"
},
"mobileNetworkCode" : {
"type" : "string",
"description" : "Mobile network code",
"minLength" : 2,
"maxLength" : 3,
"pattern" : "[0-9]+"
}
}
},
"realmMappings" : {
"type" : "array",
"description" : "Realm based authentication service mappings",
"items" : {
"type" : "object",
"description" : "Realm based authentication service mappings",
"additionalProperties" : false,
"properties" : {
"realm" : {
"type" : "string",
"maxLength" : 255,
"pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$",
"description" : "Realm"
},
"serviceType" : {
"description" : "Authentication service type, NA is NA-Request Rejected",
"enum" : [ "NA", "RADIUS", "LOCAL_DB", "HLR", "AD", "LDAP" ]
},
"id" : {
"type" : [ "string", "null" ],
"description" : "Authentication service UUID"
},
"name" : {
"type" : [ "string", "null" ],
"description" : "Authentication service name"
},
"authorizationMethod" : {
"description" : "Authorization method",
"enum" : [ "NonGPPCallFlow", "GPPCallFlow", "UpdateGPRSLocation", "RestoreData", "NoAutz" ]
},
"dynamicVlanId" : {
"type" : [ "integer", "null" ],
"description" : "Dynamic VLAN ID",
"minimum" : 2,
"maximum" : 4094
}
},
"required" : [ "realm", "serviceType", "authorizationMethod" ]
}
}
}
}
Use this API command to create a new authentication profile.
{
"name" : "authenticationProfileName",
"gppSuppportEnabled" : false,
"aaaSuppportEnabled" : false
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the authentication profile"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the authentication profile"
},
"gppSuppportEnabled" : {
"description" : "3GPP support enabled or disabled",
"type" : "boolean",
"default" : false
},
"aaaSuppportEnabled" : {
"description" : "Hosted AAA support enabled or disabled",
"type" : "boolean",
"default" : false
},
"ttgCommonSetting" : {
"type" : "object",
"description" : "Hosted AAA server RADIUS settings & PLMN ID settings",
"properties" : {
"interimAcctInterval" : {
"type" : "integer",
"description" : "Interim accounting interval (value should be 0 or 600~65536, unit: seconds)"
},
"sessionTimeout" : {
"type" : "integer",
"description" : "Session timeout (unit: seconds)",
"minimum" : 0,
"maximum" : 2147483647,
"default" : 0
},
"sessionIdleTimeout" : {
"type" : "integer",
"description" : "Session idle timeout (unit: seconds)",
"minimum" : 90,
"maximum" : 600,
"default" : 120
},
"mobileCountryCode" : {
"type" : "string",
"description" : "Mobile country code",
"minLength" : 3,
"maxLength" : 3,
"pattern" : "[0-9]+"
},
"mobileNetworkCode" : {
"type" : "string",
"description" : "Mobile network code",
"minLength" : 2,
"maxLength" : 3,
"pattern" : "[0-9]+"
}
}
},
"realmMappings" : {
"type" : "array",
"description" : "Realm based authentication service mappings",
"items" : {
"type" : "object",
"description" : "Realm based authentication service mappings",
"additionalProperties" : false,
"properties" : {
"realm" : {
"type" : "string",
"maxLength" : 255,
"pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$",
"description" : "Realm"
},
"serviceType" : {
"description" : "Authentication service type, NA is NA-Request Rejected",
"enum" : [ "NA", "RADIUS", "LOCAL_DB", "HLR", "AD", "LDAP" ]
},
"id" : {
"type" : [ "string", "null" ],
"description" : "Authentication service UUID"
},
"name" : {
"type" : [ "string", "null" ],
"description" : "Authentication service name"
},
"authorizationMethod" : {
"description" : "Authorization method",
"enum" : [ "NonGPPCallFlow", "GPPCallFlow", "UpdateGPRSLocation", "RestoreData", "NoAutz" ]
},
"dynamicVlanId" : {
"type" : [ "integer", "null" ],
"description" : "Dynamic VLAN ID",
"minimum" : 2,
"maximum" : 4094
}
},
"required" : [ "realm", "serviceType", "authorizationMethod" ]
}
}
},
"required" : [ "name", "gppSuppportEnabled", "aaaSuppportEnabled" ]
}
201
ShowHide{
"id" : "profileUUID"
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
}
}
}
Use this API command to modify the basic information of an authentication profile.
{
"name" : "new Name",
"description" : "new description"
}
{
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the authentication profile"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the authentication profile"
}
}
204
Use this API command to modify 3GPP common settings of an authentication profile.
{
"interimAcctInterval" : 600,
"sessionTimeout" : 0,
"sessionIdleTimeout" : 120,
"mobileCountryCode" : "086",
"mobileNetworkCode" : "010"
}
{
"type" : "object",
"description" : "Hosted AAA server RADIUS settings & PLMN ID settings",
"properties" : {
"interimAcctInterval" : {
"type" : "integer",
"description" : "Interim accounting interval (value should be 0 or 600~65536, unit: seconds)"
},
"sessionTimeout" : {
"type" : "integer",
"description" : "Session timeout (unit: seconds)",
"minimum" : 0,
"maximum" : 2147483647,
"default" : 0
},
"sessionIdleTimeout" : {
"type" : "integer",
"description" : "Session idle timeout (unit: seconds)",
"minimum" : 90,
"maximum" : 600,
"default" : 120
},
"mobileCountryCode" : {
"type" : "string",
"description" : "Mobile country code",
"minLength" : 3,
"maxLength" : 3,
"pattern" : "[0-9]+"
},
"mobileNetworkCode" : {
"type" : "string",
"description" : "Mobile network code",
"minLength" : 2,
"maxLength" : 3,
"pattern" : "[0-9]+"
}
}
}
204
Use this API command to modify realm based authentication service mappings of an authentication profile.
[ {
"realm" : "No Match",
"serviceType" : "LOCAL_DB",
"authorizationMethod" : "NonGPPCallFlow"
}, {
"realm" : "Unspecified",
"id" : "00f6f020-7470-11e4-afe9-08002716c79f",
"name" : "auth service",
"serviceType" : "RADIUS",
"authorizationMethod" : "GPPCallFlow"
} ]
{
"type" : "array",
"description" : "Realm based authentication service mappings",
"items" : {
"type" : "object",
"description" : "Realm based authentication service mappings",
"additionalProperties" : false,
"properties" : {
"realm" : {
"type" : "string",
"maxLength" : 255,
"pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$",
"description" : "Realm"
},
"serviceType" : {
"description" : "Authentication service type, NA is NA-Request Rejected",
"enum" : [ "NA", "RADIUS", "LOCAL_DB", "HLR", "AD", "LDAP" ]
},
"id" : {
"type" : [ "string", "null" ],
"description" : "Authentication service UUID"
},
"name" : {
"type" : [ "string", "null" ],
"description" : "Authentication service name"
},
"authorizationMethod" : {
"description" : "Authorization method",
"enum" : [ "NonGPPCallFlow", "GPPCallFlow", "UpdateGPRSLocation", "RestoreData", "NoAutz" ]
},
"dynamicVlanId" : {
"type" : [ "integer", "null" ],
"description" : "Dynamic VLAN ID",
"minimum" : 2,
"maximum" : 4094
}
},
"required" : [ "realm", "serviceType", "authorizationMethod" ]
}
}
204
Use this API command to delete an authentication profile.
204
Use this API command to retrieve a list of accounting profiles.
200
ShowHide{
"totalCount" : 1,
"hasMore" : false,
"firstIndex" : 0,
"list" : [ {
"id" : "267ef3a0-738b-11e4-96d5-0a7820524153",
"mvnoId" : "839f87c6-d116-497e-afce-aa8157abd30c",
"name" : "new name",
"description" : "new description",
"realmMappings" : [ {
"realm" : "realm",
"id" : "78585bb0-7126-11e4-a730-0800276fe6ca",
"name" : "acct service",
"serviceType" : "RADIUS"
}, {
"realm" : "No Match",
"id" : "78585bb0-7126-11e4-a730-0800276fe6ca",
"name" : "acct service",
"serviceType" : "RADIUS"
}, {
"realm" : "Unspecified",
"id" : null,
"name" : null,
"serviceType" : "NA"
} ]
} ]
}
{
"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 accounting profile",
"type" : "string"
},
"mvnoId" : {
"description" : "Tenant UUID",
"type" : "string"
},
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the accounting profile"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the accounting profile"
},
"realmMappings" : {
"type" : "array",
"description" : "Accounting service per realm",
"items" : {
"type" : "object",
"description" : "Accounting service per realm",
"additionalProperties" : false,
"properties" : {
"realm" : {
"type" : "string",
"maxLength" : 255,
"pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$",
"description" : "Realm"
},
"serviceType" : {
"description" : "Accounting service type, NA is NA-Request Rejected",
"enum" : [ "NA", "RADIUS", "CGF" ]
},
"id" : {
"type" : [ "string", "null" ],
"description" : "Accounting service UUID"
},
"name" : {
"type" : [ "string", "null" ],
"description" : "Accounting service name"
}
},
"required" : [ "realm", "serviceType" ]
}
}
}
}
}
}
}
Use this API command to retrieve an accounting profile.
200
ShowHide{
"id" : "267ef3a0-738b-11e4-96d5-0a7820524153",
"mvnoId" : "839f87c6-d116-497e-afce-aa8157abd30c",
"name" : "new name",
"description" : "new description",
"realmMappings" : [ {
"realm" : "realm",
"id" : "78585bb0-7126-11e4-a730-0800276fe6ca",
"name" : "acct service",
"serviceType" : "RADIUS"
}, {
"realm" : "No Match",
"id" : "78585bb0-7126-11e4-a730-0800276fe6ca",
"name" : "acct service",
"serviceType" : "RADIUS"
}, {
"realm" : "Unspecified",
"id" : null,
"name" : null,
"serviceType" : "NA"
} ]
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Identifier of the accounting profile",
"type" : "string"
},
"mvnoId" : {
"description" : "Tenant UUID",
"type" : "string"
},
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the accounting profile"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the accounting profile"
},
"realmMappings" : {
"type" : "array",
"description" : "Accounting service per realm",
"items" : {
"type" : "object",
"description" : "Accounting service per realm",
"additionalProperties" : false,
"properties" : {
"realm" : {
"type" : "string",
"maxLength" : 255,
"pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$",
"description" : "Realm"
},
"serviceType" : {
"description" : "Accounting service type, NA is NA-Request Rejected",
"enum" : [ "NA", "RADIUS", "CGF" ]
},
"id" : {
"type" : [ "string", "null" ],
"description" : "Accounting service UUID"
},
"name" : {
"type" : [ "string", "null" ],
"description" : "Accounting service name"
}
},
"required" : [ "realm", "serviceType" ]
}
}
}
}
Use this API command to create a new accounting profile.
{
"name" : "accountingProfileName"
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the accounting profile"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the accounting profile"
},
"realmMappings" : {
"type" : "array",
"description" : "Accounting service per realm",
"items" : {
"type" : "object",
"description" : "Accounting service per realm",
"additionalProperties" : false,
"properties" : {
"realm" : {
"type" : "string",
"maxLength" : 255,
"pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$",
"description" : "Realm"
},
"serviceType" : {
"description" : "Accounting service type, NA is NA-Request Rejected",
"enum" : [ "NA", "RADIUS", "CGF" ]
},
"id" : {
"type" : [ "string", "null" ],
"description" : "Accounting service UUID"
},
"name" : {
"type" : [ "string", "null" ],
"description" : "Accounting service name"
}
},
"required" : [ "realm", "serviceType" ]
}
}
},
"required" : [ "name" ]
}
201
ShowHide{
"id" : "profileUUID"
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
}
}
}
Use this API command to modify the basic information of an accounting profile.
{
"name" : "new name",
"description" : "new description"
}
{
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the accounting profile"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the accounting profile"
}
}
204
Use this API command to modify accounting service per realm mappings of an accounting profile.
[ {
"realm" : "realm",
"id" : "78585bb0-7126-11e4-a730-0800276fe6ca",
"serviceType" : "RADIUS"
}, {
"realm" : "No Match",
"name" : "acct service",
"serviceType" : "RADIUS"
}, {
"realm" : "Unspecified",
"id" : null,
"name" : null,
"serviceType" : "NA"
} ]
{
"type" : "array",
"description" : "Accounting service per realm",
"items" : {
"type" : "object",
"description" : "Accounting service per realm",
"additionalProperties" : false,
"properties" : {
"realm" : {
"type" : "string",
"maxLength" : 255,
"pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$",
"description" : "Realm"
},
"serviceType" : {
"description" : "Accounting service type, NA is NA-Request Rejected",
"enum" : [ "NA", "RADIUS", "CGF" ]
},
"id" : {
"type" : [ "string", "null" ],
"description" : "Accounting service UUID"
},
"name" : {
"type" : [ "string", "null" ],
"description" : "Accounting service name"
}
},
"required" : [ "realm", "serviceType" ]
}
}
204
Use this API command to delete an accounting profile.
204
Use this API command to retrieve a list of Hotspot profiles.
200
ShowHide{
"totalCount" : 1,
"hasMore" : false,
"firstIndex" : 0,
"list" : [ {
"id" : "267ef3a0-738b-11e4-96d5-0a7820524153",
"name" : "new name"
} ]
}
{
"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 profile",
"type" : "string"
},
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the profile"
}
}
}
}
}
}
Use this API command to retrieve a Hotspot profile.
200
ShowHide{
"name" : "hotspot profile internal",
"id" : "aed0c0b7-5358-465f-8091-fa0f26134d53",
"description" : "hotspot profile internal description",
"smartClientSupport" : "None",
"smartClientInfo" : null,
"portalType" : "Internal",
"portalUrl" : 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.11.12.16", "10.11.12.13" ]
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Identifier of the Hotspot profile",
"type" : "string"
},
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the Hotspot profile"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the Hotspot profile"
},
"smartClientSupport" : {
"description" : "SmartClientSupport of the Hotspot profile",
"enum" : [ "None", "Enabled", "SmartClientOnly" ]
},
"smartClientInfo" : {
"description" : "SmartClientInfo of the Hotspot profile",
"type" : "string"
},
"portalType" : {
"description" : "Portal type of the Hotspot profile",
"enum" : [ "Internal", "External" ]
},
"portalUrl" : {
"type" : "string",
"description" : "Portal URL of the Hotspot profile"
},
"location" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Portal location id",
"type" : "string"
},
"name" : {
"description" : "Portal location name",
"type" : "string"
}
},
"description" : "Location of the Hotspot profile"
},
"redirect" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"url" : {
"type" : "string",
"description" : "Portal redirect URL"
}
},
"description" : "Redirect configuration of the Hotspot profile"
},
"portalCustomization" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"language" : {
"description" : "Language",
"default" : "en_US",
"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" ],
"description" : "Portal customization of the guest access profile"
},
"userSession" : {
"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
}
},
"description" : "User session of the Hotspot profile"
},
"walledGardens" : {
"description" : "Walled garden map set of the Hotspot profile",
"type" : "array",
"items" : {
"type" : "string"
}
},
"macAddressFormat" : {
"description" : "mac address format of redirection",
"type" : "integer",
"default" : 2,
"minimum" : 0,
"maximum" : 5
}
}
}
Use this API command to create a new Hotspot profile with internal logon URL.MacAddressFormat : 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)
{
"name" : "test-hotspot222",
"description" : "description",
"smartClientSupport" : "None",
"portalUrl" : "https://172.17.26.59",
"location" : {
"id" : "locationId",
"name" : "locationName"
},
"macAddressFormat" : 2,
"walledGardens" : [ "10.11.12.16", "10.11.12.13" ]
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the Hotspot"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the Hotspot"
},
"smartClientSupport" : {
"description" : "Smart client support of the Hotspot",
"enum" : [ "None", "Enabled" ]
},
"location" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Portal location id",
"type" : "string"
},
"name" : {
"description" : "Portal location name",
"type" : "string"
}
},
"description" : "Location of the Hotspot"
},
"redirect" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"url" : {
"type" : "string",
"description" : "Portal redirect URL"
}
},
"description" : "Redirect configuration of the Hotspot"
},
"userSession" : {
"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
}
},
"description" : "User session of the Hotspot"
},
"walledGardens" : {
"description" : "Walled garden map set of the Hotspot",
"type" : "array",
"items" : {
"type" : "string"
}
},
"macAddressFormat" : {
"description" : "mac address format of redirection",
"type" : "integer",
"default" : 2,
"minimum" : 0,
"maximum" : 5
}
},
"required" : [ "name", "smartClientSupport", "macAddressFormat" ]
}
201
ShowHide{
"id" : "76f4c020-7620-11e4-b8b9-00606eb0c700"
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Identifier of the created portal profile",
"type" : "string"
}
}
}
Use this API command to create a new Hotspot profile with external logon URL.MacAddressFormat : 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)
{
"name" : "test-hotspot222",
"description" : "description",
"smartClientSupport" : "None",
"portalUrl" : "https://172.17.26.59",
"location" : {
"id" : "locationId",
"name" : "locationName"
},
"macAddressFormat" : 2,
"walledGardens" : [ "10.11.12.16", "10.11.12.13" ]
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the Hotspot"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the Hotspot"
},
"smartClientSupport" : {
"description" : "Smart client support of the Hotspot",
"enum" : [ "None", "Enabled" ]
},
"portalUrl" : {
"type" : "string",
"description" : "Portal URL of the Hotspot"
},
"location" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Portal location id",
"type" : "string"
},
"name" : {
"description" : "Portal location name",
"type" : "string"
}
},
"description" : "Location of the hotspot"
},
"redirect" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"url" : {
"type" : "string",
"description" : "Portal redirect URL"
}
},
"description" : "Redirect configuration of the Hotspot"
},
"userSession" : {
"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
}
},
"description" : "User session of the Hotspot"
},
"walledGardens" : {
"description" : "Walled garden map set of the Hotspot",
"type" : "array",
"items" : {
"type" : "string"
}
},
"macAddressFormat" : {
"description" : "mac address format of redirection",
"type" : "integer",
"default" : 2,
"minimum" : 0,
"maximum" : 5
}
},
"required" : [ "name", "smartClientSupport", "portalUrl", "macAddressFormat" ]
}
201
ShowHide{
"id" : "76f4c020-7620-11e4-b8b9-00606eb0c700"
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Identifier of the created portal profile",
"type" : "string"
}
}
}
Use this API command to create a new Hotspot profile with smart client only.MacAddressFormat : 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)
{
"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" ]
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the Hotspot"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the Hotspot"
},
"smartClientInfo" : {
"description" : "Smart client info of the Hotspot",
"type" : "string"
},
"location" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Portal location id",
"type" : "string"
},
"name" : {
"description" : "Portal location name",
"type" : "string"
}
},
"description" : "Location of the Hotspot"
},
"redirect" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"url" : {
"type" : "string",
"description" : "Portal redirect URL"
}
},
"description" : "Redirect configuration of the Hotspot"
},
"userSession" : {
"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
}
},
"description" : "Redirect configuration of the Hotspot profile"
},
"walledGardens" : {
"description" : "Walled garden map set of the Hotspot",
"type" : "array",
"items" : {
"type" : "string"
}
},
"macAddressFormat" : {
"description" : "mac address format of redirection",
"type" : "integer",
"default" : 2,
"minimum" : 0,
"maximum" : 5
}
},
"required" : [ "name", "smartClientInfo", "macAddressFormat" ]
}
201
ShowHide{
"id" : "76f4c020-7620-11e4-b8b9-00606eb0c700"
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Identifier of the created portal profile",
"type" : "string"
}
}
}
Use this API command to modify the basic information of a Hotspot profile.MacAddressFormat : 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)
{
"name" : "test-hotspot-modify",
"description" : "description-modify",
"smartClientSupport" : "Enabled",
"portalUrl" : "https://172.17.26.59",
"macAddressFormat" : 2
}
{
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the Hotspot"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the Hotspot"
},
"smartClientSupport" : {
"description" : "Smart client support of the Hotspot",
"enum" : [ "None", "Enabled" ]
},
"smartClientInfo" : {
"description" : "Smart client info of the Hotspot",
"type" : "string"
},
"portalUrl" : {
"type" : "string",
"description" : "Portal URL of the Hotspot"
},
"macAddressFormat" : {
"description" : "mac address format of redirection",
"type" : "integer",
"default" : 2,
"minimum" : 0,
"maximum" : 5
}
}
204
Use this API command to modify the redirect information of a Hotspot profile.
{
"url" : "https://www.testurl.com"
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"url" : {
"type" : "string",
"description" : "Portal redirect URL"
}
},
"description" : "Redirect configuration of the Hotspot"
}
204
Use this API command to modify portal customization of a Hotspot profile.
{
"language" : "en_US",
"title" : "Ruckus Wireless - Subscriber Portal",
"logo" : "logo",
"termsAndConditionsRequired" : false
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"language" : {
"description" : "Language",
"default" : "en_US",
"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" ],
"description" : "Portal customization of the guest access profile"
}
204
Use this API command to modify the location information of a Hotspot profile.
{
"id" : "locationId",
"name" : "locationName"
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Portal location id",
"type" : "string"
},
"name" : {
"description" : "Portal location name",
"type" : "string"
}
},
"description" : "Location of the Hotspot"
}
204
Use this API command to modify a walled gardens of a Hotspot profile.
[ "10.1.1.1", "11.11.111.11" ]
{
"description" : "Walled garden map set of the Hotspot",
"type" : "array",
"items" : {
"type" : "string"
}
}
204
Use this API command to delete a Hotspot profile.
204
Use this API command to retrieve a list of online signup portal profiles.
number
(optional) The index of the first entry to be retrieved. Default: 0
number
(optional) The maximum number of entries to be retrieved. Default: 100
200
ShowHide{
"totalCount" : 1,
"hasMore" : false,
"firstIndex" : 0,
"list" : [ {
"id" : "267ef3a0-738b-11e4-96d5-0a7820524153",
"name" : "new name"
} ]
}
{
"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 profile",
"type" : "string"
},
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the profile"
}
}
}
}
}
}
Use this API command to retrieve an online signup portal profile.
200
ShowHide{
"id" : "b25a84f0-7f77-11e4-9abf-00606eb0c700",
"name" : "public-api-osu-profile",
"description" : "osu create desc",
"portalCustomization" : {
"language" : "zh_TW",
"title" : "Welcome to the Guest Access login page.",
"logo" : "logomsg",
"termsAndConditionsText" : "test",
"termsAndConditionsRequired" : true
}
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Identifier of the online singup profile",
"type" : "string"
},
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the online singup profile"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the online singup profile"
},
"portalCustomization" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"language" : {
"description" : "Language",
"default" : "en_US",
"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" ],
"description" : "Portal customization of the online singup profile"
}
}
}
Use this API command to create a new online signup portal profile.
{
"name" : "public-api-osu-profile",
"description" : "osu create desc",
"portalCustomization" : {
"language" : "en_US",
"title" : "abctitle",
"logo" : "logomsg",
"termsAndConditionsRequired" : true,
"termsAndConditionsText" : "test"
}
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the online singup profile"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the online singup profile"
},
"portalCustomization" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"language" : {
"description" : "Language",
"default" : "en_US",
"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" ],
"description" : "Portal customization of the online singup profile"
}
},
"required" : [ "name", "portalCustomization" ]
}
201
ShowHide{
"id" : "profileUUID"
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
}
}
}
Use this API command to modify the basic information of an online signup portal profile.
{
"name" : "OSU test name",
"description" : "modify basic configuration"
}
{
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the online singup profile"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the online singup profile"
}
}
204
Use this API command to modify portal customization of an online signup portal profile.
{
"language" : "zh_TW",
"title" : "Welcome to the Guest Access login page.",
"logo" : "logomsg",
"termsAndConditionsRequired" : true,
"termsAndConditionsText" : "test"
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"language" : {
"description" : "Language",
"default" : "en_US",
"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" ],
"description" : "Portal customization of the online singup profile"
}
204
Use this API command to delete an online signup portal profile.
204
Retrieve a list of IPSEC
number
(optional) The index of the first entry to be retrieved. Default: 0
number
(optional) The maximum number of entries to be retrieved. Default: 100
200
ShowHide{
"totalCount" : 1,
"hasMore" : false,
"firstIndex" : 0,
"list" : [ {
"id" : "267ef3a0-738b-11e4-96d5-0a7820524153",
"name" : "new name"
} ]
}
{
"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 profile",
"type" : "string"
},
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the profile"
}
}
}
}
}
}
Retrieve a IPSEC
200
ShowHide{
"id" : "0b767870-ab59-11e4-87f2-000c29c1611c",
"name" : "ipsec content",
"description" : "ipsec content description",
"serverAddr" : "221.11.11.11",
"authType" : "PresharedKey",
"preSharedKey" : "2212222111",
"ikeSecurityAssociation" : {
"ikeProposalType" : "Specific",
"ikeProposals" : [ {
"encAlg" : "AES128",
"authAlg" : "SHA1",
"prfAlg" : "UseIntegrityALG",
"dhGroup" : "Modp2048"
}, {
"encAlg" : "ThreeDES",
"authAlg" : "MD5",
"prfAlg" : "UseIntegrityALG",
"dhGroup" : "Modp8192"
} ]
},
"espSecurityAssociation" : {
"espProposalType" : "Specific",
"espProposals" : [ {
"encAlg" : "AES128",
"authAlg" : "SHA1",
"dhGroup" : "Modp2048"
}, {
"encAlg" : "ThreeDES",
"authAlg" : "MD5",
"dhGroup" : "Modp8192"
} ]
},
"ikeRekeyTime" : 0,
"ikeRekeyTimeUnit" : "hour",
"espRekeyTime" : 0,
"espRekeyTimeUnit" : "day",
"cmProtocolOption" : {
"cmpDhcpOpt43Subcode" : 55,
"cmpServerAddr" : "cmp test addr",
"cmpServerPath" : "cmp test path"
},
"advancedOption" : {
"dhcpOpt43Subcode" : 8,
"retryLimit" : 6,
"replayWindow" : 30,
"ipcompEnable" : "Enabled",
"enforceNatt" : "Enabled",
"dpdDelay" : 11,
"keepAliveIntval" : 2,
"failoverRetryPeriod" : 5,
"failoverRetryInterval" : 6,
"failoverMode" : "Revertive",
"failoverPrimaryCheckInterval" : 7
},
"ipMode" : "IPV4"
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "identifier of the ipsec profile",
"type" : "string"
},
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "name of the ipsec profile"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "description of the ipsec profile"
},
"serverAddr" : {
"description" : "server Addr of the ipsec profile",
"type" : "string"
},
"authType" : {
"description" : "authentication type of the ipsec profile",
"enum" : [ "PresharedKey", "Certificate" ]
},
"preSharedKey" : {
"description" : "authentication preShared Key of the ipsec profile",
"type" : "string"
},
"ikeSecurityAssociation" : {
"type" : "object",
"description" : "ikeProposal Security Association of the ipsec profile ",
"properties" : {
"ikeProposalType" : {
"description" : "ikeProposal Type of the ipsec profile",
"enum" : [ "Default", "Specific" ]
},
"ikeProposals" : {
"type" : "array",
"description" : "ikeProposal list of the ipsec profile ",
"items" : {
"type" : "object",
"description" : "IkeProposal based ipsec service mappings",
"properties" : {
"encAlg" : {
"description" : "encAlg of ikeProposal Specific",
"enum" : [ "ThreeDES", "AES128", "AES192", "AES256" ]
},
"authAlg" : {
"description" : "authAlg of ikeProposal Specific",
"enum" : [ "MD5", "SHA1", "AESXCBC", "SHA256", "SHA384", "SHA512" ]
},
"prfAlg" : {
"description" : "prfAlg of ikeProposal Specific",
"enum" : [ "UseIntegrityALG", "PRF_MD5", "PRF_SHA1", "PRF_AES_CBC", "PRF_AES_MAC", "PRF_SHA256", "PRF_SHA384", "PRF_SHA512" ]
},
"dhGroup" : {
"description" : "dhGroup of ikeProposal Specific",
"enum" : [ "Modp768", "Modp1024", "Modp1536", "Modp2048", "Modp3072", "Modp4096", "Modp6144", "Modp8192" ]
}
},
"required" : [ "encAlg", "authAlg", "prfAlg", "dhGroup" ]
}
}
}
},
"espSecurityAssociation" : {
"type" : "object",
"description" : "espProposal Security Association of the ipsec profile ",
"properties" : {
"espProposalType" : {
"description" : "espProposal Type of the ipsec profile",
"enum" : [ "Default", "Specific" ]
},
"espProposals" : {
"type" : "array",
"description" : "espProposal list of the ipsec profile ",
"items" : {
"type" : "object",
"description" : "EspProposal based ipsec service mappings",
"properties" : {
"encAlg" : {
"description" : "encAlg of espProposal Specific",
"enum" : [ "None", "ThreeDES", "AES128", "AES192", "AES256" ]
},
"authAlg" : {
"description" : "authAlg of espProposal Specific",
"enum" : [ "MD5", "SHA1", "AESXCBC", "SHA256", "SHA384", "SHA512" ]
},
"dhGroup" : {
"description" : "dhGroup of espProposal Specific",
"enum" : [ "None", "Modp768", "Modp1024", "Modp1536", "Modp2048", "Modp3072", "Modp4096", "Modp6144", "Modp8192" ]
}
},
"required" : [ "encAlg", "authAlg", "dhGroup" ]
}
}
}
},
"ikeRekeyTime" : {
"description" : "ikeRekey Time of the ipsec profile ",
"type" : "number"
},
"ikeRekeyTimeUnit" : {
"description" : "ikeRekey time unit of the ipsec profile ",
"enum" : [ "second", "minute", "hour", "day" ]
},
"espRekeyTime" : {
"description" : "espRekey Time of the ipsec profile ",
"type" : "number"
},
"espRekeyTimeUnit" : {
"description" : "espRekey time unit of the ipsec profile ",
"enum" : [ "second", "minute", "hour", "day" ]
},
"cmProtocolOption" : {
"type" : "object",
"description" : "Certificate Management Protocol option of the ipsec profile ",
"properties" : {
"cmpDhcpOpt43Subcode" : {
"description" : "Certificate Management Protocol dhcpOpt43Subcode",
"type" : "number"
},
"cmpServerAddr" : {
"description" : "Certificate Management Protocol Server addr",
"type" : "string"
},
"cmpServerPath" : {
"description" : "Certificate Management Protocol Server Path",
"type" : "string"
}
},
"required" : [ "cmpDhcpOpt43Subcode" ]
},
"advancedOption" : {
"type" : "object",
"description" : "advanced option of the ipsec profile ",
"properties" : {
"dhcpOpt43Subcode" : {
"description" : "dhcpOpt43Subcode of the ipsec profile ",
"type" : "number"
},
"retryLimit" : {
"description" : "retryLimit of the ipsec profile ",
"type" : "number"
},
"replayWindow" : {
"description" : "replayWindow of the ipsec profile ",
"type" : "number"
},
"ipcompEnable" : {
"description" : "ipcomp Enable of the ipsec profile",
"enum" : [ "Disabled", "Enabled" ]
},
"enforceNatt" : {
"description" : "enforceNatt Enable of the ipsec profile",
"enum" : [ "Disabled", "Enabled" ]
},
"dpdDelay" : {
"description" : "dpdDelay of the ipsec profile ",
"type" : "number"
},
"keepAliveIntval" : {
"description" : "keepAliveIntval of the ipsec profile ",
"type" : "number"
},
"failoverRetryPeriod" : {
"description" : "Retry Period of the failover ",
"type" : "number"
},
"failoverRetryInterval" : {
"description" : " Retry Interval of the failover",
"type" : "number"
},
"failoverMode" : {
"description" : " mode of the failover",
"enum" : [ "Non_Revertive", "Revertive" ]
},
"failoverPrimaryCheckInterval" : {
"description" : " Primary Check Interval of the failover",
"type" : "number"
}
}
},
"ipMode" : {
"enum" : [ "IPV4", "IPV6", "IPV4_IPV6" ],
"description" : "ipMode of the ipsec profile "
}
}
}
Create a new ipsec
{
"name" : "ipsec create",
"description" : "ipsec create description",
"serverAddr" : "111.11.11.11",
"authType" : "PresharedKey",
"preSharedKey" : "11111111111",
"ikeRekeyTime" : 4,
"espRekeyTime" : 1,
"ikeRekeyTimeUnit" : "minute",
"espRekeyTimeUnit" : "day",
"ipMode" : "IPV4"
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "name of the ipsec profile"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "description of the ipsec profile"
},
"serverAddr" : {
"description" : "server Addr of the ipsec profile",
"type" : "string"
},
"authType" : {
"description" : "authentication type of the ipsec profile",
"enum" : [ "PresharedKey", "Certificate" ]
},
"preSharedKey" : {
"description" : "authentication preShared Key of the ipsec profile",
"type" : "string"
},
"ikeRekeyTime" : {
"description" : "ikeRekey Time of the ipsec profile ",
"type" : "number"
},
"ikeRekeyTimeUnit" : {
"description" : "ikeRekey time unit of the ipsec profile ",
"enum" : [ "second", "minute", "hour", "day" ]
},
"espRekeyTime" : {
"description" : "espRekey Time of the ipsec profile ",
"type" : "number"
},
"espRekeyTimeUnit" : {
"description" : "espRekey time unit of the ipsec profile ",
"enum" : [ "second", "minute", "hour", "day" ]
},
"ipMode" : {
"enum" : [ "IPV4", "IPV6", "IPV4_IPV6" ],
"description" : "ipMode of the ipsec profile "
}
},
"required" : [ "name", "serverAddr", "ikeRekeyTime", "espRekeyTime", "ipMode" ]
}
201
ShowHide{
"id" : "profileUUID"
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
}
}
}
Modify a specific ipsec basic
{
"name" : "ipsec moify",
"description" : "ipsec modify description",
"serverAddr" : "221.11.11.11",
"authType" : "PresharedKey",
"preSharedKey" : "2212222111",
"ikeRekeyTime" : 5,
"ikeRekeyTimeUnit" : "hour",
"espRekeyTime" : 6,
"espRekeyTimeUnit" : "day"
}
{
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "name of the ipsec profile"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "description of the ipsec profile"
},
"serverAddr" : {
"description" : "server Addr of the ipsec profile",
"type" : "string"
},
"authType" : {
"description" : "authentication type of the ipsec profile",
"enum" : [ "PresharedKey", "Certificate" ]
},
"preSharedKey" : {
"description" : "authentication preShared Key of the ipsec profile",
"type" : "string"
},
"ikeRekeyTime" : {
"description" : "ikeRekey Time of the ipsec profile ",
"type" : "number"
},
"ikeRekeyTimeUnit" : {
"description" : "ikeRekey time unit of the ipsec profile ",
"enum" : [ "second", "minute", "hour", "day" ]
},
"espRekeyTime" : {
"description" : "espRekey Time of the ipsec profile ",
"type" : "number"
},
"espRekeyTimeUnit" : {
"description" : "espRekey time unit of the ipsec profile ",
"enum" : [ "second", "minute", "hour", "day" ]
}
}
204
Modify a specific ipsec ikeSecurityAssociation
{
"ikeProposalType" : "Specific",
"ikeProposals" : [ {
"encAlg" : "AES128",
"authAlg" : "SHA1",
"prfAlg" : "UseIntegrityALG",
"dhGroup" : "Modp2048"
}, {
"encAlg" : "ThreeDES",
"authAlg" : "MD5",
"prfAlg" : "UseIntegrityALG",
"dhGroup" : "Modp8192"
} ]
}
{
"type" : "object",
"description" : "ikeProposal Security Association of the ipsec profile ",
"properties" : {
"ikeProposalType" : {
"description" : "ikeProposal Type of the ipsec profile",
"enum" : [ "Default", "Specific" ]
},
"ikeProposals" : {
"type" : "array",
"description" : "ikeProposal list of the ipsec profile ",
"items" : {
"type" : "object",
"description" : "IkeProposal based ipsec service mappings",
"properties" : {
"encAlg" : {
"description" : "encAlg of ikeProposal Specific",
"enum" : [ "ThreeDES", "AES128", "AES192", "AES256" ]
},
"authAlg" : {
"description" : "authAlg of ikeProposal Specific",
"enum" : [ "MD5", "SHA1", "AESXCBC", "SHA256", "SHA384", "SHA512" ]
},
"prfAlg" : {
"description" : "prfAlg of ikeProposal Specific",
"enum" : [ "UseIntegrityALG", "PRF_MD5", "PRF_SHA1", "PRF_AES_CBC", "PRF_AES_MAC", "PRF_SHA256", "PRF_SHA384", "PRF_SHA512" ]
},
"dhGroup" : {
"description" : "dhGroup of ikeProposal Specific",
"enum" : [ "Modp768", "Modp1024", "Modp1536", "Modp2048", "Modp3072", "Modp4096", "Modp6144", "Modp8192" ]
}
},
"required" : [ "encAlg", "authAlg", "prfAlg", "dhGroup" ]
}
}
}
}
204
Modify a specific ipsec espSecurityAssociation
{
"espProposalType" : "Specific",
"espProposals" : [ {
"encAlg" : "AES128",
"authAlg" : "SHA1",
"dhGroup" : "Modp2048"
}, {
"encAlg" : "ThreeDES",
"authAlg" : "MD5",
"dhGroup" : "Modp8192"
} ]
}
{
"type" : "object",
"description" : "espProposal Security Association of the ipsec profile ",
"properties" : {
"espProposalType" : {
"description" : "espProposal Type of the ipsec profile",
"enum" : [ "Default", "Specific" ]
},
"espProposals" : {
"type" : "array",
"description" : "espProposal list of the ipsec profile ",
"items" : {
"type" : "object",
"description" : "EspProposal based ipsec service mappings",
"properties" : {
"encAlg" : {
"description" : "encAlg of espProposal Specific",
"enum" : [ "None", "ThreeDES", "AES128", "AES192", "AES256" ]
},
"authAlg" : {
"description" : "authAlg of espProposal Specific",
"enum" : [ "MD5", "SHA1", "AESXCBC", "SHA256", "SHA384", "SHA512" ]
},
"dhGroup" : {
"description" : "dhGroup of espProposal Specific",
"enum" : [ "None", "Modp768", "Modp1024", "Modp1536", "Modp2048", "Modp3072", "Modp4096", "Modp6144", "Modp8192" ]
}
},
"required" : [ "encAlg", "authAlg", "dhGroup" ]
}
}
}
}
204
Modify a specific ipsec cmProtocolOption
{
"cmpDhcpOpt43Subcode" : 55,
"cmpServerAddr" : "cmp test addr",
"cmpServerPath" : "cmp test path"
}
{
"type" : "object",
"description" : "Certificate Management Protocol option of the ipsec profile ",
"properties" : {
"cmpDhcpOpt43Subcode" : {
"description" : "Certificate Management Protocol dhcpOpt43Subcode",
"type" : "number"
},
"cmpServerAddr" : {
"description" : "Certificate Management Protocol Server addr",
"type" : "string"
},
"cmpServerPath" : {
"description" : "Certificate Management Protocol Server Path",
"type" : "string"
}
},
"required" : [ "cmpDhcpOpt43Subcode" ]
}
204
Modify a specific ipsec advancedOption
{
"dhcpOpt43Subcode" : 8,
"retryLimit" : 6,
"replayWindow" : 30,
"ipcompEnable" : "Enabled",
"enforceNatt" : "Enabled",
"dpdDelay" : 11,
"keepAliveIntval" : 2,
"failoverRetryPeriod" : 5,
"failoverRetryInterval" : 6,
"failoverMode" : "Revertive",
"failoverPrimaryCheckInterval" : 7
}
{
"type" : "object",
"description" : "advanced option of the ipsec profile ",
"properties" : {
"dhcpOpt43Subcode" : {
"description" : "dhcpOpt43Subcode of the ipsec profile ",
"type" : "number"
},
"retryLimit" : {
"description" : "retryLimit of the ipsec profile ",
"type" : "number"
},
"replayWindow" : {
"description" : "replayWindow of the ipsec profile ",
"type" : "number"
},
"ipcompEnable" : {
"description" : "ipcomp Enable of the ipsec profile",
"enum" : [ "Disabled", "Enabled" ]
},
"enforceNatt" : {
"description" : "enforceNatt Enable of the ipsec profile",
"enum" : [ "Disabled", "Enabled" ]
},
"dpdDelay" : {
"description" : "dpdDelay of the ipsec profile ",
"type" : "number"
},
"keepAliveIntval" : {
"description" : "keepAliveIntval of the ipsec profile ",
"type" : "number"
},
"failoverRetryPeriod" : {
"description" : "Retry Period of the failover ",
"type" : "number"
},
"failoverRetryInterval" : {
"description" : " Retry Interval of the failover",
"type" : "number"
},
"failoverMode" : {
"description" : " mode of the failover",
"enum" : [ "Non_Revertive", "Revertive" ]
},
"failoverPrimaryCheckInterval" : {
"description" : " Primary Check Interval of the failover",
"type" : "number"
}
}
}
204
Delete a ipsec
204
Use this API command to retrieve a list of Hotspot 2.0 venue profile of a zone.
200
ShowHide{
"totalCount" : 9,
"hasMore" : false,
"firstIndex" : 0,
"list" : [ {
"id" : "c5dfc930-75dc-11e4-8d56-00606eb0c700",
"name" : "protalName1"
}, {
"id" : "15efd160-7153-11e4-aa08-00606eb0c700",
"name" : "protalName2"
}, {
"id" : "be0f0480-73a9-11e4-9d1d-f0def13d5845",
"name" : "protalName3"
}, {
"id" : "7f0eef00-7423-11e4-bcef-000c299b4765",
"name" : "protalName4"
}, {
"id" : "4f5c98a0-7123-11e4-bcef-000c299b4765",
"name" : "protalName5"
}, {
"id" : "4a023ce0-73ab-11e4-b211-f0def13d5845",
"name" : "protalName6"
}, {
"id" : "afebbc80-73be-11e4-bfde-f0def13d5845",
"name" : "protalName7"
}, {
"id" : "76f4c020-7620-11e4-b8b9-00606eb0c700",
"name" : "protalName8"
}, {
"id" : "96308310-752c-11e4-8276-00606eb0c700",
"name" : "protalName9"
} ]
}
{
"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" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the service"
}
}
}
}
}
}
Use this API command to retrieve a Hotspot 2.0 venue profile of a zone.
200
ShowHide{
"name" : "test-hs20Venue",
"id" : "4136c9f0-7f6d-11e4-8fea-80fa5b024259",
"description" : "des-hs20Venue",
"zoneId" : "6b4279d6-a003-464e-9cbc-1e7ebee387c0",
"group" : "UtilityAndMiscellaneous",
"type" : "Unspecified",
"downlinkSpeedInKbps" : 22,
"uplinkSpeedInKbps" : 224,
"venueNames" : [ {
"language" : "English",
"name" : "add friendly name"
}, {
"language" : "German",
"name" : "add friendly name"
}, {
"language" : "Japanese",
"name" : "add friendly name"
}, {
"language" : "Swedish",
"name" : "add friendly name"
}, {
"language" : "Turkish",
"name" : "add friendly name"
} ]
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Identifier of the Hotspot 2.0 venue profile",
"type" : "string"
},
"zoneId" : {
"description" : "Identifier of the zone which the Hotspot 2.0 venue profile belongs to",
"type" : "string"
},
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the Hotspot 2.0 venue profile"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the Hotspot 2.0 venue profile"
},
"group" : {
"description" : "Category group of the Hotspot 2.0 venue profile",
"enum" : [ "Unspecified", "Assembly", "Business", "Educational", "FactoryAndIndustrial", "Institutional", "Mercantile", "Residential", "Storage", "UtilityAndMiscellaneous", "Vehicular", "Outdoor" ]
},
"type" : {
"description" : "Category type of the Hotspot 2.0 venue profile",
"type" : "string"
},
"downlinkSpeedInKbps" : {
"description" : "Downlink Speed of the Hotspot 2.0 venue profile",
"type" : "number",
"minimum" : 0,
"maximum" : 4294967295
},
"uplinkSpeedInKbps" : {
"description" : "Uplink Speed of the Hotspot 2.0 venue profile",
"type" : "number",
"minimum" : 0,
"maximum" : 4294967295
},
"venueNames" : {
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"language" : {
"enum" : [ "English", "Chinese", "Czech", "Danish", "Dutch", "French", "German", "Japanese", "Spanish", "Korean", "Swedish", "Turkish" ],
"description" : "Friendly name of venue"
},
"name" : {
"description" : "Venue name",
"type" : "string"
}
},
"required" : [ "language", "name" ]
}
}
}
}
Use this API command to create a new Hotspot 2.0 venue profile of a zone.
{
"name" : "test-hs20Venue",
"description" : "des-hs20Venue",
"group" : "UtilityAndMiscellaneous",
"type" : "Unspecified",
"downlinkSpeedInKbps" : 22,
"uplinkSpeedInKbps" : 224,
"venueNames" : [ {
"language" : "English",
"name" : "add friendly name"
}, {
"language" : "German",
"name" : "add friendly name"
}, {
"language" : "Japanese",
"name" : "add friendly name"
}, {
"language" : "Swedish",
"name" : "add friendly name"
}, {
"language" : "Turkish",
"name" : "add friendly name"
} ]
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the Hotspot 2.0 venue profile"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the Hotspot 2.0 venue profile"
},
"group" : {
"description" : "Category group of the Hotspot 2.0 venue profile",
"enum" : [ "Unspecified", "Assembly", "Business", "Educational", "FactoryAndIndustrial", "Institutional", "Mercantile", "Residential", "Storage", "UtilityAndMiscellaneous", "Vehicular", "Outdoor" ]
},
"type" : {
"description" : "Category type of the Hotspot 2.0 venue profile",
"type" : "string"
},
"downlinkSpeedInKbps" : {
"description" : "Downlink Speed of the Hotspot 2.0 venue profile",
"type" : "number",
"minimum" : 0,
"maximum" : 4294967295
},
"uplinkSpeedInKbps" : {
"description" : "Uplink Speed of the Hotspot 2.0 venue profile",
"type" : "number",
"minimum" : 0,
"maximum" : 4294967295
},
"venueNames" : {
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"language" : {
"enum" : [ "English", "Chinese", "Czech", "Danish", "Dutch", "French", "German", "Japanese", "Spanish", "Korean", "Swedish", "Turkish" ],
"description" : "Friendly name of venue"
},
"name" : {
"description" : "Venue name",
"type" : "string"
}
},
"required" : [ "language", "name" ]
}
}
},
"required" : [ "name", "venueNames" ]
}
201
ShowHide{
"id" : "76f4c020-7620-11e4-b8b9-00606eb0c700"
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Identifier of the created portal profile",
"type" : "string"
}
}
}
Use this API command to modify the basic information on Hotspot 2.0 venue profile of a zone.
{
"name" : "test-hs20Venue-modify",
"description" : "des-hs20Venue-modify",
"group" : "UtilityAndMiscellaneous",
"type" : "Unspecified",
"downlinkSpeedInKbps" : 111111,
"uplinkSpeedInKbps" : 11111
}
{
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the Hotspot 2.0 venue profile"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the Hotspot 2.0 venue profile"
},
"group" : {
"description" : "Category group of the Hotspot 2.0 venue profile",
"enum" : [ "Unspecified", "Assembly", "Business", "Educational", "FactoryAndIndustrial", "Institutional", "Mercantile", "Residential", "Storage", "UtilityAndMiscellaneous", "Vehicular", "Outdoor" ]
},
"type" : {
"description" : "Category type of the Hotspot 2.0 venue profile",
"type" : "string"
},
"downlinkSpeedInKbps" : {
"description" : "Downlink Speed of the Hotspot 2.0 venue profile",
"type" : "number",
"minimum" : 0,
"maximum" : 4294967295
},
"uplinkSpeedInKbps" : {
"description" : "Uplink Speed of the Hotspot 2.0 venue profile",
"type" : "number",
"minimum" : 0,
"maximum" : 4294967295
}
}
204
Use this API command to modify the venue names on Hotspot 2.0 venue profile of a zone.
[ {
"language" : "English",
"name" : "add friendly name"
}, {
"language" : "German",
"name" : "add friendly name"
}, {
"language" : "Japanese",
"name" : "add friendly name"
}, {
"language" : "Swedish",
"name" : "add friendly name"
}, {
"language" : "Turkish",
"name" : "add friendly name"
} ]
{
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"language" : {
"enum" : [ "English", "Chinese", "Czech", "Danish", "Dutch", "French", "German", "Japanese", "Spanish", "Korean", "Swedish", "Turkish" ],
"description" : "Friendly name of venue"
},
"name" : {
"description" : "Venue name",
"type" : "string"
}
},
"required" : [ "language", "name" ]
}
}
204
Use this API command to delete Hotspot 2.0 venue profile of a zone.
204
Use this API command to retrieve list of Hotspot 2.0 Wi-Fi Operators.
number
(optional) The index of the first entry to be retrieved. Default: 0
number
(optional) The maximum number of entries to be retrieved. Default: 100
200
ShowHide{
"totalCount" : 1,
"hasMore" : false,
"firstIndex" : 0,
"list" : [ {
"id" : "267ef3a0-738b-11e4-96d5-0a7820524153",
"name" : "new name"
} ]
}
{
"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 profile",
"type" : "string"
},
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the profile"
}
}
}
}
}
}
Use this API command to retrieve a Hotspot 2.0 Wi-Fi operator.
200
ShowHide{
"name" : "public-api-operator",
"description" : "description-changed",
"domainNames" : [ "ruckus.com" ],
"friendlyNames" : [ {
"language" : "English",
"name" : "ruckus"
} ],
"certificate" : {
"id" : "certificateID",
"name" : "certificateName"
}
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Identifier of the profile",
"type" : "string"
},
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the Hotspot 2.0 Wifi operator profile"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the Hotspot 2.0 Wifi operator profile"
},
"domainNames" : {
"description" : "Domain names",
"type" : "array",
"items" : {
"description" : "Compare with FQDN, it could start with '*.'",
"type" : "string",
"pattern" : "^((?=.{1,253}$)((?=[a-z0-9-]{1,63}\.)(xn--)?[a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,63}|(\*\.)(?=.{1,253}$)((?=[a-z0-9-]{1,63}\.)(xn--)?[a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,63})$"
}
},
"friendlyNames" : {
"description" : "Friendly names",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"language" : {
"enum" : [ "English", "Chinese", "Czech", "Danish", "Dutch", "French", "German", "Japanese", "Spanish", "Korean", "Swedish", "Turkish" ],
"description" : "Language of the friendly name"
},
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the friendly name"
}
},
"required" : [ "language", "name" ]
}
},
"certificate" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
},
"description" : "Signup security certificate"
}
},
"required" : [ "name", "domainNames", "friendlyNames" ]
}
Use this API command to create a new Hotspot 2.0 Wi-Fi operator,
{
"name" : "public-api-operator",
"domainNames" : [ "ruckus.com" ],
"friendlyNames" : [ {
"language" : "English",
"name" : "ruckus"
} ],
"certificate" : {
"id" : "certificateID",
"name" : "certificateName"
}
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the Hotspot 2.0 Wifi operator profile"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the Hotspot2.0 Wifi operator profile"
},
"domainNames" : {
"description" : "Domain names",
"type" : "array",
"items" : {
"description" : "Compare with FQDN, it could start with '*.'",
"type" : "string",
"pattern" : "^((?=.{1,253}$)((?=[a-z0-9-]{1,63}\.)(xn--)?[a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,63}|(\*\.)(?=.{1,253}$)((?=[a-z0-9-]{1,63}\.)(xn--)?[a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,63})$"
}
},
"friendlyNames" : {
"description" : "Friendly names",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"language" : {
"enum" : [ "English", "Chinese", "Czech", "Danish", "Dutch", "French", "German", "Japanese", "Spanish", "Korean", "Swedish", "Turkish" ],
"description" : "Language of the friendly name"
},
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the friendly name"
}
},
"required" : [ "language", "name" ]
}
},
"certificate" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
},
"description" : "Signup security certificate"
}
},
"required" : [ "name", "domainNames", "friendlyNames" ]
}
201
ShowHide{
"id" : "profileUUID"
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
}
}
}
Use this API command to modify the basic information of a Hotspot 2.0 Wi-Fi operator.
{
"name" : "public-api-operator-changed",
"description" : "description-changed"
}
{
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the Hotspot 2.0 Wifi operator profile"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the Hotspot 2.0 Wifi operator profile"
}
}
204
Use this API command to modify domain names of a Hotspot 2.0 Wi-Fi operator.
[ "ruckus.com" ]
{
"description" : "Domain names",
"type" : "array",
"items" : {
"description" : "Compare with FQDN, it could start with '*.'",
"type" : "string",
"pattern" : "^((?=.{1,253}$)((?=[a-z0-9-]{1,63}\.)(xn--)?[a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,63}|(\*\.)(?=.{1,253}$)((?=[a-z0-9-]{1,63}\.)(xn--)?[a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,63})$"
}
}
204
Use this API command to modify friendly names of a Hotspot 2.0 Wi-Fi operator.
[ {
"language" : "English",
"name" : "ruckus"
} ]
{
"description" : "Friendly names",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"language" : {
"enum" : [ "English", "Chinese", "Czech", "Danish", "Dutch", "French", "German", "Japanese", "Spanish", "Korean", "Swedish", "Turkish" ],
"description" : "Language of the friendly name"
},
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the friendly name"
}
},
"required" : [ "language", "name" ]
}
}
204
Use this API command to enable or modify certificate of a Hotspot 2.0 Wi-Fi operator.
{
"id" : "certificateID",
"name" : "certificateName"
}
{
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
},
"description" : "Signup security certificate"
}
204
Use this API command to disable certificate of a Hotspot 2.0 Wi-Fi operator.
204
Use this API command to delete a Hotspot 2.0 Wi-Fi operator.
204
Use this API command to retrieve list of Hotspot 2.0 identity providers.
number
(optional) The index of the first entry to be retrieved. Default: 0
number
(optional) The maximum number of entries to be retrieved. Default: 100
200
ShowHide{
"totalCount" : 1,
"hasMore" : false,
"firstIndex" : 0,
"list" : [ {
"id" : "267ef3a0-738b-11e4-96d5-0a7820524153",
"name" : "new name"
} ]
}
{
"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 profile",
"type" : "string"
},
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the profile"
}
}
}
}
}
}
Use this API command to retrieve a Hotspot 2.0 identity provider.
200
ShowHide{
"id" : "1fb20eaf-7b9b-40c7-8b9b-7d69d6165176",
"mvnoId" : "839f87c6-d116-497e-afce-aa8157abd30c",
"name" : "hs20IdentithInternalOSU",
"description" : "",
"realms" : [ {
"name" : "reamlll",
"encoding" : "RFC4282",
"eapMethods" : [ {
"type" : "NA",
"authSettings" : null
}, {
"type" : "NA",
"authSettings" : null
}, {
"type" : "NA",
"authSettings" : null
}, {
"type" : "NA",
"authSettings" : null
} ]
} ],
"plmns" : null,
"homeOis" : null,
"authentications" : [ {
"id" : "868b0b20-8598-11e4-8acc-08002716c79f",
"name" : "globalRadius",
"realm" : "globalAuth",
"serviceType" : "RADIUS",
"vlanId" : 23,
"refBlank" : false
}, {
"id" : null,
"name" : null,
"realm" : "No Match",
"serviceType" : "NA",
"vlanId" : null,
"refBlank" : true
}, {
"id" : null,
"name" : null,
"realm" : "Unspecified",
"serviceType" : "NA",
"vlanId" : null,
"refBlank" : true
} ],
"accountings" : [ {
"id" : "789ff6b0-8598-11e4-8acc-08002716c79f",
"name" : "globalRadiusAcct",
"realm" : "globalAcct",
"serviceType" : "RADIUS",
"refBlank" : false
}, {
"id" : null,
"name" : null,
"realm" : "No Match",
"serviceType" : "NA",
"refBlank" : true
}, {
"id" : null,
"name" : null,
"realm" : "Unspecified",
"serviceType" : "NA",
"refBlank" : true
} ],
"osu" : {
"type" : "Internal",
"internalOSU" : {
"provisioningProtocals" : [ "SOAP_XML" ],
"provisioningFormat" : "R1_R2_ZEROIT",
"provisioningUpdateType" : "NEVER",
"osuPortal" : {
"type" : "Internal",
"internalOSUPortal" : {
"id" : "24cdfc80-8598-11e4-8acc-08002716c79f",
"name" : null,
"refBlank" : false
},
"externalUrl" : null
},
"commonLanguageIcon" : "imageDATA",
"serviceDescriptions" : [ {
"language" : "English",
"name" : "ruckus",
"description" : "",
"icon" : ""
} ],
"certificate" : {
"id" : "certificateID",
"name" : "certificateName"
},
"osuAuthServices" : [ {
"id" : "11111111-1111-1111-1111-111111111111",
"name" : null,
"credentialType" : "LOCAL",
"realm" : "reamlll",
"expiration" : -1,
"refBlank" : false
} ],
"whitelistedDomains" : [ ]
},
"externalOSU" : null
}
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Identifier of the Hotspot 2.0 identity provider profile",
"type" : "string"
},
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the Hotspot 2.0 identity provider profile"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the Hotspot 2.0 identity provider profile"
},
"realms" : {
"description" : "Realms",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of realm"
},
"encoding" : {
"description" : "Encoding",
"enum" : [ "RFC4282", "UTF8" ]
},
"eapMethods" : {
"description" : "EAP methods",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"type" : {
"description" : "EAP method type",
"enum" : [ "NA", "MD5", "EAP_TLS", "EAP_Cisco", "EAP_SIM", "EAP_TTLS", "EAP_AKA", "PEAP", "EAP_MSCHAP_V2", "EAP_AKAs", "Reserved" ]
},
"authSettings" : {
"description" : "EAP method auth settings",
"type" : [ "array", "null" ],
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"info" : {
"description" : "EAP auth info",
"enum" : [ "Expanded", "Non", "Inner", "Expanded_Inner", "Credential", "Tunneled" ]
},
"type" : {
"description" : "EAP auth type",
"type" : "string"
},
"vendorId" : {
"description" : "EAP auth vendor ID",
"type" : [ "integer", "null" ],
"minimum" : 0,
"maximum" : 16777215
},
"vendorType" : {
"description" : "EAP auth vendor type",
"type" : [ "integer", "null" ],
"minimum" : 0,
"maximum" : 4294967295
}
},
"required" : [ "info" ]
}
}
},
"required" : [ "type" ]
}
}
},
"required" : [ "name", "encoding", "eapMethods" ]
}
},
"plmns" : {
"description" : "PLMNs",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"mcc" : {
"description" : "MCC",
"type" : "string",
"pattern" : "^[0-9]{3}$"
},
"mnc" : {
"description" : "MNC",
"type" : "string",
"pattern" : "^[0-9]{2,3}$"
}
},
"required" : [ "mcc", "mnc" ]
}
},
"homeOis" : {
"description" : "Home OIs",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"name" : {
"description" : "Name of the home OI",
"type" : "string",
"maxLength" : 255
},
"oi" : {
"description" : "Orgnization ID(3Hex or 5Hex)",
"type" : "string",
"pattern" : "^(([0-9a-fA-F][0-9a-fA-F]){3}|([0-9a-fA-F][0-9a-fA-F]){5})$"
}
},
"required" : [ "name", "oi" ]
}
},
"authentications" : {
"description" : "Authentications",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Authentication id",
"type" : [ "string", "null" ]
},
"name" : {
"description" : "Authentication name",
"type" : [ "string", "null" ]
},
"realm" : {
"type" : "string",
"maxLength" : 255,
"pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$",
"description" : "Authentication realm"
},
"serviceType" : {
"description" : "Authentication service type",
"enum" : [ "NA", "LOCAL_DB", "RADIUS" ]
},
"vlanId" : {
"description" : "Dynamic vlan ID",
"type" : [ "integer", "null" ],
"minimum" : 1,
"maximum" : 4094
}
},
"required" : [ "realm", "serviceType" ]
}
},
"accountings" : {
"description" : "Accountings",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Accounting id",
"type" : [ "string", "null" ]
},
"name" : {
"description" : "Accounting name",
"type" : [ "string", "null" ]
},
"realm" : {
"type" : "string",
"maxLength" : 255,
"pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
},
"serviceType" : {
"description" : "Accounting service type",
"enum" : [ "NA", "RADIUS", "CGF" ]
}
},
"required" : [ "realm", "serviceType" ]
}
},
"osu" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"type" : {
"description" : "Online singup type",
"enum" : [ "Internal", "External" ]
},
"internalOSU" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"provisioningProtocals" : {
"description" : "Provisioning protocal",
"type" : "array",
"items" : {
"enum" : [ "SOAP_XML", "OMA_DM" ]
}
},
"provisioningFormat" : {
"description" : "Provisioning format",
"enum" : [ "R1_R2_ZEROIT", "R2_ZEROIT" ]
},
"provisioningUpdateType" : {
"description" : "Provisioning update at",
"enum" : [ "ALWAYS", "KNOWN_ROAM_PARTNERS", "NEVER" ]
},
"osuPortal" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"type" : {
"description" : "Portal type",
"enum" : [ "Internal", "External" ]
},
"internalOSUPortal" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
},
"description" : "Internal online singup portal, required when type is Internal"
},
"externalUrl" : {
"type" : [ "string", "null" ],
"pattern" : "^(https://)?(?:\w+:\w+@)?((?:(?:[-\w\d{1-3}]+\.)+(?:com|org|net|gov|mil|biz|info|mobi|name|aero|jobs|edu|co\.uk|ac\.uk|it|fr|tv|museum|asia|local|travel|[a-z]{2}))|((\b25[0-5]\b|\b[2][0-4][0-9]\b|\b[0-1]?[0-9]?[0-9]\b)(\.(\b25[0-5]\b|\b[2][0-4][0-9]\b|\b[0-1]?[0-9]?[0-9]\b)){3}))(?::[\d]{1,5})?(?:(?:(?:/(?:[-\w~!$+|.,=]|%[a-f\d]{2})+)+|/)+|\?|#)?(?:(?:\?(?:[-\w~!$+|.,*:]|%[a-f\d{2}])+=?(?:[-\w~!$+|.,*:=]|%[a-f\d]{2})*)(?:&(?:[-\w~!$+|.,*:]|%[a-f\d{2}])+=?(?:[-\w~!$+|.,*:=]|%[a-f\d]{2})*)*)*(?:#(?:[-\w~!$ |/.,*:;=]|%[a-f\d]{2})*)?$",
"description" : "External online singup portal, start with https://, required when type is External"
}
},
"required" : [ "type" ]
},
"commonLanguageIcon" : {
"description" : "The base64 encoded data of icon.",
"type" : "string"
},
"subscriptionDescriptions" : {
"description" : "Subscription descriptions",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"language" : {
"enum" : [ "English", "Chinese", "Czech", "Danish", "Dutch", "French", "German", "Japanese", "Spanish", "Korean", "Swedish", "Turkish" ],
"description" : "Language of the friendly name"
},
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the friendly name"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the friendly name"
},
"icon" : {
"description" : "The binary data of icon, maximum size 65536",
"type" : "string"
}
},
"required" : [ "language", "name" ]
}
},
"certificate" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
},
"description" : "Online signup certificate"
},
"osuAuthServices" : {
"description" : "Online signup authentication services",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Identifier of authentication service",
"type" : "string"
},
"name" : {
"description" : "Authentication service name",
"type" : "string"
},
"credentialType" : {
"description" : "Authentication credential type",
"enum" : [ "LOCAL", "REMOTE" ]
},
"realm" : {
"type" : "string",
"maxLength" : 255,
"pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$",
"description" : "Authentication realm"
},
"expiration" : {
"description" : "Expiration hour. null mean never expire",
"type" : [ "integer", "null" ],
"minimum" : 1,
"maximum" : 175200
}
},
"required" : [ "credentialType", "realm" ]
}
},
"whitelistedDomains" : {
"description" : "whitelisted domains",
"type" : "array",
"items" : {
"description" : "Compare with FQDN, it could start with '*.'",
"type" : "string",
"pattern" : "^((?=.{1,253}$)((?=[a-z0-9-]{1,63}\.)(xn--)?[a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,63}|(\*\.)(?=.{1,253}$)((?=[a-z0-9-]{1,63}\.)(xn--)?[a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,63})$"
}
}
},
"required" : [ "provisioningProtocals", "provisioningFormat", "provisioningUpdateType", "osuPortal", "commonLanguageIcon", "subscriptionDescriptions", "certificate", "osuAuthServices" ],
"description" : "Internal online singup, required when type is Internal"
},
"externalOSU" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"provisioningProtocals" : {
"description" : "Provisioning protocal",
"type" : "array",
"item" : {
"enum" : [ "SOAP_XML", "OMA_DM" ]
}
},
"osuServiceUrl" : {
"type" : [ "string", "null" ],
"pattern" : "^(https://)?(?:\w+:\w+@)?((?:(?:[-\w\d{1-3}]+\.)+(?:com|org|net|gov|mil|biz|info|mobi|name|aero|jobs|edu|co\.uk|ac\.uk|it|fr|tv|museum|asia|local|travel|[a-z]{2}))|((\b25[0-5]\b|\b[2][0-4][0-9]\b|\b[0-1]?[0-9]?[0-9]\b)(\.(\b25[0-5]\b|\b[2][0-4][0-9]\b|\b[0-1]?[0-9]?[0-9]\b)){3}))(?::[\d]{1,5})?(?:(?:(?:/(?:[-\w~!$+|.,=]|%[a-f\d]{2})+)+|/)+|\?|#)?(?:(?:\?(?:[-\w~!$+|.,*:]|%[a-f\d{2}])+=?(?:[-\w~!$+|.,*:=]|%[a-f\d]{2})*)(?:&(?:[-\w~!$+|.,*:]|%[a-f\d{2}])+=?(?:[-\w~!$+|.,*:=]|%[a-f\d]{2})*)*)*(?:#(?:[-\w~!$ |/.,*:;=]|%[a-f\d]{2})*)?$",
"description" : "External service URL, start with https://"
},
"osuNaiRealm" : {
"description" : "Online signup NAI realm, it should be one of realm as defined in Hotspot 2.0 identity provider",
"type" : "string"
},
"commonLanguageIcon" : {
"description" : "The base64 encoded data of icon.",
"type" : "string"
},
"subscriptionDescriptions" : {
"description" : "Subscription descriptions",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"language" : {
"enum" : [ "English", "Chinese", "Czech", "Danish", "Dutch", "French", "German", "Japanese", "Spanish", "Korean", "Swedish", "Turkish" ],
"description" : "Language of the friendly name"
},
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the friendly name"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the friendly name"
},
"icon" : {
"description" : "The binary data of icon, maximum size 65536",
"type" : "string"
}
},
"required" : [ "language", "name" ]
}
},
"whitelistedDomains" : {
"description" : "Whitelisted domains",
"type" : "array",
"items" : {
"description" : "Compare with FQDN, it could start with '*.'",
"type" : "string",
"pattern" : "^((?=.{1,253}$)((?=[a-z0-9-]{1,63}\.)(xn--)?[a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,63}|(\*\.)(?=.{1,253}$)((?=[a-z0-9-]{1,63}\.)(xn--)?[a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,63})$"
}
}
},
"required" : [ "provisioningProtocals", "osuServiceUrl", "osuNaiRealm", "commonLanguageIcon", "subscriptionDescriptions" ],
"description" : "External online singup, required when type is External"
}
},
"required" : [ "type" ],
"description" : "Online Signup & Provisioning"
}
}
}
Use this API command to create a new Hotspot 2.0 identity provider.
{
"name" : "test-hs20provider",
"realms" : [ {
"name" : "realm1",
"encoding" : "RFC4282",
"eapMethods" : [ {
"type" : "NA"
}, {
"type" : "NA"
}, {
"type" : "NA"
}, {
"type" : "NA"
} ]
} ],
"authentications" : [ {
"realm" : "No Match",
"serviceType" : "NA"
}, {
"realm" : "Unspecified",
"serviceType" : "NA"
} ]
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the Hotspot 2.0 identity provider profile"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the Hotspot 2.0 identity provider profile"
},
"realms" : {
"description" : "Realms",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of realm"
},
"encoding" : {
"description" : "Encoding",
"enum" : [ "RFC4282", "UTF8" ]
},
"eapMethods" : {
"description" : "EAP methods",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"type" : {
"description" : "EAP method type",
"enum" : [ "NA", "MD5", "EAP_TLS", "EAP_Cisco", "EAP_SIM", "EAP_TTLS", "EAP_AKA", "PEAP", "EAP_MSCHAP_V2", "EAP_AKAs", "Reserved" ]
},
"authSettings" : {
"description" : "EAP method auth settings",
"type" : [ "array", "null" ],
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"info" : {
"description" : "EAP auth info",
"enum" : [ "Expanded", "Non", "Inner", "Expanded_Inner", "Credential", "Tunneled" ]
},
"type" : {
"description" : "EAP auth type",
"type" : "string"
},
"vendorId" : {
"description" : "EAP auth vendor ID",
"type" : [ "integer", "null" ],
"minimum" : 0,
"maximum" : 16777215
},
"vendorType" : {
"description" : "EAP auth vendor type",
"type" : [ "integer", "null" ],
"minimum" : 0,
"maximum" : 4294967295
}
},
"required" : [ "info" ]
}
}
},
"required" : [ "type" ]
}
}
},
"required" : [ "name", "encoding", "eapMethods" ]
}
},
"plmns" : {
"description" : "PLMNs",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"mcc" : {
"description" : "MCC",
"type" : "string",
"pattern" : "^[0-9]{3}$"
},
"mnc" : {
"description" : "MNC",
"type" : "string",
"pattern" : "^[0-9]{2,3}$"
}
},
"required" : [ "mcc", "mnc" ]
}
},
"homeOis" : {
"description" : "Home OIs",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"name" : {
"description" : "Name of the home OI",
"type" : "string",
"maxLength" : 255
},
"oi" : {
"description" : "Orgnization ID(3Hex or 5Hex)",
"type" : "string",
"pattern" : "^(([0-9a-fA-F][0-9a-fA-F]){3}|([0-9a-fA-F][0-9a-fA-F]){5})$"
}
},
"required" : [ "name", "oi" ]
}
},
"authentications" : {
"description" : "Authentications",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Authentication id",
"type" : [ "string", "null" ]
},
"name" : {
"description" : "Authentication name",
"type" : [ "string", "null" ]
},
"realm" : {
"type" : "string",
"maxLength" : 255,
"pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$",
"description" : "Authentication realm"
},
"serviceType" : {
"description" : "Authentication service type",
"enum" : [ "NA", "LOCAL_DB", "RADIUS" ]
},
"vlanId" : {
"description" : "Dynamic vlan ID",
"type" : [ "integer", "null" ],
"minimum" : 1,
"maximum" : 4094
}
},
"required" : [ "realm", "serviceType" ]
}
},
"accountings" : {
"description" : "Accountings",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Accounting id",
"type" : [ "string", "null" ]
},
"name" : {
"description" : "Accounting name",
"type" : [ "string", "null" ]
},
"realm" : {
"type" : "string",
"maxLength" : 255,
"pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
},
"serviceType" : {
"description" : "Accounting service type",
"enum" : [ "NA", "RADIUS", "CGF" ]
}
},
"required" : [ "realm", "serviceType" ]
}
},
"osu" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"type" : {
"description" : "Online singup type",
"enum" : [ "Internal", "External" ]
},
"internalOSU" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"provisioningProtocals" : {
"description" : "Provisioning protocal",
"type" : "array",
"items" : {
"enum" : [ "SOAP_XML", "OMA_DM" ]
}
},
"provisioningFormat" : {
"description" : "Provisioning format",
"enum" : [ "R1_R2_ZEROIT", "R2_ZEROIT" ]
},
"provisioningUpdateType" : {
"description" : "Provisioning update at",
"enum" : [ "ALWAYS", "KNOWN_ROAM_PARTNERS", "NEVER" ]
},
"osuPortal" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"type" : {
"description" : "Portal type",
"enum" : [ "Internal", "External" ]
},
"internalOSUPortal" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
},
"description" : "Internal online singup portal, required when type is Internal"
},
"externalUrl" : {
"type" : [ "string", "null" ],
"pattern" : "^(https://)?(?:\w+:\w+@)?((?:(?:[-\w\d{1-3}]+\.)+(?:com|org|net|gov|mil|biz|info|mobi|name|aero|jobs|edu|co\.uk|ac\.uk|it|fr|tv|museum|asia|local|travel|[a-z]{2}))|((\b25[0-5]\b|\b[2][0-4][0-9]\b|\b[0-1]?[0-9]?[0-9]\b)(\.(\b25[0-5]\b|\b[2][0-4][0-9]\b|\b[0-1]?[0-9]?[0-9]\b)){3}))(?::[\d]{1,5})?(?:(?:(?:/(?:[-\w~!$+|.,=]|%[a-f\d]{2})+)+|/)+|\?|#)?(?:(?:\?(?:[-\w~!$+|.,*:]|%[a-f\d{2}])+=?(?:[-\w~!$+|.,*:=]|%[a-f\d]{2})*)(?:&(?:[-\w~!$+|.,*:]|%[a-f\d{2}])+=?(?:[-\w~!$+|.,*:=]|%[a-f\d]{2})*)*)*(?:#(?:[-\w~!$ |/.,*:;=]|%[a-f\d]{2})*)?$",
"description" : "External online singup portal, start with https://, required when type is External"
}
},
"required" : [ "type" ]
},
"commonLanguageIcon" : {
"description" : "The base64 encoded data of icon.",
"type" : "string"
},
"subscriptionDescriptions" : {
"description" : "Subscription descriptions",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"language" : {
"enum" : [ "English", "Chinese", "Czech", "Danish", "Dutch", "French", "German", "Japanese", "Spanish", "Korean", "Swedish", "Turkish" ],
"description" : "Language of the friendly name"
},
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the friendly name"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the friendly name"
},
"icon" : {
"description" : "The binary data of icon, maximum size 65536",
"type" : "string"
}
},
"required" : [ "language", "name" ]
}
},
"certificate" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
},
"description" : "Online signup certificate"
},
"osuAuthServices" : {
"description" : "Online signup authentication services",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Identifier of authentication service",
"type" : "string"
},
"name" : {
"description" : "Authentication service name",
"type" : "string"
},
"credentialType" : {
"description" : "Authentication credential type",
"enum" : [ "LOCAL", "REMOTE" ]
},
"realm" : {
"type" : "string",
"maxLength" : 255,
"pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$",
"description" : "Authentication realm"
},
"expiration" : {
"description" : "Expiration hour. null mean never expire",
"type" : [ "integer", "null" ],
"minimum" : 1,
"maximum" : 175200
}
},
"required" : [ "credentialType", "realm" ]
}
},
"whitelistedDomains" : {
"description" : "whitelisted domains",
"type" : "array",
"items" : {
"description" : "Compare with FQDN, it could start with '*.'",
"type" : "string",
"pattern" : "^((?=.{1,253}$)((?=[a-z0-9-]{1,63}\.)(xn--)?[a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,63}|(\*\.)(?=.{1,253}$)((?=[a-z0-9-]{1,63}\.)(xn--)?[a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,63})$"
}
}
},
"required" : [ "provisioningProtocals", "provisioningFormat", "provisioningUpdateType", "osuPortal", "commonLanguageIcon", "subscriptionDescriptions", "certificate", "osuAuthServices" ],
"description" : "Internal online singup, required when type is Internal"
},
"externalOSU" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"provisioningProtocals" : {
"description" : "Provisioning protocal",
"type" : "array",
"item" : {
"enum" : [ "SOAP_XML", "OMA_DM" ]
}
},
"osuServiceUrl" : {
"type" : [ "string", "null" ],
"pattern" : "^(https://)?(?:\w+:\w+@)?((?:(?:[-\w\d{1-3}]+\.)+(?:com|org|net|gov|mil|biz|info|mobi|name|aero|jobs|edu|co\.uk|ac\.uk|it|fr|tv|museum|asia|local|travel|[a-z]{2}))|((\b25[0-5]\b|\b[2][0-4][0-9]\b|\b[0-1]?[0-9]?[0-9]\b)(\.(\b25[0-5]\b|\b[2][0-4][0-9]\b|\b[0-1]?[0-9]?[0-9]\b)){3}))(?::[\d]{1,5})?(?:(?:(?:/(?:[-\w~!$+|.,=]|%[a-f\d]{2})+)+|/)+|\?|#)?(?:(?:\?(?:[-\w~!$+|.,*:]|%[a-f\d{2}])+=?(?:[-\w~!$+|.,*:=]|%[a-f\d]{2})*)(?:&(?:[-\w~!$+|.,*:]|%[a-f\d{2}])+=?(?:[-\w~!$+|.,*:=]|%[a-f\d]{2})*)*)*(?:#(?:[-\w~!$ |/.,*:;=]|%[a-f\d]{2})*)?$",
"description" : "External service URL, start with https://"
},
"osuNaiRealm" : {
"description" : "Online signup NAI realm, it should be one of realm as defined in Hotspot 2.0 identity provider",
"type" : "string"
},
"commonLanguageIcon" : {
"description" : "The base64 encoded data of icon.",
"type" : "string"
},
"subscriptionDescriptions" : {
"description" : "Subscription descriptions",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"language" : {
"enum" : [ "English", "Chinese", "Czech", "Danish", "Dutch", "French", "German", "Japanese", "Spanish", "Korean", "Swedish", "Turkish" ],
"description" : "Language of the friendly name"
},
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the friendly name"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the friendly name"
},
"icon" : {
"description" : "The binary data of icon, maximum size 65536",
"type" : "string"
}
},
"required" : [ "language", "name" ]
}
},
"whitelistedDomains" : {
"description" : "Whitelisted domains",
"type" : "array",
"items" : {
"description" : "Compare with FQDN, it could start with '*.'",
"type" : "string",
"pattern" : "^((?=.{1,253}$)((?=[a-z0-9-]{1,63}\.)(xn--)?[a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,63}|(\*\.)(?=.{1,253}$)((?=[a-z0-9-]{1,63}\.)(xn--)?[a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,63})$"
}
}
},
"required" : [ "provisioningProtocals", "osuServiceUrl", "osuNaiRealm", "commonLanguageIcon", "subscriptionDescriptions" ],
"description" : "External online singup, required when type is External"
}
},
"required" : [ "type" ],
"description" : "Online Signup & Provisioning"
}
},
"required" : [ "name", "realms", "authentications" ]
}
201
ShowHide{
"id" : "profileUUID"
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
}
}
}
Use this API command to modify the basic information of a Hotspot 2.0 identity provider.
{
"name" : "test-hs20provider"
}
{
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the Hotspot 2.0 identity provider profile"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the Hotspot 2.0 identity provider profile"
}
}
204
Use this API command to modify realms of a Hotspot 2.0 identity provider.
[ {
"name" : "realm1",
"encoding" : "UTF8",
"eapMethods" : [ {
"type" : "NA"
}, {
"type" : "NA"
}, {
"type" : "NA"
}, {
"type" : "MD5",
"authSettings" : [ {
"info" : "Expanded",
"vendorId" : 2,
"vendorType" : 34
}, {
"info" : "Non",
"type" : "PAP"
}, {
"info" : "Credential",
"type" : "Softoken"
} ]
} ]
} ]
{
"description" : "Realms",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of realm"
},
"encoding" : {
"description" : "Encoding",
"enum" : [ "RFC4282", "UTF8" ]
},
"eapMethods" : {
"description" : "EAP methods",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"type" : {
"description" : "EAP method type",
"enum" : [ "NA", "MD5", "EAP_TLS", "EAP_Cisco", "EAP_SIM", "EAP_TTLS", "EAP_AKA", "PEAP", "EAP_MSCHAP_V2", "EAP_AKAs", "Reserved" ]
},
"authSettings" : {
"description" : "EAP method auth settings",
"type" : [ "array", "null" ],
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"info" : {
"description" : "EAP auth info",
"enum" : [ "Expanded", "Non", "Inner", "Expanded_Inner", "Credential", "Tunneled" ]
},
"type" : {
"description" : "EAP auth type",
"type" : "string"
},
"vendorId" : {
"description" : "EAP auth vendor ID",
"type" : [ "integer", "null" ],
"minimum" : 0,
"maximum" : 16777215
},
"vendorType" : {
"description" : "EAP auth vendor type",
"type" : [ "integer", "null" ],
"minimum" : 0,
"maximum" : 4294967295
}
},
"required" : [ "info" ]
}
}
},
"required" : [ "type" ]
}
}
},
"required" : [ "name", "encoding", "eapMethods" ]
}
}
204
Use this API command to modify PLMNs of a Hotspot 2.0 identity provider.
[ {
"mcc" : "124",
"mnc" : "12"
}, {
"mcc" : "389",
"mnc" : "459"
} ]
{
"description" : "PLMNs",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"mcc" : {
"description" : "MCC",
"type" : "string",
"pattern" : "^[0-9]{3}$"
},
"mnc" : {
"description" : "MNC",
"type" : "string",
"pattern" : "^[0-9]{2,3}$"
}
},
"required" : [ "mcc", "mnc" ]
}
}
204
Use this API command to modify home OIs of a Hotspot 2.0 identity provider.
[ {
"name" : "abc",
"oi" : "121212"
}, {
"name" : "edf",
"oi" : "FFFFFFFFFF"
} ]
{
"description" : "Home OIs",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"name" : {
"description" : "Name of the home OI",
"type" : "string",
"maxLength" : 255
},
"oi" : {
"description" : "Orgnization ID(3Hex or 5Hex)",
"type" : "string",
"pattern" : "^(([0-9a-fA-F][0-9a-fA-F]){3}|([0-9a-fA-F][0-9a-fA-F]){5})$"
}
},
"required" : [ "name", "oi" ]
}
}
204
Use this API command to modify authentications of a Hotspot 2.0 identity provider.
[ {
"name" : "Local Database",
"realm" : "No Match",
"serviceType" : "LOCAL_DB"
}, {
"name" : "globalAuthRadius",
"realm" : "Unspecified",
"serviceType" : "RADIUS"
}, {
"name" : "globalAuthRadius",
"realm" : "realmTest",
"serviceType" : "RADIUS"
} ]
{
"description" : "Authentications",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Authentication id",
"type" : [ "string", "null" ]
},
"name" : {
"description" : "Authentication name",
"type" : [ "string", "null" ]
},
"realm" : {
"type" : "string",
"maxLength" : 255,
"pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$",
"description" : "Authentication realm"
},
"serviceType" : {
"description" : "Authentication service type",
"enum" : [ "NA", "LOCAL_DB", "RADIUS" ]
},
"vlanId" : {
"description" : "Dynamic vlan ID",
"type" : [ "integer", "null" ],
"minimum" : 1,
"maximum" : 4094
}
},
"required" : [ "realm", "serviceType" ]
}
}
204
Use this API command to modify accountings of a Hotspot 2.0 identity provider.
[ {
"realm" : "No Match",
"serviceType" : "NA"
}, {
"name" : "globalAcctRadius",
"realm" : "Unspecified",
"serviceType" : "RADIUS"
}, {
"name" : "globalAcctRadius",
"realm" : "realmTest",
"serviceType" : "RADIUS"
} ]
{
"description" : "Accountings",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Accounting id",
"type" : [ "string", "null" ]
},
"name" : {
"description" : "Accounting name",
"type" : [ "string", "null" ]
},
"realm" : {
"type" : "string",
"maxLength" : 255,
"pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
},
"serviceType" : {
"description" : "Accounting service type",
"enum" : [ "NA", "RADIUS", "CGF" ]
}
},
"required" : [ "realm", "serviceType" ]
}
}
204
Use this API command to disable accountings of a Hotspot 2.0 identity provider.
204
Use this API command to modify online signup & provisioning of a Hotspot 2.0 identity provider.
{
"type" : "Internal",
"internalOSU" : {
"provisioningProtocals" : [ "SOAP_XML" ],
"provisioningFormat" : "R1_R2_ZEROIT",
"provisioningUpdateType" : "ALWAYS",
"osuPortal" : {
"type" : "Internal",
"internalOSUPortal" : {
"name" : "${PROFILE_ONLINE_SIGNUP_NAME}"
}
},
"commonLanguageIcon" : "Base64:imageData",
"serviceDescriptions" : [ {
"language" : "English",
"name" : "ruckus"
} ],
"certificate" : {
"id" : "certificateID",
"name" : "certificateName"
},
"whitelistedDomains" : [ "google.com", "*.ruckus.com" ],
"osuAuthServices" : [ {
"name" : "Local Database",
"credentialType" : "LOCAL",
"realm" : "realm1"
} ]
},
"externalOSU" : {
"provisioningProtocals" : [ "SOAP_XML", "OMA_DM" ],
"osuServiceUrl" : "https://ruckus.com",
"osuNaiRealm" : "realm1",
"commonLanguageIcon" : "Base64:imageData",
"serviceDescriptions" : [ {
"language" : "English",
"name" : "ruckus"
} ],
"whitelistedDomains" : [ "google.com", "*.ruckus.com" ]
}
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"type" : {
"description" : "Online singup type",
"enum" : [ "Internal", "External" ]
},
"internalOSU" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"provisioningProtocals" : {
"description" : "Provisioning protocal",
"type" : "array",
"items" : {
"enum" : [ "SOAP_XML", "OMA_DM" ]
}
},
"provisioningFormat" : {
"description" : "Provisioning format",
"enum" : [ "R1_R2_ZEROIT", "R2_ZEROIT" ]
},
"provisioningUpdateType" : {
"description" : "Provisioning update at",
"enum" : [ "ALWAYS", "KNOWN_ROAM_PARTNERS", "NEVER" ]
},
"osuPortal" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"type" : {
"description" : "Portal type",
"enum" : [ "Internal", "External" ]
},
"internalOSUPortal" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
},
"description" : "Internal online singup portal, required when type is Internal"
},
"externalUrl" : {
"type" : [ "string", "null" ],
"pattern" : "^(https://)?(?:\w+:\w+@)?((?:(?:[-\w\d{1-3}]+\.)+(?:com|org|net|gov|mil|biz|info|mobi|name|aero|jobs|edu|co\.uk|ac\.uk|it|fr|tv|museum|asia|local|travel|[a-z]{2}))|((\b25[0-5]\b|\b[2][0-4][0-9]\b|\b[0-1]?[0-9]?[0-9]\b)(\.(\b25[0-5]\b|\b[2][0-4][0-9]\b|\b[0-1]?[0-9]?[0-9]\b)){3}))(?::[\d]{1,5})?(?:(?:(?:/(?:[-\w~!$+|.,=]|%[a-f\d]{2})+)+|/)+|\?|#)?(?:(?:\?(?:[-\w~!$+|.,*:]|%[a-f\d{2}])+=?(?:[-\w~!$+|.,*:=]|%[a-f\d]{2})*)(?:&(?:[-\w~!$+|.,*:]|%[a-f\d{2}])+=?(?:[-\w~!$+|.,*:=]|%[a-f\d]{2})*)*)*(?:#(?:[-\w~!$ |/.,*:;=]|%[a-f\d]{2})*)?$",
"description" : "External online singup portal, start with https://, required when type is External"
}
},
"required" : [ "type" ]
},
"commonLanguageIcon" : {
"description" : "The base64 encoded data of icon.",
"type" : "string"
},
"subscriptionDescriptions" : {
"description" : "Subscription descriptions",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"language" : {
"enum" : [ "English", "Chinese", "Czech", "Danish", "Dutch", "French", "German", "Japanese", "Spanish", "Korean", "Swedish", "Turkish" ],
"description" : "Language of the friendly name"
},
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the friendly name"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the friendly name"
},
"icon" : {
"description" : "The binary data of icon, maximum size 65536",
"type" : "string"
}
},
"required" : [ "language", "name" ]
}
},
"certificate" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
},
"description" : "Online signup certificate"
},
"osuAuthServices" : {
"description" : "Online signup authentication services",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Identifier of authentication service",
"type" : "string"
},
"name" : {
"description" : "Authentication service name",
"type" : "string"
},
"credentialType" : {
"description" : "Authentication credential type",
"enum" : [ "LOCAL", "REMOTE" ]
},
"realm" : {
"type" : "string",
"maxLength" : 255,
"pattern" : "^$|^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$",
"description" : "Authentication realm"
},
"expiration" : {
"description" : "Expiration hour. null mean never expire",
"type" : [ "integer", "null" ],
"minimum" : 1,
"maximum" : 175200
}
},
"required" : [ "credentialType", "realm" ]
}
},
"whitelistedDomains" : {
"description" : "whitelisted domains",
"type" : "array",
"items" : {
"description" : "Compare with FQDN, it could start with '*.'",
"type" : "string",
"pattern" : "^((?=.{1,253}$)((?=[a-z0-9-]{1,63}\.)(xn--)?[a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,63}|(\*\.)(?=.{1,253}$)((?=[a-z0-9-]{1,63}\.)(xn--)?[a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,63})$"
}
}
},
"required" : [ "provisioningProtocals", "provisioningFormat", "provisioningUpdateType", "osuPortal", "commonLanguageIcon", "subscriptionDescriptions", "certificate", "osuAuthServices" ],
"description" : "Internal online singup, required when type is Internal"
},
"externalOSU" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"provisioningProtocals" : {
"description" : "Provisioning protocal",
"type" : "array",
"item" : {
"enum" : [ "SOAP_XML", "OMA_DM" ]
}
},
"osuServiceUrl" : {
"type" : [ "string", "null" ],
"pattern" : "^(https://)?(?:\w+:\w+@)?((?:(?:[-\w\d{1-3}]+\.)+(?:com|org|net|gov|mil|biz|info|mobi|name|aero|jobs|edu|co\.uk|ac\.uk|it|fr|tv|museum|asia|local|travel|[a-z]{2}))|((\b25[0-5]\b|\b[2][0-4][0-9]\b|\b[0-1]?[0-9]?[0-9]\b)(\.(\b25[0-5]\b|\b[2][0-4][0-9]\b|\b[0-1]?[0-9]?[0-9]\b)){3}))(?::[\d]{1,5})?(?:(?:(?:/(?:[-\w~!$+|.,=]|%[a-f\d]{2})+)+|/)+|\?|#)?(?:(?:\?(?:[-\w~!$+|.,*:]|%[a-f\d{2}])+=?(?:[-\w~!$+|.,*:=]|%[a-f\d]{2})*)(?:&(?:[-\w~!$+|.,*:]|%[a-f\d{2}])+=?(?:[-\w~!$+|.,*:=]|%[a-f\d]{2})*)*)*(?:#(?:[-\w~!$ |/.,*:;=]|%[a-f\d]{2})*)?$",
"description" : "External service URL, start with https://"
},
"osuNaiRealm" : {
"description" : "Online signup NAI realm, it should be one of realm as defined in Hotspot 2.0 identity provider",
"type" : "string"
},
"commonLanguageIcon" : {
"description" : "The base64 encoded data of icon.",
"type" : "string"
},
"subscriptionDescriptions" : {
"description" : "Subscription descriptions",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"language" : {
"enum" : [ "English", "Chinese", "Czech", "Danish", "Dutch", "French", "German", "Japanese", "Spanish", "Korean", "Swedish", "Turkish" ],
"description" : "Language of the friendly name"
},
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the friendly name"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the friendly name"
},
"icon" : {
"description" : "The binary data of icon, maximum size 65536",
"type" : "string"
}
},
"required" : [ "language", "name" ]
}
},
"whitelistedDomains" : {
"description" : "Whitelisted domains",
"type" : "array",
"items" : {
"description" : "Compare with FQDN, it could start with '*.'",
"type" : "string",
"pattern" : "^((?=.{1,253}$)((?=[a-z0-9-]{1,63}\.)(xn--)?[a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,63}|(\*\.)(?=.{1,253}$)((?=[a-z0-9-]{1,63}\.)(xn--)?[a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,63})$"
}
}
},
"required" : [ "provisioningProtocals", "osuServiceUrl", "osuNaiRealm", "commonLanguageIcon", "subscriptionDescriptions" ],
"description" : "External online singup, required when type is External"
}
},
"required" : [ "type" ],
"description" : "Online Signup & Provisioning"
}
204
Use this API command to disable online signup & provisioning of a Hotspot 2.0 identity provider.
204
Use this API command to delete a Hotspot 2.0 identity provider.
204
Use this API command to retrieve a list of vdp.
number
(optional) The index of the first entry to be retrieved. Default: 0
number
(optional) The maximum number of entries to be retrieved. Default: 100
200
ShowHide{
"totalCount" : 1,
"hasMore" : false,
"firstIndex" : 0,
"list" : [ {
"id" : "267ef3a0-738b-11e4-96d5-0a7820524153",
"name" : "new name"
} ]
}
{
"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 profile",
"type" : "string"
},
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the profile"
}
}
}
}
}
}
Use this API command to retrieve an vdp.
200
ShowHide{
"name" : "vDP",
"mac" : "00:0C:29:5E:6D:87",
"ip" : "172.17.0.1",
"extIp" : "172.17.10.9",
"mgmtIp" : "172.17.25.10",
"mgmtExtIp" : "172.17.26.128",
"fwVersion" : "3.2.0.0.169",
"status" : "Initializing",
"registrationState" : "Pending",
"serialNumber" : "9720TWU937GM1CWXTB54C98GTTTV000C295E6D7D000C295E6D87",
"model" : "Intel DPDK",
"uptime" : "0s",
"lastSeenOn" : "2015/04/16 18:28:43",
"managedBy" : "R-FGd-VSCGE-R",
"isSupport" : false
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"name" : {
"description" : "name of vdp profile",
"type" : "string"
},
"mac" : {
"description" : "mac",
"type" : "string"
},
"ip" : {
"description" : "mac",
"type" : "string"
},
"extIp" : {
"description" : "external ip",
"type" : "string"
},
"dataVlan" : {
"description" : "data vlan",
"type" : "integer"
},
"mgmtIp" : {
"description" : "management ip",
"type" : "string"
},
"mgmtExtIp" : {
"description" : "management external ip",
"type" : "string"
},
"mgmtVlan" : {
"description" : "management vlan",
"type" : "integer"
},
"managedBy" : {
"description" : "managed by",
"type" : "string"
},
"model" : {
"description" : "model",
"type" : "string"
},
"serialNumber" : {
"description" : "serialNumber",
"type" : "string"
},
"fwVersion" : {
"description" : "Firmware version",
"type" : "string"
},
"isSupport" : {
"description" : "is support vdp",
"type" : "boolean"
},
"lastSeenOn" : {
"description" : "last seen",
"type" : "string"
},
"status" : {
"description" : "status",
"type" : "string"
},
"registrationState" : {
"description" : "registrationState",
"type" : "string"
},
"uptime" : {
"description" : "uptime",
"type" : "string"
}
}
}
Use this API command to approve vdp.
204
Use this API command to delete an vdp.
204
Use this API command to retrieve list of installed certificates.
number
(optional) The index of the first entry to be retrieved. Default: 0
number
(optional) The maximum number of entries to be retrieved. Default: 100
200
ShowHide{
"totalCount" : 2,
"hasMore" : false,
"firstIndex" : 0,
"list" : [ {
"id" : "rootCertificate",
"name" : "rootCertificate",
"description" : "root certificate description"
}, {
"id" : "hs20Certificate",
"name" : "hs20Certificate",
"description" : "Hotspot20 certificate description"
} ]
}
{
"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 certificate",
"type" : "string"
},
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the certificate"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the certificate"
}
}
}
}
}
}
Use this API command to retrieve an installed certificate.
200
ShowHide{
"id" : "certificateID",
"name" : "certificateName",
"description" : "certificate description",
"data" : "certificateData",
"information" : "certificateInformation",
"intermediateData" : [ "intermediateCertifcateData1", "intermediateCertifcateData2" ],
"rootData" : "rootCertificateData",
"privateKeyData" : "privateKeyData",
"certificasSigningRequest" : null,
"passphrase" : "passphrase"
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Identifier of the certificate",
"type" : "string"
},
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the certificate"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the certificate"
},
"data" : {
"description" : "Data of the certificate",
"type" : "string"
},
"information" : {
"description" : "Information of the certificate",
"type" : "string"
},
"intermediateData" : {
"description" : "Intermediate data of the certificate",
"type" : [ "array", "null" ],
"items" : {
"type" : "string"
}
},
"rootData" : {
"description" : "Root data of the certificate",
"type" : "string"
},
"privateKeyData" : {
"description" : "Private key data of the certificate",
"type" : "string"
},
"certificasSigningRequest" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
},
"description" : "Certificates signing request of the certificate"
},
"passphrase" : {
"description" : "Key passphrase",
"type" : "string"
}
}
}
Use this API command to retrieve list of certificates signing request.
number
(optional) The index of the first entry to be retrieved. Default: 0
number
(optional) The maximum number of entries to be retrieved. Default: 100
200
ShowHide{
"totalCount" : 2,
"hasMore" : false,
"firstIndex" : 0,
"list" : [ {
"id" : "privateKey1",
"name" : "privateKey1",
"description" : "private key1 description"
}, {
"id" : "privateKey2",
"name" : "privateKey2",
"description" : "private key2 description"
} ]
}
{
"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 certificates signing request",
"type" : "string"
},
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the certificates signing request"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the certificates signing request"
}
}
}
}
}
}
Use this API command to retrieve a certificates signing request.
200
ShowHide{
"id" : "csrID",
"name" : "csr-test",
"commonName" : "ruckus.com",
"email" : "[email protected]",
"organization" : "org",
"organizationUnit" : "orgUnit",
"city" : "shenzhen",
"state" : "guangdong",
"countryCode" : "US"
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Identifier of the certificates signing request",
"type" : "string"
},
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the certificates signing request"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the certificates signing request"
},
"commonName" : {
"description" : "Common name of the certificates signing request",
"type" : "string"
},
"email" : {
"description" : "Email of the certificates signing request",
"type" : "string"
},
"organization" : {
"description" : "Organization of the certificates signing request",
"type" : "string"
},
"organizationUnit" : {
"description" : "Organization unit of the certificates signing request",
"type" : "string"
},
"city" : {
"description" : "City of the certificates signing request",
"type" : "string"
},
"state" : {
"description" : "State of the certificates signing request",
"type" : "string"
},
"countryCode" : {
"description" : "Country code of the certificates signing request",
"type" : "string"
}
}
}
Use this API command to create an installed certificate.
{
"name" : "hs20Certificate",
"description" : "Hotspot20 certificate description",
"data" : "certificateData",
"intermediateData" : [ "intermediateCertifcateData1", "intermediateCertifcateData2" ],
"rootData" : "rootCertificateData",
"privateKeyData" : "privateKeyData",
"passphrase" : "passphrase"
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the certificate"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the certificate"
},
"data" : {
"description" : "Data of the certificate",
"type" : "string"
},
"intermediateData" : {
"description" : "Intermediate data of the certificate",
"type" : [ "array", "null" ],
"items" : {
"type" : "string"
}
},
"rootData" : {
"description" : "Root data of the certificate",
"type" : "string"
},
"privateKeyData" : {
"description" : "Private key data of the certificate",
"type" : "string"
},
"certificasSigningRequest" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
},
"description" : "Certificates signing request of the certificate"
},
"passphrase" : {
"description" : "Key passphrase",
"type" : "string"
}
},
"required" : [ "name", "data" ]
}
201
ShowHide{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
}
}
}
Use this API command to create a certificates signing request.
{
"name" : "csr-test",
"commonName" : "ruckus.com",
"email" : "[email protected]",
"organization" : "org",
"city" : "shenzhen",
"state" : "guangdong",
"countryCode" : "US"
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the certificates signing request"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the certificates signing request"
},
"commonName" : {
"type" : "string",
"pattern" : "^(?=.{1,253}$)((?=[a-z0-9-]{1,63}\.)(xn--)?[a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,63}$",
"description" : "Common name of the certificates signing request"
},
"email" : {
"type" : "string",
"pattern" : "^(\w+)([\-+.\'][\w]+)*@(\w[\-\w]*\.){1,255}([A-Za-z]){2,6}$",
"description" : "Email of the certificates signing request"
},
"organization" : {
"description" : "Organization of the certificates signing request",
"type" : "string",
"maxLength" : 64
},
"organizationUnit" : {
"description" : "Organization unit of the certificates signing request",
"type" : "string",
"maxLength" : 64
},
"city" : {
"description" : "City of the certificates signing request",
"type" : "string",
"maxLength" : 128
},
"state" : {
"description" : "State of the certificates signing request",
"type" : "string",
"maxLength" : 128
},
"countryCode" : {
"description" : "Country code of the certificates signing request",
"type" : "string"
}
},
"required" : [ "name", "commonName", "email", "organization", "city", "state", "countryCode" ]
}
201
ShowHide{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
}
}
}
Use this API command to delete an installed certificate.
204
Use this API command to delete a certificates signing request.
204
Use this API command to retrieve the total AP count within a zone or a domain.
string
(optional) filter AP total count by zone. Default: current logon domain
string
(optional) filter AP total count by domain. Default: current logon domain
200
ShowHideThe total count (integer)
Use this API command to retrieve the summary information of an AP. This is used by the Ruckus Wireless AP mobile app.
number
(optional) The index of the first entry to be retrieved. Default: 0
number
(optional) The maximum number of entries to be retrieved. Default: 100
string
(optional) filter AP lineman by zone. Default: current login domain
string
(optional) filter AP lineman by domain. Default: current login domain
string
(optional) indicate to show alarm counter. Default: true
200
ShowHide{
"totalCount" : 1,
"hasMore" : false,
"firstIndex" : 0,
"list" : [ {
"mac" : "00:11:22:33:44:55",
"name" : "apName",
"latitude" : "22.3",
"longitude" : "114",
"location" : "location",
"configState" : "newConfig",
"alarms" : {
"criticalCount" : 0,
"majorCount" : 1,
"minorCount" : 7,
"warningCount" : 0
}
} ]
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"totalCount" : {
"description" : "Total AP count",
"type" : "integer"
},
"hasMore" : {
"description" : "Indicates if there are more APs after the currently displayed list",
"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" : {
"type" : "string",
"pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$",
"description" : "MAC address of the AP"
},
"name" : {
"description" : "Name of the AP",
"type" : "string"
},
"latitude" : {
"type" : "number",
"description" : "Latitude coordinate (in decimal format) of the AP"
},
"longitude" : {
"type" : "number",
"description" : "Longitude coordinate (in decimal format) of the AP"
},
"configState" : {
"description" : "State of the AP configuration",
"enum" : [ "newConfig", "fwApplied", "fwDownloaded", "fwFailed", "configApplied", "completed", "configFailed" ]
},
"location" : {
"type" : "string",
"pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Location of the AP. This is a free format text description that indicates the location of the AP."
},
"alarms" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"criticalCount" : {
"description" : "Critical alarm count",
"type" : "integer"
},
"majorCount" : {
"description" : "Major alarm count",
"type" : "integer"
},
"minorCount" : {
"description" : "Minor alarm count",
"type" : "integer"
},
"warningCount" : {
"description" : "Warning alarm count",
"type" : "integer"
}
},
"description" : "Alarm counters by severity on the AP"
}
}
}
}
}
}
Use this API command to upload a workflow file used by the Ruckus Wireless AP mobile app.
The workflow file
204
Use this API command to download the workflow file used by the Ruckus Wireless AP mobile app.
200
ShowHideThe workflow file
Use this API command to start the SpeedFlex test.
{
"tool" : "ZAP_DOWN",
"protocol" : "UDP",
"model" : "AP",
"clientIp" : "1.1.1.1",
"clientMac" : "00:11:22:33:44:55",
"serverIp" : "2.2.2.2",
"serverMac" : "11:22:33:44:55:66",
"syspmtu" : 1500
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"tool" : {
"description" : "SpeedFlex tool",
"enum" : [ "ZAP_DOWN", "ZAP_UP" ]
},
"protocol" : {
"description" : "Protocol used in the SpeedFlex test",
"enum" : [ "UDP", "TCP" ]
},
"model" : {
"description" : "Test model",
"enum" : [ "AP", "CLIENT", "TRACE", "HOP", "NULL" ]
},
"clientIp" : {
"type" : "string",
"description" : "The HTTP request remove address is used if none is specified"
},
"clientMac" : {
"type" : "string",
"pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$",
"description" : "The HTTP request remove MAC address is used if none is specified"
},
"serverIp" : {
"type" : "string",
"description" : "The AP IP address is resolved from the client IP address if none is specified"
},
"serverMac" : {
"type" : "string",
"pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$",
"description" : "The AP MAC address is resolved from the client MAC address if none is specified"
},
"syspmtu" : {
"description" : "Default: 1500",
"type" : "integer"
}
},
"required" : [ "tool", "protocol" ]
}
200
ShowHide{
"wcid" : "123",
"resultId" : 11,
"uplink" : 33,
"downlink" : 44,
"latency" : 23,
"packetLoss" : 21,
"etf" : 21
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"wcid" : {
"descriptin" : "WCID",
"type" : "string"
},
"resultId" : {
"description" : "Result ID",
"type" : "integer"
},
"uplink" : {
"description" : "Uplink",
"type" : "integer"
},
"downlink" : {
"description" : "Downlink",
"type" : "integer"
},
"latency" : {
"description" : "Latency",
"type" : "integer"
},
"packetLoss" : {
"description" : "Packet loss",
"type" : "integer"
},
"etf" : {
"description" : "ETF",
"type" : "integer"
}
}
}
Use this API command to retrieve existing SpeedFlex test results.
200
ShowHide{
"wcid" : "123",
"resultId" : 11,
"uplink" : 33,
"downlink" : 44,
"latency" : 23,
"packetLoss" : 21,
"etf" : 21
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"wcid" : {
"descriptin" : "WCID",
"type" : "string"
},
"resultId" : {
"description" : "Result ID",
"type" : "integer"
},
"uplink" : {
"description" : "Uplink",
"type" : "integer"
},
"downlink" : {
"description" : "Downlink",
"type" : "integer"
},
"latency" : {
"description" : "Latency",
"type" : "integer"
},
"packetLoss" : {
"description" : "Packet loss",
"type" : "integer"
},
"etf" : {
"description" : "ETF",
"type" : "integer"
}
}
}
Use this API command to run the PING test on an AP.
string
(required) MAC address of the AP running the PING test
string
(required) the IP address to PING
200
ShowHidePING Result
Use this API command to run the traceroute test on an AP.
string
(required) MAC address of the AP running the traceRoute test
string
(required) the target IP address to traceRoute
string
(optional) Timeout in unit of seconds (Default: 30)
200
ShowHideTrace Route Result
Use this API command to retrieve the system summary.
200
ShowHide{
"totalCount" : 1,
"hasMore" : false,
"firstIndex" : 0,
"list" : [ {
"id" : "b42be2c8-71bf-465a-8fd2-3911dcf885e4",
"model" : "SCG200",
"description" : "gui96-scg200-vm",
"hostName" : "gui96-scg200-vm",
"mac" : "00:0C:29:B1:34:69",
"serialNumber" : "00000096",
"clusterRole" : "Follower",
"controlNatIp" : null,
"uptimeInSec" : 165561,
"name" : "gui96-scg200-vm-C",
"version" : "3.0.0.0.211",
"cpVersion" : "3.0.0.0.543",
"dpVersion" : "3.0.0.0.56",
"apVersion" : "3.0.0.0.125",
"controlIp" : "172.18.114.29",
"clusterIp" : "172.18.114.32",
"managementIp" : "172.18.114.96"
} ]
}
{
"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 controller",
"type" : "string"
},
"model" : {
"description" : "Product model",
"type" : "string"
},
"description" : {
"description" : "Description of the controller",
"type" : "string"
},
"hostName" : {
"description" : "Host name of the controller",
"type" : "string"
},
"mac" : {
"description" : "MAC address of the controller",
"type" : "string"
},
"serialNumber" : {
"description" : "Serial number of the controller",
"type" : "string"
},
"clusterRole" : {
"description" : "Indicator the role of the controller",
"type" : "string"
},
"controlNatIp" : {
"description" : "Control NAT IP address settings",
"type" : "string"
},
"uptimeInSec" : {
"description" : "Uptime (in seconds) of the controller",
"type" : "integer"
},
"name" : {
"description" : "Name of the controller",
"type" : "string"
},
"version" : {
"description" : "SCG version",
"type" : "string"
},
"cpVersion" : {
"description" : "Control plane version",
"type" : "string"
},
"dpVersion" : {
"description" : "Data plane version",
"type" : "string"
},
"apVersion" : {
"description" : "AP version",
"type" : "string"
},
"controlIp" : {
"description" : "Control IP",
"type" : "string"
},
"clusterIp" : {
"description" : "Cluster IP",
"type" : "string"
},
"managementIp" : {
"description" : "Management IP",
"type" : "string"
},
"controlIpv6" : {
"description" : "Control IPv6",
"type" : "string"
},
"clusterIpv6" : {
"description" : "Cluster IPv6",
"type" : "string"
},
"managementIpv6" : {
"description" : "Management IPv6",
"type" : "string"
}
}
}
}
}
}
Use this API command to retrieve AP models.
200
ShowHideList of AP Models(ex: ["ZF7782","ZF7762"])
Use this API command to retrieve the system statistics.
string
(optional) Interval, only valid of (QUARTER, HOUR, DAY). Default: QUARTER
number
(optional) Size, list size to response. Default: 32
200
ShowHide[ {
"cpId" : "f214c803-c88f-40f8-83d5-a6e37a9840de",
"timestamp" : 1419877800000,
"cpu" : {
"percent" : 8.776667,
"maxPercent" : 32.85,
"minPercent" : 3.78
},
"disk" : {
"total" : 71417208,
"free" : 70844653,
"maxFree" : 70845604,
"minFree" : 70843696
},
"memory" : {
"percent" : 77.59,
"maxPercent" : 77.61,
"minPercent" : 77.58
},
"control" : {
"rxBps" : 898,
"rxBpsMax" : 9160,
"rxBpsMin" : 192,
"rxBytes" : 101038,
"rxDropped" : 0,
"rxPackets" : 761,
"txBps" : 293,
"txBpsMax" : 4771.2,
"txBpsMin" : 0,
"txBytes" : 32964,
"txDropped" : 0,
"txPackets" : 209
},
"cluster" : {
"rxBps" : 24,
"rxBpsMax" : 2080,
"rxBpsMin" : 0,
"rxBytes" : 2794,
"rxDropped" : 0,
"rxPackets" : 10,
"txBps" : 6,
"txBpsMax" : 614.4,
"txBpsMin" : 0,
"txBytes" : 768,
"txDropped" : 0,
"txPackets" : 4
},
"management" : {
"rxBps" : 216,
"rxBpsMax" : 25016,
"rxBpsMin" : 0,
"rxBytes" : 24328,
"rxDropped" : 0,
"rxPackets" : 146,
"txBps" : 139,
"txBpsMax" : 15129.6,
"txBpsMin" : 0,
"txBytes" : 15641,
"txDropped" : 0,
"txPackets" : 108
},
"port0" : {
"rxBps" : 867,
"rxBpsMax" : 9064,
"rxBpsMin" : 192,
"rxBytes" : 97557,
"rxDropped" : 0,
"rxPackets" : 732,
"txBps" : 293,
"txBpsMax" : 4771.2,
"txBpsMin" : 0,
"txBytes" : 32964,
"txDropped" : 0,
"txPackets" : 209
},
"port1" : {
"rxBps" : 13,
"rxBpsMax" : 1040,
"rxBpsMin" : 0,
"rxBytes" : 1494,
"rxDropped" : 0,
"rxPackets" : 6,
"txBps" : 6,
"txBpsMax" : 614.4,
"txBpsMin" : 0,
"txBytes" : 768,
"txDropped" : 0,
"txPackets" : 4
},
"port2" : {
"rxBps" : 216,
"rxBpsMax" : 25016,
"rxBpsMin" : 0,
"rxBytes" : 24328,
"rxDropped" : 0,
"rxPackets" : 146,
"txBps" : 139,
"txBpsMax" : 15129.6,
"txBpsMin" : 0,
"txBytes" : 15641,
"txDropped" : 0,
"txPackets" : 108
},
"port3" : {
"rxBps" : 30,
"rxBpsMax" : 1248,
"rxBpsMin" : 0,
"rxBytes" : 3481,
"rxDropped" : 0,
"rxPackets" : 29,
"txBps" : 0,
"txBpsMax" : 0,
"txBpsMin" : 0,
"txBytes" : 0,
"txDropped" : 0,
"txPackets" : 0
},
"port4" : {
"rxBps" : 11,
"rxBpsMax" : 1040,
"rxBpsMin" : 0,
"rxBytes" : 1300,
"rxDropped" : 0,
"rxPackets" : 4,
"txBps" : 0,
"txBpsMax" : 0,
"txBpsMin" : 0,
"txBytes" : 0,
"txDropped" : 0,
"txPackets" : 0
},
"port5" : {
"rxBps" : 0,
"rxBpsMax" : 0,
"rxBpsMin" : 0,
"rxBytes" : 0,
"rxDropped" : 0,
"rxPackets" : 0,
"txBps" : 0,
"txBpsMax" : 0,
"txBpsMin" : 0,
"txBytes" : 0,
"txDropped" : 0,
"txPackets" : 0
}
} ]
Use this API command to retrieve the system inventory with current logon user domain.
number
(optional) The index of the first entry to be retrieved. Default: 0
number
(optional) The maximum number of entries to be retrieved. Default: 100
200
ShowHide{
"totalCount" : 2,
"hasMore" : false,
"firstIndex" : 0,
"list" : [ {
"zoneId" : "1690614e-1c1f-4fe8-9144-24ccf28d83c4",
"zoneName" : "api-test-zone",
"meshSSID" : null,
"totalAPs" : 0,
"discoveryAPs" : 0,
"provisionedAPs" : 0,
"connectedAPs" : 0,
"disconnectedAPs" : 0,
"rebootingAPs" : 0,
"connectedRootAPs" : 0,
"disconnectedRootAPs" : 0,
"rebootingRootAPs" : 0,
"connectedMeshAPs" : 0,
"disconnectedMeshAPs" : 0,
"rebootingMeshAPs" : 0,
"connectedeMeshAPs" : 0,
"disconnectedeMeshAPs" : 0,
"rebootingeMeshAPs" : 0,
"connectedDownMeshAPs" : 0,
"disconnectedDownMeshAPs" : 0,
"rebootingDownMeshAPs" : 0,
"connectedMeshDisabledAPs" : 0,
"disconnectedMeshDisabledAPs" : 0,
"clients" : 0
}, {
"zoneId" : "b4187899-38ae-4ace-8e40-0bc444455156",
"zoneName" : "Staging Zone",
"meshSSID" : null,
"totalAPs" : 1,
"discoveryAPs" : 0,
"provisionedAPs" : 0,
"connectedAPs" : 1,
"disconnectedAPs" : 0,
"rebootingAPs" : 0,
"connectedRootAPs" : 0,
"disconnectedRootAPs" : 0,
"rebootingRootAPs" : 0,
"connectedMeshAPs" : 0,
"disconnectedMeshAPs" : 0,
"rebootingMeshAPs" : 0,
"connectedeMeshAPs" : 0,
"disconnectedeMeshAPs" : 0,
"rebootingeMeshAPs" : 0,
"connectedDownMeshAPs" : 0,
"disconnectedDownMeshAPs" : 0,
"rebootingDownMeshAPs" : 0,
"connectedMeshDisabledAPs" : 1,
"disconnectedMeshDisabledAPs" : 0,
"clients" : 0
} ]
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"totalCount" : {
"type" : "integer"
},
"hasMore" : {
"type" : "boolean"
},
"firstIndex" : {
"type" : "integer"
},
"list" : {
"type" : "array"
}
}
}
Execute ap balance
200
Use this API command to retrieve the total client count per AP.
200
ShowHideThe total count (integer)
Use this API command to retrieve the client list per AP.
number
(optional) The index of the first entry to be retrieved. Default: 0
number
(optional) The maximum number of entries to be retrieved. Default: 100
200
ShowHide{
"totalCount" : 1,
"hasMore" : false,
"firstIndex" : 0,
"list" : [ {
"mac" : "3C:A9:F4:0C:85:B0",
"ipAddress" : "172.18.116.141",
"ipv6Address" : "2001:b030:2516:1a0::5d6e",
"hostName" : "SDC-Randall-PC",
"osType" : "Windows 7/Vista",
"user" : "",
"status" : "AUTHORIZED",
"radioId" : "0",
"radioMode" : null,
"channel" : "11",
"wlanId" : "1",
"ssid" : "client-test",
"fromClientBytes" : 240863,
"toClientBytes" : 642897,
"fromClientPkts" : 2247,
"toClientPkts" : 7678,
"connectedSince" : 2600,
"vlan" : "1",
"toClientDroppedPkts" : 108
} ]
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"totalCount" : {
"description" : "Total client count",
"type" : "integer"
},
"hasMore" : {
"description" : "Indicates whether there are more clients after the currently displayed list",
"type" : "boolean"
},
"firstIndex" : {
"description" : "Index of the first client returned out of the complete client list",
"type" : "integer"
},
"list" : {
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"mac" : {
"type" : "string",
"pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$",
"description" : "MAC of the Client"
},
"ipAddress" : {
"type" : "string",
"description" : "IP address of the Client"
},
"ipv6Address" : {
"type" : "string",
"description" : "IP V6 address of the Client"
},
"hostName" : {
"description" : "Host name",
"type" : "string"
},
"osType" : {
"description" : "OS type",
"type" : "string"
},
"user" : {
"description" : "User",
"type" : "string"
},
"status" : {
"description" : "Status",
"type" : "string"
},
"radioId" : {
"description" : "Radio inditifier",
"type" : "string"
},
"radioMode" : {
"description" : "Radio mode",
"type" : "string"
},
"channel" : {
"description" : "Channel",
"type" : "string"
},
"wlanId" : {
"description" : "WLAN inditifier",
"type" : "string"
},
"ssid" : {
"description" : "SSID",
"type" : "string"
},
"rssi" : {
"description" : "RSSI",
"type" : "string"
},
"fromClientBytes" : {
"description" : "From client bytes",
"type" : "integer"
},
"toClientBytes" : {
"description" : "To client bytes",
"type" : "integer"
},
"fromClientPkts" : {
"description" : "From client package frames",
"type" : "integer"
},
"toClientPkts" : {
"description" : "To client package frames",
"type" : "integer"
},
"connectedSince" : {
"description" : "Connected since (in milliseconds)",
"type" : "integer"
},
"vlan" : {
"description" : "VLAN id",
"type" : "string"
},
"toClientDroppedPkts" : {
"description" : "To client dropped packages",
"type" : "integer"
},
"apTxDataRate" : {
"description" : "AP Tx Data Rate",
"type" : "string"
},
"apRxSignal" : {
"description" : "AP Rx signal",
"type" : "string"
}
}
}
}
}
}
Backup system configuration
204
Restore system configuration with specified backupUUID
204
Retrive system configuration list
number
(optional) The index of the first entry to be retrieved. Default: 0
number
(optional) The maximum number of entries to be retrieved. Default: 100
200
ShowHide{
"totalCount" : 2,
"hasMore" : false,
"firstIndex" : 0,
"list" : [ {
"id" : "b9c6e66e-f436-402f-a8b1-004d0b9ec7d8",
"createdOn" : "2015/04/29 16:27:13",
"scgVersion" : "3.2.0.0.71",
"controlPlaneSoftwareVersion" : "3.2.0.0.56",
"dataPlaneSoftwareVersion" : "0.0.0.0",
"createdBy" : "admin",
"type" : "1",
"backupElapsed" : null,
"fileSize" : 40026
}, {
"id" : "b0d4df4d-c8eb-4738-ae45-ce73bf936f34",
"createdOn" : "2015/04/29 16:48:32",
"scgVersion" : "3.2.0.0.71",
"controlPlaneSoftwareVersion" : "3.2.0.0.56",
"dataPlaneSoftwareVersion" : "0.0.0.0",
"createdBy" : "admin",
"type" : "1",
"backupElapsed" : null,
"fileSize" : 40053
} ]
}
{
"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 system configuration backup file.",
"type" : "string"
},
"createdOn" : {
"description" : "the create time of the configuration backup file.",
"type" : "number"
},
"scgVersion" : {
"description" : "SCG version of the configuration backup file.",
"type" : "string"
},
"controlPlaneSoftwareVersion" : {
"description" : "control plane software version of the configuration backup file",
"type" : "string"
},
"dataPlaneSoftwareVersion" : {
"description" : "data plane software version of the configuration backup file",
"type" : "string"
},
"createdBy" : {
"description" : "creator of the configuration backup file.",
"type" : "string"
},
"type" : {
"description" : "type of the configuration backup file",
"type" : "string"
},
"backupElapsed" : {
"description" : "backup elapsed of the configuration backup file",
"type" : "number"
},
"fileSize" : {
"description" : "file size of the backup file",
"type" : "number"
}
}
}
}
}
}
Get Auto Export Backup Settings
200
ShowHide{
"enableAutoExportBackup" : true,
"ftpServer" : "FTP server name"
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"enableAutoExportBackup" : {
"description" : "enable auto export backup",
"type" : "boolean"
},
"ftpServer" : {
"description" : "FTP server name",
"type" : "string"
}
}
}
Get Schedule Backup Setting
200
ShowHide{
"enableScheduleBackup" : true,
"interval" : "MONTHLY",
"dateOfMonth" : 5,
"hour" : 2,
"minute" : 15
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"enableScheduleBackup" : {
"description" : "enable schedule backup",
"type" : "boolean"
},
"interval" : {
"description" : "schedule interval",
"enum" : [ "MONTHLY", "WEEKLY", "DAILY" ]
},
"dayOfWeek" : {
"description" : "day of the week",
"enum" : [ "SUNDAY", "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY" ]
},
"dateOfMonth" : {
"description" : "date of the month",
"type" : "integer"
},
"hour" : {
"description" : "hour",
"type" : "integer"
},
"minute" : {
"description" : "minute",
"type" : "integer"
}
}
}
Delete system configuration file
204
Modify Auto Export Backup Settings
{
"enableAutoExportBackup" : true,
"ftpServer" : "FTP server name"
}
{
"enableAutoExportBackup" : {
"description" : "enable auto export backup",
"type" : "boolean",
"default" : false
},
"ftpServer" : {
"description" : "ftp server name",
"type" : "string"
}
}
204
Modify Schedule Backup Setting
{
"enableScheduleBackup" : true,
"interval" : "WEEKLY",
"dayOfWeek" : "MONDAY",
"hour" : 2,
"minute" : 15
}
{
"enableScheduleBackup" : {
"description" : "enable schedule backup",
"type" : "boolean",
"default" : false
},
"interval" : {
"description" : "schedule interval",
"enum" : [ "MONTHLY", "WEEKLY", "DAILY" ]
},
"dayOfWeek" : {
"description" : "day of the week",
"enum" : [ "SUNDAY", "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY" ]
},
"dateOfMonth" : {
"description" : "date of the month",
"type" : "integer"
},
"hour" : {
"description" : "hour",
"type" : "integer",
"default" : 0
},
"minute" : {
"description" : "minute",
"type" : "integer",
"default" : 0
}
}
204
Upload system configuration file
204
Download system configuration file
string
(required) System configuration file uuid
string
(required) Time zone
200
Retrieve syslog server sertting
number
(optional) The index of the first entry to be retrieved. Default: 0
number
(optional) The maximum number of entries to be retrieved. Default: 100
200
ShowHide{
"enabled" : true,
"primaryServer" : {
"host" : "192.1.0.1",
"port" : 90
},
"secondaryServer" : {
"host" : "192.10.8.9",
"port" : 82,
"redundancyMode" : "primary_backup"
}
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"enabled" : {
"description" : "enable logging to remote syslog server",
"type" : "boolean"
},
"primaryServer" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"host" : {
"description" : "address of the syslog server.",
"type" : "string"
},
"port" : {
"description" : "port number of the syslog server",
"type" : "integer"
}
},
"description" : "The primary server settings of syslog server"
},
"secondaryServer" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"host" : {
"description" : "address of the syslog server.",
"type" : "string"
},
"port" : {
"description" : "port number of the syslog server",
"type" : "integer"
},
"redundancyMode" : {
"description" : "The redundancy mode of syslog server",
"enum" : [ "active_active", "primary_backup" ]
}
},
"description" : "The secondary server settings of syslog server"
}
}
}
Modify syslog server setting
{
"enabled" : true
}
{
"enabled" : {
"description" : "enable logging to remote syslog server",
"type" : "boolean"
}
}
204
Modify Primary Server of syslog
{
"host" : "192.1.0.1",
"port" : 90
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"host" : {
"description" : "address of the syslog server.",
"type" : "string"
},
"port" : {
"description" : "port number of the syslog server",
"type" : "integer"
}
},
"description" : "The primary server settings of syslog server"
}
204
Modify Secondary Server of syslog
{
"host" : "192.10.8.9",
"port" : 82,
"redundancyMode" : "primary_backup"
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"host" : {
"description" : "address of the syslog server.",
"type" : "string"
},
"port" : {
"description" : "port number of the syslog server",
"type" : "integer"
},
"redundancyMode" : {
"description" : "The redundancy mode of syslog server",
"enum" : [ "active_active", "primary_backup" ]
}
},
"description" : "The secondary server settings of syslog server"
}
204
Retrieve a list of AP Usb Software Package
number
(optional) The index of the first entry to be retrieved. Default: 0
number
(optional) The maximum number of entries to be retrieved. Default: 100
200
ShowHide{
"totalCount" : 2,
"hasMore" : false,
"firstIndex" : 0,
"list" : [ {
"id" : "0a6987e0-cedd-11e4-8148-f0def13d5845",
"name" : "usbdev.tar.bz2"
}, {
"id" : "6b1dc3b0-d1eb-11e4-b379-f0def13d5845",
"name" : "usbdev-test.tar.bz2"
} ]
}
{
"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 AP Usb Software Package",
"type" : "string"
},
"name" : {
"description" : "name of AP Usb Software Package",
"type" : "string"
}
}
}
}
}
}
Create new AP Usb Software Package by upload file
201
ShowHide{
"id" : "0a6987e0-cedd-11e4-8148-f0def13d5845"
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "the identifier of the create object",
"type" : "string"
}
}
}
Delete specified AP Usb Software Package
204
Get APUsbSoftwarePackage associate with zone by model name
200
ShowHide{
"id" : "APUsbSoftwarePackageId",
"name" : "APUsbSoftwarePackageName"
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "identifier of AP Usb Software Package",
"type" : "string"
},
"name" : {
"description" : "name of AP Usb Software Package",
"type" : "string"
}
}
}
Get APUsbSoftwarePackage associate with APGroup by model name
200
ShowHide{
"id" : "APUsbSoftwarePackageId",
"name" : "APUsbSoftwarePackageName"
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "identifier of AP Usb Software Package",
"type" : "string"
},
"name" : {
"description" : "name of AP Usb Software Package",
"type" : "string"
}
}
}
Get APUsbSoftwarePackage associate AP by model name
200
ShowHide{
"id" : "APUsbSoftwarePackageId",
"name" : "APUsbSoftwarePackageName"
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "identifier of AP Usb Software Package",
"type" : "string"
},
"name" : {
"description" : "name of AP Usb Software Package",
"type" : "string"
}
}
}
Retrieve a list of L2 Access Control
number
(optional) The index of the first entry to be retrieved. Default: 0
number
(optional) The maximum number of entries to be retrieved. Default: 100
200
ShowHide{
"totalCount" : 9,
"hasMore" : false,
"firstIndex" : 0,
"list" : [ {
"id" : "c5dfc930-75dc-11e4-8d56-00606eb0c700",
"name" : "protalName1"
}, {
"id" : "15efd160-7153-11e4-aa08-00606eb0c700",
"name" : "protalName2"
}, {
"id" : "be0f0480-73a9-11e4-9d1d-f0def13d5845",
"name" : "protalName3"
}, {
"id" : "7f0eef00-7423-11e4-bcef-000c299b4765",
"name" : "protalName4"
}, {
"id" : "4f5c98a0-7123-11e4-bcef-000c299b4765",
"name" : "protalName5"
}, {
"id" : "4a023ce0-73ab-11e4-b211-f0def13d5845",
"name" : "protalName6"
}, {
"id" : "afebbc80-73be-11e4-bfde-f0def13d5845",
"name" : "protalName7"
}, {
"id" : "76f4c020-7620-11e4-b8b9-00606eb0c700",
"name" : "protalName8"
}, {
"id" : "96308310-752c-11e4-8276-00606eb0c700",
"name" : "protalName9"
} ]
}
{
"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" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the service"
}
}
}
}
}
}
Retrieve an L2 Access Control
200
ShowHide{
"name" : "l2acl_name",
"id" : "128a26b0-ab73-11e4-87f2-000c29c1611c",
"description" : "l2acl_desc",
"zoneId" : "f4c2fbf6-7f94-44f2-a509-5308db165891",
"restriction" : "ALLOW",
"ruleMacs" : [ "33:11:11:11:11:12", "22:11:11:11:11:11" ]
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "identifier of the L2 Access Control ",
"type" : "string"
},
"zoneId" : {
"description" : "identifier of the zone which the L2 Access Control belongs to",
"type" : "string"
},
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "name of the L2 Access Control "
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "description of the L2 Access Control "
},
"restriction" : {
"description" : "restriction of the L2 Access Control, ALLOW: Only allow all stations listed below, BLOCK:Only block all stations listed below",
"enum" : [ "ALLOW", "BLOCK" ]
},
"ruleMacs" : {
"type" : "array",
"items" : {
"type" : "string",
"pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
}
}
}
}
Create a new L2 Access Control
{
"name" : "l2acl_create_name",
"description" : "l2acl_create_desc",
"restriction" : "ALLOW",
"ruleMacs" : [ "55:11:11:11:11:12", "66:11:11:11:11:11" ]
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "name of the L2 Access Control "
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "description of the L2 Access Control "
},
"restriction" : {
"description" : "restriction of the L2 Access Control, ALLOW: Only allow all stations listed below, BLOCK:Only block all stations listed below",
"enum" : [ "ALLOW", "BLOCK" ]
},
"ruleMacs" : {
"type" : "array",
"items" : {
"type" : "string",
"pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
}
}
},
"required" : [ "name", "restriction" ]
}
201
ShowHide{
"id" : "76f4c020-7620-11e4-b8b9-00606eb0c700"
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Identifier of the created portal profile",
"type" : "string"
}
}
}
Modify a specific L2 Access Control basic
{
"name" : "l2acl_modify_name",
"description" : "l2acl_modify_desc",
"restriction" : "BLOCK"
}
{
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "name of the L2 Access Control "
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "description of the L2 Access Control "
},
"restriction" : {
"description" : "restriction of the L2 Access Control, ALLOW: Only allow all stations listed below, BLOCK:Only block all stations listed below",
"enum" : [ "ALLOW", "BLOCK" ]
}
}
204
Modify a specific L2 Access Control Rule Macs
[ "55:11:11:11:11:12", "66:11:11:11:11:11" ]
{
"type" : "array",
"items" : {
"type" : "string",
"pattern" : "^([0-9a-fA-F][0-9a-fA-F]:){5}([0-9a-fA-F][0-9a-fA-F])$"
}
}
204
Delete an L2 Access Control
204
Retrieve a list of Ethernet Port Porfiles within a zone
number
(optional) The index of the first entry to be retrieved. Default: 0
number
(optional) The maximum number of entries to be retrieved. Default: 100
200
ShowHide{
"totalCount" : 2,
"hasMore" : false,
"firstIndex" : 0,
"list" : [ {
"id" : "0",
"name" : "Default Trunk Port"
}, {
"id" : "1",
"name" : "Default Access Port"
} ]
}
{
"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" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the service"
}
}
}
}
}
}
Retrieve a Ethernet Port Porfile
200
ShowHide{
"name" : "ethport",
"id" : "13",
"description" : "ethportDesc",
"type" : "AccessPort",
"tunnelEnabled" : true,
"untagId" : 1,
"vlanMembers" : "1",
"dynamicVlanEnabled" : false,
"guestVlan" : null,
"_8021X" : {
"type" : "Disable",
"authenticator" : null,
"supplicant" : null
}
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "identifier of the ethernet port profile",
"type" : "string"
},
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "name of the ethernet port profile"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "description of the ethernet port profile"
},
"type" : {
"description" : "type of the ethernet port profile",
"enum" : [ "AccessPort", "TrunkPort", "GeneralPort" ]
},
"tunnelEnabled" : {
"description" : "tunnelEnabled of the ethernet port profile for AccessPort type",
"type" : "boolean"
},
"untagId" : {
"description" : "VLAN Untag ID of the ethernet port profile",
"type" : "integer",
"minimum" : 1,
"maximum" : 4094
},
"vlanMembers" : {
"description" : "VLAN Members of the ethernet port profile",
"type" : "string"
},
"dynamicVlanEnabled" : {
"type" : "boolean"
},
"guestVlan" : {
"type" : "integer",
"minimum" : 1,
"maximum" : 4094
},
"_8021X" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"type" : {
"enum" : [ "Disable", "Supplicant", "PortBasedAuthenticator", "MACBasedAuthenticator" ]
},
"authenticator" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"authentication" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"enableUseSCGasProxy" : {
"type" : "boolean"
},
"server" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
}
},
"required" : [ "enableUseSCGasProxy" ]
},
"disabledAccounting" : {
"type" : "boolean"
},
"accounting" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"enableUseSCGasProxy" : {
"type" : "boolean"
},
"server" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
}
},
"required" : [ "enableUseSCGasProxy" ]
},
"macAuthByPassEnabled" : {
"type" : "boolean"
}
},
"required" : [ "macAuthByPassEnabled" ]
},
"supplicant" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"type" : {
"enum" : [ "MACAddress", "Custom" ]
},
"userName" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^([!-?A-~]([!-?A-~]){0,62}[!-?A-~]|[!-?A-~]{1,1})$"
},
"password" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$"
}
},
"required" : [ "type" ]
}
},
"required" : [ "type" ],
"description" : "VLAN 802.1X of the ethernet port profile"
}
}
}
Create a new Ethernet Port Porfile
{
"name" : "ethport",
"description" : "ethportDesc",
"type" : "AccessPort",
"tunnelEnabled" : true,
"_8021X" : {
"type" : "Disable",
"authenticator" : null,
"supplicant" : null
}
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "name of the ethernet port profile"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "description of the ethernet port profile"
},
"type" : {
"description" : "type of the ethernet port profile",
"enum" : [ "AccessPort", "TrunkPort", "GeneralPort" ]
},
"tunnelEnabled" : {
"description" : "tunnelEnabled of the ethernet port profile for AccessPort type",
"type" : "boolean"
},
"untagId" : {
"description" : "VLAN Untag ID of the ethernet port profile",
"type" : "integer",
"minimum" : 1,
"maximum" : 4094
},
"vlanMembers" : {
"description" : "VLAN Members of the ethernet port profile",
"type" : "string"
},
"dynamicVlanEnabled" : {
"type" : "boolean"
},
"guestVlan" : {
"type" : "integer",
"minimum" : 1,
"maximum" : 4094
},
"_8021X" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"type" : {
"enum" : [ "Disable", "Supplicant", "PortBasedAuthenticator", "MACBasedAuthenticator" ]
},
"authenticator" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"authentication" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"enableUseSCGasProxy" : {
"type" : "boolean"
},
"server" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
}
},
"required" : [ "enableUseSCGasProxy" ]
},
"disabledAccounting" : {
"type" : "boolean"
},
"accounting" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"enableUseSCGasProxy" : {
"type" : "boolean"
},
"server" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
}
},
"required" : [ "enableUseSCGasProxy" ]
},
"macAuthByPassEnabled" : {
"type" : "boolean"
}
},
"required" : [ "macAuthByPassEnabled" ]
},
"supplicant" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"type" : {
"enum" : [ "MACAddress", "Custom" ]
},
"userName" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^([!-?A-~]([!-?A-~]){0,62}[!-?A-~]|[!-?A-~]{1,1})$"
},
"password" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$"
}
},
"required" : [ "type" ]
}
},
"required" : [ "type" ],
"description" : "VLAN 802.1X of the ethernet port profile"
}
},
"required" : [ "name", "type", "_8021X" ]
}
201
ShowHide{
"id" : "2"
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "the identifier of the create object",
"type" : "string"
}
}
}
Modify a specific Ethernet Port Porfile
{
"name" : "modify-ethport",
"description" : "modify-ethport",
"tunnelEnabled" : null,
"untagId" : 1,
"vlanMembers" : "1-4094",
"dynamicVlanEnabled" : false,
"guestVlan" : null
}
{
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "name of the ethernet port profile"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "description of the ethernet port profile"
},
"tunnelEnabled" : {
"description" : "tunnelEnabled of the ethernet port profile for AccessPort type",
"type" : "boolean"
},
"untagId" : {
"description" : "VLAN Untag ID of the ethernet port profile",
"type" : "integer",
"minimum" : 1,
"maximum" : 4094
},
"vlanMembers" : {
"description" : "VLAN Members of the ethernet port profile",
"type" : "string"
},
"dynamicVlanEnabled" : {
"type" : "boolean"
},
"guestVlan" : {
"type" : "integer",
"minimum" : 1,
"maximum" : 4094
}
}
204
Modify _8021X of Ethernet Port Porfile
{
"type" : "Supplicant",
"authenticator" : null,
"supplicant" : {
"type" : "Custom",
"userName" : "testuser",
"password" : "testpassword"
}
}
{
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"type" : {
"enum" : [ "Disable", "Supplicant", "PortBasedAuthenticator", "MACBasedAuthenticator" ]
},
"authenticator" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"authentication" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"enableUseSCGasProxy" : {
"type" : "boolean"
},
"server" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
}
},
"required" : [ "enableUseSCGasProxy" ]
},
"disabledAccounting" : {
"type" : "boolean"
},
"accounting" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"enableUseSCGasProxy" : {
"type" : "boolean"
},
"server" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
}
},
"required" : [ "enableUseSCGasProxy" ]
},
"macAuthByPassEnabled" : {
"type" : "boolean"
}
},
"required" : [ "macAuthByPassEnabled" ]
},
"supplicant" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"type" : {
"enum" : [ "MACAddress", "Custom" ]
},
"userName" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^([!-?A-~]([!-?A-~]){0,62}[!-?A-~]|[!-?A-~]{1,1})$"
},
"password" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$"
}
},
"required" : [ "type" ]
}
},
"required" : [ "type" ],
"description" : "VLAN 802.1X of the ethernet port profile"
}
204
Delete Ethernet Port Porfile
204
Use this API command to retrieve a list of domain under Administration Domain.
number
(optional) The index of the first entry to be retrieved. Default: 0
number
(optional) The maximum number of entries to be retrieved. Default: 100
string
(optional) Get domain list recursively.
string
(optional) Get domain list include Self.
200
ShowHide{
"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 domain",
"type" : "string"
},
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "domain name"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the domain"
},
"createdBy" : {
"description" : "Created by",
"type" : "string"
},
"createDatetime" : {
"description" : "Created by",
"type" : "string"
},
"zoneCount" : {
"description" : "# of Zones",
"type" : "Integer"
},
"subDomainCount" : {
"description" : "# of Subdomains",
"type" : "integer"
},
"administratorCount" : {
"description" : "# of Subdomains",
"type" : "integer"
},
"apCount" : {
"description" : "# of Subdomains",
"type" : "integer"
}
}
}
}
}
}
Use this API command to retrieve a list of subdomain by specified Domain ID.
number
(optional) The index of the first entry to be retrieved. Default: 0
number
(optional) The maximum number of entries to be retrieved. Default: 100
string
(optional) Get domain list recursively.
string
(optional) Get domain list include Self.
200
ShowHide{
"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 domain",
"type" : "string"
},
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "domain name"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the domain"
},
"createdBy" : {
"description" : "Created by",
"type" : "string"
},
"createDatetime" : {
"description" : "Created by",
"type" : "string"
},
"zoneCount" : {
"description" : "# of Zones",
"type" : "Integer"
},
"subDomainCount" : {
"description" : "# of Subdomains",
"type" : "integer"
},
"administratorCount" : {
"description" : "# of Subdomains",
"type" : "integer"
},
"apCount" : {
"description" : "# of Subdomains",
"type" : "integer"
}
}
}
}
}
}
Use this API command to retrieve domain by specified Domain ID.
200
ShowHide{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Identifier of the domain",
"type" : "string"
},
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "domain name"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the domain"
},
"createdBy" : {
"description" : "Created by",
"type" : "string"
},
"createDatetime" : {
"description" : "Created by",
"type" : "string"
},
"zoneCount" : {
"description" : "# of Zones",
"type" : "Integer"
},
"subDomainCount" : {
"description" : "# of Subdomains",
"type" : "integer"
},
"administratorCount" : {
"description" : "# of Subdomains",
"type" : "integer"
},
"apCount" : {
"description" : "# of Subdomains",
"type" : "integer"
}
}
}
Use this API command to create new domain.
string
(optional) {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "domain name"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the domain name"
}
},
"required" : [ "name" ]
}
201
ShowHide{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "the identifier of the create object",
"type" : "string"
}
}
}
Use this API command to modify the basic information of domain.
{
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "domain name"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the domain"
}
}
204
Use this API command to delete domain.
204
Use this API command to retrieve a list of wechat profile.
number
(optional) The index of the first entry to be retrieved. Default: 0
number
(optional) The maximum number of entries to be retrieved. Default: 100
200
ShowHide{
"totalCount" : 9,
"hasMore" : false,
"firstIndex" : 0,
"list" : [ {
"id" : "c5dfc930-75dc-11e4-8d56-00606eb0c700",
"name" : "protalName1"
}, {
"id" : "15efd160-7153-11e4-aa08-00606eb0c700",
"name" : "protalName2"
}, {
"id" : "be0f0480-73a9-11e4-9d1d-f0def13d5845",
"name" : "protalName3"
}, {
"id" : "7f0eef00-7423-11e4-bcef-000c299b4765",
"name" : "protalName4"
}, {
"id" : "4f5c98a0-7123-11e4-bcef-000c299b4765",
"name" : "protalName5"
}, {
"id" : "4a023ce0-73ab-11e4-b211-f0def13d5845",
"name" : "protalName6"
}, {
"id" : "afebbc80-73be-11e4-bfde-f0def13d5845",
"name" : "protalName7"
}, {
"id" : "76f4c020-7620-11e4-b8b9-00606eb0c700",
"name" : "protalName8"
}, {
"id" : "96308310-752c-11e4-8276-00606eb0c700",
"name" : "protalName9"
} ]
}
{
"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" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the service"
}
}
}
}
}
}
Use this API command to retrieve wechat profile by ID.
200
ShowHide{
"name" : "wechat_name",
"description" : "wechat_desc",
"authUrl" : "http://www.ruckuswireless.com",
"dnatDestination" : "ruckus",
"gracePeriod" : 60,
"blackList" : "172.15.20.80",
"whiteList" : [ "10.1.2.3", "10.9.0.5" ],
"dnatPortMapping" : [ {
"sourcePort" : 80,
"destPort" : 80
}, {
"sourcePort" : 60,
"destPort" : 60
}, {
"sourcePort" : 83,
"destPort" : 85
} ]
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the wechat profile"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the wechat profile"
},
"authUrl" : {
"description" : "Authentication URL of the wechat profile",
"type" : "string"
},
"dnatDestination" : {
"description" : "DNAT destination of the wechat profile",
"type" : "string"
},
"gracePeriod" : {
"description" : "Grace period of the wechat profile",
"type" : "integer",
"default" : 60,
"minimum" : 1,
"maximum" : 14399
},
"blackList" : {
"description" : "Black list of the wechat profile",
"type" : "string"
},
"whiteList" : {
"description" : "White list of the wechat profile",
"type" : "array",
"items" : {
"type" : "string"
}
},
"dnatPortMapping" : {
"description" : "DNAT Port Mapping of the wechat profile",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"sourcePort" : {
"description" : "Source port",
"type" : "integer",
"minimum" : 0,
"maximum" : 65535
},
"destPort" : {
"description" : "Destination port",
"type" : "integer",
"minimum" : 0,
"maximum" : 65535
}
}
}
}
}
}
Use this API command to create wechat profile.
{
"name" : "wechat_create_name",
"description" : "wechat_create_desc",
"authUrl" : "http://www.ruckuswireless.com",
"dnatDestination" : "ruckus",
"gracePeriod" : 60,
"blackList" : "172.15.20.80",
"whiteList" : [ "10.1.2.3", "10.9.0.5" ],
"dnatPortMapping" : [ {
"sourcePort" : 80,
"destPort" : 80
}, {
"sourcePort" : 60,
"destPort" : 60
}, {
"sourcePort" : 83,
"destPort" : 85
} ]
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the wechat profile"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the wechat profile"
},
"authUrl" : {
"description" : "Authentication URL of the wechat profile",
"type" : "string"
},
"dnatDestination" : {
"description" : "DNAT destination of the wechat profile",
"type" : "string"
},
"gracePeriod" : {
"description" : "Grace period of the wechat profile",
"type" : "integer",
"default" : 60,
"minimum" : 1,
"maximum" : 14399
},
"blackList" : {
"description" : "Black list of the wechat profile",
"type" : "string"
},
"whiteList" : {
"description" : "White list of the wechat profile",
"type" : "array",
"items" : {
"type" : "string"
}
},
"dnatPortMapping" : {
"description" : "DNAT Port Mapping of the wechat profile",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"sourcePort" : {
"description" : "Source port",
"type" : "integer",
"minimum" : 0,
"maximum" : 65535
},
"destPort" : {
"description" : "Destination port",
"type" : "integer",
"minimum" : 0,
"maximum" : 65535
}
}
}
}
},
"required" : [ "name", "authUrl", "dnatDestination", "blackList", "whiteList" ]
}
201
ShowHide{
"id" : "76f4c020-7620-11e4-b8b9-00606eb0c700"
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Identifier of the created portal profile",
"type" : "string"
}
}
}
Use this API command to modify the basic information of wechat profile.
{
"name" : "wechat_modify_name",
"description" : "wechat_modify_desc",
"authUrl" : "http://www.ruckuswireless.com",
"dnatDestination" : "ruckus",
"gracePeriod" : 60,
"blackList" : "172.15.20.80"
}
{
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the wechat profile"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the wechat profile"
},
"authUrl" : {
"description" : "Authentication URL of the wechat profile",
"type" : "string"
},
"dnatDestination" : {
"description" : "DNAT destination of the wechat profile",
"type" : "string"
},
"gracePeriod" : {
"description" : "Grace period of the wechat profile",
"type" : "integer",
"default" : 60,
"minimum" : 1,
"maximum" : 14399
},
"blackList" : {
"description" : "Black list of the wechat profile",
"type" : "string"
}
}
204
Use this API command to modify DNAT port mapping of a wechat profile.
[ {
"sourcePort" : 80,
"destPort" : 80
}, {
"sourcePort" : 60,
"destPort" : 60
}, {
"sourcePort" : 83,
"destPort" : 85
} ]
{
"description" : "DNAT Port Mapping of the wechat profile",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"sourcePort" : {
"description" : "Source port",
"type" : "integer",
"minimum" : 0,
"maximum" : 65535
},
"destPort" : {
"description" : "Destination port",
"type" : "integer",
"minimum" : 0,
"maximum" : 65535
}
}
}
}
204
Use this API command to delete wechat profile.
204
Use this API command to retrieve a list of L2oGRE profile.
200
ShowHide{
"totalCount" : 1,
"hasMore" : false,
"firstIndex" : 0,
"list" : [ {
"id" : "267ef3a0-738b-11e4-96d5-0a7820524153",
"name" : "new name"
} ]
}
{
"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 profile",
"type" : "string"
},
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the profile"
}
}
}
}
}
}
Use this API command to retrieve L2oGRE profile by ID.
200
ShowHide{
"name" : "L2oGRE profile name",
"description" : "L2oGRE profile description",
"coreNetworkGateway" : {
"primaryGateway" : "1.1.1.1",
"secondaryGateway" : null,
"tunnelMTU" : "AUTO",
"tunnelMTUSize" : null,
"keepAlivePeriod" : 10,
"keepAliveRetry" : 3
},
"dhcpRelay" : {
"dhcpRelayEnabled" : true,
"dhcpServer1" : "172.13.22.5",
"dhcpServer2" : "172.13.22.10",
"relayBothEnabled" : false,
"dhcpOption82" : {
"dhcpOption82Enabled" : true,
"subopt1Enabled" : true,
"subopt1Format" : "AP_MAC_hex_ESSID",
"subopt2Enabled" : true,
"subopt2Format" : "AP_MAC_hex",
"subopt150Enabled" : false,
"subopt151Enabled" : true,
"subopt151Format" : "AREA_NAME",
"subopt151AreaName" : "area name"
}
}
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of L2oGRE profile"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the L2oGRE profile"
},
"coreNetworkGateway" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"primaryGateway" : {
"description" : "Primary Gateway",
"type" : "string"
},
"secondaryGateway" : {
"description" : "Secondary Gateway",
"type" : "string"
},
"tunnelMTU" : {
"description" : "Gateway path MTU",
"enum" : [ "AUTO", "MANUAL" ]
},
"tunnelMTUSize" : {
"description" : "Manual setting value of Gateway path MTU",
"type" : "integer",
"minimum" : 850,
"maximum" : 1500,
"default" : 1500
},
"keepAlivePeriod" : {
"description" : "ICMP Keep-Alive Period(secs)",
"type" : "integer",
"minimum" : 1,
"maximum" : 32767,
"default" : 10
},
"keepAliveRetry" : {
"description" : "ICMP Keep-Alive Retry",
"type" : "integer",
"minimum" : 1,
"maximum" : 255,
"default" : 3
}
},
"description" : "Core Network Gateway"
},
"dhcpRelay" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"dhcpRelayEnabled" : {
"description" : "Enable DHCP Relay",
"type" : "boolean"
},
"dhcpServer1" : {
"description" : "DHCP Server 1",
"type" : "string"
},
"dhcpServer2" : {
"description" : "DHCP Server 2",
"type" : "string"
},
"relayBothEnabled" : {
"description" : "Send DHCP requests to both servers simultaneously.",
"type" : "boolean"
},
"dhcpOption82" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"dhcpOption82Enabled" : {
"description" : "Enable DHCP Option 82",
"type" : "boolean"
},
"subopt1Enabled" : {
"description" : "Enable subopt-1",
"type" : "boolean"
},
"subopt1Format" : {
"description" : "Subopt-1 format",
"enum" : [ "AP_INFO", "AP_MAC_hex", "AP_MAC_hex_ESSID" ]
},
"subopt2Enabled" : {
"description" : "Enable subopt-2",
"type" : "boolean"
},
"subopt2Format" : {
"description" : "Subopt-2 format",
"enum" : [ "CLIENT_MAC_hex", "CLIENT_MAC_hex_ESSID", "AP_MAC_hex", "AP_MAC__hex_ESSID" ]
},
"subopt150Enabled" : {
"description" : "Subopt-150 with VLAN",
"type" : "boolean"
},
"subopt151Enabled" : {
"description" : "Enable subopt-151",
"type" : "boolean"
},
"subopt151Format" : {
"description" : "Subopt-151 format",
"enum" : [ "AREA_NAME", "ESSID" ]
},
"subopt151AreaName" : {
"description" : "Subopt-151 Area Name value",
"type" : "string"
}
},
"description" : "DHCP Option 82"
}
},
"description" : "DHCP Relay"
}
}
}
Use this API command to create L2oGRE profile.
{
"name" : "L2oGRE profile create name",
"description" : "L2oGRE profile create description",
"coreNetworkGateway" : {
"primaryGateway" : "1.1.1.1",
"tunnelMTU" : "AUTO",
"keepAlivePeriod" : 10,
"keepAliveRetry" : 3
}
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of L2oGRE profile"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the L2oGRE profile"
},
"coreNetworkGateway" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"primaryGateway" : {
"description" : "Primary Gateway",
"type" : "string"
},
"secondaryGateway" : {
"description" : "Secondary Gateway",
"type" : "string"
},
"tunnelMTU" : {
"description" : "Gateway path MTU",
"enum" : [ "AUTO", "MANUAL" ]
},
"tunnelMTUSize" : {
"description" : "Manual setting value of Gateway path MTU",
"type" : "integer",
"minimum" : 850,
"maximum" : 1500,
"default" : 1500
},
"keepAlivePeriod" : {
"description" : "ICMP Keep-Alive Period(secs)",
"type" : "integer",
"minimum" : 1,
"maximum" : 32767,
"default" : 10
},
"keepAliveRetry" : {
"description" : "ICMP Keep-Alive Retry",
"type" : "integer",
"minimum" : 1,
"maximum" : 255,
"default" : 3
}
},
"description" : "Core Network Gateway"
},
"dhcpRelay" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"dhcpRelayEnabled" : {
"description" : "Enable DHCP Relay",
"type" : "boolean"
},
"dhcpServer1" : {
"description" : "DHCP Server 1",
"type" : "string"
},
"dhcpServer2" : {
"description" : "DHCP Server 2",
"type" : "string"
},
"relayBothEnabled" : {
"description" : "Send DHCP requests to both servers simultaneously.",
"type" : "boolean"
},
"dhcpOption82" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"dhcpOption82Enabled" : {
"description" : "Enable DHCP Option 82",
"type" : "boolean"
},
"subopt1Enabled" : {
"description" : "Enable subopt-1",
"type" : "boolean"
},
"subopt1Format" : {
"description" : "Subopt-1 format",
"enum" : [ "AP_INFO", "AP_MAC_hex", "AP_MAC_hex_ESSID" ]
},
"subopt2Enabled" : {
"description" : "Enable subopt-2",
"type" : "boolean"
},
"subopt2Format" : {
"description" : "Subopt-2 format",
"enum" : [ "CLIENT_MAC_hex", "CLIENT_MAC_hex_ESSID", "AP_MAC_hex", "AP_MAC__hex_ESSID" ]
},
"subopt150Enabled" : {
"description" : "Subopt-150 with VLAN",
"type" : "boolean"
},
"subopt151Enabled" : {
"description" : "Enable subopt-151",
"type" : "boolean"
},
"subopt151Format" : {
"description" : "Subopt-151 format",
"enum" : [ "AREA_NAME", "ESSID" ]
},
"subopt151AreaName" : {
"description" : "Subopt-151 Area Name value",
"type" : "string"
}
},
"description" : "DHCP Option 82"
}
},
"description" : "DHCP Relay"
}
},
"required" : [ "name", "coreNetworkGateway" ]
}
201
ShowHide{
"id" : "profileUUID"
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
}
}
}
Use this API command to modify the basic information of L2oGRE profile.
{
"name" : "L2oGRE profile modify name",
"description" : "L2oGRE profile modify description"
}
{
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of L2oGRE profile"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the L2oGRE profile"
}
}
204
Use this API command to modify Core Network Gateway of a L2oGRE profile.
{
"primaryGateway" : "1.1.1.1",
"tunnelMTU" : "MANUAL",
"tunnelMTUSize" : 1500,
"keepAlivePeriod" : 10,
"keepAliveRetry" : 3
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"primaryGateway" : {
"description" : "Primary Gateway",
"type" : "string"
},
"secondaryGateway" : {
"description" : "Secondary Gateway",
"type" : "string"
},
"tunnelMTU" : {
"description" : "Gateway path MTU",
"enum" : [ "AUTO", "MANUAL" ]
},
"tunnelMTUSize" : {
"description" : "Manual setting value of Gateway path MTU",
"type" : "integer",
"minimum" : 850,
"maximum" : 1500,
"default" : 1500
},
"keepAlivePeriod" : {
"description" : "ICMP Keep-Alive Period(secs)",
"type" : "integer",
"minimum" : 1,
"maximum" : 32767,
"default" : 10
},
"keepAliveRetry" : {
"description" : "ICMP Keep-Alive Retry",
"type" : "integer",
"minimum" : 1,
"maximum" : 255,
"default" : 3
}
},
"description" : "Core Network Gateway"
}
204
Use this API command to modify DHCP Relay of L2oGRE profile.
{
"dhcpRelayEnabled" : true,
"dhcpServer1" : "172.13.22.5",
"dhcpServer2" : "172.13.22.10",
"relayBothEnabled" : false,
"dhcpOption82" : {
"dhcpOption82Enabled" : true,
"subopt1Enabled" : true,
"subopt1Format" : "AP_MAC_hex_ESSID",
"subopt2Enabled" : true,
"subopt2Format" : "AP_MAC_hex",
"subopt150Enabled" : false,
"subopt151Enabled" : true,
"subopt151Format" : "AREA_NAME",
"subopt151AreaName" : "testAreaName"
}
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"dhcpRelayEnabled" : {
"description" : "Enable DHCP Relay",
"type" : "boolean"
},
"dhcpServer1" : {
"description" : "DHCP Server 1",
"type" : "string"
},
"dhcpServer2" : {
"description" : "DHCP Server 2",
"type" : "string"
},
"relayBothEnabled" : {
"description" : "Send DHCP requests to both servers simultaneously.",
"type" : "boolean"
},
"dhcpOption82" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"dhcpOption82Enabled" : {
"description" : "Enable DHCP Option 82",
"type" : "boolean"
},
"subopt1Enabled" : {
"description" : "Enable subopt-1",
"type" : "boolean"
},
"subopt1Format" : {
"description" : "Subopt-1 format",
"enum" : [ "AP_INFO", "AP_MAC_hex", "AP_MAC_hex_ESSID" ]
},
"subopt2Enabled" : {
"description" : "Enable subopt-2",
"type" : "boolean"
},
"subopt2Format" : {
"description" : "Subopt-2 format",
"enum" : [ "CLIENT_MAC_hex", "CLIENT_MAC_hex_ESSID", "AP_MAC_hex", "AP_MAC__hex_ESSID" ]
},
"subopt150Enabled" : {
"description" : "Subopt-150 with VLAN",
"type" : "boolean"
},
"subopt151Enabled" : {
"description" : "Enable subopt-151",
"type" : "boolean"
},
"subopt151Format" : {
"description" : "Subopt-151 format",
"enum" : [ "AREA_NAME", "ESSID" ]
},
"subopt151AreaName" : {
"description" : "Subopt-151 Area Name value",
"type" : "string"
}
},
"description" : "DHCP Option 82"
}
},
"description" : "DHCP Relay"
}
204
Use this API command to delete L2oGRE profile.
204
Use this API command to retrieve a list of L3oGRE profile.
200
ShowHide{
"totalCount" : 1,
"hasMore" : false,
"firstIndex" : 0,
"list" : [ {
"id" : "267ef3a0-738b-11e4-96d5-0a7820524153",
"name" : "new name"
} ]
}
{
"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 profile",
"type" : "string"
},
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the profile"
}
}
}
}
}
}
Use this API command to retrieve L3oGRE profile by ID.
200
ShowHide{
"name" : "L3oGRE profile name",
"description" : "L3oGRE profile description",
"coreNetworkGateway" : {
"primaryGateway" : "1.1.1.1",
"tunnelMTU" : "MANUAL",
"tunnelMTUSize" : 850
},
"dhcpRelay" : {
"dhcpServer1" : "21.11.11.11",
"dhcpServer2" : "32.22.22.22",
"relayBothEnabled" : false,
"dhcpOption82" : {
"dhcpOption82Enabled" : true,
"subopt1Enabled" : true,
"subopt1Format" : "AP_INFO",
"subopt2Enabled" : true,
"subopt2Format" : "CLIENT_MAC_hex",
"subopt150Enabled" : true,
"subopt151Enabled" : true,
"subopt151Format" : "AREA_NAME",
"subopt151AreaName" : "area name"
},
"dhcpRelayTunnelEnabled" : false
},
"dpTunnelAddresses" : [ {
"name" : "scg200-D0",
"tunnelInterface" : "",
"mask" : ""
}, {
"name" : "scg200-D1",
"tunnelInterface" : "",
"mask" : ""
} ],
"tunnelKeepAlive" : {
"enabled" : false
}
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of L2oGRE profile"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the L2oGRE profile"
},
"coreNetworkGateway" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"primaryGateway" : {
"description" : "Primary Gateway",
"type" : "string"
},
"secondaryGateway" : {
"description" : "Secondary Gateway",
"type" : "string"
},
"tunnelMTU" : {
"description" : "Gateway path MTU",
"enum" : [ "AUTO", "MANUAL" ]
},
"tunnelMTUSize" : {
"description" : "Manual setting value of Gateway path MTU",
"type" : "integer",
"minimum" : 850,
"maximum" : 1500,
"default" : 1500
}
},
"description" : "Core Network Gateway"
},
"dhcpRelay" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"dhcpServer1" : {
"description" : "DHCP Server 1",
"type" : "string"
},
"dhcpServer2" : {
"description" : "DHCP Server 2",
"type" : "string"
},
"relayBothEnabled" : {
"description" : "Send DHCP requests to both servers simultaneously.",
"type" : "boolean"
},
"dhcpOption82" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"dhcpOption82Enabled" : {
"description" : "Enable DHCP Option 82",
"type" : "boolean"
},
"subopt1Enabled" : {
"description" : "Enable subopt-1",
"type" : "boolean"
},
"subopt1Format" : {
"description" : "Subopt-1 format",
"enum" : [ "AP_INFO", "AP_MAC_hex", "AP_MAC_hex_ESSID" ]
},
"subopt2Enabled" : {
"description" : "Enable subopt-2",
"type" : "boolean"
},
"subopt2Format" : {
"description" : "Subopt-2 format",
"enum" : [ "CLIENT_MAC_hex", "CLIENT_MAC_hex_ESSID", "AP_MAC_hex", "AP_MAC__hex_ESSID" ]
},
"subopt150Enabled" : {
"description" : "Subopt-150 with VLAN",
"type" : "boolean"
},
"subopt151Enabled" : {
"description" : "Enable subopt-151",
"type" : "boolean"
},
"subopt151Format" : {
"description" : "Subopt-151 format",
"enum" : [ "AREA_NAME", "ESSID" ]
},
"subopt151AreaName" : {
"description" : "Subopt-151 Area Name value",
"type" : "string"
}
},
"description" : "DHCP Option 82"
},
"dhcpRelayTunnelEnabled" : {
"description" : "Enable DHCP Relay Tunnel",
"type" : "boolean"
}
},
"description" : "DHCP Relay"
},
"dpTunnelAddresses" : {
"type" : "array",
"description" : "Data Plane Tunnel Addresses",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"name" : {
"description" : "Data Plane name",
"type" : "string"
},
"tunnelInterface" : {
"description" : "Tunnel Interface Address",
"type" : "string"
},
"mask" : {
"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)$)",
"description" : "Mask"
}
}
}
},
"tunnelKeepAlive" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"enabled" : {
"description" : "Tunnel Keep Alive Enabled",
"type" : "boolean"
},
"period" : {
"description" : "Keep Alive Period",
"type" : "integer",
"minimum" : 1,
"maximum" : 32767,
"default" : 10
},
"retry" : {
"description" : "Keep Alive Retry",
"type" : "integer",
"minimum" : 1,
"maximum" : 255,
"default" : 3
}
},
"description" : "Tunnel Keep Alive"
}
}
}
Use this API command to create L3oGRE profile.
{
"name" : "L3oGRE profile create name",
"description" : "L3oGRE profile create description",
"coreNetworkGateway" : {
"primaryGateway" : "1.1.1.1",
"tunnelMTU" : "AUTO"
},
"dhcpRelay" : {
"dhcpServer1" : "21.11.11.11",
"dhcpServer2" : "32.22.22.22",
"relayBothEnabled" : false,
"dhcpOption82" : {
"dhcpOption82Enabled" : true,
"subopt1Enabled" : true,
"subopt1Format" : "AP_INFO",
"subopt2Enabled" : true,
"subopt2Format" : "CLIENT_MAC_hex",
"subopt150Enabled" : true,
"subopt151Enabled" : true,
"subopt151Format" : "ESSID"
}
},
"dpTunnelAddresses" : [ {
"name" : "scg200-D0",
"tunnelInterface" : "11.11.11.1",
"mask" : "255.255.0.0"
}, {
"name" : "scg200-D1",
"tunnelInterface" : "11.11.11.1",
"mask" : "255.255.0.0"
} ]
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of L3oGRE profile"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the L3oGRE profile"
},
"coreNetworkGateway" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"primaryGateway" : {
"description" : "Primary Gateway",
"type" : "string"
},
"secondaryGateway" : {
"description" : "Secondary Gateway",
"type" : "string"
},
"tunnelMTU" : {
"description" : "Gateway path MTU",
"enum" : [ "AUTO", "MANUAL" ]
},
"tunnelMTUSize" : {
"description" : "Manual setting value of Gateway path MTU",
"type" : "integer",
"minimum" : 850,
"maximum" : 1500,
"default" : 1500
}
},
"description" : "Core Network Gateway"
},
"dhcpRelay" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"dhcpServer1" : {
"description" : "DHCP Server 1",
"type" : "string"
},
"dhcpServer2" : {
"description" : "DHCP Server 2",
"type" : "string"
},
"relayBothEnabled" : {
"description" : "Send DHCP requests to both servers simultaneously.",
"type" : "boolean"
},
"dhcpOption82" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"dhcpOption82Enabled" : {
"description" : "Enable DHCP Option 82",
"type" : "boolean"
},
"subopt1Enabled" : {
"description" : "Enable subopt-1",
"type" : "boolean"
},
"subopt1Format" : {
"description" : "Subopt-1 format",
"enum" : [ "AP_INFO", "AP_MAC_hex", "AP_MAC_hex_ESSID" ]
},
"subopt2Enabled" : {
"description" : "Enable subopt-2",
"type" : "boolean"
},
"subopt2Format" : {
"description" : "Subopt-2 format",
"enum" : [ "CLIENT_MAC_hex", "CLIENT_MAC_hex_ESSID", "AP_MAC_hex", "AP_MAC__hex_ESSID" ]
},
"subopt150Enabled" : {
"description" : "Subopt-150 with VLAN",
"type" : "boolean"
},
"subopt151Enabled" : {
"description" : "Enable subopt-151",
"type" : "boolean"
},
"subopt151Format" : {
"description" : "Subopt-151 format",
"enum" : [ "AREA_NAME", "ESSID" ]
},
"subopt151AreaName" : {
"description" : "Subopt-151 Area Name value",
"type" : "string"
}
},
"description" : "DHCP Option 82"
},
"dhcpRelayTunnelEnabled" : {
"description" : "Enable DHCP Relay Tunnel",
"type" : "boolean"
}
},
"description" : "DHCP Relay"
},
"dpTunnelAddresses" : {
"type" : "array",
"description" : "Data Plane Tunnel Addresses",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"name" : {
"description" : "Data Plane name",
"type" : "string"
},
"tunnelInterface" : {
"description" : "Tunnel Interface Address",
"type" : "string"
},
"mask" : {
"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)$)",
"description" : "Mask"
}
}
}
}
},
"required" : [ "name", "coreNetworkGateway", "dhcpRelay" ]
}
201
ShowHide{
"id" : "profileUUID"
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
}
}
}
Use this API command to modify the basic information of L3oGRE profile.
{
"name" : "L3oGRE profile modify name",
"description" : "L3oGRE profile modify description"
}
{
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of L2oGRE profile"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the L2oGRE profile"
}
}
204
Use this API command to modify Core Network Gateway of a L3oGRE profile.
{
"primaryGateway" : "1.1.1.1",
"tunnelMTU" : "MANUAL",
"tunnelMTUSize" : 850
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"primaryGateway" : {
"description" : "Primary Gateway",
"type" : "string"
},
"secondaryGateway" : {
"description" : "Secondary Gateway",
"type" : "string"
},
"tunnelMTU" : {
"description" : "Gateway path MTU",
"enum" : [ "AUTO", "MANUAL" ]
},
"tunnelMTUSize" : {
"description" : "Manual setting value of Gateway path MTU",
"type" : "integer",
"minimum" : 850,
"maximum" : 1500,
"default" : 1500
}
},
"description" : "Core Network Gateway"
}
204
Use this API command to modify DHCP Relay of L3oGRE profile.
{
"dhcpServer1" : "21.11.11.11",
"dhcpServer2" : "32.22.22.22",
"relayBothEnabled" : false,
"dhcpOption82" : {
"dhcpOption82Enabled" : true,
"subopt1Enabled" : true,
"subopt1Format" : "AP_INFO",
"subopt2Enabled" : true,
"subopt2Format" : "CLIENT_MAC_hex",
"subopt150Enabled" : true,
"subopt151Enabled" : true,
"subopt151Format" : "AREA_NAME",
"subopt151AreaName" : "area name"
},
"dhcpRelayTunnelEnabled" : true
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"dhcpServer1" : {
"description" : "DHCP Server 1",
"type" : "string"
},
"dhcpServer2" : {
"description" : "DHCP Server 2",
"type" : "string"
},
"relayBothEnabled" : {
"description" : "Send DHCP requests to both servers simultaneously.",
"type" : "boolean"
},
"dhcpOption82" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"dhcpOption82Enabled" : {
"description" : "Enable DHCP Option 82",
"type" : "boolean"
},
"subopt1Enabled" : {
"description" : "Enable subopt-1",
"type" : "boolean"
},
"subopt1Format" : {
"description" : "Subopt-1 format",
"enum" : [ "AP_INFO", "AP_MAC_hex", "AP_MAC_hex_ESSID" ]
},
"subopt2Enabled" : {
"description" : "Enable subopt-2",
"type" : "boolean"
},
"subopt2Format" : {
"description" : "Subopt-2 format",
"enum" : [ "CLIENT_MAC_hex", "CLIENT_MAC_hex_ESSID", "AP_MAC_hex", "AP_MAC__hex_ESSID" ]
},
"subopt150Enabled" : {
"description" : "Subopt-150 with VLAN",
"type" : "boolean"
},
"subopt151Enabled" : {
"description" : "Enable subopt-151",
"type" : "boolean"
},
"subopt151Format" : {
"description" : "Subopt-151 format",
"enum" : [ "AREA_NAME", "ESSID" ]
},
"subopt151AreaName" : {
"description" : "Subopt-151 Area Name value",
"type" : "string"
}
},
"description" : "DHCP Option 82"
},
"dhcpRelayTunnelEnabled" : {
"description" : "Enable DHCP Relay Tunnel",
"type" : "boolean"
}
},
"description" : "DHCP Relay"
}
204
Use this API command to modify Data Plane Tunnel Addresses of L3oGRE profile.
[ {
"name" : "scg200-D0",
"tunnelInterface" : "11.11.11.1",
"mask" : "255.255.0.0"
}, {
"name" : "scg200-D1",
"tunnelInterface" : "11.11.11.1",
"mask" : "255.255.0.0"
} ]
{
"type" : "array",
"description" : "Data Plane Tunnel Addresses",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"name" : {
"description" : "Data Plane name",
"type" : "string"
},
"tunnelInterface" : {
"description" : "Tunnel Interface Address",
"type" : "string"
},
"mask" : {
"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)$)",
"description" : "Mask"
}
}
}
}
204
Use this API command to modify Tunnel Keep Alive of L3oGRE profile.
{
"enabled" : true,
"period" : 255,
"retry" : 1
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"enabled" : {
"description" : "Tunnel Keep Alive Enabled",
"type" : "boolean"
},
"period" : {
"description" : "Keep Alive Period",
"type" : "integer",
"minimum" : 1,
"maximum" : 32767,
"default" : 10
},
"retry" : {
"description" : "Keep Alive Retry",
"type" : "integer",
"minimum" : 1,
"maximum" : 255,
"default" : 3
}
},
"description" : "Tunnel Keep Alive"
}
204
Use this API command to delete L3oGRE profile.
204
Use this API command to retrieve a list of identity user role.
200
ShowHide{
"totalCount" : 2,
"hasMore" : false,
"firstIndex" : 0,
"list" : [ {
"id" : "c5dfc930-75dc-11e4-8d56-00606eb0c700",
"name" : "identity name"
}, {
"id" : "15efd160-7153-11e4-aa08-00606eb0c700",
"name" : "identity name"
} ]
}
{
"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" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the service"
}
}
}
}
}
}
Use this API command to retrieve identity user role by ID.
200
ShowHide{
"id" : "e5db11b3-71ff-4234-80d0-c7562e9868af",
"name" : "identity user role name",
"description" : "identity user role desc",
"userTrafficProfile" : {
"id" : "91c3fcf0-2f83-11e5-a2b8-000c29cf8ec4",
"name" : "userTrafficProfile"
},
"maxDevices" : {
"maxDevicesAllowed" : "UNLIMITED",
"maxDevicesNumber" : 0
},
"allowedWlans" : {
"allowWlanType" : "ALLOW_WLAN",
"zoneUUIDList" : [ "4f771a8a-c0c3-4b88-8a73-78cb460fc637" ],
"wlanUUIDList" : [ "1" ]
}
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "the identifier of the object",
"type" : "string"
},
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "name"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "description"
},
"userTrafficProfile" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
},
"description" : "User traffic profile"
},
"maxDevices" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"maxDevicesAllowed" : {
"description" : "Max devices allowed",
"enum" : [ "UNLIMITED", "LIMITED" ],
"default" : "LIMITED"
},
"maxDevicesNumber" : {
"description" : "max devices number",
"type" : "integer",
"default" : 3,
"minimum" : 1,
"maximum" : 10
}
},
"description" : "max Devices"
},
"allowedWlans" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"allowWlanType" : {
"description" : "allow wlan type",
"enum" : [ "ALLOW_ALL", "ALLOW_ZONE", "ALLOW_WLAN" ],
"default" : "ALLOW_ALL"
},
"zoneUUIDList" : {
"type" : "array",
"description" : "Selected zone UUID",
"items" : {
"type" : "string"
}
},
"wlanUUIDList" : {
"type" : "array",
"description" : "Selected wlan UUID",
"items" : {
"type" : "string"
}
}
},
"description" : "Allowed wlans"
}
}
}
Use this API command to create identity user role.
{
"name" : "create-identity-user-role-name",
"description" : "create identity user role desc",
"userTrafficProfile" : {
"name" : "utp"
},
"maxDevices" : {
"maxDevicesAllowed" : "LIMITED",
"maxDeviceNumber" : 3
},
"allowedWlans" : {
"allowWlanType" : "ALLOW_ALL"
}
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "name"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "description"
},
"userTrafficProfile" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
},
"description" : "User traffic profile"
},
"maxDevices" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"maxDevicesAllowed" : {
"description" : "Max devices allowed",
"enum" : [ "UNLIMITED", "LIMITED" ],
"default" : "LIMITED"
},
"maxDevicesNumber" : {
"description" : "max devices number",
"type" : "integer",
"default" : 3,
"minimum" : 1,
"maximum" : 10
}
},
"description" : "max Devices"
},
"allowedWlans" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"allowWlanType" : {
"description" : "allow wlan type",
"enum" : [ "ALLOW_ALL", "ALLOW_ZONE", "ALLOW_WLAN" ],
"default" : "ALLOW_ALL"
},
"zoneUUIDList" : {
"type" : "array",
"description" : "Selected zone UUID",
"items" : {
"type" : "string"
}
},
"wlanUUIDList" : {
"type" : "array",
"description" : "Selected wlan UUID",
"items" : {
"type" : "string"
}
}
},
"description" : "Allowed wlans"
}
},
"required" : [ "name", "userTrafficProfile", "maxDevices" ]
}
201
ShowHide{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "the identifier of the create object",
"type" : "string"
}
}
}
Use this API command to modify the basic information of identity user role.
{
"name" : "modify-userrole-test",
"description" : "modify user role test"
}
{
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "name"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "description"
}
}
204
Use this API command to modify max device allowed of identity user role.
{
"maxDevicesAllowed" : "LIMITED",
"maxDeviceNumber" : 3
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"maxDevicesAllowed" : {
"description" : "Max devices allowed",
"enum" : [ "UNLIMITED", "LIMITED" ],
"default" : "LIMITED"
},
"maxDevicesNumber" : {
"description" : "max devices number",
"type" : "integer",
"default" : 3,
"minimum" : 1,
"maximum" : 10
}
},
"description" : "max Devices"
}
204
Use this API command to modify user traffic profile of identity user role.
{
"name" : "userTrafficProfileName"
}
{
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
},
"description" : "User traffic profile"
}
204
Use this API command to modify allowed wlans of identity user role.
{
"allowWlanType" : "ALLOW_WLAN",
"zoneUUIDList" : [ "4f771a8a-c0c3-4b88-8a73-78cb460fc637" ],
"wlanUUIDList" : [ "1" ]
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"allowWlanType" : {
"description" : "allow wlan type",
"enum" : [ "ALLOW_ALL", "ALLOW_ZONE", "ALLOW_WLAN" ],
"default" : "ALLOW_ALL"
},
"zoneUUIDList" : {
"type" : "array",
"description" : "Selected zone UUID",
"items" : {
"type" : "string"
}
},
"wlanUUIDList" : {
"type" : "array",
"description" : "Selected wlan UUID",
"items" : {
"type" : "string"
}
}
},
"description" : "Allowed wlans"
}
204
Use this API command to delete identity user role.
204
Use this API command to retrieve a list of AP Registration Rules profile.
200
ShowHide{
"totalCount" : 3,
"hasMore" : false,
"firstIndex" : 0,
"list" : [ {
"id" : "f031d790-f2dd-11e4-b4f9-000c292547b9",
"priority" : 1,
"description" : "aprule1"
}, {
"id" : "ba7b3fb0-f2fb-11e4-b680-80fa5b024259",
"priority" : 2,
"description" : "aprule2"
}, {
"id" : "ba7b3fb0-f2fb-11e4-b680-80fa5b024259",
"priority" : 3,
"description" : "aprule3"
} ]
}
{
"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 Registration Rules",
"type" : "string"
},
"priority" : {
"description" : "priority of the AP Registration Rules",
"type" : "integer"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the AP Registration Rules"
}
}
}
}
}
}
Use this API command to retrieve AP Registration Rules profile by ID.
200
ShowHide{
"id" : "f031d790-f2dd-11e4-b4f9-000c292547b9",
"priority" : 1,
"description" : "aprule1",
"type" : "IPAddressRange",
"ipAddressRange" : {
"fromIp" : "11.11.11.17",
"toIp" : "11.11.11.18"
},
"subnet" : null,
"gpsCoordinates" : null,
"provisionTag" : null,
"mobilityZone" : {
"id" : "1690614e-1c1f-4fe8-9144-24ccf28d83c4",
"name" : "api-test-zone"
}
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"description" : "Identifier of the AP Registration Rules",
"type" : "string"
},
"priority" : {
"description" : "priority of the AP Registration Rules",
"type" : "integer"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the AP Registration Rules"
},
"type" : {
"description" : "type of the AP Registration Rules",
"enum" : [ "IPAddressRange", "Subnet", "GPSCoordinates", "ProvisionTag" ]
},
"ipAddressRange" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"fromIp" : {
"type" : "string",
"description" : "from IP Address"
},
"toIp" : {
"type" : "string",
"description" : "to IP Address"
}
},
"description" : "IPAddressRange of the AP Registration Rules"
},
"subnet" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"networkAddress" : {
"type" : "string",
"description" : "networkAddress"
},
"subnetMask" : {
"description" : "subnetMask",
"type" : "string"
}
},
"description" : "Subnet of the AP Registration Rules"
},
"gpsCoordinates" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"latitude" : {
"type" : "number",
"description" : "latitude"
},
"longitude" : {
"type" : "number",
"description" : "longitude"
},
"distance" : {
"description" : "distance",
"type" : "number"
}
},
"description" : "GPSCoordinates of the AP Registration Rules"
},
"provisionTag" : {
"description" : "ProvisionTag of the AP Registration Rules",
"pattern" : "^[!-~]([!-~]){0,31}$"
},
"mobilityZone" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
},
"description" : "mobilityZone of the AP Registration Rules"
}
}
}
Use this API command to create AP Registration Rules profile.
{
"description" : "postman_aprule",
"type" : "IPAddressRange",
"ipAddressRange" : {
"fromIp" : "11.11.11.11",
"toIp" : "11.11.11.13"
},
"mobilityZone" : {
"id" : "1690614e-1c1f-4fe8-9144-24ccf28d83c4"
}
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the AP Registration Rules"
},
"type" : {
"description" : "type of the AP Registration Rules",
"enum" : [ "IPAddressRange", "Subnet", "GPSCoordinates", "ProvisionTag" ]
},
"ipAddressRange" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"fromIp" : {
"type" : "string",
"description" : "from IP Address"
},
"toIp" : {
"type" : "string",
"description" : "to IP Address"
}
},
"description" : "IPAddressRange of the AP Registration Rules"
},
"subnet" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"networkAddress" : {
"type" : "string",
"description" : "networkAddress"
},
"subnetMask" : {
"description" : "subnetMask",
"type" : "string"
}
},
"description" : "Subnet of the AP Registration Rules"
},
"gpsCoordinates" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"latitude" : {
"type" : "number",
"description" : "latitude"
},
"longitude" : {
"type" : "number",
"description" : "longitude"
},
"distance" : {
"description" : "distance",
"type" : "number"
}
},
"description" : "GPSCoordinates of the AP Registration Rules"
},
"provisionTag" : {
"description" : "ProvisionTag of the AP Registration Rules",
"pattern" : "^[!-~]([!-~]){0,31}$"
},
"mobilityZone" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
},
"description" : "mobilityZone of the AP Registration Rules"
}
},
"required" : [ "type", "mobilityZone" ]
}
201
ShowHide{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
}
}
}
Use this API command to modify the basic information of AP Registration Rules profile.
{
"description" : "postman_aprule",
"type" : "Subnet",
"provisionTag" : "provisiontag"
}
{
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "Description of the AP Registration Rules"
},
"type" : {
"description" : "type of the AP Registration Rules",
"enum" : [ "IPAddressRange", "Subnet", "GPSCoordinates", "ProvisionTag" ]
},
"provisionTag" : {
"description" : "ProvisionTag of the AP Registration Rules",
"type" : "string",
"pattern" : "^[!-~]([!-~]){0,31}$"
}
}
204
Use this API command to modify IP Address Range of a AP Registration Rules profile.
{
"fromIp" : "11.11.11.11",
"toIp" : "11.11.11.13"
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"fromIp" : {
"type" : "string",
"description" : "from IP Address"
},
"toIp" : {
"type" : "string",
"description" : "to IP Address"
}
},
"description" : "IPAddressRange of the AP Registration Rules"
}
204
Use this API command to modify subnet of AP Registration Rules profile.
{
"networkAddress" : "11.11.11.11",
"subnetMask" : "255.255.0.0"
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"networkAddress" : {
"type" : "string",
"description" : "networkAddress"
},
"subnetMask" : {
"description" : "subnetMask",
"type" : "string"
}
},
"description" : "Subnet of the AP Registration Rules"
}
204
Use this API command to modify GPSCoordinates of AP Registration Rules profile.
{
"latitude" : 50.11,
"longitude" : 100.533,
"distance" : 10
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"latitude" : {
"type" : "number",
"description" : "latitude"
},
"longitude" : {
"type" : "number",
"description" : "longitude"
},
"distance" : {
"description" : "distance",
"type" : "number"
}
},
"description" : "GPSCoordinates of the AP Registration Rules"
}
204
Use this API command to modify mobilityZone of AP Registration Rules profile.
{
"id" : "1690614e-1c1f-4fe8-9144-24ccf28d83c4"
}
{
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
},
"description" : "mobilityZone of the AP Registration Rules"
}
204
Use this API command to delete AP Registration Rules profile.
204
Use this API command to move Priority Up of AP Registration Rules profile.
204
Use this API command to move Priority Down of AP Registration Rules profile.
204
Use this API command to retrieve a list of data planes.
200
ShowHide{
"totalCount" : 2,
"hasMore" : false,
"firstIndex" : 0,
"list" : [ {
"id" : "24:C9:A1:3F:10:60",
"bladeName" : "test63-D0",
"mac" : "24:C9:A1:3F:10:60",
"ip" : null,
"fwVersion" : null,
"model" : null,
"serialNumber" : null,
"dpStatus" : "Disconnected",
"lastSeen" : null,
"uptime" : "0s",
"greTunnels" : 0,
"managedBy" : null
}, {
"id" : "24:C9:A1:3F:10:68",
"bladeName" : "test63-D1",
"mac" : "24:C9:A1:3F:10:68",
"ip" : null,
"fwVersion" : null,
"model" : null,
"serialNumber" : null,
"dpStatus" : "Disconnected",
"lastSeen" : null,
"uptime" : "0s",
"greTunnels" : 0,
"managedBy" : null
} ]
}
{
"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 data plane",
"type" : "string"
},
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the data plane"
},
"mac" : {
"description" : "DP MAC Address",
"type" : "string"
},
"ip" : {
"description" : "IP address",
"type" : "string"
},
"managedBy" : {
"description" : "Managed By",
"type" : "string"
},
"model" : {
"description" : "Model",
"type" : "string"
},
"serialNumber" : {
"description" : "Serial Number",
"type" : "string"
},
"greTunnels" : {
"description" : "# of Ruckus GRE Tunnels",
"type" : "string"
},
"fwVersion" : {
"description" : "Firmware",
"type" : "string"
},
"lastSeen" : {
"description" : "Last Seen On",
"type" : "string"
},
"dpStatus" : {
"description" : "Status",
"type" : "string"
},
"uptime" : {
"description" : "Uptime",
"type" : "string"
}
}
}
}
}
}
Use this API command to retrieve data plane by id.
200
ShowHide{
"interfaceMode" : "ACCESS_AND_CORE",
"primaryInterface" : {
"ipMode" : "STATIC",
"ipAddress" : "192.168.1.0",
"subnetMask" : "255.255.255.0",
"gateway" : "192.168.1.0",
"primaryDNSServer" : "2.2.2.2",
"secondaryDNSServer" : "5.5.5.5",
"vlan" : "22",
"natIp" : "10.2.3.10"
},
"secondaryInterface" : {
"ipAddress" : "192.168.10.1",
"subnetMask" : "255.255.255.0",
"vlan" : "123"
},
"ipv6PrimaryInterface" : {
"ipMode" : "STATIC",
"ipAddress" : "2222:3333::5555/64",
"gateway" : "2222:3333::0000",
"primaryDNSServer" : "2222:3333::5555",
"secondaryDNSServer" : "2222:3333::2222"
},
"staticRoute" : [ {
"networkAddress" : "255.255.255.0",
"subnetMask" : "255.255.255.0",
"gateway" : "192.168.10.15"
} ]
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"interfaceMode" : {
"description" : "Interface mode",
"enum" : [ "SINGLE", "ACCESS_AND_CORE" ]
},
"primaryInterface" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"ipMode" : {
"description" : "IP mode",
"enum" : [ "STATIC", "DHCP" ]
},
"ipAddress" : {
"description" : "IP address",
"type" : "string"
},
"subnetMask" : {
"description" : "Subnet mask",
"type" : "string"
},
"gateway" : {
"description" : "Gateway",
"type" : "string"
},
"primaryDNSServer" : {
"description" : "Primary DNS server",
"type" : "string"
},
"secondaryDNSServer" : {
"description" : "Secondary DNS server",
"type" : "string"
},
"vlan" : {
"description" : "Vlan",
"type" : "string"
},
"natIp" : {
"description" : "NAT IP",
"type" : "string"
}
},
"description" : "Primary(Access) Interface"
},
"ipv6PrimaryInterface" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"ipMode" : {
"description" : "IP mode",
"enum" : [ "STATIC", "AUTO" ]
},
"ipAddress" : {
"description" : "IP address",
"type" : "string"
},
"gateway" : {
"description" : "Gateway",
"type" : "string"
},
"primaryDNSServer" : {
"description" : "Primary DNS server",
"type" : "string"
},
"secondaryDNSServer" : {
"description" : "Secondary DNS server",
"type" : "string"
}
},
"description" : "IPv6 Primary(Access) Interface"
},
"secondaryInterface" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"ipAddress" : {
"description" : "IP address",
"type" : "string"
},
"subnetMask" : {
"description" : "Subnet mask",
"type" : "string"
},
"vlan" : {
"description" : "vlan",
"type" : "string"
}
},
"description" : "Secondary (Core) Interface"
},
"staticRoute" : {
"description" : "Primary(Access) interface",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"networkAddress" : {
"description" : "Network address",
"type" : "string"
},
"subnetMask" : {
"description" : "Subnet mask",
"type" : "string"
},
"gateway" : {
"description" : "Gateway",
"type" : "string"
}
},
"required" : [ "networkAddress", "subnetMask", "gateway" ]
}
}
}
}
Use this API command to modify the basic information of data plane.
{
"interfaceMode" : "ACCESS_AND_CORE"
}
{
"interfaceMode" : {
"description" : "Interface mode",
"enum" : [ "SINGLE", "ACCESS_AND_CORE" ]
}
}
204
Use this API command to modify primary interface of data plane.
{
"ipMode" : "STATIC",
"ipAddress" : "192.168.1.0",
"subnetMask" : "255.255.255.0",
"gateway" : "192.168.1.0",
"primaryDNSServer" : "2.2.2.2",
"secondaryDNSServer" : "5.5.5.5",
"vlan" : "22",
"natIp" : "10.2.3.10"
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"ipMode" : {
"description" : "IP mode",
"enum" : [ "STATIC", "DHCP" ]
},
"ipAddress" : {
"description" : "IP address",
"type" : "string"
},
"subnetMask" : {
"description" : "Subnet mask",
"type" : "string"
},
"gateway" : {
"description" : "Gateway",
"type" : "string"
},
"primaryDNSServer" : {
"description" : "Primary DNS server",
"type" : "string"
},
"secondaryDNSServer" : {
"description" : "Secondary DNS server",
"type" : "string"
},
"vlan" : {
"description" : "Vlan",
"type" : "string"
},
"natIp" : {
"description" : "NAT IP",
"type" : "string"
}
},
"description" : "Primary(Access) Interface"
}
204
Use this API command to modify ipv6 Primary Interface of data plane.
{
"ipMode" : "STATIC",
"ipAddress" : "2222:3333::5555/64",
"gateway" : "2222:3333::0000",
"primaryDNSServer" : "2222:3333::5555",
"secondaryDNSServer" : "2222:3333::2222"
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"ipMode" : {
"description" : "IP mode",
"enum" : [ "STATIC", "AUTO" ]
},
"ipAddress" : {
"description" : "IP address",
"type" : "string"
},
"gateway" : {
"description" : "Gateway",
"type" : "string"
},
"primaryDNSServer" : {
"description" : "Primary DNS server",
"type" : "string"
},
"secondaryDNSServer" : {
"description" : "Secondary DNS server",
"type" : "string"
}
},
"description" : "IPv6 Primary(Access) Interface"
}
204
Use this API command to modify secondary interface of data plane.
{
"ipAddress" : "192.168.10.1",
"subnetMask" : "255.255.255.0",
"vlan" : "123"
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"ipAddress" : {
"description" : "IP address",
"type" : "string"
},
"subnetMask" : {
"description" : "Subnet mask",
"type" : "string"
},
"vlan" : {
"description" : "vlan",
"type" : "string"
}
},
"description" : "Secondary (Core) Interface"
}
204
Use this API command to modify static route of data plane.
[ {
"networkAddress" : "255.255.255.0",
"subnetMask" : "255.255.255.0",
"gateway" : "192.168.10.15"
} ]
{
"description" : "Primary(Access) interface",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"networkAddress" : {
"description" : "Network address",
"type" : "string"
},
"subnetMask" : {
"description" : "Subnet mask",
"type" : "string"
},
"gateway" : {
"description" : "Gateway",
"type" : "string"
}
},
"required" : [ "networkAddress", "subnetMask", "gateway" ]
}
}
204
Use this API command to delete static route.
204
Use this API command to retrieve a list of RuckusGRE tunnel profile.
200
ShowHide{
"totalCount" : 1,
"hasMore" : false,
"firstIndex" : 0,
"list" : [ {
"id" : "267ef3a0-738b-11e4-96d5-0a7820524153",
"name" : "new name"
} ]
}
{
"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 profile",
"type" : "string"
},
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the profile"
}
}
}
}
}
}
Use this API command to retrieve RuckusGRE tunnel profile.
200
ShowHide{
"name" : "RuckusGRE tunnel profile name",
"description" : "RuckusGRE tunnel profile description",
"tunnelMode" : "GRE",
"enableTunnelEncryption" : false,
"tunnelMtuAutoEnabled" : "MANUAL",
"tunnelMtuSize" : 1500
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "name of the RuckusGRE profile"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "description of the RuckusGRE profile"
},
"tunnelMode" : {
"description" : "Ruckus Tunnel Mode of RuckusGRE profile",
"enum" : [ "GRE", "GREUDP" ]
},
"enableTunnelEncryption" : {
"description" : "Tunnel Encryption of the RuckusGRE profile",
"type" : "boolean"
},
"tunnelMtuAutoEnabled" : {
"description" : "WAN Interface MTU of the RuckusGRE profile",
"enum" : [ "AUTO", "MANUAL" ]
},
"tunnelMtuSize" : {
"description" : "Tunnel MTU size of RuckusGRE profile",
"type" : "integer"
}
}
}
Use this API command to create RuckusGRE tunnel profile.
{
"name" : "RuckusGRE tunnel profile name",
"description" : "RuckusGRE tunnel profile description",
"tunnelMode" : "GREUDP",
"enableTunnelEncryption" : false,
"tunnelMtuAutoEnabled" : "AUTO"
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "name of the RuckusGRE profile"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "description of the RuckusGRE profile"
},
"tunnelMode" : {
"description" : "Ruckus Tunnel Mode of RuckusGRE profile",
"enum" : [ "GRE", "GREUDP" ]
},
"enableTunnelEncryption" : {
"description" : "Tunnel Encryption of the RuckusGRE profile",
"type" : "boolean",
"default" : false
},
"tunnelMtuAutoEnabled" : {
"description" : "WAN Interface MTU of the RuckusGRE profile",
"enum" : [ "AUTO", "MANUAL" ]
},
"tunnelMtuSize" : {
"description" : "Tunnel MTU size of RuckusGRE profile",
"type" : "integer",
"minimum" : 850,
"maximum" : 1500,
"default" : 1500
}
},
"required" : [ "name", "tunnelMtuAutoEnabled" ]
}
201
ShowHide{
"id" : "profileUUID"
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
}
}
}
Use this API command to modify the basic information of RuckusGRE tunnel profile.
{
"name" : "RuckusGRE tunnel profile name",
"description" : "RuckusGRE tunnel profile description",
"tunnelMode" : "GRE",
"enableTunnelEncryption" : false,
"tunnelMtuAutoEnabled" : "MANUAL",
"tunnelMtuSize" : 1500
}
{
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "name of the RuckusGRE profile"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "description of the RuckusGRE profile"
},
"tunnelMode" : {
"description" : "Ruckus Tunnel Mode of RuckusGRE profile",
"enum" : [ "GRE", "GREUDP" ]
},
"enableTunnelEncryption" : {
"description" : "Tunnel Encryption of the RuckusGRE profile",
"type" : "boolean",
"default" : false
},
"tunnelMtuAutoEnabled" : {
"description" : "WAN Interface MTU of the RuckusGRE profile",
"enum" : [ "AUTO", "MANUAL" ]
},
"tunnelMtuSize" : {
"description" : "Tunnel MTU size of RuckusGRE profile",
"type" : "integer",
"minimum" : 850,
"maximum" : 1500,
"default" : 1500
}
}
204
Use this API command to delete RuckusGRE tunnel profile.
204
Use this API command to retrieve a list of SoftGRE tunnel profile.
200
ShowHide{
"totalCount" : 1,
"hasMore" : false,
"firstIndex" : 0,
"list" : [ {
"id" : "267ef3a0-738b-11e4-96d5-0a7820524153",
"name" : "new name"
} ]
}
{
"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 profile",
"type" : "string"
},
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of the profile"
}
}
}
}
}
}
Use this API command to retrieve SoftGRE tunnel profile.
200
ShowHide{
"name" : "SoftGRE tunnel profile name",
"description" : "SoftGRE tunnel profile description",
"ipMode" : "IPV6",
"primaryGateway" : "2222:3333::5555",
"secondaryGateway" : "2222:3333::1111",
"tunnelMtuAutoEnabled" : "MANUAL",
"tunnelMtuSize" : 1500,
"keepAlivePeriod" : 10,
"keepAliveRetry" : 5
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "name of the SoftGRE profile"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "description of the SoftGRE profile"
},
"ipMode" : {
"enum" : [ "IPV4", "IPV6", "IPV4_IPV6" ],
"description" : "Gateway IP Mode of SoftGRE profile"
},
"primaryGateway" : {
"description" : "Primary gateway address of the SoftGRE profile",
"type" : "string"
},
"secondaryGateway" : {
"description" : "Secondary gateway address of the SoftGRE profile",
"type" : "string"
},
"tunnelMtuAutoEnabled" : {
"description" : "WAN Interface MTU of the RuckusGRE profile",
"enum" : [ "AUTO", "MANUAL" ]
},
"tunnelMtuSize" : {
"description" : "Tunnel MTU size of RuckusGRE profile",
"type" : "integer"
},
"keepAlivePeriod" : {
"description" : "ICMP Keep-Alive Period(secs)",
"type" : "integer"
},
"keepAliveRetry" : {
"description" : "ICMP Keep-Alive Retry",
"type" : "integer"
}
}
}
Use this API command to create SoftGRE tunnel profile.
{
"name" : "SoftGRE tunnel profile name",
"description" : "SoftGRE tunnel profile description",
"ipMode" : "IPV4",
"primaryGateway" : "172.18.110.29",
"secondaryGateway" : "192.168.10.1",
"tunnelMtuAutoEnabled" : "MANUAL",
"tunnelMtuSize" : 1500,
"keepAlivePeriod" : 10,
"keepAliveRetry" : 5
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "name of the SoftGRE profile"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "description of the SoftGRE profile"
},
"ipMode" : {
"enum" : [ "IPV4", "IPV6", "IPV4_IPV6" ],
"description" : "Gateway IP Mode of SoftGRE profile"
},
"primaryGateway" : {
"description" : "Primary gateway address of the SoftGRE profile",
"type" : "string"
},
"secondaryGateway" : {
"description" : "Secondary gateway address of the SoftGRE profile",
"type" : "string"
},
"tunnelMtuAutoEnabled" : {
"description" : "WAN Interface MTU of the RuckusGRE profile",
"enum" : [ "AUTO", "MANUAL" ]
},
"tunnelMtuSize" : {
"description" : "Tunnel MTU size of RuckusGRE profile",
"type" : "integer",
"minimum" : 850,
"maximum" : 1500,
"default" : 1500
},
"keepAlivePeriod" : {
"description" : "ICMP Keep-Alive Period(secs)",
"type" : "integer",
"minimum" : 1,
"maximum" : 180,
"default" : 10
},
"keepAliveRetry" : {
"description" : "ICMP Keep-Alive Retry",
"type" : "integer",
"minimum" : 2,
"maximum" : 20,
"default" : 5
}
},
"required" : [ "name", "primaryGateway", "tunnelMtuAutoEnabled", "keepAlivePeriod", "keepAliveRetry" ]
}
201
ShowHide{
"id" : "profileUUID"
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : "string"
}
}
}
Use this API command to modify the basic information of SoftGRE tunnel profile.
{
"name" : "SoftGRE tunnel profile name",
"description" : "SoftGRE tunnel profile description",
"primaryGateway" : "172.18.110.50",
"secondaryGateway" : "192.168.10.2",
"tunnelMtuAutoEnabled" : "AUTO",
"keepAlivePeriod" : 10,
"keepAliveRetry" : 5
}
{
"name" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "name of the SoftGRE profile"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 64,
"pattern" : "^$|^([!-~]([ -~]){0,62}[!-~]|[!-~]{1,1})$",
"description" : "description of the SoftGRE profile"
},
"primaryGateway" : {
"description" : "Primary gateway address of the SoftGRE profile",
"type" : "string"
},
"secondaryGateway" : {
"description" : "Secondary gateway address of the SoftGRE profile",
"type" : "string"
},
"tunnelMtuAutoEnabled" : {
"description" : "WAN Interface MTU of the RuckusGRE profile",
"enum" : [ "AUTO", "MANUAL" ]
},
"tunnelMtuSize" : {
"description" : "Tunnel MTU size of RuckusGRE profile",
"type" : "integer",
"minimum" : 850,
"maximum" : 1500,
"default" : 1500
},
"keepAlivePeriod" : {
"description" : "ICMP Keep-Alive Period(secs)",
"type" : "integer",
"minimum" : 1,
"maximum" : 180,
"default" : 10
},
"keepAliveRetry" : {
"description" : "ICMP Keep-Alive Retry",
"type" : "integer",
"minimum" : 2,
"maximum" : 20,
"default" : 5
}
}
204
Use this API command to delete SoftGRE tunnel profile.
204
Backup cluster
204
Restore cluster backup by ID
204
Retrive cluster backup list
number
(optional) The index of the first entry to be retrieved. Default: 0
number
(optional) The maximum number of entries to be retrieved. Default: 100
string
(optional) Change display timezone of created date and time, like timezone=Asia/Taipei, default is UTC time.
200
ShowHide{
"totalCount" : 1,
"hasMore" : false,
"firstIndex" : 0,
"list" : [ {
"id" : "20150907031120_3.2.0.0.721",
"version" : "3.2.0.0.721",
"filesize" : "998.4 MB",
"createdOn" : "2015/09/07 11:11:20"
} ]
}
{
"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 cluster backup file.",
"type" : "string"
},
"version" : {
"description" : "the patch version of the cluster backup file.",
"type" : "string"
},
"filesize" : {
"description" : "filesize of the cluster backup file.",
"type" : "number"
},
"createdOn" : {
"description" : "Created date and time of the cluster backup file",
"type" : "string"
}
}
}
}
}
}
Delete cluster backup by ID
204
Use this API command to upload patch file
200
ShowHide{
"clusterOperationProgress" : {
"operation" : "None",
"overallProgress" : 0,
"isSelfBladeRebooting" : null,
"bladeProgresss" : [ {
"bladeUUID" : "386988fe-72fe-41e0-a373-7a73fea5d16e",
"hostName" : "neilscg200",
"iterationName" : "None",
"state" : "",
"progress" : 0
} ],
"previousOperationRecord" : {
"operation" : "Upload",
"success" : true,
"errorMsg" : null
},
"clusterSubTaskState" : "Completed",
"clusterOperationBlockUI" : false,
"clusterOperationDisplayMsg" : ""
}
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"clusterOperationProgress" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"operation" : {
"description" : "operation of clusterOperationProgress",
"enum" : [ "None", "Join", "Backup", "Restore", "Upload", "Upgrade", "BackupAndUpgrade", "RemoveBlade", "ChangeBladeIP", "DiskSnapshot", "UploadVDPFirmware" ]
},
"overallProgress" : {
"description" : "overallProgress of clusterOperationProgress",
"type" : "integer"
},
"isSelfBladeRebooting" : {
"description" : "isSelfBladeRebooting of clusterOperationProgress",
"type" : "boolean"
},
"bladeProgresss" : {
"description" : "bladeProgressMap of clusterOperationProgress",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"bladeUUID" : {
"description" : "bladeUUID of bladeProgress",
"type" : "string"
},
"hostName" : {
"description" : "hostName of bladeProgress",
"type" : "string"
},
"iterationName" : {
"description" : "iterationName of bladeProgress",
"type" : "string"
},
"state" : {
"description" : "state of bladeProgress",
"type" : "string"
},
"progress" : {
"description" : "progress of bladeProgress",
"type" : "integer"
}
}
}
},
"previousOperationRecord" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"operation" : {
"description" : "operation of previousOperationRecord",
"enum" : [ "None", "Join", "Backup", "Restore", "Upload", "Upgrade", "BackupAndUpgrade", "RemoveBlade", "ChangeBladeIP", "DiskSnapshot", "UploadVDPFirmware" ]
},
"success" : {
"description" : "success of previousOperationRecord",
"type" : "boolean"
},
"errorMsg" : {
"description" : "errorMsg of previousOperationRecord",
"type" : "string"
}
},
"description" : "previousOperationRecord of clusterOperationProgress"
},
"clusterSubTaskState" : {
"description" : "clusterSubTaskState of clusterOperationProgress",
"enum" : [ "None", "Running", "Failed", "Completed" ]
},
"clusterOperationBlockUI" : {
"description" : "clusterOperationBlockUI of clusterOperationProgress",
"type" : "boolean"
},
"clusterOperationDisplayMsg" : {
"description" : "clusterOperationDisplayMsg of clusterOperationProgress",
"type" : "string"
}
},
"description" : "upgrade status"
}
}
}
Use this API command to retrive cluster progress status
200
ShowHide{
"clusterOperationProgress" : {
"operation" : "None",
"overallProgress" : 0,
"isSelfBladeRebooting" : null,
"bladeProgresss" : [ {
"bladeUUID" : "386988fe-72fe-41e0-a373-7a73fea5d16e",
"hostName" : "neilscg200",
"iterationName" : "None",
"state" : "",
"progress" : 0
} ],
"previousOperationRecord" : {
"operation" : "Upload",
"success" : true,
"errorMsg" : null
},
"clusterSubTaskState" : "Completed",
"clusterOperationBlockUI" : false,
"clusterOperationDisplayMsg" : ""
}
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"clusterOperationProgress" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"operation" : {
"description" : "operation of clusterOperationProgress",
"enum" : [ "None", "Join", "Backup", "Restore", "Upload", "Upgrade", "BackupAndUpgrade", "RemoveBlade", "ChangeBladeIP", "DiskSnapshot", "UploadVDPFirmware" ]
},
"overallProgress" : {
"description" : "overallProgress of clusterOperationProgress",
"type" : "integer"
},
"isSelfBladeRebooting" : {
"description" : "isSelfBladeRebooting of clusterOperationProgress",
"type" : "boolean"
},
"bladeProgresss" : {
"description" : "bladeProgressMap of clusterOperationProgress",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"bladeUUID" : {
"description" : "bladeUUID of bladeProgress",
"type" : "string"
},
"hostName" : {
"description" : "hostName of bladeProgress",
"type" : "string"
},
"iterationName" : {
"description" : "iterationName of bladeProgress",
"type" : "string"
},
"state" : {
"description" : "state of bladeProgress",
"type" : "string"
},
"progress" : {
"description" : "progress of bladeProgress",
"type" : "integer"
}
}
}
},
"previousOperationRecord" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"operation" : {
"description" : "operation of previousOperationRecord",
"enum" : [ "None", "Join", "Backup", "Restore", "Upload", "Upgrade", "BackupAndUpgrade", "RemoveBlade", "ChangeBladeIP", "DiskSnapshot", "UploadVDPFirmware" ]
},
"success" : {
"description" : "success of previousOperationRecord",
"type" : "boolean"
},
"errorMsg" : {
"description" : "errorMsg of previousOperationRecord",
"type" : "string"
}
},
"description" : "previousOperationRecord of clusterOperationProgress"
},
"clusterSubTaskState" : {
"description" : "clusterSubTaskState of clusterOperationProgress",
"enum" : [ "None", "Running", "Failed", "Completed" ]
},
"clusterOperationBlockUI" : {
"description" : "clusterOperationBlockUI of clusterOperationProgress",
"type" : "boolean"
},
"clusterOperationDisplayMsg" : {
"description" : "clusterOperationDisplayMsg of clusterOperationProgress",
"type" : "string"
}
},
"description" : "upgrade status"
}
}
}
Use this API command to retrive upload file Info
200
ShowHide{
"clusterOperationProgress" : {
"operation" : "None",
"overallProgress" : 0,
"isSelfBladeRebooting" : null,
"bladeProgresss" : [ {
"bladeUUID" : "386988fe-72fe-41e0-a373-7a73fea5d16e",
"hostName" : "neilscg200",
"iterationName" : "None",
"state" : "",
"progress" : 0
} ],
"previousOperationRecord" : {
"operation" : "Upload",
"success" : true,
"errorMsg" : null
},
"clusterSubTaskState" : "Completed",
"clusterOperationBlockUI" : false,
"clusterOperationDisplayMsg" : ""
},
"uploadPatchInfo" : {
"fileName" : "scg-installer_3.2.1.0.2.ximg",
"fileSize" : 893545600,
"fileUploadPath" : null,
"controlbladeVersion" : "3.2.1.0.4",
"allowVersions" : null,
"databladeVersion" : "3.2.1.0.6",
"apVersion" : "3.2.1.99.528",
"version" : "3.2.1.0.2"
}
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"clusterOperationProgress" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"operation" : {
"description" : "operation of clusterOperationProgress",
"enum" : [ "None", "Join", "Backup", "Restore", "Upload", "Upgrade", "BackupAndUpgrade", "RemoveBlade", "ChangeBladeIP", "DiskSnapshot", "UploadVDPFirmware" ]
},
"overallProgress" : {
"description" : "overallProgress of clusterOperationProgress",
"type" : "integer"
},
"isSelfBladeRebooting" : {
"description" : "isSelfBladeRebooting of clusterOperationProgress",
"type" : "boolean"
},
"bladeProgresss" : {
"description" : "bladeProgressMap of clusterOperationProgress",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"bladeUUID" : {
"description" : "bladeUUID of bladeProgress",
"type" : "string"
},
"hostName" : {
"description" : "hostName of bladeProgress",
"type" : "string"
},
"iterationName" : {
"description" : "iterationName of bladeProgress",
"type" : "string"
},
"state" : {
"description" : "state of bladeProgress",
"type" : "string"
},
"progress" : {
"description" : "progress of bladeProgress",
"type" : "integer"
}
}
}
},
"previousOperationRecord" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"operation" : {
"description" : "operation of previousOperationRecord",
"enum" : [ "None", "Join", "Backup", "Restore", "Upload", "Upgrade", "BackupAndUpgrade", "RemoveBlade", "ChangeBladeIP", "DiskSnapshot", "UploadVDPFirmware" ]
},
"success" : {
"description" : "success of previousOperationRecord",
"type" : "boolean"
},
"errorMsg" : {
"description" : "errorMsg of previousOperationRecord",
"type" : "string"
}
},
"description" : "previousOperationRecord of clusterOperationProgress"
},
"clusterSubTaskState" : {
"description" : "clusterSubTaskState of clusterOperationProgress",
"enum" : [ "None", "Running", "Failed", "Completed" ]
},
"clusterOperationBlockUI" : {
"description" : "clusterOperationBlockUI of clusterOperationProgress",
"type" : "boolean"
},
"clusterOperationDisplayMsg" : {
"description" : "clusterOperationDisplayMsg of clusterOperationProgress",
"type" : "string"
}
},
"description" : "upgrade status"
},
"uploadPatchInfo" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"fileName" : {
"description" : "fileName of uploadPatchInfo",
"type" : "string"
},
"fileSize" : {
"description" : "fileSize of uploadPatchInfo",
"type" : "number"
},
"fileUploadPath" : {
"description" : "fileUploadPath of uploadPatchInfo",
"type" : "string"
},
"controlbladeVersion" : {
"description" : "controlbladeVersion of uploadPatchInfo",
"type" : "string"
},
"databladeVersion" : {
"description" : "databladeVersion of uploadPatchInfo",
"type" : "string"
},
"apVersion" : {
"description" : "apVersion of uploadPatchInfo",
"type" : "string"
},
"version" : {
"description" : "version of uploadPatchInfo",
"type" : "string"
},
"allowVersions" : {
"description" : "allowVersions of uploadPatchInfo",
"type" : "array",
"items" : {
"type" : "string"
}
}
},
"description" : "upgrade patch info"
}
}
}
Use this API command to do system upgrade
200
ShowHide{
"clusterOperationProgress" : {
"operation" : "None",
"overallProgress" : 0,
"isSelfBladeRebooting" : null,
"bladeProgresss" : [ {
"bladeUUID" : "386988fe-72fe-41e0-a373-7a73fea5d16e",
"hostName" : "neilscg200",
"iterationName" : "None",
"state" : "",
"progress" : 0
} ],
"previousOperationRecord" : {
"operation" : "Upload",
"success" : true,
"errorMsg" : null
},
"clusterSubTaskState" : "Completed",
"clusterOperationBlockUI" : false,
"clusterOperationDisplayMsg" : ""
}
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"clusterOperationProgress" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"operation" : {
"description" : "operation of clusterOperationProgress",
"enum" : [ "None", "Join", "Backup", "Restore", "Upload", "Upgrade", "BackupAndUpgrade", "RemoveBlade", "ChangeBladeIP", "DiskSnapshot", "UploadVDPFirmware" ]
},
"overallProgress" : {
"description" : "overallProgress of clusterOperationProgress",
"type" : "integer"
},
"isSelfBladeRebooting" : {
"description" : "isSelfBladeRebooting of clusterOperationProgress",
"type" : "boolean"
},
"bladeProgresss" : {
"description" : "bladeProgressMap of clusterOperationProgress",
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"bladeUUID" : {
"description" : "bladeUUID of bladeProgress",
"type" : "string"
},
"hostName" : {
"description" : "hostName of bladeProgress",
"type" : "string"
},
"iterationName" : {
"description" : "iterationName of bladeProgress",
"type" : "string"
},
"state" : {
"description" : "state of bladeProgress",
"type" : "string"
},
"progress" : {
"description" : "progress of bladeProgress",
"type" : "integer"
}
}
}
},
"previousOperationRecord" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"operation" : {
"description" : "operation of previousOperationRecord",
"enum" : [ "None", "Join", "Backup", "Restore", "Upload", "Upgrade", "BackupAndUpgrade", "RemoveBlade", "ChangeBladeIP", "DiskSnapshot", "UploadVDPFirmware" ]
},
"success" : {
"description" : "success of previousOperationRecord",
"type" : "boolean"
},
"errorMsg" : {
"description" : "errorMsg of previousOperationRecord",
"type" : "string"
}
},
"description" : "previousOperationRecord of clusterOperationProgress"
},
"clusterSubTaskState" : {
"description" : "clusterSubTaskState of clusterOperationProgress",
"enum" : [ "None", "Running", "Failed", "Completed" ]
},
"clusterOperationBlockUI" : {
"description" : "clusterOperationBlockUI of clusterOperationProgress",
"type" : "boolean"
},
"clusterOperationDisplayMsg" : {
"description" : "clusterOperationDisplayMsg of clusterOperationProgress",
"type" : "string"
}
},
"description" : "upgrade status"
}
}
}
Use this API command to retrive upgrade history
number
(optional) The index of the first entry to be retrieved. Default: 0
number
(optional) The maximum number of entries to be retrieved. Default: 100
string
(optional) 200
ShowHide{
"totalCount" : 1,
"hasMore" : false,
"firstIndex" : 0,
"list" : [ {
"startTime" : "2015/10/15 02:48:38",
"version" : "3.2.1.0.1",
"cbVersion" : "3.2.1.0.20151014063356",
"dpVersion" : "3.2.1.0.20",
"apFwVersion" : "3.2.1.99.537",
"oldVersion" : "3.2.1.0.1",
"oldCbVersion" : "3.2.1.0.20151014063356",
"oldDpVersion" : "3.2.1.0.20",
"oldApFwVersion" : "3.2.1.99.537",
"fileName" : "Fresh Installation",
"elapsedSeconds" : 772
} ]
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"totalCount" : {
"type" : "integer"
},
"hasMore" : {
"type" : "boolean"
},
"firstIndex" : {
"type" : "integer"
},
"list" : {
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"startTime" : {
"description" : "startTime of the upgrade history",
"type" : "string"
},
"version" : {
"description" : "version of the upgrade history",
"type" : "string"
},
"cbVersion" : {
"description" : "cbVersion of the upgrade history",
"type" : "string"
},
"dpVersion" : {
"description" : "dpVersion of the upgrade history",
"type" : "string"
},
"apFwVersion" : {
"description" : "apFwVersion of the upgrade history",
"type" : "string"
},
"oldVersion" : {
"description" : "oldVersion of the upgrade history",
"type" : "string"
},
"oldCbVersion" : {
"description" : "oldCbVersion of the upgrade history",
"type" : "string"
},
"oldDpVersion" : {
"description" : "oldDpVersion of the upgrade history",
"type" : "string"
},
"oldApFwVersion" : {
"description" : "oldApFwVersion of the upgrade history",
"type" : "string"
},
"fileName" : {
"description" : "fileName of the upgrade history",
"type" : "string"
},
"elapsedSeconds" : {
"description" : "elapsedSeconds of the upgrade history",
"type" : "number"
}
}
}
}
}
}
Use this API command to retrieve a list of application log and status.
number
(optional) The index of the first entry to be retrieved. Default: 0
number
(optional) The maximum number of entries to be retrieved. Default: 100
200
ShowHide{
"totalCount" : 1,
"hasMore" : false,
"firstIndex" : 0,
"list" : [ {
"applicationName" : "API",
"healthStatus" : "Online",
"logLevel" : "WARN",
"numOfLogs" : 1,
"logFileNames" : [ "api.log" ]
} ]
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"totalCount" : {
"type" : "integer"
},
"hasMore" : {
"type" : "boolean"
},
"firstIndex" : {
"type" : "integer"
},
"list" : {
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"applicationName" : {
"description" : "Application name",
"type" : "string"
},
"healthStatus" : {
"description" : "Health status",
"type" : "string"
},
"logLevel" : {
"description" : "Log level",
"type" : "string"
},
"numOfLogs" : {
"description" : "# of Logs",
"type" : "integer"
},
"logFileNames" : {
"description" : "List of log file name",
"type" : "array",
"items" : {
"type" : "string"
}
}
}
}
}
}
}
Use this API command to retrieve a list of control plane.
200
ShowHide{
"totalCount" : 1,
"hasMore" : false,
"firstIndex" : 0,
"list" : [ {
"cpUUID" : "9db2975b-1af2-4153-b400-b7f094058b4f",
"cpName" : "R-KVM-200-C"
} ]
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"totalCount" : {
"type" : "integer"
},
"hasMore" : {
"type" : "boolean"
},
"firstIndex" : {
"type" : "integer"
},
"list" : {
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"cpUUID" : {
"description" : "Identifier of control plane",
"type" : "string"
},
"cpName" : {
"type" : "string",
"minLength" : 2,
"maxLength" : 32,
"pattern" : "^[!-~]([ -~]){0,30}[!-~]$",
"description" : "Name of control plane"
}
}
}
}
}
}
Use this API command to modify log level of specified application.
204
ShowHide{
"applicationName" : "API",
"logLevel" : "WARN"
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"applicationName" : {
"description" : "Application name.",
"type" : "string"
},
"logLevel" : {
"description" : "Log level.",
"enum" : [ "DEBUG", "INFO", "WARN", "ERROR" ]
}
}
}
Use this API command to download logs of the application.
string
(optional) Download all logs of the specified application name.
string
(optional) Download log of the specified log file name.
200
Use this API command to download snapshot logs.
200
Use this API command to retrieve Lwapp Config.
200
ShowHide{
"policy" : "DENY_ALL",
"pasvMaxPort" : null,
"pasvMinPort" : null,
"acl" : "null",
"apList" : [ ],
"natIpTranslation" : true
}
{
"type" : "object",
"additionalProperties" : false,
"properties" : {
"policy" : {
"description" : "policy of the lwapp",
"enum" : [ "DENY", "ACCEPT", "DENY_ALL", "ACCEPT_ALL" ]
},
"pasvMaxPort" : {
"description" : "pasvMaxPort of the lwapp",
"type" : "integer",
"minimum" : 16384,
"maximum" : 65000
},
"pasvMinPort" : {
"description" : "pasvMinPort of the lwapp",
"type" : "integer",
"minimum" : 16384,
"maximum" : 65000
},
"apList" : {
"description" : "accessPoint List of the lwapp",
"type" : "array",
"items" : {
"description" : "AP MAC Address or AP Serial Number",
"type" : "string"
}
},
"acl" : {
"description" : "acl of the lwapp",
"type" : "string"
},
"natIpTranslation" : {
"description" : "natIpTranslation of the lwapp",
"type" : "boolean"
}
}
}
Use this API command to modify the basic information of the Lwapp Config.
{
"policy" : "ACCEPT",
"pasvMaxPort" : 65000,
"pasvMinPort" : 16384,
"natIpTranslation" : true
}
{
"policy" : {
"description" : "policy of the lwapp",
"enum" : [ "DENY", "ACCEPT", "DENY_ALL", "ACCEPT_ALL" ]
},
"pasvMaxPort" : {
"description" : "pasvMaxPort of the lwapp",
"type" : "integer",
"minimum" : 16384,
"maximum" : 65000
},
"pasvMinPort" : {
"description" : "pasvMinPort of the lwapp",
"type" : "integer",
"minimum" : 16384,
"maximum" : 65000
},
"natIpTranslation" : {
"description" : "natIpTranslation of the lwapp",
"type" : "boolean"
}
}
204
Use this API command to modify the apList of the Lwapp Config.
[ "12345", "00:1D:2E:45:10:00" ]
{
"description" : "accessPoint List of the lwapp",
"type" : "array",
"items" : {
"description" : "AP MAC Address or AP Serial Number",
"type" : "string"
}
}
204
Generated by aglio on 05 Feb 2016