Virtual SmartZone (High Scale) Public API Reference Guide

Body

{
  "cpId": "DEV_BLADE_UUID",
  "domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
  "adminRoleId": "69962d35-9447-41a1-aff5-facf1e85c674",
  "mvnoId": "839f87c6-d116-497e-afce-aa8157abd30c",
  "adminId": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25",
  "clientIp": "172.18.193.1",
  "apiVersions": [
    "1_0"
  ],
  "timeZoneUtcOffset": 0
}

Schema

{
  "type": "object",
  "properties": {
    "cpId": {
      "type": "string"
    },
    "domainId": {
      "type": "string"
    },
    "adminRoleId": {
      "type": "string"
    },
    "mvnoId": {
      "type": "string"
    },
    "adminId": {
      "type": "string"
    },
    "clientIp": {
      "type": "string"
    },
    "apiVersions": {
      "description": "API version supported by the client",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "timeZoneUtcOffset": {
      "type": "integer"
    }
  }
}

Body

{
  "totalCount": 2,
  "hasMore": false,
  "firstIndex": 0,
  "list": [
    {
      "id": "zoneUUID",
      "name": "zoneName"
    },
    {
      "id": "zoneUUID2",
      "name": "zoneName2"
    }
  ]
}

Schema

{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "Identifier of the zone",
            "type": "string"
          },
          "name": {
            "description": "Name of the zone",
            "type": "string"
          },
          "serviceName": {
            "description": "Name of the zone",
            "type": "string"
          }
        }
      }
    }
  }
}

Body

