Virtual SmartZone - Essentials Public API Reference Guide

Body

{
  "apiSupportVersions": [
    "v6_0",
    "v6_1",
    "v7_0",
    "v8_0",
    "v8_1",
    "v8_2",
    "v9_0",
    "v9_1"
  ]
}

Schema

{
  "type": "object",
  "properties": {
    "apiSupportVersions": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}

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": [
    {
      "authType": "PUBLIC_API",
      "lastAccessTime": 1536290141430,
      "lastAccessURI": "/v8_0/sessionManagement",
      "sessionId": "5C2450F464951DD70FDA73D68824A547",
      "sourceIp": "127.0.0.1",
      "userName": "admin",
      "userUUID": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25"
    },
    {
      "authType": "PUBLIC_API",
      "lastAccessTime": 1536290095781,
      "lastAccessURI": null,
      "sessionId": "6991866A7F5689C859D09B33C31A262A",
      "sourceIp": "127.0.0.1",
      "userName": "admin",
      "userUUID": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25"
    }
  ]
}

Schema

{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "lastAccessTime": {
            "type": "string",
            "description": "The last access time"
          },
          "lastAccessURI": {
            "type": "string",
            "description": "The last access URI"
          },
          "userUUID": {
            "type": "string",
            "description": "The user UUID"
          },
          "userName": {
            "type": "string",
            "description": "Logon user name"
          },
          "sessionId": {
            "type": "string",
            "description": "The user session ID"
          },
          "sourceIp": {
            "type": "string",
            "description": "The source IP address"
          },
          "authType": {
            "type": "string",
            "description": "The authentication type of logon"
          }
        }
      }
    }
  }
}

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

Schema

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

Body

{
  "ledStatusEnabled": true,
  "lacp": {
    "keepApSetting": false,
    "enabled": true
  },
  "lldp": {
    "enabled": true,
    "advertiseIntervalInSec": 30,
    "holdTimeInSec": 120,
    "managementIPTLVEnabled": false
  },
  "cellularSettings": {
    "mobileAPName": "internet",
    "mobileAPName2": "internet",
    "simCardUsage": 0,
    "select3g4g": 0,
    "select3g4g2": 0,
    "dataRoaming": 1,
    "dataRoaming2": 1,
    "wanConnection": 0,
    "wanRecoveryTimer": 60
  },
  "ledMode": null,
  "internalHeaterEnabled": null,
  "poeOutPortEnabled": null,
  "usbPowerEnable": true,
  "poeModeSetting": "Auto",
  "poeTxChain": 2,
  "radioBand": null,
  "externalAntenna24": null,
  "externalAntenna50": null,
  "lanPorts": [
    {
      "portName": "LAN1",
      "enabled": false,
      "ethPortProfile": null
    },
    {
      "portName": "LAN2",
      "enabled": true,
      "ethPortProfile": {
        "id": "0",
        "name": "Default Trunk Port"
      }
    },
    {
      "portName": "LAN3",
      "enabled": true,
      "ethPortProfile": {
        "id": "1",
        "name": "Default Access Port"
      }
    }
  ]
}

Schema

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

Body

{
  "nonEditablePorts": [
    2
  ],
  "isAllowDisableExtAnt": null,
  "nonVisiblePorts": [
    2
  ],
  "hasScanRadio": null,
  "hasCablemodem": true,
  "hasGps": false,
  "isDualRadio": true,
  "isOutdoor": false,
  "maxChannelization24G": 40,
  "maxChannelization5G": 80,
  "maxClientsUpper": 256,
  "maxWlanNum24G": 15,
  "maxWlanNum5G": 16,
  "noAvc": false,
  "noMesh": false,
  "meshRadioCaps": "1,2",
  "reserved5GWlanForMesh": 3,
  "support11AC": true,
  "supportChannelization160": null,
  "supportAPUsbSoftwarePackage": null,
  "supportBandSwitch": false,
  "supportBonjour": true,
  "supportIpsec": false,
  "supportLBS": true,
  "supportResetCablemodem": true,
  "allowDfsCountry": "US",
  "ram": 512,
  "numOfCores": 4,
  "cpuFrequency": 600,
  "scalingFactor": 1,
  "capabilityScore": 75
}

Schema

{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "nonEditablePorts": {
      "type": "array",
      "items": {
        "type": "integer"
      }
    },
    "isAllowDisableExtAnt": {
      "type": [
        "boolean",
        "null"
      ]
    },
    "nonVisiblePorts": {
      "type": "array",
      "items": {
        "type": "integer"
      }
    },
    "hasScanRadio": {
      "type": [
        "boolean",
        "null"
      ]
    },
    "hasCablemodem": {
      "type": [
        "boolean",
        "null"
      ]
    },
    "hasGps": {
      "type": [
        "boolean",
        "null"
      ]
    },
    "isDualRadio": {
      "type": [
        "boolean",
        "null"
      ]
    },
    "isOutdoor": {
      "type": [
        "boolean",
        "null"
      ]
    },
    "maxChannelization24G": {
      "type": "integer"
    },
    "maxChannelization5G": {
      "type": "integer"
    },
    "maxClientsUpper": {
      "type": "integer"
    },
    "maxWlanNum24G": {
      "type": "integer"
    },
    "maxWlanNum5G": {
      "type": "integer"
    },
    "noAvc": {
      "type": [
        "boolean",
        "null"
      ]
    },
    "noMesh": {
      "type": [
        "boolean",
        "null"
      ]
    },
    "meshRadioCaps": {
      "type": "string"
    },
    "reserved5GWlanForMesh": {
      "type": "integer"
    },
    "support11AC": {
      "type": [
        "boolean",
        "null"
      ]
    },
    "supportChannelization160": {
      "type": [
        "boolean",
        "null"
      ]
    },
    "supportAPUsbSoftwarePackage": {
      "type": [
        "boolean",
        "null"
      ]
    },
    "supportBandSwitch": {
      "type": [
        "boolean",
        "null"
      ]
    },
    "supportBonjour": {
      "type": [
        "boolean",
        "null"
      ]
    },
    "supportIpsec": {
      "type": [
        "boolean",
        "null"
      ]
    },
    "supportLBS": {
      "type": [
        "boolean",
        "null"
      ]
    },
    "supportResetCablemodem": {
      "type": [
        "boolean",
        "null"
      ]
    },
    "allowDfsCountry": {
      "type": "string"
    },
    "ram": {
      "type": "integer"
    },
    "numOfCores": {
      "type": "integer"
    },
    "cpuFrequency": {
      "type": "integer"
    },
    "scalingFactor": {
      "type": "integer"
    },
    "capabilityScore": {
      "type": "integer",
      "format": "int64"
    },
    "poeModeCaps": {
      "type": "string"
    }
  }
}