{
  "id": "ad5ffab1-b3ed-4b36-b054-bc723a977dbb",
  "domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
  "name": "public-api-zone-ipv6",
  "description": null,
  "countryCode": "US",
  "version": "3.1.0.0.55",
  "timezone": {
    "systemTimezone": "UTC",
    "customizedTimezone": null
  },
  "ipMode": "IPV6",
  "login": {
    "apLoginName": "admin",
    "apLoginPassword": "admin!234"
  },
  "mesh": {
    "ssid": "meshSSID",
    "passphrase": "passphrase"
  },
  "dfsChannelEnabled": false,
  "cbandChannelEnabled": false,
  "cbandChannelLicenseEnabled": false,
  "wifi24": {
    "txPower": "Full",
    "channelWidth": 20,
    "channel": 0,
    "channelRange": [
      1,
      2,
      3,
      4,
      5,
      6,
      7,
      8,
      9,
      10,
      11
    ],
    "availableChannelRange": [
      1,
      2,
      3,
      4,
      5,
      6,
      7,
      8,
      9,
      10,
      11
    ]
  },
  "wifi50": {
    "txPower": "-1dB",
    "channelWidth": 40,
    "indoorChannel": 0,
    "outdoorChannel": 0,
    "indoorChannelRange": [
      36,
      40,
      44,
      48,
      149,
      153,
      157,
      161
    ],
    "outdoorChannelRange": [
      149,
      153,
      157,
      161
    ],
    "availableIndoorChannelRange": [
      36,
      40,
      44,
      48,
      149,
      153,
      157,
      161
    ],
    "availableOutdoorChannelRange": [
      149,
      153,
      157,
      161
    ]
  },
  "protectionMode24": "CTS_ONLY",
  "syslog": null,
  "smartMonitor": null,
  "clientAdmissionControl24": null,
  "clientAdmissionControl50": null,
  "channelModeEnabled": false,
  "tunnelType": "No_Tunneled",
  "tunnelProfile": null,
  "backgroundScanning24": null,
  "backgroundScanning50": null,
  "clientLoadBalancing24": null,
  "clientLoadBalancing50": null,
  "bandBalancing": null,
  "rogue": null,
  "dosBarringEnable": 0,
  "dosBarringPeriod": 60,
  "dosBarringThreshold": 5,
  "dosBarringCheckPeriod": 30,
  "locationBasedService": null,
  "apRebootTimeout": {
    "gatewayLossTimeoutInSec": 1800,
    "serverLossTimeoutInSec": 7200
  },
  "location": null,
  "locationAdditionalInfo": null,
  "latitude": null,
  "longitude": null,
  "vlanOverlappingEnabled": false,
  "nodeAffinityProfile": null,
  "venueProfile": null,
  "autoChannelSelection24": {
    "channelSelectMode": "ChannelFly",
    "channelFlyMtbc": 480
  },
  "autoChannelSelection50": {
    "channelSelectMode": "BackgroundScanning",
    "channelFlyMtbc": 480
  },
  "channelEvaluationInterval": 777,
  "apMgmtVlan": {
    "id": 1,
    "mode": "KEEP"
  },
  "ipsecProfile": {
    "id": "ipsecProfileId",
    "name": "ipsecProfileName"
  },
  "bonjourFencingPolicyEnabled": true,
  "bonjourFencingPolicy": {
    "id": "bonjourFencingPolicyId",
    "name": "bonjourFencingPolicyName"
  },
  "recoverySsid": {
    "recoverySsidEnabled": true
  },
  "dhcpSiteConfig": {
    "zoneName": "zoneK",
    "siteEnabled": true,
    "dwpdEnabled": false,
    "manualSelect": true,
    "siteMode": "EnableOnMultipleAPs",
    "siteAps": [
      {
        "apMac": "38:FF:36:00:0E:10",
        "apServerEnabled": true,
        "apServerPrimary": true
      },
      {
        "apMac": "58:FF:36:00:0E:20",
        "apServerEnabled": true,
        "apServerPrimary": true
      }
    ],
    "siteProfileIds": [
      "75e26590-547f-11e6-9ca7-5a095364c13c",
      "869bb532-547f-11e6-9ca7-5a095364c13c"
    ]
  },
  "snmpAgent": {
    "apSnmpEnabled": true,
    "snmpV2Agent": [
      {
        "communityName": "v2Agent",
        "notificationEnabled": true,
        "readEnabled": true,
        "writeEnabled": true,
        "notificationType": "TRAP",
        "notificationTarget": [
          {
            "address": "172.19.16.20",
            "port": 161
          }
        ]
      }
    ],
    "snmpV3Agent": [
      {
        "userName": "v3Agent",
        "authProtocol": "MD5",
        "authPassword": "admin!234",
        "privProtocol": "DES",
        "privPassword": "admin!234",
        "notificationEnabled": true,
        "readEnabled": true,
        "writeEnabled": true,
        "notificationType": "TRAP",
        "notificationTarget": [
          {
            "address": "172.19.16.20",
            "port": 161
          }
        ]
      }
    ]
  },
  "directedMulticastFromWiredClientEnabled": true,
  "directedMulticastFromWirelessClientEnabled": true,
  "directedMulticastFromNetworkEnabled": false,
  "rkusGreTunnelProfile": {
    "id": "f5b92938-aa4e-4d02-90ea-273799ff689b",
    "name": "Default Tunnel Profile"
  },
  "softGreTunnelProflies": [
    {
      "id": "5a2e41b0-df53-11e7-98e1-08002748d78e",
      "name": "softGre1",
      "aaaAffinityEnabled": true
    },
    {
      "id": "7803e411-df53-11e7-98e1-08002748d78e",
      "name": "softGre2",
      "aaaAffinityEnabled": true
    }
  ],
  "ipsecProfiles": [
    {
      "id": "3fd9aa91-df65-11e7-98e1-08002748d78e",
      "name": "ipsec1"
    }
  ],
  "sshTunnelEncryption": "AES128"
}

Schema

{
    "additionalProperties" : false,
    "properties" : {
        "altitude" : {
            "description" : "GPS Altitude",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "altitudeUnit" : {
                    "description" : "altitude unit",
                    "enum" : [ "meters", "floor" ]
                },
                "altitudeValue" : {
                    "description" : "altitude value",
                    "type" : "integer"
                }
            }
        },
        "apMgmtVlan" : {
            "description" : "ap Management Vlan of the zone",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "mode" : {
                    "description" : "Vlan Mode of the zone",
                    "enum" : [ "KEEP", "USER_DEFINED" ]
                },
                "id" : {
                    "description" : "Vlan id of the zone",
                    "type" : "integer"
                }
            }
        },
        "apLatencyInterval" : {
            "description" : "$64",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "pingEnabled" : {
                    "description" : "AP ping latency enabled",
                    "type" : "boolean"
                }
            }
        },
        "apRebootTimeout" : {
            "description" : "AP reboot timeout of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "gatewayLossTimeoutInSec" : {
                    "description" : "Gateway loss timeout in second",
                    "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 ]
                }
            }
        },
        "autoChannelSelection24" : {
            "description" : "client load balancing on Radio 2.4G, auto channel selection mode",
            "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
                }
            }
        },
        "autoChannelSelection50" : {
            "description" : "client load balancing on Radio 5G, auto channel selection mode",
            "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
                }
            }
        },
        "awsVenue" : {
            "description" : "venue code",
            "type" : "string"
        },
        "backgroundScanning24" : {
            "description" : "Background scanning on 2.4GHz radio configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "frequencyInSec" : {
                    "description" : "Frequency in second",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 65535
                }
            }
        },
        "backgroundScanning50" : {
            "description" : "Background scanning on 5GHz radio configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "frequencyInSec" : {
                    "description" : "Frequency in second",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 65535
                }
            }
        },
        "bandBalancing" : {
            "description" : "Band balancing configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "mode" : {
                    "description" : "Band Balancing Mode: BASIC-Withholds probe and authentication responses at connetcion time in heavily loaded band to balance clients to the other band, PROACTIVE-Uses BASIC functionality and actively rebalances clients via 802.11v BTM, STRICT-Uses PROACTIVE functionality and forcefully rebalances clients via 802.11v BTM",
                    "enum" : [ "BASIC", "PROACTIVE", "STRICT" ]
                },
                "wifi24Percentage" : {
                    "description" : "Percentage of client load on 2.4GHz radio band",
                    "type" : "integer",
                    "minimum" : 0,
                    "maximum" : 100
                }
            }
        },
        "bonjourFencingPolicy" : {
            "description" : "Bonjour Fencing Policy on the AP",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "bonjourFencingPolicyEnabled" : {
            "description" : "Enable Bonjour Fencing Policy on the AP",
            "type" : "boolean"
        },
        "channelEvaluationInterval" : {
            "default" : 600,
            "description" : "channel evaluation Interval of the zone",
            "maximum" : 3600,
            "minimum" : 60,
            "type" : "integer"
        },
        "channelModeEnabled" : {
            "description" : "Channel mode configuration of the zone.",
            "type" : "boolean"
        },
        "clientAdmissionControl24" : {
            "description" : "AP client admission control 2.4GHz radio configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "maxRadioLoadPercent" : {
                    "description" : "Maximum radio load percentage.",
                    "type" : "integer",
                    "default" : 75,
                    "minimum" : 50,
                    "maximum" : 100
                },
                "minClientCount" : {
                    "description" : "Minimum client count number.",
                    "type" : "integer",
                    "default" : 10,
                    "minimum" : 0,
                    "maximum" : 100
                },
                "minClientThroughputMbps" : {
                    "description" : "Minimum client throughput in Mbps.",
                    "type" : "number",
                    "default" : 0,
                    "minimum" : 0,
                    "maximum" : 100
                }
            }
        },
        "clientAdmissionControl50" : {
            "description" : "AP client admission control 5GHz radio configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "maxRadioLoadPercent" : {
                    "description" : "Maximum radio load percentage.",
                    "type" : "integer",
                    "default" : 75,
                    "minimum" : 50,
                    "maximum" : 100
                },
                "minClientCount" : {
                    "description" : "Minimum client count number.",
                    "type" : "integer",
                    "default" : 10,
                    "minimum" : 0,
                    "maximum" : 100
                },
                "minClientThroughputMbps" : {
                    "description" : "Minimum client throughput in Mbps.",
                    "type" : "number",
                    "default" : 0,
                    "minimum" : 0,
                    "maximum" : 100
                }
            }
        },
        "clientLoadBalancing24" : {
            "description" : "Client load balancing on 2.4GHz radio configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "adjacentRadioThreshold" : {
                    "description" : "Adjacent radio threshold",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 100
                }
            }
        },
        "clientLoadBalancing50" : {
            "description" : "Client load balancing on 5GHz radio configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "adjacentRadioThreshold" : {
                    "description" : "Adjacent radio threshold",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 100
                }
            }
        },
        "countryCode" : {
            "description" : "Country code of the zone",
            "type" : "string"
        },
        "description" : {
            "description" : "Description of the zone",
            "type" : [ "string", "null" ],
            "maxLength" : 64
        },
        "dfsChannelEnabled" : {
            "description" : "DFS Channel enabled configuration of the zone, only for the US country code .",
            "type" : "boolean"
        },
        "cbandChannelEnabled" : {
            "description" : "5.8Ghz channels enabled configuration of the zone.",
            "type" : "boolean"
        },
        "cbandChannelLicenseEnabled" : {
            "description" : "5.8Ghz channels license enabled configuration of the zone.",
            "type" : "boolean"
        },
        "dhcpSiteConfig" : {
            "description" : "DHCP Site Config in Zone",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "siteEnabled" : {
                    "description" : "DHCP Service Enabling Status",
                    "type" : "boolean"
                },
                "dwpdEnabled" : {
                    "description" : "DHCP Service Dynamic WAN Port Detection",
                    "type" : "boolean"
                },
                "manualSelect" : {
                    "description" : "DHCP Service AP Selection Mode. This value is effective when the siteMode is EnableOnMultipleAPs.",
                    "type" : "boolean"
                },
                "siteMode" : {
                    "description" : "DHCP Service mode",
                    "enum" : [ "EnableOnEachAPs", "EnableOnMultipleAPs", "EnableOnHierarchicalAPs" ]
                },
                "eth0ProfileId" : {
                    "description" : "$215",
                    "type" : "integer"
                },
                "eth1ProfileId" : {
                    "description" : "$216",
                    "type" : "integer"
                },
                "siteAps" : {
                    "type" : "array",
                    "items" : {
                        "type" : "object",
                        "description" : "DHCP Site selected APs. The content is effective when the siteMode is EnableOnMultipleAPs.",
                        "additionalProperties" : false,
                        "properties" : {
                            "apMac" : {
                                "type" : "string"
                            },
                            "apName" : {
                                "type" : "string"
                            },
                            "apStatus" : {
                                "enum" : [ "Online", "Offline", "Flagged" ]
                            },
                            "apServerEnabled" : {
                                "type" : "boolean"
                            },
                            "apServerPrimary" : {
                                "type" : "boolean"
                            },
                            "apServerIp" : {
                                "type" : [ "string", "null" ]
                            },
                            "apGatewayIp" : {
                                "type" : "string"
                            }
                        }
                    }
                },
                "siteProfileIds" : {
                    "type" : "array",
                    "items" : {
                        "type" : "string"
                    }
                }
            }
        },
        "domainId" : {
            "description" : "Identifier of the management domain to which the zone belongs",
            "type" : "string"
        },
        "dosBarringCheckPeriod" : {
            "description" : "DoS Protection(Barring UE) check period of the zone.",
            "type" : "integer"
        },
        "dosBarringEnable" : {
            "description" : "Enable DoS Protection(Barring UE) of the zone.",
            "type" : "integer"
        },
        "dosBarringPeriod" : {
            "description" : "DoS Protection(Barring UE) blocking period of the zone.",
            "type" : "integer"
        },
        "dosBarringThreshold" : {
            "description" : "DoS Protection(Barring UE) threshold of the zone.",
            "type" : "integer"
        },
        "id" : {
            "description" : "Identifier of the zone",
            "type" : "string"
        },
        "ipMode" : {
            "description" : "IP mode of the zone",
            "enum" : [ "IPV4", "IPV6", "IPV4_IPV6" ]
        },
        "ipsecProfile" : {
            "description" : "ipsec profile configuration of the Zone.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "ipv6TrafficFilterEnabled" : {
            "description" : "IPv6 Traffic filtering on the AP",
            "type" : "integer"
        },
        "latitude" : {
            "description" : "Latitude coordinate (in decimal format) of the zone",
            "type" : "number"
        },
        "location" : {
            "description" : "Location of the Zone.",
            "type" : "string"
        },
        "locationAdditionalInfo" : {
            "description" : "Location additional info of the zone.",
            "type" : "string",
            "pattern" : "^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
        },
        "locationBasedService" : {
            "description" : "Location based service configuration of the zone.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "login" : {
            "description" : "AP administrator account",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "apLoginName" : {
                    "description" : "User name of the AP administrator",
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : "^((?!\$\()[!-_a-~]){1,64}$"
                },
                "apLoginPassword" : {
                    "description" : "Password of the AP administrator",
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : ".*(?=.{8,})(?=.*[a-zA-Z])(?=.*[0-9])(?=.*[_`[email protected]#$%^&*\(\)\[\]\{\}|;:'\",.\<>\/?=+-]).*"
                }
            },
            "required" : [ "apLoginName", "apLoginPassword" ]
        },
        "longitude" : {
            "description" : "Longitude coordinate (in decimal format) of the zone",
            "type" : "number"
        },
        "mesh" : {
            "description" : "Mesh configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "ssid" : {
                    "description" : "SSID of the mesh network",
                    "type" : "string"
                },
                "passphrase" : {
                    "description" : "Passphrase for the mesh network",
                    "type" : "string"
                },
                "meshRadioIdx" : {
                    "description" : "Mesh radio index",
                    "enum" : [ "Radio24G", "Radio5G" ],
                    "default" : "Radio5G"
                },
                "zeroTouchStatus" : {
                    "description" : "$197",
                    "type" : "boolean"
                }
            }
        },
        "name" : {
            "description" : "Name of the zone",
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 32,
            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$"
        },
        "nodeAffinityProfile" : {
            "description" : "Node affinity profile of the zone.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "rogue" : {
            "description" : "Rogue AP detection configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "reportType" : {
                    "description" : "Report type",
                    "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"
                }
            }
        },
        "smartMonitor" : {
            "description" : "Smart monitor configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "intervalInSec" : {
                    "description" : "Interval in seconds. This is required if smartMonitor is enabled",
                    "type" : "integer",
                    "default" : 10,
                    "minimum" : 5,
                    "maximum" : 60
                },
                "retryThreshold" : {
                    "description" : "Retry threshold. This is required if smartMonitor is enabled",
                    "type" : "integer",
                    "default" : 3,
                    "minimum" : 1,
                    "maximum" : 10
                }
            }
        },
        "syslog" : {
            "description" : "Syslog configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "flowLevel" : {
                    "description" : "Flow Level of the syslog",
                    "enum" : [ "GENERAL_LOGS", "CLIENT_FLOW", "ALL" ],
                    "default" : "GENERAL_LOGS"
                },
                "address" : {
                    "description" : "Address of the syslog server.",
                    "type" : "string"
                },
                "port" : {
                    "description" : "Port number of the syslog server",
                    "type" : "integer",
                    "default" : 514,
                    "minimum" : 1,
                    "maximum" : 65535
                },
                "protocol" : {
                    "description" : "Protocol of the syslog server",
                    "enum" : [ "IPPROTO_TCP", "IPPROTO_UDP" ],
                    "default" : "IPPROTO_TCP"
                },
                "secondaryAddress" : {
                    "description" : "Secondary Server Address of the syslog server",
                    "type" : "string"
                },
                "secondaryPort" : {
                    "description" : "Secondary Server Port of the syslog server",
                    "type" : "integer",
                    "default" : 514,
                    "minimum" : 1,
                    "maximum" : 65535
                },
                "secondaryProtocol" : {
                    "description" : "Secondary Server Protocol of the syslog server",
                    "enum" : [ "IPPROTO_TCP", "IPPROTO_UDP" ],
                    "default" : "IPPROTO_TCP"
                },
                "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"
                }
            }
        },
        "timezone" : {
            "description" : "Either systemTimezone or customizedTimezone must be specified",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "systemTimezone" : {
                    "description" : "System defined time zone, please refer to the “Overview > Time Zone” list",
                    "type" : "string"
                },
                "customizedTimezone" : {
                    "description" : "User defined time zone",
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "abbreviation" : {
                            "description" : "Time zone abbreviation",
                            "type" : "string",
                            "pattern" : "^[a-zA-Z]{3,4}$"
                        },
                        "gmtOffset" : {
                            "description" : "GMT offset",
                            "type" : "integer",
                            "minimum" : -11,
                            "maximum" : 14
                        },
                        "gmtOffsetMinute" : {
                            "description" : "GMT offset minute",
                            "type" : "integer",
                            "minimum" : 0,
                            "maximum" : 59
                        },
                        "start" : {
                            "description" : "Daylight saving time start",
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "month" : {
                                    "description" : "Month when daylight saving time begins",
                                    "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" ]
                        },
                        "end" : {
                            "description" : "Daylight saving time 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" ]
                        }
                    },
                    "required" : [ "abbreviation", "gmtOffset", "gmtOffsetMinute" ]
                }
            }
        },
        "tunnelProfile" : {
            "description" : "Tunnel type configuration of the zone.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "aaaAffinityEnabled" : {
            "description" : "$109",
            "type" : "boolean"
        },
        "tunnelType" : {
            "description" : "Tunnel type configuration of the zone. No_Tunneled is for IPv6 mode",
            "enum" : [ "No_Tunneled", "RuckusGRE", "SoftGRE", "SoftGREIpsec" ]
        },
        "venueProfile" : {
            "description" : "venue profile configuration of the Zone.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "version" : {
            "description" : "AP firmware version of the zone",
            "type" : "string",
            "pattern" : "^\d+\.\d+\.\d+\.\d+\.\d+$"
        },
        "vlanOverlappingEnabled" : {
            "description" : "VLAN pooling overlapping of the zone",
            "type" : "boolean"
        },
        "wifi24" : {
            "description" : "AP 2.4GHz radio configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "autoCellSizing" : {
                    "description" : "$2",
                    "type" : "boolean"
                },
                "txPower" : {
                    "description" : "Transmission power",
                    "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ]
                },
                "channelWidth" : {
                    "description" : "Channel width. Zero (0) means Auto.",
                    "enum" : [ 0, 20, 40 ]
                },
                "channel" : {
                    "description" : "Channel number",
                    "type" : "integer"
                },
                "channelRange" : {
                    "description" : "Channel range options",
                    "type" : "array",
                    "items" : {
                        "type" : "integer"
                    }
                },
                "availableChannelRange" : {
                    "description" : "Available channel range options",
                    "type" : "array",
                    "items" : {
                        "type" : "integer"
                    }
                }
            }
        },
        "wifi50" : {
            "description" : "AP 5GHz radio configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "autoCellSizing" : {
                    "description" : "$13",
                    "type" : "boolean"
                },
                "txPower" : {
                    "description" : "Transmission power",
                    "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ]
                },
                "channelWidth" : {
                    "description" : "Channel width. Zero (0) means Auto. 8080 means 80+80MHz",
                    "enum" : [ 0, 20, 40, 80, 8080, 160 ]
                },
                "indoorChannel" : {
                    "description" : "Channel number for Indoor AP",
                    "type" : "integer"
                },
                "outdoorChannel" : {
                    "description" : "Channel number for Outdoor AP",
                    "type" : "integer"
                },
                "indoorSecondaryChannel" : {
                    "description" : "Secondary channel number for Indoor AP (channelWidth is 80+80MHz only)",
                    "type" : "integer"
                },
                "outdoorSecondaryChannel" : {
                    "description" : "Secondary channel number for outdoor AP (channelWidth is 80+80MHz only)",
                    "type" : "integer"
                },
                "indoorChannelRange" : {
                    "description" : "Channel range options for Indoor AP",
                    "type" : "array",
                    "items" : {
                        "type" : "integer"
                    }
                },
                "outdoorChannelRange" : {
                    "description" : "Channel range options for outdoor AP",
                    "type" : "array",
                    "items" : {
                        "type" : "integer"
                    }
                },
                "availableIndoorChannelRange" : {
                    "description" : "Available channel range options",
                    "type" : "array",
                    "items" : {
                        "type" : "integer"
                    }
                },
                "availableOutdoorChannelRange" : {
                    "description" : "Available channel range options",
                    "type" : "array",
                    "items" : {
                        "type" : "integer"
                    }
                }
            }
        },
        "protectionMode24" : {
            "description" : "$115",
            "enum" : [ "NONE", "CTS_ONLY", "RTS_CTS" ],
            "default" : "RTS_CTS"
        },
        "zoneAffinityProfileId" : {
            "description" : "zone affinity profile Id",
            "type" : "string"
        },
        "snmpAgent" : {
            "description" : "AP SNMP Options",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "apSnmpEnabled" : {
                    "description" : "Enable AP SNMP",
                    "type" : "boolean"
                },
                "snmpV2Agent" : {
                    "description" : "Community List of the SNMP V2 Agent.",
                    "type" : "array",
                    "items" : {
                        "type" : "object",
                        "additionalProperties" : false,
                        "properties" : {
                            "communityName" : {
                                "description" : "name of the SNMP Community.",
                                "type" : "string"
                            },
                            "readEnabled" : {
                                "description" : "read privilege of the SNMP Coummunity",
                                "type" : "boolean"
                            },
                            "writeEnabled" : {
                                "description" : "write privilege of the SNMP Coummunity",
                                "type" : "boolean"
                            },
                            "notificationEnabled" : {
                                "description" : "notification privilege of the SNMP Coummunity",
                                "type" : "boolean"
                            },
                            "notificationType" : {
                                "description" : "type of the notification privilege",
                                "enum" : [ "TRAP", "INFORM" ]
                            },
                            "notificationTarget" : {
                                "description" : "Trap List of the SNMP Coummunity",
                                "type" : "array",
                                "items" : {
                                    "type" : "object",
                                    "additionalProperties" : false,
                                    "properties" : {
                                        "address" : {
                                            "description" : "address of the SNMP Trap",
                                            "type" : "string"
                                        },
                                        "port" : {
                                            "description" : "port number of the SNMP Trap",
                                            "type" : "integer",
                                            "minimum" : 1,
                                            "maximum" : 65535
                                        }
                                    },
                                    "required" : [ "address", "port" ]
                                }
                            }
                        },
                        "required" : [ "communityName" ]
                    }
                },
                "snmpV3Agent" : {
                    "description" : "User List of the SNMP V3 Agent.",
                    "type" : "array",
                    "items" : {
                        "type" : "object",
                        "additionalProperties" : false,
                        "properties" : {
                            "userName" : {
                                "description" : "name of the SNMP User.",
                                "type" : "string"
                            },
                            "authProtocol" : {
                                "description" : "authProtocol of the SNMP User.",
                                "enum" : [ "NONE", "MD5", "SHA" ]
                            },
                            "authPassword" : {
                                "description" : "authPassword of the SNMP User.",
                                "type" : "string",
                                "minLength" : 8
                            },
                            "privProtocol" : {
                                "description" : "privProtocol of the SNMP User.",
                                "enum" : [ "NONE", "DES", "AES" ]
                            },
                            "privPassword" : {
                                "description" : "privPassword of the SNMP User.",
                                "type" : "string",
                                "minLength" : 8
                            },
                            "readEnabled" : {
                                "description" : "read privilege of the SNMP User",
                                "type" : "boolean"
                            },
                            "writeEnabled" : {
                                "description" : "write privilege of the SNMP User",
                                "type" : "boolean"
                            },
                            "notificationEnabled" : {
                                "description" : "notification privilege of the SNMP User",
                                "type" : "boolean"
                            },
                            "notificationType" : {
                                "description" : "type of the notification privilege",
                                "enum" : [ "TRAP", "INFORM" ]
                            },
                            "notificationTarget" : {
                                "description" : "Trap List of the SNMP User",
                                "type" : "array",
                                "items" : {
                                    "type" : "object",
                                    "additionalProperties" : false,
                                    "properties" : {
                                        "address" : {
                                            "description" : "address of the SNMP Trap",
                                            "type" : "string"
                                        },
                                        "port" : {
                                            "description" : "port number of the SNMP Trap",
                                            "type" : "integer",
                                            "minimum" : 1,
                                            "maximum" : 65535
                                        }
                                    },
                                    "required" : [ "address", "port" ]
                                }
                            }
                        },
                        "required" : [ "userName" ]
                    }
                }
            }
        },
        "recoverySsid" : {
            "description" : "Recovery SSID",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "recoverySsidEnabled" : {
                    "description" : "recovery ssid enable/disable",
                    "type" : "boolean"
                }
            }
        },
        "clusterRedundancyEnabled" : {
            "description" : "Enable Cluster redundancy on zone",
            "type" : "boolean"
        },
        "directedMulticastFromWiredClientEnabled" : {
            "description" : "Directed multicast from wired client.",
            "type" : "boolean"
        },
        "directedMulticastFromWirelessClientEnabled" : {
            "description" : "Directed multicast from wireless client.",
            "type" : "boolean"
        },
        "directedMulticastFromNetworkEnabled" : {
            "description" : "Directed multicast from network.",
            "type" : "boolean"
        },
        "ruckusGreTunnelProfile" : {
            "description" : "Ruckus GRE Profile for Multiple Tunnel (Start from SZ 5.0)",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "softGreTunnelProflies" : {
            "description" : "SoftGRE Profiles for Multiple Tunnel (Start from SZ 5.0)",
            "type" : "array",
            "items" : {
                "type" : [ "object", "null" ],
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "type" : "string"
                    },
                    "name" : {
                        "type" : "string"
                    },
                    "aaaAffinityEnabled" : {
                        "type" : "boolean"
                    }
                }
            }
        },
        "ipsecProfiles" : {
            "description" : "Ipsec profile for Multiple Tunnel (Start from SZ 5.0)",
            "type" : "array",
            "items" : {
                "type" : [ "object", "null" ],
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "type" : "string"
                    },
                    "name" : {
                        "type" : "string"
                    }
                }
            }
        },
        "sshTunnelEncryption" : {
            "description" : "$126",
            "enum" : [ "AES128", "AES256" ]
        }
    },
    "type" : "object"
}

Schema

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