Body

[
  {
    "firmwareVersion": "3.4.0.101.492",
    "unsupportedApModelSummary": [
      {
        "model": "R300",
        "amount": 1
      }
    ],
    "supported": false
  },
  {
    "firmwareVersion": "3.4.0.101.505",
    "unsupportedApModelSummary": [],
    "supported": true
  }
]

Schema

{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "firstIndex": {
      "type": "integer"
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "firmwareVersion": {
            "description": "version of the AP firmare",
            "type": "string"
          },
          "unsupportedApModelSummary": {
            "description": "summary of the AP Model is unsupported for AP firmware version.",
            "type": "array",
            "items": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "model": {
                  "description": "name of the AP Model",
                  "type": "string"
                },
                "amount": {
                  "description": "amount of the AP Model",
                  "type": "integer"
                }
              }
            }
          },
          "supported": {
            "description": "version of the AP firmare is supported for Upgrade or Downgrade.",
            "type": "boolean"
          }
        }
      }
    }
  }
}

Schema

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

Schema

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

Body

{
  "id": "ad5ffab1-b3ed-4b36-b054-bc723a977dbb",
  "domainId": "8b2081d5-9662-40d9-a3db-2a3cf4dde3f7",
  "name": "public-api-zone-ipv6",
  "description": null,
  "countryCode": "US",
  "version": "3.1.0.0.55",
  "timezone": {
    "systemTimezone": "UTC",
    "customizedTimezone": null
  },
  "ipMode": "IPV6",
  "login": {
    "apLoginName": "admin",
    "apLoginPassword": "admin!234"
  },
  "mesh": null,
  "dfsChannelEnabled": false,
  "cbandChannelEnabled": false,
  "cbandChannelLicenseEnabled": false,
  "channel144Enabled": false,
  "wifi24": {
    "txPower": "Full",
    "channelWidth": 20,
    "channel": 0,
    "channelRange": [
      1,
      2,
      3,
      4,
      5,
      6,
      7,
      8,
      9,
      10,
      11
    ],
    "availableChannelRange": [
      1,
      2,
      3,
      4,
      5,
      6,
      7,
      8,
      9,
      10,
      11
    ]
  },
  "wifi50": {
    "txPower": "-1dB",
    "channelWidth": 40,
    "indoorChannel": 0,
    "outdoorChannel": 0,
    "indoorChannelRange": [
      36,
      40,
      44,
      48,
      149,
      153,
      157,
      161
    ],
    "outdoorChannelRange": [
      149,
      153,
      157,
      161
    ],
    "availableIndoorChannelRange": [
      36,
      40,
      44,
      48,
      149,
      153,
      157,
      161
    ],
    "availableOutdoorChannelRange": [
      149,
      153,
      157,
      161
    ]
  },
  "protectionMode24": "CTS_ONLY",
  "syslog": null,
  "smartMonitor": null,
  "clientAdmissionControl24": null,
  "clientAdmissionControl50": null,
  "channelModeEnabled": false,
  "tunnelType": "SoftGREIpsec",
  "tunnelProfile": {
    "id": "tunnelProfileId",
    "name": "tunnelProfileName"
  },
  "backgroundScanning24": null,
  "backgroundScanning50": null,
  "loadBalancing": {
    "loadBalancingMethod": "BASED_ON_CLIENT_COUNT",
    "clientLoadBalancing24": {
      "adjacentRadioThreshold": 12
    },
    "clientLoadBalancing50": {
      "adjacentRadioThreshold": 12
    },
    "bandBalancing": {
      "wifi24Percentage": 10
    },
    "steeringMode": "BASIC"
  },
  "rogue": null,
  "locationBasedService": null,
  "apRebootTimeout": {
    "gatewayLossTimeoutInSec": 1800,
    "serverLossTimeoutInSec": 7200
  },
  "location": null,
  "locationAdditionalInfo": null,
  "latitude": null,
  "longitude": null,
  "vlanOverlappingEnabled": false,
  "nodeAffinityProfile": null,
  "venueProfile": null,
  "autoChannelSelection24": {
    "channelSelectMode": "ChannelFly",
    "channelFlyMtbc": 480
  },
  "autoChannelSelection50": {
    "channelSelectMode": "BackgroundScanning",
    "channelFlyMtbc": 480
  },
  "channelEvaluationInterval": 777,
  "apMgmtVlan": {
    "id": 1,
    "mode": "KEEP"
  },
  "ipsecProfile": {
    "id": "ipsecProfileId",
    "name": "ipsecProfileName"
  },
  "autoPurgeExpiredDpsk": "OneDay",
  "altitude": {
    "altitudeUnit": "meters",
    "altitudeValue": 1
  },
  "bonjourFencingPolicyEnabled": true,
  "bonjourFencingPolicy": {
    "id": "bonjourFencingPolicyId",
    "name": "bonjourFencingPolicyName"
  },
  "recoverySsid": {
    "recoverySsidEnabled": true
  },
  "dhcpSiteConfig": {
    "zoneName": "zoneK",
    "siteEnabled": true,
    "dwpdEnabled": false,
    "manualSelect": true,
    "siteMode": "EnableOnMultipleAPs",
    "siteAps": [
      {
        "apMac": "38:FF:36:00:0E:10",
        "apServerEnabled": true,
        "apServerPrimary": true
      },
      {
        "apMac": "58:FF:36:00:0E:20",
        "apServerEnabled": true,
        "apServerPrimary": false
      }
    ],
    "siteProfileIds": [
      "75e26590-547f-11e6-9ca7-5a095364c13c",
      "869bb532-547f-11e6-9ca7-5a095364c13c"
    ]
  },
  "snmpAgent": {
    "apSnmpEnabled": true,
    "snmpV2Agent": [
      {
        "communityName": "v2Agent",
        "notificationEnabled": true,
        "readEnabled": true,
        "writeEnabled": true,
        "notificationType": "TRAP",
        "notificationTarget": [
          {
            "address": "172.19.16.20",
            "port": 161
          }
        ]
      }
    ],
    "snmpV3Agent": [
      {
        "userName": "v3Agent",
        "authProtocol": "MD5",
        "authPassword": "admin!234",
        "privProtocol": "DES",
        "privPassword": "admin!234",
        "notificationEnabled": true,
        "readEnabled": true,
        "writeEnabled": true,
        "notificationType": "TRAP",
        "notificationTarget": [
          {
            "address": "172.19.16.20",
            "port": 161
          }
        ]
      }
    ]
  },
  "rogueApReportThreshold": 40,
  "rogueApAggressivenessMode": 2,
  "rogueApJammingDetection": true,
  "rogueApJammingThreshold": 40,
  "directedMulticastFromWiredClientEnabled": true,
  "directedMulticastFromWirelessClientEnabled": true,
  "directedMulticastFromNetworkEnabled": false,
  "healthCheckSitesEnabled": true,
  "healthCheckSites": [
    "www.google.com",
    "www.live.com:443",
    "www.github.com:443",
    "source.codeaurora.org:443",
    "www.wikipedia.com"
  ],
  "rkusGreTunnelProfile": {
    "id": "f5b92938-aa4e-4d02-90ea-273799ff689b",
    "name": "Default Tunnel Profile"
  },
  "softGreTunnelProflies": [
    {
      "id": "5a2e41b0-df53-11e7-98e1-08002748d78e",
      "name": "softGre1",
      "aaaAffinityEnabled": true
    },
    {
      "id": "7803e411-df53-11e7-98e1-08002748d78e",
      "name": "softGre2",
      "aaaAffinityEnabled": true
    }
  ],
  "ipsecProfiles": [
    {
      "id": "3fd9aa91-df65-11e7-98e1-08002748d78e",
      "name": "ipsec1"
    }
  ],
  "paloAltoFirewallProfileId": "2f59b0f4-c86f-11e8-a8d5-f2801f1b9fd1",
  "apHccdEnabled": true,
  "apHccdPersist": true,
  "rksGreForwardBroadcast": false
}

Schema

{
    "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" : {
            "description" : "Name of the zone",
            "type" : "string",
            "minLength" : 2,
            "maxLength" : 32,
            "pattern" : "^[!-~]([ -~]){0,30}[!-~]$"
        },
        "description" : {
            "description" : "Description of the zone",
            "type" : [ "string", "null" ],
            "maxLength" : 64
        },
        "version" : {
            "description" : "AP firmware version of the zone",
            "type" : "string",
            "pattern" : "^\d+\.\d+\.\d+\.\d+\.\d+$"
        },
        "countryCode" : {
            "description" : "Country code of the zone",
            "type" : "string"
        },
        "timezone" : {
            "description" : "Time zone",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "systemTimezone" : {
                    "description" : "System defined time zone, please refer to the 'Overview > Time Zone' list",
                    "type" : "string"
                },
                "customizedTimezone" : {
                    "description" : "User defined time zone",
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "abbreviation" : {
                            "description" : "Time zone abbreviation",
                            "type" : "string",
                            "pattern" : "^[a-zA-Z]{3,4}$"
                        },
                        "gmtOffset" : {
                            "description" : "GMT offset",
                            "type" : "integer",
                            "minimum" : -11,
                            "maximum" : 14
                        },
                        "gmtOffsetMinute" : {
                            "description" : "GMT offset minute",
                            "type" : "integer",
                            "minimum" : 0,
                            "maximum" : 59
                        },
                        "start" : {
                            "description" : "Daylight saving time start",
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "month" : {
                                    "description" : "Month when daylight saving time begins",
                                    "type" : "integer",
                                    "enum" : [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ]
                                },
                                "week" : {
                                    "description" : "Week of the month (1 for the first week, 2 for the second week, and so on)",
                                    "type" : "integer",
                                    "enum" : [ 1, 2, 3, 4, 5 ]
                                },
                                "day" : {
                                    "description" : "Day of the week (0 for Sunday, 1 for Monday, 2 for Tuesday, and so on)",
                                    "type" : "integer",
                                    "enum" : [ 0, 1, 2, 3, 4, 5, 6 ]
                                },
                                "hour" : {
                                    "description" : "Hour of the day",
                                    "type" : "integer",
                                    "minimum" : 0,
                                    "maximum" : 23
                                }
                            },
                            "required" : [ "month", "week", "day", "hour" ]
                        },
                        "end" : {
                            "description" : "Daylight saving time end",
                            "type" : "object",
                            "additionalProperties" : false,
                            "properties" : {
                                "month" : {
                                    "description" : "Month when daylight saving time begins",
                                    "type" : "integer",
                                    "enum" : [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ]
                                },
                                "week" : {
                                    "description" : "Week of the month (1 for the first week, 2 for the second week, and so on)",
                                    "type" : "integer",
                                    "enum" : [ 1, 2, 3, 4, 5 ]
                                },
                                "day" : {
                                    "description" : "Day of the week (0 for Sunday, 1 for Monday, 2 for Tuesday, and so on)",
                                    "type" : "integer",
                                    "enum" : [ 0, 1, 2, 3, 4, 5, 6 ]
                                },
                                "hour" : {
                                    "description" : "Hour of the day",
                                    "type" : "integer",
                                    "minimum" : 0,
                                    "maximum" : 23
                                }
                            },
                            "required" : [ "month", "week", "day", "hour" ]
                        }
                    },
                    "required" : [ "abbreviation", "gmtOffset", "gmtOffsetMinute" ]
                }
            }
        },
        "login" : {
            "description" : "AP administrator account",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "apLoginName" : {
                    "description" : "User name of the AP administrator",
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : "^((?!\$\()[!-_a-~]){1,64}$"
                },
                "apLoginPassword" : {
                    "description" : "Password of the AP administrator",
                    "type" : "string",
                    "maxLength" : 64,
                    "pattern" : ".*(?=.{8,})(?=.*[a-zA-Z])(?=.*[0-9])(?=.*[_`~!@#$%^&*\(\)\[\]\{\}|;:'\",.\<>\/?=+-]).*"
                }
            },
            "required" : [ "apLoginName", "apLoginPassword" ]
        },
        "ipMode" : {
            "description" : "IP mode of the zone",
            "type" : "string",
            "enum" : [ "IPV4", "IPV6", "IPV4_IPV6" ]
        },
        "mesh" : {
            "description" : "Mesh configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "ssid" : {
                    "description" : "SSID of the mesh network",
                    "type" : "string"
                },
                "passphrase" : {
                    "description" : "Passphrase for the mesh network",
                    "type" : "string"
                },
                "meshRadioIdx" : {
                    "description" : "Mesh radio index",
                    "type" : "string",
                    "enum" : [ "Radio24G", "Radio5G" ],
                    "default" : "Radio5G"
                },
                "zeroTouchStatus" : {
                    "type" : "boolean"
                }
            }
        },
        "dfsChannelEnabled" : {
            "description" : "DFS Channel enabled configuration of the zone, only for the US country code .",
            "type" : "boolean"
        },
        "cbandChannelEnabled" : {
            "description" : "5.8Ghz channels enabled configuration of the zone.",
            "type" : "boolean"
        },
        "cbandChannelLicenseEnabled" : {
            "description" : "5.8Ghz channels license enabled configuration of the zone.",
            "type" : "boolean"
        },
        "channel144Enabled" : {
            "description" : "Channel 144 enabled configuration of the zone.",
            "type" : "boolean"
        },
        "wifi24" : {
            "description" : "AP 2.4GHz radio configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "autoCellSizing" : {
                    "description" : "Auto Cell Sizing",
                    "type" : "boolean"
                },
                "txPower" : {
                    "description" : "Transmission power",
                    "type" : "string",
                    "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
                    "default" : "Full"
                },
                "channelWidth" : {
                    "description" : "Channel width. Zero (0) means Auto.",
                    "type" : "integer",
                    "enum" : [ 0, 20, 40 ]
                },
                "channel" : {
                    "description" : "Channel number",
                    "type" : "integer"
                },
                "channelRange" : {
                    "description" : "Channel range options",
                    "type" : "array",
                    "items" : {
                        "type" : "integer"
                    }
                },
                "availableChannelRange" : {
                    "description" : "Available channel range options",
                    "type" : "array",
                    "items" : {
                        "type" : "integer"
                    }
                }
            }
        },
        "wifi50" : {
            "description" : "AP 5GHz radio configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "autoCellSizing" : {
                    "description" : "Auto Cell Sizing",
                    "type" : "boolean"
                },
                "txPower" : {
                    "description" : "Transmission power",
                    "type" : "string",
                    "enum" : [ "Full", "-1dB", "-2dB", "-3dB(1/2)", "-4dB", "-5dB", "-6dB(1/4)", "-7dB", "-8dB", "-9dB(1/8)", "-10dB", "Min" ],
                    "default" : "Full"
                },
                "channelWidth" : {
                    "description" : "Channel width. Zero (0) means Auto. 8080 means 80+80MHz",
                    "type" : "integer",
                    "enum" : [ 0, 20, 40, 80, 8080, 160 ]
                },
                "indoorChannel" : {
                    "description" : "Channel number for Indoor AP",
                    "type" : "integer"
                },
                "outdoorChannel" : {
                    "description" : "Channel number for Outdoor AP",
                    "type" : "integer"
                },
                "indoorSecondaryChannel" : {
                    "description" : "Secondary channel number for Indoor AP (channelWidth is 80+80MHz only)",
                    "type" : "integer"
                },
                "outdoorSecondaryChannel" : {
                    "description" : "Secondary channel number for outdoor AP (channelWidth is 80+80MHz only)",
                    "type" : "integer"
                },
                "indoorChannelRange" : {
                    "description" : "Channel range options for Indoor AP",
                    "type" : "array",
                    "items" : {
                        "type" : "integer"
                    }
                },
                "outdoorChannelRange" : {
                    "description" : "Channel range options for outdoor AP",
                    "type" : "array",
                    "items" : {
                        "type" : "integer"
                    }
                },
                "availableIndoorChannelRange" : {
                    "description" : "Available channel range options",
                    "type" : "array",
                    "items" : {
                        "type" : "integer"
                    }
                },
                "availableOutdoorChannelRange" : {
                    "description" : "Available channel range options",
                    "type" : "array",
                    "items" : {
                        "type" : "integer"
                    }
                }
            }
        },
        "protectionMode24" : {
            "description" : "AP 2.4GHz Protection mode configuration of the zone.",
            "type" : "string",
            "enum" : [ "NONE", "CTS_ONLY", "RTS_CTS" ],
            "default" : "RTS_CTS"
        },
        "syslog" : {
            "description" : "Syslog configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "flowLevel" : {
                    "description" : "Flow Level of the syslog",
                    "type" : "string",
                    "enum" : [ "GENERAL_LOGS", "CLIENT_FLOW", "ALL" ],
                    "default" : "GENERAL_LOGS"
                },
                "address" : {
                    "description" : "Address of the syslog server.",
                    "type" : "string"
                },
                "port" : {
                    "description" : "Port number of the syslog server",
                    "type" : "integer",
                    "default" : 514,
                    "minimum" : 1,
                    "maximum" : 65535
                },
                "protocol" : {
                    "description" : "Protocol of the syslog server",
                    "type" : "string",
                    "enum" : [ "IPPROTO_TCP", "IPPROTO_UDP" ],
                    "default" : "IPPROTO_TCP"
                },
                "secondaryAddress" : {
                    "description" : "Secondary Server Address of the syslog server",
                    "type" : "string"
                },
                "secondaryPort" : {
                    "description" : "Secondary Server Port of the syslog server",
                    "type" : "integer",
                    "default" : 514,
                    "minimum" : 1,
                    "maximum" : 65535
                },
                "secondaryProtocol" : {
                    "description" : "Secondary Server Protocol of the syslog server",
                    "type" : "string",
                    "enum" : [ "IPPROTO_TCP", "IPPROTO_UDP" ],
                    "default" : "IPPROTO_TCP"
                },
                "facility" : {
                    "description" : "Facility of the syslog server",
                    "type" : "string",
                    "enum" : [ "Keep_Original", "Local0", "Local1", "Local2", "Local3", "Local4", "Local5", "Local6", "Local7" ],
                    "default" : "Keep_Original"
                },
                "priority" : {
                    "description" : "Priority of the log messages",
                    "type" : "string",
                    "enum" : [ "Emergency", "Alert", "Critical", "Error", "Warning", "Notice", "Info", "All" ],
                    "default" : "Error"
                }
            }
        },
        "smartMonitor" : {
            "description" : "Smart monitor configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "intervalInSec" : {
                    "description" : "Interval in seconds. This is required if smartMonitor is enabled",
                    "type" : "integer",
                    "default" : 10,
                    "minimum" : 5,
                    "maximum" : 60
                },
                "retryThreshold" : {
                    "description" : "Retry threshold. This is required if smartMonitor is enabled",
                    "type" : "integer",
                    "default" : 3,
                    "minimum" : 1,
                    "maximum" : 10
                }
            }
        },
        "clientAdmissionControl24" : {
            "description" : "AP client admission control 2.4GHz radio configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "maxRadioLoadPercent" : {
                    "description" : "Maximum radio load percentage.",
                    "type" : "integer",
                    "default" : 75,
                    "minimum" : 50,
                    "maximum" : 100
                },
                "minClientCount" : {
                    "description" : "Minimum client count number.",
                    "type" : "integer",
                    "default" : 10,
                    "minimum" : 0,
                    "maximum" : 100
                },
                "minClientThroughputMbps" : {
                    "description" : "Minimum client throughput in Mbps.",
                    "type" : "number",
                    "default" : 0,
                    "minimum" : 0,
                    "maximum" : 100
                }
            }
        },
        "clientAdmissionControl50" : {
            "description" : "AP client admission control 5GHz radio configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "maxRadioLoadPercent" : {
                    "description" : "Maximum radio load percentage.",
                    "type" : "integer",
                    "default" : 75,
                    "minimum" : 50,
                    "maximum" : 100
                },
                "minClientCount" : {
                    "description" : "Minimum client count number.",
                    "type" : "integer",
                    "default" : 10,
                    "minimum" : 0,
                    "maximum" : 100
                },
                "minClientThroughputMbps" : {
                    "description" : "Minimum client throughput in Mbps.",
                    "type" : "number",
                    "default" : 0,
                    "minimum" : 0,
                    "maximum" : 100
                }
            }
        },
        "channelModeEnabled" : {
            "description" : "Channel mode configuration of the zone.",
            "type" : "boolean"
        },
        "tunnelType" : {
            "description" : "Tunnel type configuration of the zone. No_Tunneled is for IPv6 mode",
            "type" : "string",
            "enum" : [ "No_Tunneled", "RuckusGRE", "SoftGRE", "SoftGREIpsec" ],
            "default" : "RuckusGRE"
        },
        "tunnelProfile" : {
            "description" : "Tunnel type configuration of the zone.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "backgroundScanning24" : {
            "description" : "Background scanning on 2.4GHz radio configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "frequencyInSec" : {
                    "description" : "Frequency in second",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 65535,
                    "default" : 20
                }
            }
        },
        "backgroundScanning50" : {
            "description" : "Background scanning on 5GHz radio configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "frequencyInSec" : {
                    "description" : "Frequency in second",
                    "type" : "integer",
                    "minimum" : 1,
                    "maximum" : 65535,
                    "default" : 20
                }
            }
        },
        "loadBalancing" : {
            "description" : "Load Balancing configuration of the zone",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "loadBalancingMethod" : {
                    "type" : "string",
                    "enum" : [ "BASED_ON_CLIENT_COUNT", "BASED_ON_CAPACITY", "OFF" ],
                    "default" : "BASED_ON_CLIENT_COUNT"
                },
                "clientLoadBalancing24" : {
                    "description" : "Client load balancing on 2.4GHz radio configuration of the zone.",
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "adjacentRadioThreshold" : {
                            "description" : "Adjacent radio threshold",
                            "type" : "integer",
                            "minimum" : 1,
                            "maximum" : 100
                        }
                    }
                },
                "clientLoadBalancing50" : {
                    "description" : "Client load balancing on 5GHz radio configuration of the zone.",
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "adjacentRadioThreshold" : {
                            "description" : "Adjacent radio threshold",
                            "type" : "integer",
                            "minimum" : 1,
                            "maximum" : 100
                        }
                    }
                },
                "bandBalancing" : {
                    "description" : "Band Balancing configuration of the zone.",
                    "type" : "object",
                    "additionalProperties" : false,
                    "properties" : {
                        "wifi24Percentage" : {
                            "description" : "Percentage of client load on 2.4GHz radio band",
                            "type" : "integer",
                            "minimum" : 0,
                            "maximum" : 100,
                            "default" : 25
                        }
                    }
                },
                "steeringMode" : {
                    "description" : "Steering Mode: BASIC-Withholds probe and authentication responses at connetcion time in heavily loaded band to balance clients to the other band, PROACTIVE-Uses BASIC functionality and actively rebalances clients via 802.11v BTM, STRICT-Uses PROACTIVE functionality and forcefully rebalances clients via 802.11v BTM",
                    "type" : "string",
                    "enum" : [ "BASIC", "PROACTIVE", "STRICT" ],
                    "default" : "BASIC"
                }
            }
        },
        "rogue" : {
            "description" : "Rogue AP detection configuration of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "reportType" : {
                    "description" : "Report type",
                    "type" : "string",
                    "enum" : [ "All", "Malicious" ]
                },
                "maliciousTypes" : {
                    "description" : "Malicious type when reportType is Malicious",
                    "type" : [ "array", "null" ],
                    "items" : {
                        "type" : "string",
                        "enum" : [ "SSIDSpoofing", "SameNetwork", "MACSpoofing" ]
                    }
                },
                "protectionEnabled" : {
                    "description" : "Protection enabled",
                    "type" : "boolean"
                }
            }
        },
        "dosBarringEnable" : {
            "description" : "Enable DoS Protection(Barring UE) of the zone.",
            "type" : "integer"
        },
        "dosBarringPeriod" : {
            "description" : "DoS Protection(Barring UE) blocking period of the zone.",
            "type" : "integer"
        },
        "dosBarringThreshold" : {
            "description" : "DoS Protection(Barring UE) threshold of the zone.",
            "type" : "integer"
        },
        "dosBarringCheckPeriod" : {
            "description" : "DoS Protection(Barring UE) check period of the zone.",
            "type" : "integer"
        },
        "locationBasedService" : {
            "description" : "Location based service configuration of the zone.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "apRebootTimeout" : {
            "description" : "AP reboot timeout of the zone.",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "gatewayLossTimeoutInSec" : {
                    "description" : "Gateway loss timeout in second",
                    "type" : "integer",
                    "enum" : [ 0, 1800, 3600, 5400, 7200, 9000, 10800, 12600, 14400, 16200, 18000, 19800, 23400, 25200, 27000, 28800, 30600, 32400, 34200, 36000, 37800, 39600, 41400, 43200, 45000, 46800, 48600, 50400, 52200, 54000, 55800, 57600, 59400, 61200, 63000, 64800, 66600, 68400, 70200, 72000, 73800, 75600, 77400, 79200, 81000, 82800, 84600, 86400 ],
                    "default" : 1800
                },
                "serverLossTimeoutInSec" : {
                    "description" : "Server loss timeout in second",
                    "type" : "integer",
                    "enum" : [ 0, 7200, 14400, 21600, 28800, 36000, 43200, 50400, 57600, 64800, 72000, 79200, 86400 ],
                    "default" : 7200
                }
            }
        },
        "location" : {
            "description" : "Location of the Zone.",
            "type" : "string"
        },
        "locationAdditionalInfo" : {
            "description" : "Location additional info of the zone.",
            "type" : "string",
            "pattern" : "^([!-~]([ -~]){0,253}[!-~]|[!-~]{1,1})$"
        },
        "altitude" : {
            "description" : "GPS Altitude",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "altitudeUnit" : {
                    "description" : "altitude unit",
                    "type" : "string",
                    "enum" : [ "meters", "floor" ],
                    "default" : "meters"
                },
                "altitudeValue" : {
                    "description" : "altitude value",
                    "type" : "integer"
                }
            }
        },
        "latitude" : {
            "description" : "Latitude coordinate (in decimal format) of the zone",
            "type" : "number"
        },
        "longitude" : {
            "description" : "Longitude coordinate (in decimal format) of the zone",
            "type" : "number"
        },
        "vlanOverlappingEnabled" : {
            "description" : "VLAN pooling overlapping of the zone",
            "type" : "boolean"
        },
        "nodeAffinityProfile" : {
            "description" : "Node affinity profile of the zone.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "venueProfile" : {
            "description" : "venue profile configuration of the Zone.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "autoChannelSelection24" : {
            "description" : "client load balancing on Radio 2.4G, auto channel selection mode",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "channelSelectMode" : {
                    "description" : "Channel Select Mode",
                    "type" : "string",
                    "enum" : [ "None", "BackgroundScanning", "ChannelFly" ],
                    "default" : "BackgroundScanning"
                },
                "channelFlyMtbc" : {
                    "description" : "ChannelFly MTBC",
                    "type" : "integer",
                    "default" : 480,
                    "minimum" : 100,
                    "maximum" : 1440
                },
                "channelFlyChangeFrequency" : {
                    "description" : "ChannelFly Change Frequency",
                    "type" : "integer",
                    "default" : 33,
                    "minimum" : 1,
                    "maximum" : 100
                },
                "channelFlyOptimizationTimePeriod" : {
                    "description" : "ChannelFly Optimization Time Period",
                    "type" : "array",
                    "items" : {
                        "type" : "string",
                        "pattern" : "^([0-1][0-9]|2[0-3]):00-(([0-1][0-9]|2[0-4]):00)$"
                    }
                }
            }
        },
        "autoChannelSelection50" : {
            "description" : "client load balancing on Radio 5G, auto channel selection mode",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "channelSelectMode" : {
                    "description" : "Channel Select Mode",
                    "type" : "string",
                    "enum" : [ "None", "BackgroundScanning", "ChannelFly" ],
                    "default" : "BackgroundScanning"
                },
                "channelFlyMtbc" : {
                    "description" : "ChannelFly MTBC",
                    "type" : "integer",
                    "default" : 480,
                    "minimum" : 100,
                    "maximum" : 1440
                },
                "channelFlyChangeFrequency" : {
                    "description" : "ChannelFly Change Frequency",
                    "type" : "integer",
                    "default" : 33,
                    "minimum" : 1,
                    "maximum" : 100
                },
                "channelFlyOptimizationTimePeriod" : {
                    "description" : "ChannelFly Optimization Time Period",
                    "type" : "array",
                    "items" : {
                        "type" : "string",
                        "pattern" : "^([0-1][0-9]|2[0-3]):00-(([0-1][0-9]|2[0-4]):00)$"
                    }
                }
            }
        },
        "channelEvaluationInterval" : {
            "description" : "channel evaluation Interval of the zone",
            "type" : "integer",
            "default" : 600,
            "minimum" : 60,
            "maximum" : 3600
        },
        "apMgmtVlan" : {
            "description" : "ap Management Vlan of the zone",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "mode" : {
                    "description" : "Vlan Mode of the zone",
                    "type" : "string",
                    "enum" : [ "KEEP", "USER_DEFINED" ],
                    "default" : "KEEP"
                },
                "id" : {
                    "description" : "Vlan id of the zone",
                    "type" : "integer",
                    "default" : "1"
                }
            }
        },
        "apLatencyInterval" : {
            "description" : "AP latency interval",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "pingEnabled" : {
                    "description" : "AP ping latency enabled",
                    "type" : "boolean",
                    "default" : true
                }
            }
        },
        "ipsecProfile" : {
            "description" : "ipsec profile configuration of the Zone.",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "ipv6TrafficFilterEnabled" : {
            "description" : "IPv6 Traffic filtering on the AP",
            "type" : "integer"
        },
        "restrictedApAccessEnabled" : {
            "description" : "Enable Restricted AP Access of the zone.",
            "type" : "boolean"
        },
        "restrictedApAccessProfileId" : {
            "description" : "Restricted AP Access Profile Id of the zone.",
            "type" : "string"
        },
        "bonjourFencingPolicyEnabled" : {
            "description" : "Enable Bonjour Fencing Policy on the AP",
            "type" : "boolean"
        },
        "bonjourFencingPolicy" : {
            "description" : "Bonjour Fencing Policy on the AP",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "dhcpSiteConfig" : {
            "description" : "DHCP Site Config in Zone",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "siteEnabled" : {
                    "description" : "DHCP Service Enabling Status",
                    "type" : "boolean"
                },
                "dwpdEnabled" : {
                    "description" : "DHCP Service Dynamic WAN Port Detection",
                    "type" : "boolean"
                },
                "manualSelect" : {
                    "description" : "DHCP Service AP Selection Mode. This value is effective when the siteMode is EnableOnMultipleAPs.",
                    "type" : "boolean"
                },
                "siteMode" : {
                    "description" : "DHCP Service mode",
                    "type" : "string",
                    "enum" : [ "EnableOnEachAPs", "EnableOnMultipleAPs", "EnableOnHierarchicalAPs" ]
                },
                "eth0ProfileId" : {
                    "type" : "integer"
                },
                "eth1ProfileId" : {
                    "type" : "integer"
                },
                "siteAps" : {
                    "type" : "array",
                    "items" : {
                        "type" : "object",
                        "description" : "DHCP Site selected APs. The content is effective when the siteMode is EnableOnMultipleAPs.",
                        "additionalProperties" : false,
                        "properties" : {
                            "apMac" : {
                                "type" : "string"
                            },
                            "apName" : {
                                "type" : "string"
                            },
                            "apStatus" : {
                                "type" : "string",
                                "enum" : [ "Online", "Offline", "Flagged" ]
                            },
                            "apServerEnabled" : {
                                "type" : "boolean"
                            },
                            "apServerPrimary" : {
                                "type" : "boolean"
                            },
                            "apServerIp" : {
                                "type" : [ "string", "null" ]
                            },
                            "apGatewayIp" : {
                                "type" : "string"
                            },
                            "apServerType" : {
                                "type" : "string"
                            }
                        }
                    }
                },
                "siteProfileIds" : {
                    "type" : "array",
                    "items" : {
                        "type" : "string"
                    }
                }
            }
        },
        "snmpAgent" : {
            "description" : "AP SNMP Options",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "apSnmpEnabled" : {
                    "description" : "Enable AP SNMP",
                    "type" : "boolean"
                },
                "snmpV2Agent" : {
                    "description" : "Community List of the SNMP V2 Agent.",
                    "type" : "array",
                    "items" : {
                        "type" : "object",
                        "additionalProperties" : false,
                        "properties" : {
                            "communityName" : {
                                "description" : "name of the SNMP Community.",
                                "type" : "string"
                            },
                            "readEnabled" : {
                                "description" : "read privilege of the SNMP Coummunity",
                                "type" : "boolean"
                            },
                            "writeEnabled" : {
                                "description" : "write privilege of the SNMP Coummunity",
                                "type" : "boolean"
                            },
                            "notificationEnabled" : {
                                "description" : "notification privilege of the SNMP Coummunity",
                                "type" : "boolean"
                            },
                            "notificationType" : {
                                "description" : "type of the notification privilege",
                                "type" : "string",
                                "enum" : [ "TRAP", "INFORM" ]
                            },
                            "notificationTarget" : {
                                "description" : "Trap List of the SNMP Coummunity",
                                "type" : "array",
                                "items" : {
                                    "type" : "object",
                                    "additionalProperties" : false,
                                    "properties" : {
                                        "address" : {
                                            "description" : "address of the SNMP Trap",
                                            "type" : "string"
                                        },
                                        "port" : {
                                            "description" : "port number of the SNMP Trap",
                                            "type" : "integer",
                                            "minimum" : 1,
                                            "maximum" : 65535
                                        }
                                    },
                                    "required" : [ "address", "port" ]
                                }
                            }
                        },
                        "required" : [ "communityName", "readEnabled", "writeEnabled", "notificationEnabled" ]
                    }
                },
                "snmpV3Agent" : {
                    "description" : "User List of the SNMP V3 Agent.",
                    "type" : "array",
                    "items" : {
                        "type" : "object",
                        "additionalProperties" : false,
                        "properties" : {
                            "userName" : {
                                "description" : "name of the SNMP User.",
                                "type" : "string"
                            },
                            "authProtocol" : {
                                "description" : "authProtocol of the SNMP User.",
                                "type" : "string",
                                "enum" : [ "NONE", "MD5", "SHA" ]
                            },
                            "authPassword" : {
                                "description" : "authPassword of the SNMP User.",
                                "type" : "string",
                                "minLength" : 8
                            },
                            "privProtocol" : {
                                "description" : "privProtocol of the SNMP User.",
                                "type" : "string",
                                "enum" : [ "NONE", "DES", "AES" ]
                            },
                            "privPassword" : {
                                "description" : "privPassword of the SNMP User.",
                                "type" : "string",
                                "minLength" : 8
                            },
                            "readEnabled" : {
                                "description" : "read privilege of the SNMP User",
                                "type" : "boolean"
                            },
                            "writeEnabled" : {
                                "description" : "write privilege of the SNMP User",
                                "type" : "boolean"
                            },
                            "notificationEnabled" : {
                                "description" : "notification privilege of the SNMP User",
                                "type" : "boolean"
                            },
                            "notificationType" : {
                                "description" : "type of the notification privilege",
                                "type" : "string",
                                "enum" : [ "TRAP", "INFORM" ]
                            },
                            "notificationTarget" : {
                                "description" : "Trap List of the SNMP User",
                                "type" : "array",
                                "items" : {
                                    "type" : "object",
                                    "additionalProperties" : false,
                                    "properties" : {
                                        "address" : {
                                            "description" : "address of the SNMP Trap",
                                            "type" : "string"
                                        },
                                        "port" : {
                                            "description" : "port number of the SNMP Trap",
                                            "type" : "integer",
                                            "minimum" : 1,
                                            "maximum" : 65535
                                        }
                                    },
                                    "required" : [ "address", "port" ]
                                }
                            }
                        },
                        "required" : [ "userName", "readEnabled", "writeEnabled", "notificationEnabled" ]
                    }
                }
            }
        },
        "recoverySsid" : {
            "description" : "Recovery SSID",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "recoverySsidPskKey" : {
                    "description" : "Custom recovery ssid passphrase. If passphrase has been customized, this property cannot be empty in the future. ",
                    "type" : "string"
                },
                "recoverySsidEnabled" : {
                    "description" : "recovery ssid enable/disable",
                    "type" : "boolean"
                }
            }
        },
        "clusterRedundancyEnabled" : {
            "description" : "Enable Cluster redundancy on zone",
            "type" : "boolean"
        },
        "rogueApReportThreshold" : {
            "description" : "Rogue AP report will leave out all entries that have signal strength lower than this threshold.",
            "type" : "integer"
        },
        "rogueApAggressivenessMode" : {
            "description" : "Adjust the frequency interval to de-authenticate rogue APs.",
            "type" : "integer"
        },
        "rogueApJammingDetection" : {
            "description" : "Enable jamming detection.",
            "type" : "boolean"
        },
        "rogueApJammingThreshold" : {
            "type" : "integer"
        },
        "directedMulticastFromWiredClientEnabled" : {
            "description" : "Directed multicast from wired client.",
            "type" : "boolean"
        },
        "directedMulticastFromWirelessClientEnabled" : {
            "description" : "Directed multicast from wireless client.",
            "type" : "boolean"
        },
        "directedMulticastFromNetworkEnabled" : {
            "description" : "Directed multicast from network.",
            "type" : "boolean"
        },
        "healthCheckSitesEnabled" : {
            "description" : "Enabled Health Check Sites. ",
            "type" : "boolean",
            "default" : false
        },
        "healthCheckSites" : {
            "description" : "Health Check Sites.",
            "type" : "array",
            "items" : {
                "type" : "string"
            }
        },
        "ruckusGreTunnelProfile" : {
            "description" : "Ruckus GRE Profile for Multiple Tunnel (Start from SZ 5.0)",
            "type" : [ "object", "null" ],
            "additionalProperties" : false,
            "properties" : {
                "id" : {
                    "type" : "string"
                },
                "name" : {
                    "type" : "string"
                }
            }
        },
        "softGreTunnelProflies" : {
            "description" : "SoftGRE Profiles for Multiple Tunnel (Start from SZ 5.0)",
            "type" : "array",
            "items" : {
                "type" : [ "object", "null" ],
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "type" : "string"
                    },
                    "name" : {
                        "type" : "string"
                    },
                    "aaaAffinityEnabled" : {
                        "type" : "boolean"
                    }
                }
            }
        },
        "ipsecProfiles" : {
            "description" : "Ipsec profile for Multiple Tunnel (Start from SZ 5.0)",
            "type" : "array",
            "items" : {
                "type" : [ "object", "null" ],
                "additionalProperties" : false,
                "properties" : {
                    "id" : {
                        "type" : "string"
                    },
                    "name" : {
                        "type" : "string"
                    }
                }
            }
        },
        "ipsecTunnelMode" : {
            "type" : "string",
            "enum" : [ "DISABLE", "SOFT_GRE", "RUCKUS_GRE" ]
        },
        "rksGreForwardBroadcast" : {
            "description" : "Ruckus GRE tunnel broadcast packet forwarding",
            "type" : "boolean",
            "default" : false
        },
        "sshTunnelEncryption" : {
            "type" : "string",
            "enum" : [ "AES128", "AES256" ]
        },
        "lteBandLockChannels" : {
            "description" : "LTE band lock channels options",
            "type" : "array",
            "items" : {
                "type" : "object",
                "additionalProperties" : false,
                "properties" : {
                    "simCardId" : {
                        "description" : "SIM card ID(Primary:0, Secondary:1)",
                        "type" : "integer"
                    },
                    "type" : {
                        "description" : "LTE chipset SKU type",
                        "type" : "string"
                    },
                    "channel4g" : {
                        "description" : "LTE 4G channels",
                        "type" : "string"
                    },
                    "channel3g" : {
                        "description" : "LTE 3G channels",
                        "type" : "string"
                    }
                }
            }
        },
        "paloAltoFirewallProfileId" : {
            "type" : "string"
        },
        "apHccdEnabled" : {
            "description" : "Historical Connection Failures allows the AP to report historical client connection failures for this zone.",
            "type" : "boolean",
            "default" : false
        },
        "apHccdPersist" : {
            "description" : "Allow Historical Connection Failures to be persisted.",
            "type" : "boolean",
            "default" : true
        },
        "aaaAffinityEnabled" : {
            "type" : "boolean"
        },
        "awsVenue" : {
            "description" : "Venue Code",
            "type" : "string",
            "minLength" : 0,
            "maxLength" : 64,
            "pattern" : "^[!-~]{0,63}[!-~]$|^$"
        },
        "zoneAffinityProfileId" : {
            "description" : "zone affinity profile Id",
            "type" : "string"
        },
        "enforcePriorityZoneAffinityEnable" : {
            "type" : "boolean"
        },
        "myRuckusConfig" : {
            "description" : "My.Ruckus configuration",
            "type" : "object",
            "additionalProperties" : false,
            "properties" : {
                "aclForTunnelWlanAndVlanEnable" : {
                    "description" : "My.Ruckus support for tunnel-wlan/vlan",
                    "type" : "boolean"
                }
            },
            "required" : [ "aclForTunnelWlanAndVlanEnable" ]
        }
    }
}